blob: be4f3b598c9756c135f3f5b300157cd9cab0c226 [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 {
Dan Gohmanbb854092010-08-16 16:16:11 +0000261 for (op_iterator I = op_begin(), E = op_end(); I != E; ++I)
262 if (!(*I)->dominates(BB, DT))
Evan Cheng5a6c1a82009-02-17 00:13:06 +0000263 return false;
Evan Cheng5a6c1a82009-02-17 00:13:06 +0000264 return true;
265}
266
Dan Gohman6e70e312009-09-27 15:26:03 +0000267bool SCEVNAryExpr::properlyDominates(BasicBlock *BB, DominatorTree *DT) const {
Dan Gohmanbb854092010-08-16 16:16:11 +0000268 for (op_iterator I = op_begin(), E = op_end(); I != E; ++I)
269 if (!(*I)->properlyDominates(BB, DT))
Dan Gohman6e70e312009-09-27 15:26:03 +0000270 return false;
Dan Gohman6e70e312009-09-27 15:26:03 +0000271 return true;
272}
273
Dan Gohman2f199f92010-08-16 16:21:27 +0000274bool SCEVNAryExpr::isLoopInvariant(const Loop *L) const {
275 for (op_iterator I = op_begin(), E = op_end(); I != E; ++I)
276 if (!(*I)->isLoopInvariant(L))
277 return false;
278 return true;
279}
280
281// hasComputableLoopEvolution - N-ary expressions have computable loop
282// evolutions iff they have at least one operand that varies with the loop,
283// but that all varying operands are computable.
284bool SCEVNAryExpr::hasComputableLoopEvolution(const Loop *L) const {
285 bool HasVarying = false;
286 for (op_iterator I = op_begin(), E = op_end(); I != E; ++I) {
287 const SCEV *S = *I;
288 if (!S->isLoopInvariant(L)) {
289 if (S->hasComputableLoopEvolution(L))
290 HasVarying = true;
291 else
292 return false;
293 }
294 }
295 return HasVarying;
296}
297
298bool SCEVNAryExpr::hasOperand(const SCEV *O) const {
299 for (op_iterator I = op_begin(), E = op_end(); I != E; ++I) {
300 const SCEV *S = *I;
301 if (O == S || S->hasOperand(O))
302 return true;
303 }
304 return false;
305}
306
Evan Cheng5a6c1a82009-02-17 00:13:06 +0000307bool SCEVUDivExpr::dominates(BasicBlock *BB, DominatorTree *DT) const {
308 return LHS->dominates(BB, DT) && RHS->dominates(BB, DT);
309}
310
Dan Gohman6e70e312009-09-27 15:26:03 +0000311bool SCEVUDivExpr::properlyDominates(BasicBlock *BB, DominatorTree *DT) const {
312 return LHS->properlyDominates(BB, DT) && RHS->properlyDominates(BB, DT);
313}
314
Dan Gohmanb7ef7292009-04-21 00:47:46 +0000315void SCEVUDivExpr::print(raw_ostream &OS) const {
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000316 OS << "(" << *LHS << " /u " << *RHS << ")";
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000317}
318
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000319const Type *SCEVUDivExpr::getType() const {
Dan Gohman91bb61a2009-05-26 17:44:05 +0000320 // In most cases the types of LHS and RHS will be the same, but in some
321 // crazy cases one or the other may be a pointer. ScalarEvolution doesn't
322 // depend on the type for correctness, but handling types carefully can
323 // avoid extra casts in the SCEVExpander. The LHS is more likely to be
324 // a pointer type than the RHS, so use the RHS' type here.
325 return RHS->getType();
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000326}
327
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000328bool SCEVAddRecExpr::isLoopInvariant(const Loop *QueryLoop) const {
Dan Gohmana3035a62009-05-20 01:01:24 +0000329 // Add recurrences are never invariant in the function-body (null loop).
Dan Gohmane890eea2009-06-26 22:17:21 +0000330 if (!QueryLoop)
331 return false;
332
333 // This recurrence is variant w.r.t. QueryLoop if QueryLoop contains L.
Dan Gohman92329c72009-12-18 01:24:09 +0000334 if (QueryLoop->contains(L))
Dan Gohmane890eea2009-06-26 22:17:21 +0000335 return false;
336
Dan Gohman71c41442010-08-13 20:11:39 +0000337 // This recurrence is invariant w.r.t. QueryLoop if L contains QueryLoop.
338 if (L->contains(QueryLoop))
339 return true;
340
Dan Gohmane890eea2009-06-26 22:17:21 +0000341 // This recurrence is variant w.r.t. QueryLoop if any of its operands
342 // are variant.
343 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
344 if (!getOperand(i)->isLoopInvariant(QueryLoop))
345 return false;
346
347 // Otherwise it's loop-invariant.
348 return true;
Chris Lattner53e677a2004-04-02 20:23:17 +0000349}
350
Dan Gohman39125d82010-02-13 00:19:39 +0000351bool
352SCEVAddRecExpr::dominates(BasicBlock *BB, DominatorTree *DT) const {
353 return DT->dominates(L->getHeader(), BB) &&
354 SCEVNAryExpr::dominates(BB, DT);
355}
356
357bool
358SCEVAddRecExpr::properlyDominates(BasicBlock *BB, DominatorTree *DT) const {
359 // This uses a "dominates" query instead of "properly dominates" query because
360 // the instruction which produces the addrec's value is a PHI, and a PHI
361 // effectively properly dominates its entire containing block.
362 return DT->dominates(L->getHeader(), BB) &&
363 SCEVNAryExpr::properlyDominates(BB, DT);
364}
365
Dan Gohmanb7ef7292009-04-21 00:47:46 +0000366void SCEVAddRecExpr::print(raw_ostream &OS) const {
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000367 OS << "{" << *Operands[0];
Dan Gohmanf9e64722010-03-18 01:17:13 +0000368 for (unsigned i = 1, e = NumOperands; i != e; ++i)
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000369 OS << ",+," << *Operands[i];
Dan Gohman30733292010-01-09 18:17:45 +0000370 OS << "}<";
371 WriteAsOperand(OS, L->getHeader(), /*PrintType=*/false);
372 OS << ">";
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000373}
Chris Lattner53e677a2004-04-02 20:23:17 +0000374
Dan Gohmanab37f502010-08-02 23:49:30 +0000375void SCEVUnknown::deleted() {
376 // Clear this SCEVUnknown from ValuesAtScopes.
377 SE->ValuesAtScopes.erase(this);
378
379 // Remove this SCEVUnknown from the uniquing map.
380 SE->UniqueSCEVs.RemoveNode(this);
381
382 // Release the value.
383 setValPtr(0);
384}
385
386void SCEVUnknown::allUsesReplacedWith(Value *New) {
387 // Clear this SCEVUnknown from ValuesAtScopes.
388 SE->ValuesAtScopes.erase(this);
389
390 // Remove this SCEVUnknown from the uniquing map.
391 SE->UniqueSCEVs.RemoveNode(this);
392
393 // Update this SCEVUnknown to point to the new value. This is needed
394 // because there may still be outstanding SCEVs which still point to
395 // this SCEVUnknown.
396 setValPtr(New);
397}
398
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000399bool SCEVUnknown::isLoopInvariant(const Loop *L) const {
400 // All non-instruction values are loop invariant. All instructions are loop
401 // invariant if they are not contained in the specified loop.
Dan Gohmana3035a62009-05-20 01:01:24 +0000402 // Instructions are never considered invariant in the function body
403 // (null loop) because they are defined within the "loop".
Dan Gohmanab37f502010-08-02 23:49:30 +0000404 if (Instruction *I = dyn_cast<Instruction>(getValue()))
Dan Gohman92329c72009-12-18 01:24:09 +0000405 return L && !L->contains(I);
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000406 return true;
407}
Chris Lattner53e677a2004-04-02 20:23:17 +0000408
Evan Cheng5a6c1a82009-02-17 00:13:06 +0000409bool SCEVUnknown::dominates(BasicBlock *BB, DominatorTree *DT) const {
410 if (Instruction *I = dyn_cast<Instruction>(getValue()))
411 return DT->dominates(I->getParent(), BB);
412 return true;
413}
414
Dan Gohman6e70e312009-09-27 15:26:03 +0000415bool SCEVUnknown::properlyDominates(BasicBlock *BB, DominatorTree *DT) const {
416 if (Instruction *I = dyn_cast<Instruction>(getValue()))
417 return DT->properlyDominates(I->getParent(), BB);
418 return true;
419}
420
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000421const Type *SCEVUnknown::getType() const {
Dan Gohmanab37f502010-08-02 23:49:30 +0000422 return getValue()->getType();
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000423}
Chris Lattner53e677a2004-04-02 20:23:17 +0000424
Dan Gohman0f5efe52010-01-28 02:15:55 +0000425bool SCEVUnknown::isSizeOf(const Type *&AllocTy) const {
Dan Gohmanab37f502010-08-02 23:49:30 +0000426 if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
Dan Gohman0f5efe52010-01-28 02:15:55 +0000427 if (VCE->getOpcode() == Instruction::PtrToInt)
428 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
Dan Gohman8db08df2010-02-02 01:38:49 +0000429 if (CE->getOpcode() == Instruction::GetElementPtr &&
430 CE->getOperand(0)->isNullValue() &&
431 CE->getNumOperands() == 2)
432 if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(1)))
433 if (CI->isOne()) {
434 AllocTy = cast<PointerType>(CE->getOperand(0)->getType())
435 ->getElementType();
436 return true;
437 }
Dan Gohman0f5efe52010-01-28 02:15:55 +0000438
439 return false;
440}
441
442bool SCEVUnknown::isAlignOf(const Type *&AllocTy) const {
Dan Gohmanab37f502010-08-02 23:49:30 +0000443 if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
Dan Gohman0f5efe52010-01-28 02:15:55 +0000444 if (VCE->getOpcode() == Instruction::PtrToInt)
445 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
Dan Gohman8db08df2010-02-02 01:38:49 +0000446 if (CE->getOpcode() == Instruction::GetElementPtr &&
447 CE->getOperand(0)->isNullValue()) {
448 const Type *Ty =
449 cast<PointerType>(CE->getOperand(0)->getType())->getElementType();
450 if (const StructType *STy = dyn_cast<StructType>(Ty))
451 if (!STy->isPacked() &&
452 CE->getNumOperands() == 3 &&
453 CE->getOperand(1)->isNullValue()) {
454 if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(2)))
455 if (CI->isOne() &&
456 STy->getNumElements() == 2 &&
Duncan Sandsb0bc6c32010-02-15 16:12:20 +0000457 STy->getElementType(0)->isIntegerTy(1)) {
Dan Gohman8db08df2010-02-02 01:38:49 +0000458 AllocTy = STy->getElementType(1);
459 return true;
460 }
461 }
462 }
Dan Gohman0f5efe52010-01-28 02:15:55 +0000463
464 return false;
465}
466
Dan Gohman4f8eea82010-02-01 18:27:38 +0000467bool SCEVUnknown::isOffsetOf(const Type *&CTy, Constant *&FieldNo) const {
Dan Gohmanab37f502010-08-02 23:49:30 +0000468 if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
Dan Gohman4f8eea82010-02-01 18:27:38 +0000469 if (VCE->getOpcode() == Instruction::PtrToInt)
470 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
471 if (CE->getOpcode() == Instruction::GetElementPtr &&
472 CE->getNumOperands() == 3 &&
473 CE->getOperand(0)->isNullValue() &&
474 CE->getOperand(1)->isNullValue()) {
475 const Type *Ty =
476 cast<PointerType>(CE->getOperand(0)->getType())->getElementType();
477 // Ignore vector types here so that ScalarEvolutionExpander doesn't
478 // emit getelementptrs that index into vectors.
Duncan Sands1df98592010-02-16 11:11:14 +0000479 if (Ty->isStructTy() || Ty->isArrayTy()) {
Dan Gohman4f8eea82010-02-01 18:27:38 +0000480 CTy = Ty;
481 FieldNo = CE->getOperand(2);
482 return true;
483 }
484 }
485
486 return false;
487}
488
Dan Gohmanb7ef7292009-04-21 00:47:46 +0000489void SCEVUnknown::print(raw_ostream &OS) const {
Dan Gohman0f5efe52010-01-28 02:15:55 +0000490 const Type *AllocTy;
491 if (isSizeOf(AllocTy)) {
492 OS << "sizeof(" << *AllocTy << ")";
493 return;
494 }
495 if (isAlignOf(AllocTy)) {
496 OS << "alignof(" << *AllocTy << ")";
497 return;
498 }
499
Dan Gohman4f8eea82010-02-01 18:27:38 +0000500 const Type *CTy;
Dan Gohman0f5efe52010-01-28 02:15:55 +0000501 Constant *FieldNo;
Dan Gohman4f8eea82010-02-01 18:27:38 +0000502 if (isOffsetOf(CTy, FieldNo)) {
503 OS << "offsetof(" << *CTy << ", ";
Dan Gohman0f5efe52010-01-28 02:15:55 +0000504 WriteAsOperand(OS, FieldNo, false);
505 OS << ")";
506 return;
507 }
508
509 // Otherwise just print it normally.
Dan Gohmanab37f502010-08-02 23:49:30 +0000510 WriteAsOperand(OS, getValue(), false);
Chris Lattner53e677a2004-04-02 20:23:17 +0000511}
512
Chris Lattner8d741b82004-06-20 06:23:15 +0000513//===----------------------------------------------------------------------===//
514// SCEV Utilities
515//===----------------------------------------------------------------------===//
516
517namespace {
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 Gohman9f1fb422010-08-13 20:17:27 +0000522 const LoopInfo *const 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 Gohman67ef74e2010-08-27 15:26:01 +0000526 // Return true or false if LHS is less than, or at least RHS, respectively.
Dan Gohmanf7b37b22008-04-14 18:23:56 +0000527 bool operator()(const SCEV *LHS, const SCEV *RHS) const {
Dan Gohman67ef74e2010-08-27 15:26:01 +0000528 return compare(LHS, RHS) < 0;
529 }
530
531 // Return negative, zero, or positive, if LHS is less than, equal to, or
532 // greater than RHS, respectively. A three-way result allows recursive
533 // comparisons to be more efficient.
534 int compare(const SCEV *LHS, const SCEV *RHS) const {
Dan Gohman42214892009-08-31 21:15:23 +0000535 // Fast-path: SCEVs are uniqued so we can do a quick equality check.
536 if (LHS == RHS)
Dan Gohman67ef74e2010-08-27 15:26:01 +0000537 return 0;
Dan Gohman42214892009-08-31 21:15:23 +0000538
Dan Gohman72861302009-05-07 14:39:04 +0000539 // Primarily, sort the SCEVs by their getSCEVType().
Dan Gohman304a7a62010-07-23 21:20:52 +0000540 unsigned LType = LHS->getSCEVType(), RType = RHS->getSCEVType();
541 if (LType != RType)
Dan Gohman67ef74e2010-08-27 15:26:01 +0000542 return (int)LType - (int)RType;
Dan Gohman72861302009-05-07 14:39:04 +0000543
Dan Gohman3bf63762010-06-18 19:54:20 +0000544 // Aside from the getSCEVType() ordering, the particular ordering
545 // isn't very important except that it's beneficial to be consistent,
546 // so that (a + b) and (b + a) don't end up as different expressions.
Dan Gohman67ef74e2010-08-27 15:26:01 +0000547 switch (LType) {
548 case scUnknown: {
549 const SCEVUnknown *LU = cast<SCEVUnknown>(LHS);
Dan Gohman3bf63762010-06-18 19:54:20 +0000550 const SCEVUnknown *RU = cast<SCEVUnknown>(RHS);
Dan Gohman67ef74e2010-08-27 15:26:01 +0000551
552 // Sort SCEVUnknown values with some loose heuristics. TODO: This is
553 // not as complete as it could be.
Dan Gohman0ad2c7a2010-08-13 21:24:58 +0000554 const Value *LV = LU->getValue(), *RV = RU->getValue();
Dan Gohman3bf63762010-06-18 19:54:20 +0000555
556 // Order pointer values after integer values. This helps SCEVExpander
557 // form GEPs.
Dan Gohman0ad2c7a2010-08-13 21:24:58 +0000558 bool LIsPointer = LV->getType()->isPointerTy(),
559 RIsPointer = RV->getType()->isPointerTy();
Dan Gohman304a7a62010-07-23 21:20:52 +0000560 if (LIsPointer != RIsPointer)
Dan Gohman67ef74e2010-08-27 15:26:01 +0000561 return (int)LIsPointer - (int)RIsPointer;
Dan Gohman3bf63762010-06-18 19:54:20 +0000562
563 // Compare getValueID values.
Dan Gohman0ad2c7a2010-08-13 21:24:58 +0000564 unsigned LID = LV->getValueID(),
565 RID = RV->getValueID();
Dan Gohman304a7a62010-07-23 21:20:52 +0000566 if (LID != RID)
Dan Gohman67ef74e2010-08-27 15:26:01 +0000567 return (int)LID - (int)RID;
Dan Gohman3bf63762010-06-18 19:54:20 +0000568
569 // Sort arguments by their position.
Dan Gohman0ad2c7a2010-08-13 21:24:58 +0000570 if (const Argument *LA = dyn_cast<Argument>(LV)) {
571 const Argument *RA = cast<Argument>(RV);
Dan Gohman67ef74e2010-08-27 15:26:01 +0000572 unsigned LArgNo = LA->getArgNo(), RArgNo = RA->getArgNo();
573 return (int)LArgNo - (int)RArgNo;
Dan Gohman3bf63762010-06-18 19:54:20 +0000574 }
575
Dan Gohman67ef74e2010-08-27 15:26:01 +0000576 // For instructions, compare their loop depth, and their operand
577 // count. This is pretty loose.
Dan Gohman0ad2c7a2010-08-13 21:24:58 +0000578 if (const Instruction *LInst = dyn_cast<Instruction>(LV)) {
579 const Instruction *RInst = cast<Instruction>(RV);
Dan Gohman3bf63762010-06-18 19:54:20 +0000580
581 // Compare loop depths.
Dan Gohman0ad2c7a2010-08-13 21:24:58 +0000582 const BasicBlock *LParent = LInst->getParent(),
583 *RParent = RInst->getParent();
584 if (LParent != RParent) {
585 unsigned LDepth = LI->getLoopDepth(LParent),
586 RDepth = LI->getLoopDepth(RParent);
587 if (LDepth != RDepth)
Dan Gohman67ef74e2010-08-27 15:26:01 +0000588 return (int)LDepth - (int)RDepth;
Dan Gohman0ad2c7a2010-08-13 21:24:58 +0000589 }
Dan Gohman3bf63762010-06-18 19:54:20 +0000590
591 // Compare the number of operands.
Dan Gohman0ad2c7a2010-08-13 21:24:58 +0000592 unsigned LNumOps = LInst->getNumOperands(),
593 RNumOps = RInst->getNumOperands();
Dan Gohman67ef74e2010-08-27 15:26:01 +0000594 return (int)LNumOps - (int)RNumOps;
Dan Gohman3bf63762010-06-18 19:54:20 +0000595 }
596
Dan Gohman67ef74e2010-08-27 15:26:01 +0000597 return 0;
Dan Gohman3bf63762010-06-18 19:54:20 +0000598 }
599
Dan Gohman67ef74e2010-08-27 15:26:01 +0000600 case scConstant: {
601 const SCEVConstant *LC = cast<SCEVConstant>(LHS);
Dan Gohman3bf63762010-06-18 19:54:20 +0000602 const SCEVConstant *RC = cast<SCEVConstant>(RHS);
Dan Gohman67ef74e2010-08-27 15:26:01 +0000603
604 // Compare constant values.
Dan Gohmane28d7922010-08-16 16:25:35 +0000605 const APInt &LA = LC->getValue()->getValue();
606 const APInt &RA = RC->getValue()->getValue();
607 unsigned LBitWidth = LA.getBitWidth(), RBitWidth = RA.getBitWidth();
Dan Gohman304a7a62010-07-23 21:20:52 +0000608 if (LBitWidth != RBitWidth)
Dan Gohman67ef74e2010-08-27 15:26:01 +0000609 return (int)LBitWidth - (int)RBitWidth;
610 return LA.ult(RA) ? -1 : 1;
Dan Gohman3bf63762010-06-18 19:54:20 +0000611 }
612
Dan Gohman67ef74e2010-08-27 15:26:01 +0000613 case scAddRecExpr: {
614 const SCEVAddRecExpr *LA = cast<SCEVAddRecExpr>(LHS);
Dan Gohman3bf63762010-06-18 19:54:20 +0000615 const SCEVAddRecExpr *RA = cast<SCEVAddRecExpr>(RHS);
Dan Gohman67ef74e2010-08-27 15:26:01 +0000616
617 // Compare addrec loop depths.
Dan Gohman0ad2c7a2010-08-13 21:24:58 +0000618 const Loop *LLoop = LA->getLoop(), *RLoop = RA->getLoop();
619 if (LLoop != RLoop) {
620 unsigned LDepth = LLoop->getLoopDepth(),
621 RDepth = RLoop->getLoopDepth();
622 if (LDepth != RDepth)
Dan Gohman67ef74e2010-08-27 15:26:01 +0000623 return (int)LDepth - (int)RDepth;
Dan Gohman0ad2c7a2010-08-13 21:24:58 +0000624 }
Dan Gohman67ef74e2010-08-27 15:26:01 +0000625
626 // Addrec complexity grows with operand count.
627 unsigned LNumOps = LA->getNumOperands(), RNumOps = RA->getNumOperands();
628 if (LNumOps != RNumOps)
629 return (int)LNumOps - (int)RNumOps;
630
631 // Lexicographically compare.
632 for (unsigned i = 0; i != LNumOps; ++i) {
633 long X = compare(LA->getOperand(i), RA->getOperand(i));
634 if (X != 0)
635 return X;
636 }
637
638 return 0;
Dan Gohman3bf63762010-06-18 19:54:20 +0000639 }
640
Dan Gohman67ef74e2010-08-27 15:26:01 +0000641 case scAddExpr:
642 case scMulExpr:
643 case scSMaxExpr:
644 case scUMaxExpr: {
645 const SCEVNAryExpr *LC = cast<SCEVNAryExpr>(LHS);
Dan Gohman3bf63762010-06-18 19:54:20 +0000646 const SCEVNAryExpr *RC = cast<SCEVNAryExpr>(RHS);
Dan Gohman67ef74e2010-08-27 15:26:01 +0000647
648 // Lexicographically compare n-ary expressions.
Dan Gohman304a7a62010-07-23 21:20:52 +0000649 unsigned LNumOps = LC->getNumOperands(), RNumOps = RC->getNumOperands();
650 for (unsigned i = 0; i != LNumOps; ++i) {
651 if (i >= RNumOps)
Dan Gohman67ef74e2010-08-27 15:26:01 +0000652 return 1;
653 long X = compare(LC->getOperand(i), RC->getOperand(i));
654 if (X != 0)
655 return X;
Dan Gohman3bf63762010-06-18 19:54:20 +0000656 }
Dan Gohman67ef74e2010-08-27 15:26:01 +0000657 return (int)LNumOps - (int)RNumOps;
Dan Gohman3bf63762010-06-18 19:54:20 +0000658 }
659
Dan Gohman67ef74e2010-08-27 15:26:01 +0000660 case scUDivExpr: {
661 const SCEVUDivExpr *LC = cast<SCEVUDivExpr>(LHS);
Dan Gohman3bf63762010-06-18 19:54:20 +0000662 const SCEVUDivExpr *RC = cast<SCEVUDivExpr>(RHS);
Dan Gohman67ef74e2010-08-27 15:26:01 +0000663
664 // Lexicographically compare udiv expressions.
665 long X = compare(LC->getLHS(), RC->getLHS());
666 if (X != 0)
667 return X;
668 return compare(LC->getRHS(), RC->getRHS());
Dan Gohman3bf63762010-06-18 19:54:20 +0000669 }
670
Dan Gohman67ef74e2010-08-27 15:26:01 +0000671 case scTruncate:
672 case scZeroExtend:
673 case scSignExtend: {
674 const SCEVCastExpr *LC = cast<SCEVCastExpr>(LHS);
Dan Gohman3bf63762010-06-18 19:54:20 +0000675 const SCEVCastExpr *RC = cast<SCEVCastExpr>(RHS);
Dan Gohman67ef74e2010-08-27 15:26:01 +0000676
677 // Compare cast expressions by operand.
678 return compare(LC->getOperand(), RC->getOperand());
679 }
680
681 default:
682 break;
Dan Gohman3bf63762010-06-18 19:54:20 +0000683 }
684
685 llvm_unreachable("Unknown SCEV kind!");
Dan Gohman67ef74e2010-08-27 15:26:01 +0000686 return 0;
Chris Lattner8d741b82004-06-20 06:23:15 +0000687 }
688 };
689}
690
691/// GroupByComplexity - Given a list of SCEV objects, order them by their
692/// complexity, and group objects of the same complexity together by value.
693/// When this routine is finished, we know that any duplicates in the vector are
694/// consecutive and that complexity is monotonically increasing.
695///
Dan Gohman3f46a3a2010-03-01 17:49:51 +0000696/// Note that we go take special precautions to ensure that we get deterministic
Chris Lattner8d741b82004-06-20 06:23:15 +0000697/// results from this routine. In other words, we don't want the results of
698/// this to depend on where the addresses of various SCEV objects happened to
699/// land in memory.
700///
Dan Gohman0bba49c2009-07-07 17:06:11 +0000701static void GroupByComplexity(SmallVectorImpl<const SCEV *> &Ops,
Dan Gohman72861302009-05-07 14:39:04 +0000702 LoopInfo *LI) {
Chris Lattner8d741b82004-06-20 06:23:15 +0000703 if (Ops.size() < 2) return; // Noop
704 if (Ops.size() == 2) {
705 // This is the common case, which also happens to be trivially simple.
706 // Special case it.
Dan Gohman3bf63762010-06-18 19:54:20 +0000707 if (SCEVComplexityCompare(LI)(Ops[1], Ops[0]))
Chris Lattner8d741b82004-06-20 06:23:15 +0000708 std::swap(Ops[0], Ops[1]);
709 return;
710 }
711
Dan Gohman3bf63762010-06-18 19:54:20 +0000712 // Do the rough sort by complexity.
713 std::stable_sort(Ops.begin(), Ops.end(), SCEVComplexityCompare(LI));
714
715 // Now that we are sorted by complexity, group elements of the same
716 // complexity. Note that this is, at worst, N^2, but the vector is likely to
717 // be extremely short in practice. Note that we take this approach because we
718 // do not want to depend on the addresses of the objects we are grouping.
719 for (unsigned i = 0, e = Ops.size(); i != e-2; ++i) {
720 const SCEV *S = Ops[i];
721 unsigned Complexity = S->getSCEVType();
722
723 // If there are any objects of the same complexity and same value as this
724 // one, group them.
725 for (unsigned j = i+1; j != e && Ops[j]->getSCEVType() == Complexity; ++j) {
726 if (Ops[j] == S) { // Found a duplicate.
727 // Move it to immediately after i'th element.
728 std::swap(Ops[i+1], Ops[j]);
729 ++i; // no need to rescan it.
730 if (i == e-2) return; // Done!
731 }
732 }
733 }
Chris Lattner8d741b82004-06-20 06:23:15 +0000734}
735
Chris Lattner53e677a2004-04-02 20:23:17 +0000736
Chris Lattner53e677a2004-04-02 20:23:17 +0000737
738//===----------------------------------------------------------------------===//
739// Simple SCEV method implementations
740//===----------------------------------------------------------------------===//
741
Eli Friedmanb42a6262008-08-04 23:49:06 +0000742/// BinomialCoefficient - Compute BC(It, K). The result has width W.
Dan Gohman6c0866c2009-05-24 23:45:28 +0000743/// Assume, K > 0.
Dan Gohman0bba49c2009-07-07 17:06:11 +0000744static const SCEV *BinomialCoefficient(const SCEV *It, unsigned K,
Dan Gohmanc2b015e2009-07-21 00:38:55 +0000745 ScalarEvolution &SE,
746 const Type* ResultTy) {
Eli Friedmanb42a6262008-08-04 23:49:06 +0000747 // Handle the simplest case efficiently.
748 if (K == 1)
749 return SE.getTruncateOrZeroExtend(It, ResultTy);
750
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000751 // We are using the following formula for BC(It, K):
752 //
753 // BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / K!
754 //
Eli Friedmanb42a6262008-08-04 23:49:06 +0000755 // Suppose, W is the bitwidth of the return value. We must be prepared for
756 // overflow. Hence, we must assure that the result of our computation is
757 // equal to the accurate one modulo 2^W. Unfortunately, division isn't
758 // safe in modular arithmetic.
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000759 //
Eli Friedmanb42a6262008-08-04 23:49:06 +0000760 // However, this code doesn't use exactly that formula; the formula it uses
Dan Gohman64a845e2009-06-24 04:48:43 +0000761 // is something like the following, where T is the number of factors of 2 in
Eli Friedmanb42a6262008-08-04 23:49:06 +0000762 // K! (i.e. trailing zeros in the binary representation of K!), and ^ is
763 // exponentiation:
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000764 //
Eli Friedmanb42a6262008-08-04 23:49:06 +0000765 // BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / 2^T / (K! / 2^T)
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000766 //
Eli Friedmanb42a6262008-08-04 23:49:06 +0000767 // This formula is trivially equivalent to the previous formula. However,
768 // this formula can be implemented much more efficiently. The trick is that
769 // K! / 2^T is odd, and exact division by an odd number *is* safe in modular
770 // arithmetic. To do exact division in modular arithmetic, all we have
771 // to do is multiply by the inverse. Therefore, this step can be done at
772 // width W.
Dan Gohman64a845e2009-06-24 04:48:43 +0000773 //
Eli Friedmanb42a6262008-08-04 23:49:06 +0000774 // The next issue is how to safely do the division by 2^T. The way this
775 // is done is by doing the multiplication step at a width of at least W + T
776 // bits. This way, the bottom W+T bits of the product are accurate. Then,
777 // when we perform the division by 2^T (which is equivalent to a right shift
778 // by T), the bottom W bits are accurate. Extra bits are okay; they'll get
779 // truncated out after the division by 2^T.
780 //
781 // In comparison to just directly using the first formula, this technique
782 // is much more efficient; using the first formula requires W * K bits,
783 // but this formula less than W + K bits. Also, the first formula requires
784 // a division step, whereas this formula only requires multiplies and shifts.
785 //
786 // It doesn't matter whether the subtraction step is done in the calculation
787 // width or the input iteration count's width; if the subtraction overflows,
788 // the result must be zero anyway. We prefer here to do it in the width of
789 // the induction variable because it helps a lot for certain cases; CodeGen
790 // isn't smart enough to ignore the overflow, which leads to much less
791 // efficient code if the width of the subtraction is wider than the native
792 // register width.
793 //
794 // (It's possible to not widen at all by pulling out factors of 2 before
795 // the multiplication; for example, K=2 can be calculated as
796 // It/2*(It+(It*INT_MIN/INT_MIN)+-1). However, it requires
797 // extra arithmetic, so it's not an obvious win, and it gets
798 // much more complicated for K > 3.)
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000799
Eli Friedmanb42a6262008-08-04 23:49:06 +0000800 // Protection from insane SCEVs; this bound is conservative,
801 // but it probably doesn't matter.
802 if (K > 1000)
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +0000803 return SE.getCouldNotCompute();
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000804
Dan Gohmanaf79fb52009-04-21 01:07:12 +0000805 unsigned W = SE.getTypeSizeInBits(ResultTy);
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000806
Eli Friedmanb42a6262008-08-04 23:49:06 +0000807 // Calculate K! / 2^T and T; we divide out the factors of two before
808 // multiplying for calculating K! / 2^T to avoid overflow.
809 // Other overflow doesn't matter because we only care about the bottom
810 // W bits of the result.
811 APInt OddFactorial(W, 1);
812 unsigned T = 1;
813 for (unsigned i = 3; i <= K; ++i) {
814 APInt Mult(W, i);
815 unsigned TwoFactors = Mult.countTrailingZeros();
816 T += TwoFactors;
817 Mult = Mult.lshr(TwoFactors);
818 OddFactorial *= Mult;
Chris Lattner53e677a2004-04-02 20:23:17 +0000819 }
Nick Lewycky6f8abf92008-06-13 04:38:55 +0000820
Eli Friedmanb42a6262008-08-04 23:49:06 +0000821 // We need at least W + T bits for the multiplication step
Nick Lewycky237d8732009-01-25 08:16:27 +0000822 unsigned CalculationBits = W + T;
Eli Friedmanb42a6262008-08-04 23:49:06 +0000823
Dan Gohman3f46a3a2010-03-01 17:49:51 +0000824 // Calculate 2^T, at width T+W.
Eli Friedmanb42a6262008-08-04 23:49:06 +0000825 APInt DivFactor = APInt(CalculationBits, 1).shl(T);
826
827 // Calculate the multiplicative inverse of K! / 2^T;
828 // this multiplication factor will perform the exact division by
829 // K! / 2^T.
830 APInt Mod = APInt::getSignedMinValue(W+1);
831 APInt MultiplyFactor = OddFactorial.zext(W+1);
832 MultiplyFactor = MultiplyFactor.multiplicativeInverse(Mod);
833 MultiplyFactor = MultiplyFactor.trunc(W);
834
835 // Calculate the product, at width T+W
Owen Anderson1d0be152009-08-13 21:58:54 +0000836 const IntegerType *CalculationTy = IntegerType::get(SE.getContext(),
837 CalculationBits);
Dan Gohman0bba49c2009-07-07 17:06:11 +0000838 const SCEV *Dividend = SE.getTruncateOrZeroExtend(It, CalculationTy);
Eli Friedmanb42a6262008-08-04 23:49:06 +0000839 for (unsigned i = 1; i != K; ++i) {
Dan Gohmandeff6212010-05-03 22:09:21 +0000840 const SCEV *S = SE.getMinusSCEV(It, SE.getConstant(It->getType(), i));
Eli Friedmanb42a6262008-08-04 23:49:06 +0000841 Dividend = SE.getMulExpr(Dividend,
842 SE.getTruncateOrZeroExtend(S, CalculationTy));
843 }
844
845 // Divide by 2^T
Dan Gohman0bba49c2009-07-07 17:06:11 +0000846 const SCEV *DivResult = SE.getUDivExpr(Dividend, SE.getConstant(DivFactor));
Eli Friedmanb42a6262008-08-04 23:49:06 +0000847
848 // Truncate the result, and divide by K! / 2^T.
849
850 return SE.getMulExpr(SE.getConstant(MultiplyFactor),
851 SE.getTruncateOrZeroExtend(DivResult, ResultTy));
Chris Lattner53e677a2004-04-02 20:23:17 +0000852}
853
Chris Lattner53e677a2004-04-02 20:23:17 +0000854/// evaluateAtIteration - Return the value of this chain of recurrences at
855/// the specified iteration number. We can evaluate this recurrence by
856/// multiplying each element in the chain by the binomial coefficient
857/// corresponding to it. In other words, we can evaluate {A,+,B,+,C,+,D} as:
858///
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000859/// A*BC(It, 0) + B*BC(It, 1) + C*BC(It, 2) + D*BC(It, 3)
Chris Lattner53e677a2004-04-02 20:23:17 +0000860///
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000861/// where BC(It, k) stands for binomial coefficient.
Chris Lattner53e677a2004-04-02 20:23:17 +0000862///
Dan Gohman0bba49c2009-07-07 17:06:11 +0000863const SCEV *SCEVAddRecExpr::evaluateAtIteration(const SCEV *It,
Dan Gohmanc2b015e2009-07-21 00:38:55 +0000864 ScalarEvolution &SE) const {
Dan Gohman0bba49c2009-07-07 17:06:11 +0000865 const SCEV *Result = getStart();
Chris Lattner53e677a2004-04-02 20:23:17 +0000866 for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000867 // The computation is correct in the face of overflow provided that the
868 // multiplication is performed _after_ the evaluation of the binomial
869 // coefficient.
Dan Gohman0bba49c2009-07-07 17:06:11 +0000870 const SCEV *Coeff = BinomialCoefficient(It, i, SE, getType());
Nick Lewyckycb8f1b52008-10-13 03:58:02 +0000871 if (isa<SCEVCouldNotCompute>(Coeff))
872 return Coeff;
873
874 Result = SE.getAddExpr(Result, SE.getMulExpr(getOperand(i), Coeff));
Chris Lattner53e677a2004-04-02 20:23:17 +0000875 }
876 return Result;
877}
878
Chris Lattner53e677a2004-04-02 20:23:17 +0000879//===----------------------------------------------------------------------===//
880// SCEV Expression folder implementations
881//===----------------------------------------------------------------------===//
882
Dan Gohman0bba49c2009-07-07 17:06:11 +0000883const SCEV *ScalarEvolution::getTruncateExpr(const SCEV *Op,
Dan Gohmanf5074ec2009-07-13 22:05:32 +0000884 const Type *Ty) {
Dan Gohmanaf79fb52009-04-21 01:07:12 +0000885 assert(getTypeSizeInBits(Op->getType()) > getTypeSizeInBits(Ty) &&
Dan Gohmanfb17fd22009-04-21 00:55:22 +0000886 "This is not a truncating conversion!");
Dan Gohman10b94792009-05-01 16:44:18 +0000887 assert(isSCEVable(Ty) &&
888 "This is not a conversion to a SCEVable type!");
889 Ty = getEffectiveSCEVType(Ty);
Dan Gohmanfb17fd22009-04-21 00:55:22 +0000890
Dan Gohmanc050fd92009-07-13 20:50:19 +0000891 FoldingSetNodeID ID;
892 ID.AddInteger(scTruncate);
893 ID.AddPointer(Op);
894 ID.AddPointer(Ty);
895 void *IP = 0;
896 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
897
Dan Gohmanc39f44b2009-06-30 20:13:32 +0000898 // Fold if the operand is constant.
Dan Gohman622ed672009-05-04 22:02:23 +0000899 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
Dan Gohmanb8be8b72009-06-24 00:38:39 +0000900 return getConstant(
Dan Gohman1faa8822010-06-24 16:33:38 +0000901 cast<ConstantInt>(ConstantExpr::getTrunc(SC->getValue(),
902 getEffectiveSCEVType(Ty))));
Chris Lattner53e677a2004-04-02 20:23:17 +0000903
Dan Gohman20900ca2009-04-22 16:20:48 +0000904 // trunc(trunc(x)) --> trunc(x)
Dan Gohman622ed672009-05-04 22:02:23 +0000905 if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op))
Dan Gohman20900ca2009-04-22 16:20:48 +0000906 return getTruncateExpr(ST->getOperand(), Ty);
907
Nick Lewycky5cd28fa2009-04-23 05:15:08 +0000908 // trunc(sext(x)) --> sext(x) if widening or trunc(x) if narrowing
Dan Gohman622ed672009-05-04 22:02:23 +0000909 if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op))
Nick Lewycky5cd28fa2009-04-23 05:15:08 +0000910 return getTruncateOrSignExtend(SS->getOperand(), Ty);
911
912 // trunc(zext(x)) --> zext(x) if widening or trunc(x) if narrowing
Dan Gohman622ed672009-05-04 22:02:23 +0000913 if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op))
Nick Lewycky5cd28fa2009-04-23 05:15:08 +0000914 return getTruncateOrZeroExtend(SZ->getOperand(), Ty);
915
Dan Gohman6864db62009-06-18 16:24:47 +0000916 // If the input value is a chrec scev, truncate the chrec's operands.
Dan Gohman622ed672009-05-04 22:02:23 +0000917 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(Op)) {
Dan Gohman0bba49c2009-07-07 17:06:11 +0000918 SmallVector<const SCEV *, 4> Operands;
Chris Lattner53e677a2004-04-02 20:23:17 +0000919 for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i)
Dan Gohman728c7f32009-05-08 21:03:19 +0000920 Operands.push_back(getTruncateExpr(AddRec->getOperand(i), Ty));
921 return getAddRecExpr(Operands, AddRec->getLoop());
Chris Lattner53e677a2004-04-02 20:23:17 +0000922 }
923
Dan Gohmanf53462d2010-07-15 20:02:11 +0000924 // As a special case, fold trunc(undef) to undef. We don't want to
925 // know too much about SCEVUnknowns, but this special case is handy
926 // and harmless.
927 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(Op))
928 if (isa<UndefValue>(U->getValue()))
929 return getSCEV(UndefValue::get(Ty));
930
Dan Gohman420ab912010-06-25 18:47:08 +0000931 // The cast wasn't folded; create an explicit cast node. We can reuse
932 // the existing insert position since if we get here, we won't have
933 // made any changes which would invalidate it.
Dan Gohman95531882010-03-18 18:49:47 +0000934 SCEV *S = new (SCEVAllocator) SCEVTruncateExpr(ID.Intern(SCEVAllocator),
935 Op, Ty);
Dan Gohman1c343752009-06-27 21:21:31 +0000936 UniqueSCEVs.InsertNode(S, IP);
937 return S;
Chris Lattner53e677a2004-04-02 20:23:17 +0000938}
939
Dan Gohman0bba49c2009-07-07 17:06:11 +0000940const SCEV *ScalarEvolution::getZeroExtendExpr(const SCEV *Op,
Dan Gohmanf5074ec2009-07-13 22:05:32 +0000941 const Type *Ty) {
Dan Gohmanaf79fb52009-04-21 01:07:12 +0000942 assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
Dan Gohman8170a682009-04-16 19:25:55 +0000943 "This is not an extending conversion!");
Dan Gohman10b94792009-05-01 16:44:18 +0000944 assert(isSCEVable(Ty) &&
945 "This is not a conversion to a SCEVable type!");
946 Ty = getEffectiveSCEVType(Ty);
Dan Gohman8170a682009-04-16 19:25:55 +0000947
Dan Gohmanc39f44b2009-06-30 20:13:32 +0000948 // Fold if the operand is constant.
Dan Gohmaneaf6cf22010-06-24 16:47:03 +0000949 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
950 return getConstant(
951 cast<ConstantInt>(ConstantExpr::getZExt(SC->getValue(),
952 getEffectiveSCEVType(Ty))));
Chris Lattner53e677a2004-04-02 20:23:17 +0000953
Dan Gohman20900ca2009-04-22 16:20:48 +0000954 // zext(zext(x)) --> zext(x)
Dan Gohman622ed672009-05-04 22:02:23 +0000955 if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op))
Dan Gohman20900ca2009-04-22 16:20:48 +0000956 return getZeroExtendExpr(SZ->getOperand(), Ty);
957
Dan Gohman69fbc7f2009-07-13 20:55:53 +0000958 // Before doing any expensive analysis, check to see if we've already
959 // computed a SCEV for this Op and Ty.
960 FoldingSetNodeID ID;
961 ID.AddInteger(scZeroExtend);
962 ID.AddPointer(Op);
963 ID.AddPointer(Ty);
964 void *IP = 0;
965 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
966
Dan Gohman01ecca22009-04-27 20:16:15 +0000967 // If the input value is a chrec scev, and we can prove that the value
Chris Lattner53e677a2004-04-02 20:23:17 +0000968 // did not overflow the old, smaller, value, we can zero extend all of the
Dan Gohman01ecca22009-04-27 20:16:15 +0000969 // operands (often constants). This allows analysis of something like
Chris Lattner53e677a2004-04-02 20:23:17 +0000970 // this: for (unsigned char X = 0; X < 100; ++X) { int Y = X; }
Dan Gohman622ed672009-05-04 22:02:23 +0000971 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op))
Dan Gohman01ecca22009-04-27 20:16:15 +0000972 if (AR->isAffine()) {
Dan Gohman85b05a22009-07-13 21:35:55 +0000973 const SCEV *Start = AR->getStart();
974 const SCEV *Step = AR->getStepRecurrence(*this);
975 unsigned BitWidth = getTypeSizeInBits(AR->getType());
976 const Loop *L = AR->getLoop();
977
Dan Gohmaneb490a72009-07-25 01:22:26 +0000978 // If we have special knowledge that this addrec won't overflow,
979 // we don't need to do any further analysis.
Dan Gohman5078f842009-08-20 17:11:38 +0000980 if (AR->hasNoUnsignedWrap())
Dan Gohmaneb490a72009-07-25 01:22:26 +0000981 return getAddRecExpr(getZeroExtendExpr(Start, Ty),
982 getZeroExtendExpr(Step, Ty),
983 L);
984
Dan Gohman01ecca22009-04-27 20:16:15 +0000985 // Check whether the backedge-taken count is SCEVCouldNotCompute.
986 // Note that this serves two purposes: It filters out loops that are
987 // simply not analyzable, and it covers the case where this code is
988 // being called from within backedge-taken count analysis, such that
989 // attempting to ask for the backedge-taken count would likely result
990 // in infinite recursion. In the later case, the analysis code will
991 // cope with a conservative value, and it will take care to purge
992 // that value once it has finished.
Dan Gohman85b05a22009-07-13 21:35:55 +0000993 const SCEV *MaxBECount = getMaxBackedgeTakenCount(L);
Dan Gohmana1af7572009-04-30 20:47:05 +0000994 if (!isa<SCEVCouldNotCompute>(MaxBECount)) {
Dan Gohmanf0aa4852009-04-29 01:54:20 +0000995 // Manually compute the final value for AR, checking for
Dan Gohmanac70cea2009-04-29 22:28:28 +0000996 // overflow.
Dan Gohman01ecca22009-04-27 20:16:15 +0000997
998 // Check whether the backedge-taken count can be losslessly casted to
999 // the addrec's type. The count is always unsigned.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001000 const SCEV *CastedMaxBECount =
Dan Gohmana1af7572009-04-30 20:47:05 +00001001 getTruncateOrZeroExtend(MaxBECount, Start->getType());
Dan Gohman0bba49c2009-07-07 17:06:11 +00001002 const SCEV *RecastedMaxBECount =
Dan Gohman5183cae2009-05-18 15:58:39 +00001003 getTruncateOrZeroExtend(CastedMaxBECount, MaxBECount->getType());
1004 if (MaxBECount == RecastedMaxBECount) {
Owen Anderson1d0be152009-08-13 21:58:54 +00001005 const Type *WideTy = IntegerType::get(getContext(), BitWidth * 2);
Dan Gohmana1af7572009-04-30 20:47:05 +00001006 // Check whether Start+Step*MaxBECount has no unsigned overflow.
Dan Gohman8f767d92010-02-24 19:31:06 +00001007 const SCEV *ZMul = getMulExpr(CastedMaxBECount, Step);
Dan Gohman0bba49c2009-07-07 17:06:11 +00001008 const SCEV *Add = getAddExpr(Start, ZMul);
1009 const SCEV *OperandExtendedAdd =
Dan Gohman5183cae2009-05-18 15:58:39 +00001010 getAddExpr(getZeroExtendExpr(Start, WideTy),
1011 getMulExpr(getZeroExtendExpr(CastedMaxBECount, WideTy),
1012 getZeroExtendExpr(Step, WideTy)));
1013 if (getZeroExtendExpr(Add, WideTy) == OperandExtendedAdd)
Dan Gohmanac70cea2009-04-29 22:28:28 +00001014 // Return the expression with the addrec on the outside.
1015 return getAddRecExpr(getZeroExtendExpr(Start, Ty),
1016 getZeroExtendExpr(Step, Ty),
Dan Gohman85b05a22009-07-13 21:35:55 +00001017 L);
Dan Gohman01ecca22009-04-27 20:16:15 +00001018
1019 // Similar to above, only this time treat the step value as signed.
1020 // This covers loops that count down.
Dan Gohman8f767d92010-02-24 19:31:06 +00001021 const SCEV *SMul = getMulExpr(CastedMaxBECount, Step);
Dan Gohmanac70cea2009-04-29 22:28:28 +00001022 Add = getAddExpr(Start, SMul);
Dan Gohman5183cae2009-05-18 15:58:39 +00001023 OperandExtendedAdd =
1024 getAddExpr(getZeroExtendExpr(Start, WideTy),
1025 getMulExpr(getZeroExtendExpr(CastedMaxBECount, WideTy),
1026 getSignExtendExpr(Step, WideTy)));
1027 if (getZeroExtendExpr(Add, WideTy) == OperandExtendedAdd)
Dan Gohmanac70cea2009-04-29 22:28:28 +00001028 // Return the expression with the addrec on the outside.
1029 return getAddRecExpr(getZeroExtendExpr(Start, Ty),
1030 getSignExtendExpr(Step, Ty),
Dan Gohman85b05a22009-07-13 21:35:55 +00001031 L);
1032 }
1033
1034 // If the backedge is guarded by a comparison with the pre-inc value
1035 // the addrec is safe. Also, if the entry is guarded by a comparison
1036 // with the start value and the backedge is guarded by a comparison
1037 // with the post-inc value, the addrec is safe.
1038 if (isKnownPositive(Step)) {
1039 const SCEV *N = getConstant(APInt::getMinValue(BitWidth) -
1040 getUnsignedRange(Step).getUnsignedMax());
1041 if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_ULT, AR, N) ||
Dan Gohman3948d0b2010-04-11 19:27:13 +00001042 (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_ULT, Start, N) &&
Dan Gohman85b05a22009-07-13 21:35:55 +00001043 isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_ULT,
1044 AR->getPostIncExpr(*this), N)))
1045 // Return the expression with the addrec on the outside.
1046 return getAddRecExpr(getZeroExtendExpr(Start, Ty),
1047 getZeroExtendExpr(Step, Ty),
1048 L);
1049 } else if (isKnownNegative(Step)) {
1050 const SCEV *N = getConstant(APInt::getMaxValue(BitWidth) -
1051 getSignedRange(Step).getSignedMin());
Dan Gohmanc0ed0092010-05-04 01:11:15 +00001052 if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_UGT, AR, N) ||
1053 (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_UGT, Start, N) &&
Dan Gohman85b05a22009-07-13 21:35:55 +00001054 isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_UGT,
1055 AR->getPostIncExpr(*this), N)))
1056 // Return the expression with the addrec on the outside.
1057 return getAddRecExpr(getZeroExtendExpr(Start, Ty),
1058 getSignExtendExpr(Step, Ty),
1059 L);
Dan Gohman01ecca22009-04-27 20:16:15 +00001060 }
1061 }
1062 }
Chris Lattner53e677a2004-04-02 20:23:17 +00001063
Dan Gohman69fbc7f2009-07-13 20:55:53 +00001064 // The cast wasn't folded; create an explicit cast node.
1065 // Recompute the insert position, as it may have been invalidated.
Dan Gohman1c343752009-06-27 21:21:31 +00001066 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
Dan Gohman95531882010-03-18 18:49:47 +00001067 SCEV *S = new (SCEVAllocator) SCEVZeroExtendExpr(ID.Intern(SCEVAllocator),
1068 Op, Ty);
Dan Gohman1c343752009-06-27 21:21:31 +00001069 UniqueSCEVs.InsertNode(S, IP);
1070 return S;
Chris Lattner53e677a2004-04-02 20:23:17 +00001071}
1072
Dan Gohman0bba49c2009-07-07 17:06:11 +00001073const SCEV *ScalarEvolution::getSignExtendExpr(const SCEV *Op,
Dan Gohmanf5074ec2009-07-13 22:05:32 +00001074 const Type *Ty) {
Dan Gohmanaf79fb52009-04-21 01:07:12 +00001075 assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
Dan Gohmanfb17fd22009-04-21 00:55:22 +00001076 "This is not an extending conversion!");
Dan Gohman10b94792009-05-01 16:44:18 +00001077 assert(isSCEVable(Ty) &&
1078 "This is not a conversion to a SCEVable type!");
1079 Ty = getEffectiveSCEVType(Ty);
Dan Gohmanfb17fd22009-04-21 00:55:22 +00001080
Dan Gohmanc39f44b2009-06-30 20:13:32 +00001081 // Fold if the operand is constant.
Dan Gohmaneaf6cf22010-06-24 16:47:03 +00001082 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1083 return getConstant(
1084 cast<ConstantInt>(ConstantExpr::getSExt(SC->getValue(),
1085 getEffectiveSCEVType(Ty))));
Dan Gohmand19534a2007-06-15 14:38:12 +00001086
Dan Gohman20900ca2009-04-22 16:20:48 +00001087 // sext(sext(x)) --> sext(x)
Dan Gohman622ed672009-05-04 22:02:23 +00001088 if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op))
Dan Gohman20900ca2009-04-22 16:20:48 +00001089 return getSignExtendExpr(SS->getOperand(), Ty);
1090
Dan Gohman69fbc7f2009-07-13 20:55:53 +00001091 // Before doing any expensive analysis, check to see if we've already
1092 // computed a SCEV for this Op and Ty.
1093 FoldingSetNodeID ID;
1094 ID.AddInteger(scSignExtend);
1095 ID.AddPointer(Op);
1096 ID.AddPointer(Ty);
1097 void *IP = 0;
1098 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1099
Dan Gohman01ecca22009-04-27 20:16:15 +00001100 // If the input value is a chrec scev, and we can prove that the value
Dan Gohmand19534a2007-06-15 14:38:12 +00001101 // did not overflow the old, smaller, value, we can sign extend all of the
Dan Gohman01ecca22009-04-27 20:16:15 +00001102 // operands (often constants). This allows analysis of something like
Dan Gohmand19534a2007-06-15 14:38:12 +00001103 // this: for (signed char X = 0; X < 100; ++X) { int Y = X; }
Dan Gohman622ed672009-05-04 22:02:23 +00001104 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op))
Dan Gohman01ecca22009-04-27 20:16:15 +00001105 if (AR->isAffine()) {
Dan Gohman85b05a22009-07-13 21:35:55 +00001106 const SCEV *Start = AR->getStart();
1107 const SCEV *Step = AR->getStepRecurrence(*this);
1108 unsigned BitWidth = getTypeSizeInBits(AR->getType());
1109 const Loop *L = AR->getLoop();
1110
Dan Gohmaneb490a72009-07-25 01:22:26 +00001111 // If we have special knowledge that this addrec won't overflow,
1112 // we don't need to do any further analysis.
Dan Gohman5078f842009-08-20 17:11:38 +00001113 if (AR->hasNoSignedWrap())
Dan Gohmaneb490a72009-07-25 01:22:26 +00001114 return getAddRecExpr(getSignExtendExpr(Start, Ty),
1115 getSignExtendExpr(Step, Ty),
1116 L);
1117
Dan Gohman01ecca22009-04-27 20:16:15 +00001118 // Check whether the backedge-taken count is SCEVCouldNotCompute.
1119 // Note that this serves two purposes: It filters out loops that are
1120 // simply not analyzable, and it covers the case where this code is
1121 // being called from within backedge-taken count analysis, such that
1122 // attempting to ask for the backedge-taken count would likely result
1123 // in infinite recursion. In the later case, the analysis code will
1124 // cope with a conservative value, and it will take care to purge
1125 // that value once it has finished.
Dan Gohman85b05a22009-07-13 21:35:55 +00001126 const SCEV *MaxBECount = getMaxBackedgeTakenCount(L);
Dan Gohmana1af7572009-04-30 20:47:05 +00001127 if (!isa<SCEVCouldNotCompute>(MaxBECount)) {
Dan Gohmanf0aa4852009-04-29 01:54:20 +00001128 // Manually compute the final value for AR, checking for
Dan Gohmanac70cea2009-04-29 22:28:28 +00001129 // overflow.
Dan Gohman01ecca22009-04-27 20:16:15 +00001130
1131 // Check whether the backedge-taken count can be losslessly casted to
Dan Gohmanac70cea2009-04-29 22:28:28 +00001132 // the addrec's type. The count is always unsigned.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001133 const SCEV *CastedMaxBECount =
Dan Gohmana1af7572009-04-30 20:47:05 +00001134 getTruncateOrZeroExtend(MaxBECount, Start->getType());
Dan Gohman0bba49c2009-07-07 17:06:11 +00001135 const SCEV *RecastedMaxBECount =
Dan Gohman5183cae2009-05-18 15:58:39 +00001136 getTruncateOrZeroExtend(CastedMaxBECount, MaxBECount->getType());
1137 if (MaxBECount == RecastedMaxBECount) {
Owen Anderson1d0be152009-08-13 21:58:54 +00001138 const Type *WideTy = IntegerType::get(getContext(), BitWidth * 2);
Dan Gohmana1af7572009-04-30 20:47:05 +00001139 // Check whether Start+Step*MaxBECount has no signed overflow.
Dan Gohman8f767d92010-02-24 19:31:06 +00001140 const SCEV *SMul = getMulExpr(CastedMaxBECount, Step);
Dan Gohman0bba49c2009-07-07 17:06:11 +00001141 const SCEV *Add = getAddExpr(Start, SMul);
1142 const SCEV *OperandExtendedAdd =
Dan Gohman5183cae2009-05-18 15:58:39 +00001143 getAddExpr(getSignExtendExpr(Start, WideTy),
1144 getMulExpr(getZeroExtendExpr(CastedMaxBECount, WideTy),
1145 getSignExtendExpr(Step, WideTy)));
1146 if (getSignExtendExpr(Add, WideTy) == OperandExtendedAdd)
Dan Gohmanac70cea2009-04-29 22:28:28 +00001147 // Return the expression with the addrec on the outside.
1148 return getAddRecExpr(getSignExtendExpr(Start, Ty),
1149 getSignExtendExpr(Step, Ty),
Dan Gohman85b05a22009-07-13 21:35:55 +00001150 L);
Dan Gohman850f7912009-07-16 17:34:36 +00001151
1152 // Similar to above, only this time treat the step value as unsigned.
1153 // This covers loops that count up with an unsigned step.
Dan Gohman8f767d92010-02-24 19:31:06 +00001154 const SCEV *UMul = getMulExpr(CastedMaxBECount, Step);
Dan Gohman850f7912009-07-16 17:34:36 +00001155 Add = getAddExpr(Start, UMul);
1156 OperandExtendedAdd =
Dan Gohman19378d62009-07-25 16:03:30 +00001157 getAddExpr(getSignExtendExpr(Start, WideTy),
Dan Gohman850f7912009-07-16 17:34:36 +00001158 getMulExpr(getZeroExtendExpr(CastedMaxBECount, WideTy),
1159 getZeroExtendExpr(Step, WideTy)));
Dan Gohman19378d62009-07-25 16:03:30 +00001160 if (getSignExtendExpr(Add, WideTy) == OperandExtendedAdd)
Dan Gohman850f7912009-07-16 17:34:36 +00001161 // Return the expression with the addrec on the outside.
1162 return getAddRecExpr(getSignExtendExpr(Start, Ty),
1163 getZeroExtendExpr(Step, Ty),
1164 L);
Dan Gohman85b05a22009-07-13 21:35:55 +00001165 }
1166
1167 // If the backedge is guarded by a comparison with the pre-inc value
1168 // the addrec is safe. Also, if the entry is guarded by a comparison
1169 // with the start value and the backedge is guarded by a comparison
1170 // with the post-inc value, the addrec is safe.
1171 if (isKnownPositive(Step)) {
1172 const SCEV *N = getConstant(APInt::getSignedMinValue(BitWidth) -
1173 getSignedRange(Step).getSignedMax());
1174 if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_SLT, AR, N) ||
Dan Gohman3948d0b2010-04-11 19:27:13 +00001175 (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_SLT, Start, N) &&
Dan Gohman85b05a22009-07-13 21:35:55 +00001176 isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_SLT,
1177 AR->getPostIncExpr(*this), N)))
1178 // Return the expression with the addrec on the outside.
1179 return getAddRecExpr(getSignExtendExpr(Start, Ty),
1180 getSignExtendExpr(Step, Ty),
1181 L);
1182 } else if (isKnownNegative(Step)) {
1183 const SCEV *N = getConstant(APInt::getSignedMaxValue(BitWidth) -
1184 getSignedRange(Step).getSignedMin());
1185 if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_SGT, AR, N) ||
Dan Gohman3948d0b2010-04-11 19:27:13 +00001186 (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_SGT, Start, N) &&
Dan Gohman85b05a22009-07-13 21:35:55 +00001187 isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_SGT,
1188 AR->getPostIncExpr(*this), N)))
1189 // Return the expression with the addrec on the outside.
1190 return getAddRecExpr(getSignExtendExpr(Start, Ty),
1191 getSignExtendExpr(Step, Ty),
1192 L);
Dan Gohman01ecca22009-04-27 20:16:15 +00001193 }
1194 }
1195 }
Dan Gohmand19534a2007-06-15 14:38:12 +00001196
Dan Gohman69fbc7f2009-07-13 20:55:53 +00001197 // The cast wasn't folded; create an explicit cast node.
1198 // Recompute the insert position, as it may have been invalidated.
Dan Gohman1c343752009-06-27 21:21:31 +00001199 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
Dan Gohman95531882010-03-18 18:49:47 +00001200 SCEV *S = new (SCEVAllocator) SCEVSignExtendExpr(ID.Intern(SCEVAllocator),
1201 Op, Ty);
Dan Gohman1c343752009-06-27 21:21:31 +00001202 UniqueSCEVs.InsertNode(S, IP);
1203 return S;
Dan Gohmand19534a2007-06-15 14:38:12 +00001204}
1205
Dan Gohman2ce84c8d2009-06-13 15:56:47 +00001206/// getAnyExtendExpr - Return a SCEV for the given operand extended with
1207/// unspecified bits out to the given type.
1208///
Dan Gohman0bba49c2009-07-07 17:06:11 +00001209const SCEV *ScalarEvolution::getAnyExtendExpr(const SCEV *Op,
Dan Gohmanc40f17b2009-08-18 16:46:41 +00001210 const Type *Ty) {
Dan Gohman2ce84c8d2009-06-13 15:56:47 +00001211 assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
1212 "This is not an extending conversion!");
1213 assert(isSCEVable(Ty) &&
1214 "This is not a conversion to a SCEVable type!");
1215 Ty = getEffectiveSCEVType(Ty);
1216
1217 // Sign-extend negative constants.
1218 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1219 if (SC->getValue()->getValue().isNegative())
1220 return getSignExtendExpr(Op, Ty);
1221
1222 // Peel off a truncate cast.
1223 if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Op)) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00001224 const SCEV *NewOp = T->getOperand();
Dan Gohman2ce84c8d2009-06-13 15:56:47 +00001225 if (getTypeSizeInBits(NewOp->getType()) < getTypeSizeInBits(Ty))
1226 return getAnyExtendExpr(NewOp, Ty);
1227 return getTruncateOrNoop(NewOp, Ty);
1228 }
1229
1230 // Next try a zext cast. If the cast is folded, use it.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001231 const SCEV *ZExt = getZeroExtendExpr(Op, Ty);
Dan Gohman2ce84c8d2009-06-13 15:56:47 +00001232 if (!isa<SCEVZeroExtendExpr>(ZExt))
1233 return ZExt;
1234
1235 // Next try a sext cast. If the cast is folded, use it.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001236 const SCEV *SExt = getSignExtendExpr(Op, Ty);
Dan Gohman2ce84c8d2009-06-13 15:56:47 +00001237 if (!isa<SCEVSignExtendExpr>(SExt))
1238 return SExt;
1239
Dan Gohmana10756e2010-01-21 02:09:26 +00001240 // Force the cast to be folded into the operands of an addrec.
1241 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op)) {
1242 SmallVector<const SCEV *, 4> Ops;
1243 for (SCEVAddRecExpr::op_iterator I = AR->op_begin(), E = AR->op_end();
1244 I != E; ++I)
1245 Ops.push_back(getAnyExtendExpr(*I, Ty));
1246 return getAddRecExpr(Ops, AR->getLoop());
1247 }
1248
Dan Gohmanf53462d2010-07-15 20:02:11 +00001249 // As a special case, fold anyext(undef) to undef. We don't want to
1250 // know too much about SCEVUnknowns, but this special case is handy
1251 // and harmless.
1252 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(Op))
1253 if (isa<UndefValue>(U->getValue()))
1254 return getSCEV(UndefValue::get(Ty));
1255
Dan Gohman2ce84c8d2009-06-13 15:56:47 +00001256 // If the expression is obviously signed, use the sext cast value.
1257 if (isa<SCEVSMaxExpr>(Op))
1258 return SExt;
1259
1260 // Absent any other information, use the zext cast value.
1261 return ZExt;
1262}
1263
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001264/// CollectAddOperandsWithScales - Process the given Ops list, which is
1265/// a list of operands to be added under the given scale, update the given
1266/// map. This is a helper function for getAddRecExpr. As an example of
1267/// what it does, given a sequence of operands that would form an add
1268/// expression like this:
1269///
1270/// m + n + 13 + (A * (o + p + (B * q + m + 29))) + r + (-1 * r)
1271///
1272/// where A and B are constants, update the map with these values:
1273///
1274/// (m, 1+A*B), (n, 1), (o, A), (p, A), (q, A*B), (r, 0)
1275///
1276/// and add 13 + A*B*29 to AccumulatedConstant.
1277/// This will allow getAddRecExpr to produce this:
1278///
1279/// 13+A*B*29 + n + (m * (1+A*B)) + ((o + p) * A) + (q * A*B)
1280///
1281/// This form often exposes folding opportunities that are hidden in
1282/// the original operand list.
1283///
1284/// Return true iff it appears that any interesting folding opportunities
1285/// may be exposed. This helps getAddRecExpr short-circuit extra work in
1286/// the common case where no interesting opportunities are present, and
1287/// is also used as a check to avoid infinite recursion.
1288///
1289static bool
Dan Gohman0bba49c2009-07-07 17:06:11 +00001290CollectAddOperandsWithScales(DenseMap<const SCEV *, APInt> &M,
1291 SmallVector<const SCEV *, 8> &NewOps,
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001292 APInt &AccumulatedConstant,
Dan Gohmanf9e64722010-03-18 01:17:13 +00001293 const SCEV *const *Ops, size_t NumOperands,
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001294 const APInt &Scale,
1295 ScalarEvolution &SE) {
1296 bool Interesting = false;
1297
Dan Gohmane0f0c7b2010-06-18 19:12:32 +00001298 // Iterate over the add operands. They are sorted, with constants first.
1299 unsigned i = 0;
1300 while (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) {
1301 ++i;
1302 // Pull a buried constant out to the outside.
1303 if (Scale != 1 || AccumulatedConstant != 0 || C->getValue()->isZero())
1304 Interesting = true;
1305 AccumulatedConstant += Scale * C->getValue()->getValue();
1306 }
1307
1308 // Next comes everything else. We're especially interested in multiplies
1309 // here, but they're in the middle, so just visit the rest with one loop.
1310 for (; i != NumOperands; ++i) {
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001311 const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[i]);
1312 if (Mul && isa<SCEVConstant>(Mul->getOperand(0))) {
1313 APInt NewScale =
1314 Scale * cast<SCEVConstant>(Mul->getOperand(0))->getValue()->getValue();
1315 if (Mul->getNumOperands() == 2 && isa<SCEVAddExpr>(Mul->getOperand(1))) {
1316 // A multiplication of a constant with another add; recurse.
Dan Gohmanf9e64722010-03-18 01:17:13 +00001317 const SCEVAddExpr *Add = cast<SCEVAddExpr>(Mul->getOperand(1));
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001318 Interesting |=
1319 CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant,
Dan Gohmanf9e64722010-03-18 01:17:13 +00001320 Add->op_begin(), Add->getNumOperands(),
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001321 NewScale, SE);
1322 } else {
1323 // A multiplication of a constant with some other value. Update
1324 // the map.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001325 SmallVector<const SCEV *, 4> MulOps(Mul->op_begin()+1, Mul->op_end());
1326 const SCEV *Key = SE.getMulExpr(MulOps);
1327 std::pair<DenseMap<const SCEV *, APInt>::iterator, bool> Pair =
Dan Gohman23737e02009-06-29 18:25:52 +00001328 M.insert(std::make_pair(Key, NewScale));
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001329 if (Pair.second) {
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001330 NewOps.push_back(Pair.first->first);
1331 } else {
1332 Pair.first->second += NewScale;
1333 // The map already had an entry for this value, which may indicate
1334 // a folding opportunity.
1335 Interesting = true;
1336 }
1337 }
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001338 } else {
1339 // An ordinary operand. Update the map.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001340 std::pair<DenseMap<const SCEV *, APInt>::iterator, bool> Pair =
Dan Gohman23737e02009-06-29 18:25:52 +00001341 M.insert(std::make_pair(Ops[i], Scale));
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001342 if (Pair.second) {
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001343 NewOps.push_back(Pair.first->first);
1344 } else {
1345 Pair.first->second += Scale;
1346 // The map already had an entry for this value, which may indicate
1347 // a folding opportunity.
1348 Interesting = true;
1349 }
1350 }
1351 }
1352
1353 return Interesting;
1354}
1355
1356namespace {
1357 struct APIntCompare {
1358 bool operator()(const APInt &LHS, const APInt &RHS) const {
1359 return LHS.ult(RHS);
1360 }
1361 };
1362}
1363
Dan Gohman6c0866c2009-05-24 23:45:28 +00001364/// getAddExpr - Get a canonical add expression, or something simpler if
1365/// possible.
Dan Gohman3645b012009-10-09 00:10:36 +00001366const SCEV *ScalarEvolution::getAddExpr(SmallVectorImpl<const SCEV *> &Ops,
1367 bool HasNUW, bool HasNSW) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001368 assert(!Ops.empty() && "Cannot get empty add!");
Chris Lattner627018b2004-04-07 16:16:11 +00001369 if (Ops.size() == 1) return Ops[0];
Dan Gohmanf78a9782009-05-18 15:44:58 +00001370#ifndef NDEBUG
Dan Gohmanc72f0c82010-06-18 19:09:27 +00001371 const Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
Dan Gohmanf78a9782009-05-18 15:44:58 +00001372 for (unsigned i = 1, e = Ops.size(); i != e; ++i)
Dan Gohmanc72f0c82010-06-18 19:09:27 +00001373 assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
Dan Gohmanf78a9782009-05-18 15:44:58 +00001374 "SCEVAddExpr operand types don't match!");
1375#endif
Chris Lattner53e677a2004-04-02 20:23:17 +00001376
Dan Gohmana10756e2010-01-21 02:09:26 +00001377 // If HasNSW is true and all the operands are non-negative, infer HasNUW.
1378 if (!HasNUW && HasNSW) {
1379 bool All = true;
Dan Gohman2d16fc52010-08-16 16:27:53 +00001380 for (SmallVectorImpl<const SCEV *>::const_iterator I = Ops.begin(),
1381 E = Ops.end(); I != E; ++I)
1382 if (!isKnownNonNegative(*I)) {
Dan Gohmana10756e2010-01-21 02:09:26 +00001383 All = false;
1384 break;
1385 }
1386 if (All) HasNUW = true;
1387 }
1388
Chris Lattner53e677a2004-04-02 20:23:17 +00001389 // Sort by complexity, this groups all similar expression types together.
Dan Gohman72861302009-05-07 14:39:04 +00001390 GroupByComplexity(Ops, LI);
Chris Lattner53e677a2004-04-02 20:23:17 +00001391
1392 // If there are any constants, fold them together.
1393 unsigned Idx = 0;
Dan Gohman622ed672009-05-04 22:02:23 +00001394 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001395 ++Idx;
Chris Lattner627018b2004-04-07 16:16:11 +00001396 assert(Idx < Ops.size());
Dan Gohman622ed672009-05-04 22:02:23 +00001397 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001398 // We found two constants, fold them together!
Dan Gohmana82752c2009-06-14 22:47:23 +00001399 Ops[0] = getConstant(LHSC->getValue()->getValue() +
1400 RHSC->getValue()->getValue());
Dan Gohman7f7c4362009-06-14 22:53:57 +00001401 if (Ops.size() == 2) return Ops[0];
Nick Lewycky3e630762008-02-20 06:48:22 +00001402 Ops.erase(Ops.begin()+1); // Erase the folded element
Nick Lewycky3e630762008-02-20 06:48:22 +00001403 LHSC = cast<SCEVConstant>(Ops[0]);
Chris Lattner53e677a2004-04-02 20:23:17 +00001404 }
1405
1406 // If we are left with a constant zero being added, strip it off.
Dan Gohmanbca091d2010-04-12 23:08:18 +00001407 if (LHSC->getValue()->isZero()) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001408 Ops.erase(Ops.begin());
1409 --Idx;
1410 }
Chris Lattner53e677a2004-04-02 20:23:17 +00001411
Dan Gohmanbca091d2010-04-12 23:08:18 +00001412 if (Ops.size() == 1) return Ops[0];
1413 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +00001414
Chris Lattner53e677a2004-04-02 20:23:17 +00001415 // Okay, check to see if the same value occurs in the operand list twice. If
1416 // so, merge them together into an multiply expression. Since we sorted the
1417 // list, these values are required to be adjacent.
1418 const Type *Ty = Ops[0]->getType();
Dan Gohmandc7692b2010-08-12 14:46:54 +00001419 bool FoundMatch = false;
Chris Lattner53e677a2004-04-02 20:23:17 +00001420 for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
1421 if (Ops[i] == Ops[i+1]) { // X + Y + Y --> X + Y*2
1422 // Found a match, merge the two values into a multiply, and add any
1423 // remaining values to the result.
Dan Gohmandeff6212010-05-03 22:09:21 +00001424 const SCEV *Two = getConstant(Ty, 2);
Dan Gohman58a85b92010-08-13 20:17:14 +00001425 const SCEV *Mul = getMulExpr(Two, Ops[i]);
Chris Lattner53e677a2004-04-02 20:23:17 +00001426 if (Ops.size() == 2)
1427 return Mul;
Dan Gohmandc7692b2010-08-12 14:46:54 +00001428 Ops[i] = Mul;
1429 Ops.erase(Ops.begin()+i+1);
1430 --i; --e;
1431 FoundMatch = true;
Chris Lattner53e677a2004-04-02 20:23:17 +00001432 }
Dan Gohmandc7692b2010-08-12 14:46:54 +00001433 if (FoundMatch)
1434 return getAddExpr(Ops, HasNUW, HasNSW);
Chris Lattner53e677a2004-04-02 20:23:17 +00001435
Dan Gohman728c7f32009-05-08 21:03:19 +00001436 // Check for truncates. If all the operands are truncated from the same
1437 // type, see if factoring out the truncate would permit the result to be
1438 // folded. eg., trunc(x) + m*trunc(n) --> trunc(x + trunc(m)*n)
1439 // if the contents of the resulting outer trunc fold to something simple.
1440 for (; Idx < Ops.size() && isa<SCEVTruncateExpr>(Ops[Idx]); ++Idx) {
1441 const SCEVTruncateExpr *Trunc = cast<SCEVTruncateExpr>(Ops[Idx]);
1442 const Type *DstType = Trunc->getType();
1443 const Type *SrcType = Trunc->getOperand()->getType();
Dan Gohman0bba49c2009-07-07 17:06:11 +00001444 SmallVector<const SCEV *, 8> LargeOps;
Dan Gohman728c7f32009-05-08 21:03:19 +00001445 bool Ok = true;
1446 // Check all the operands to see if they can be represented in the
1447 // source type of the truncate.
1448 for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
1449 if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Ops[i])) {
1450 if (T->getOperand()->getType() != SrcType) {
1451 Ok = false;
1452 break;
1453 }
1454 LargeOps.push_back(T->getOperand());
1455 } else if (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) {
Dan Gohmanc6863982010-04-23 01:51:29 +00001456 LargeOps.push_back(getAnyExtendExpr(C, SrcType));
Dan Gohman728c7f32009-05-08 21:03:19 +00001457 } else if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(Ops[i])) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00001458 SmallVector<const SCEV *, 8> LargeMulOps;
Dan Gohman728c7f32009-05-08 21:03:19 +00001459 for (unsigned j = 0, f = M->getNumOperands(); j != f && Ok; ++j) {
1460 if (const SCEVTruncateExpr *T =
1461 dyn_cast<SCEVTruncateExpr>(M->getOperand(j))) {
1462 if (T->getOperand()->getType() != SrcType) {
1463 Ok = false;
1464 break;
1465 }
1466 LargeMulOps.push_back(T->getOperand());
1467 } else if (const SCEVConstant *C =
1468 dyn_cast<SCEVConstant>(M->getOperand(j))) {
Dan Gohmanc6863982010-04-23 01:51:29 +00001469 LargeMulOps.push_back(getAnyExtendExpr(C, SrcType));
Dan Gohman728c7f32009-05-08 21:03:19 +00001470 } else {
1471 Ok = false;
1472 break;
1473 }
1474 }
1475 if (Ok)
1476 LargeOps.push_back(getMulExpr(LargeMulOps));
1477 } else {
1478 Ok = false;
1479 break;
1480 }
1481 }
1482 if (Ok) {
1483 // Evaluate the expression in the larger type.
Dan Gohman3645b012009-10-09 00:10:36 +00001484 const SCEV *Fold = getAddExpr(LargeOps, HasNUW, HasNSW);
Dan Gohman728c7f32009-05-08 21:03:19 +00001485 // If it folds to something simple, use it. Otherwise, don't.
1486 if (isa<SCEVConstant>(Fold) || isa<SCEVUnknown>(Fold))
1487 return getTruncateExpr(Fold, DstType);
1488 }
1489 }
1490
1491 // Skip past any other cast SCEVs.
Dan Gohmanf50cd742007-06-18 19:30:09 +00001492 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddExpr)
1493 ++Idx;
1494
1495 // If there are add operands they would be next.
Chris Lattner53e677a2004-04-02 20:23:17 +00001496 if (Idx < Ops.size()) {
1497 bool DeletedAdd = false;
Dan Gohman622ed672009-05-04 22:02:23 +00001498 while (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[Idx])) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001499 // If we have an add, expand the add operands onto the end of the operands
1500 // list.
Chris Lattner53e677a2004-04-02 20:23:17 +00001501 Ops.erase(Ops.begin()+Idx);
Dan Gohman403a8cd2010-06-21 19:47:52 +00001502 Ops.append(Add->op_begin(), Add->op_end());
Chris Lattner53e677a2004-04-02 20:23:17 +00001503 DeletedAdd = true;
1504 }
1505
1506 // If we deleted at least one add, we added operands to the end of the list,
1507 // and they are not necessarily sorted. Recurse to resort and resimplify
Dan Gohman3f46a3a2010-03-01 17:49:51 +00001508 // any operands we just acquired.
Chris Lattner53e677a2004-04-02 20:23:17 +00001509 if (DeletedAdd)
Dan Gohman246b2562007-10-22 18:31:58 +00001510 return getAddExpr(Ops);
Chris Lattner53e677a2004-04-02 20:23:17 +00001511 }
1512
1513 // Skip over the add expression until we get to a multiply.
1514 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr)
1515 ++Idx;
1516
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001517 // Check to see if there are any folding opportunities present with
1518 // operands multiplied by constant values.
1519 if (Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx])) {
1520 uint64_t BitWidth = getTypeSizeInBits(Ty);
Dan Gohman0bba49c2009-07-07 17:06:11 +00001521 DenseMap<const SCEV *, APInt> M;
1522 SmallVector<const SCEV *, 8> NewOps;
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001523 APInt AccumulatedConstant(BitWidth, 0);
1524 if (CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant,
Dan Gohmanf9e64722010-03-18 01:17:13 +00001525 Ops.data(), Ops.size(),
1526 APInt(BitWidth, 1), *this)) {
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001527 // Some interesting folding opportunity is present, so its worthwhile to
1528 // re-generate the operands list. Group the operands by constant scale,
1529 // to avoid multiplying by the same constant scale multiple times.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001530 std::map<APInt, SmallVector<const SCEV *, 4>, APIntCompare> MulOpLists;
Dan Gohman8d9c7a62010-08-16 16:30:01 +00001531 for (SmallVector<const SCEV *, 8>::const_iterator I = NewOps.begin(),
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001532 E = NewOps.end(); I != E; ++I)
1533 MulOpLists[M.find(*I)->second].push_back(*I);
1534 // Re-generate the operands list.
1535 Ops.clear();
1536 if (AccumulatedConstant != 0)
1537 Ops.push_back(getConstant(AccumulatedConstant));
Dan Gohman64a845e2009-06-24 04:48:43 +00001538 for (std::map<APInt, SmallVector<const SCEV *, 4>, APIntCompare>::iterator
1539 I = MulOpLists.begin(), E = MulOpLists.end(); I != E; ++I)
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001540 if (I->first != 0)
Dan Gohman64a845e2009-06-24 04:48:43 +00001541 Ops.push_back(getMulExpr(getConstant(I->first),
1542 getAddExpr(I->second)));
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001543 if (Ops.empty())
Dan Gohmandeff6212010-05-03 22:09:21 +00001544 return getConstant(Ty, 0);
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001545 if (Ops.size() == 1)
1546 return Ops[0];
1547 return getAddExpr(Ops);
1548 }
1549 }
1550
Chris Lattner53e677a2004-04-02 20:23:17 +00001551 // If we are adding something to a multiply expression, make sure the
1552 // something is not already an operand of the multiply. If so, merge it into
1553 // the multiply.
1554 for (; Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx]); ++Idx) {
Dan Gohman35738ac2009-05-04 22:30:44 +00001555 const SCEVMulExpr *Mul = cast<SCEVMulExpr>(Ops[Idx]);
Chris Lattner53e677a2004-04-02 20:23:17 +00001556 for (unsigned MulOp = 0, e = Mul->getNumOperands(); MulOp != e; ++MulOp) {
Dan Gohman35738ac2009-05-04 22:30:44 +00001557 const SCEV *MulOpSCEV = Mul->getOperand(MulOp);
Dan Gohman918e76b2010-08-12 14:52:55 +00001558 if (isa<SCEVConstant>(MulOpSCEV))
1559 continue;
Chris Lattner53e677a2004-04-02 20:23:17 +00001560 for (unsigned AddOp = 0, e = Ops.size(); AddOp != e; ++AddOp)
Dan Gohman918e76b2010-08-12 14:52:55 +00001561 if (MulOpSCEV == Ops[AddOp]) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001562 // Fold W + X + (X * Y * Z) --> W + (X * ((Y*Z)+1))
Dan Gohman0bba49c2009-07-07 17:06:11 +00001563 const SCEV *InnerMul = Mul->getOperand(MulOp == 0);
Chris Lattner53e677a2004-04-02 20:23:17 +00001564 if (Mul->getNumOperands() != 2) {
1565 // If the multiply has more than two operands, we must get the
1566 // Y*Z term.
Dan Gohman18959912010-08-16 16:57:24 +00001567 SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(),
1568 Mul->op_begin()+MulOp);
1569 MulOps.append(Mul->op_begin()+MulOp+1, Mul->op_end());
Dan Gohman246b2562007-10-22 18:31:58 +00001570 InnerMul = getMulExpr(MulOps);
Chris Lattner53e677a2004-04-02 20:23:17 +00001571 }
Dan Gohmandeff6212010-05-03 22:09:21 +00001572 const SCEV *One = getConstant(Ty, 1);
Dan Gohman58a85b92010-08-13 20:17:14 +00001573 const SCEV *AddOne = getAddExpr(One, InnerMul);
Dan Gohman918e76b2010-08-12 14:52:55 +00001574 const SCEV *OuterMul = getMulExpr(AddOne, MulOpSCEV);
Chris Lattner53e677a2004-04-02 20:23:17 +00001575 if (Ops.size() == 2) return OuterMul;
1576 if (AddOp < Idx) {
1577 Ops.erase(Ops.begin()+AddOp);
1578 Ops.erase(Ops.begin()+Idx-1);
1579 } else {
1580 Ops.erase(Ops.begin()+Idx);
1581 Ops.erase(Ops.begin()+AddOp-1);
1582 }
1583 Ops.push_back(OuterMul);
Dan Gohman246b2562007-10-22 18:31:58 +00001584 return getAddExpr(Ops);
Chris Lattner53e677a2004-04-02 20:23:17 +00001585 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +00001586
Chris Lattner53e677a2004-04-02 20:23:17 +00001587 // Check this multiply against other multiplies being added together.
Dan Gohman727356f2010-08-12 15:00:23 +00001588 bool AnyFold = false;
Chris Lattner53e677a2004-04-02 20:23:17 +00001589 for (unsigned OtherMulIdx = Idx+1;
1590 OtherMulIdx < Ops.size() && isa<SCEVMulExpr>(Ops[OtherMulIdx]);
1591 ++OtherMulIdx) {
Dan Gohman35738ac2009-05-04 22:30:44 +00001592 const SCEVMulExpr *OtherMul = cast<SCEVMulExpr>(Ops[OtherMulIdx]);
Chris Lattner53e677a2004-04-02 20:23:17 +00001593 // If MulOp occurs in OtherMul, we can fold the two multiplies
1594 // together.
1595 for (unsigned OMulOp = 0, e = OtherMul->getNumOperands();
1596 OMulOp != e; ++OMulOp)
1597 if (OtherMul->getOperand(OMulOp) == MulOpSCEV) {
1598 // Fold X + (A*B*C) + (A*D*E) --> X + (A*(B*C+D*E))
Dan Gohman0bba49c2009-07-07 17:06:11 +00001599 const SCEV *InnerMul1 = Mul->getOperand(MulOp == 0);
Chris Lattner53e677a2004-04-02 20:23:17 +00001600 if (Mul->getNumOperands() != 2) {
Dan Gohman64a845e2009-06-24 04:48:43 +00001601 SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(),
Dan Gohman18959912010-08-16 16:57:24 +00001602 Mul->op_begin()+MulOp);
1603 MulOps.append(Mul->op_begin()+MulOp+1, Mul->op_end());
Dan Gohman246b2562007-10-22 18:31:58 +00001604 InnerMul1 = getMulExpr(MulOps);
Chris Lattner53e677a2004-04-02 20:23:17 +00001605 }
Dan Gohman0bba49c2009-07-07 17:06:11 +00001606 const SCEV *InnerMul2 = OtherMul->getOperand(OMulOp == 0);
Chris Lattner53e677a2004-04-02 20:23:17 +00001607 if (OtherMul->getNumOperands() != 2) {
Dan Gohman64a845e2009-06-24 04:48:43 +00001608 SmallVector<const SCEV *, 4> MulOps(OtherMul->op_begin(),
Dan Gohman18959912010-08-16 16:57:24 +00001609 OtherMul->op_begin()+OMulOp);
1610 MulOps.append(OtherMul->op_begin()+OMulOp+1, OtherMul->op_end());
Dan Gohman246b2562007-10-22 18:31:58 +00001611 InnerMul2 = getMulExpr(MulOps);
Chris Lattner53e677a2004-04-02 20:23:17 +00001612 }
Dan Gohman0bba49c2009-07-07 17:06:11 +00001613 const SCEV *InnerMulSum = getAddExpr(InnerMul1,InnerMul2);
1614 const SCEV *OuterMul = getMulExpr(MulOpSCEV, InnerMulSum);
Chris Lattner53e677a2004-04-02 20:23:17 +00001615 if (Ops.size() == 2) return OuterMul;
Dan Gohman727356f2010-08-12 15:00:23 +00001616 Ops[Idx] = OuterMul;
1617 Ops.erase(Ops.begin()+OtherMulIdx);
1618 OtherMulIdx = Idx;
1619 AnyFold = true;
Chris Lattner53e677a2004-04-02 20:23:17 +00001620 }
1621 }
Dan Gohman727356f2010-08-12 15:00:23 +00001622 if (AnyFold)
1623 return getAddExpr(Ops);
Chris Lattner53e677a2004-04-02 20:23:17 +00001624 }
1625 }
1626
1627 // If there are any add recurrences in the operands list, see if any other
1628 // added values are loop invariant. If so, we can fold them into the
1629 // recurrence.
1630 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr)
1631 ++Idx;
1632
1633 // Scan over all recurrences, trying to fold loop invariants into them.
1634 for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) {
1635 // Scan all of the other operands to this add and add them to the vector if
1636 // they are loop invariant w.r.t. the recurrence.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001637 SmallVector<const SCEV *, 8> LIOps;
Dan Gohman35738ac2009-05-04 22:30:44 +00001638 const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]);
Dan Gohmanbca091d2010-04-12 23:08:18 +00001639 const Loop *AddRecLoop = AddRec->getLoop();
Chris Lattner53e677a2004-04-02 20:23:17 +00001640 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
Dan Gohmanbca091d2010-04-12 23:08:18 +00001641 if (Ops[i]->isLoopInvariant(AddRecLoop)) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001642 LIOps.push_back(Ops[i]);
1643 Ops.erase(Ops.begin()+i);
1644 --i; --e;
1645 }
1646
1647 // If we found some loop invariants, fold them into the recurrence.
1648 if (!LIOps.empty()) {
Dan Gohman8dae1382008-09-14 17:21:12 +00001649 // NLI + LI + {Start,+,Step} --> NLI + {LI+Start,+,Step}
Chris Lattner53e677a2004-04-02 20:23:17 +00001650 LIOps.push_back(AddRec->getStart());
1651
Dan Gohman0bba49c2009-07-07 17:06:11 +00001652 SmallVector<const SCEV *, 4> AddRecOps(AddRec->op_begin(),
Dan Gohman3a5d4092009-12-18 03:57:04 +00001653 AddRec->op_end());
Dan Gohman246b2562007-10-22 18:31:58 +00001654 AddRecOps[0] = getAddExpr(LIOps);
Chris Lattner53e677a2004-04-02 20:23:17 +00001655
Dan Gohmanb9f96512010-06-30 07:16:37 +00001656 // Build the new addrec. Propagate the NUW and NSW flags if both the
1657 // outer add and the inner addrec are guaranteed to have no overflow.
1658 const SCEV *NewRec = getAddRecExpr(AddRecOps, AddRecLoop,
1659 HasNUW && AddRec->hasNoUnsignedWrap(),
1660 HasNSW && AddRec->hasNoSignedWrap());
Dan Gohman59de33e2009-12-18 18:45:31 +00001661
Chris Lattner53e677a2004-04-02 20:23:17 +00001662 // If all of the other operands were loop invariant, we are done.
1663 if (Ops.size() == 1) return NewRec;
1664
1665 // Otherwise, add the folded AddRec by the non-liv parts.
1666 for (unsigned i = 0;; ++i)
1667 if (Ops[i] == AddRec) {
1668 Ops[i] = NewRec;
1669 break;
1670 }
Dan Gohman246b2562007-10-22 18:31:58 +00001671 return getAddExpr(Ops);
Chris Lattner53e677a2004-04-02 20:23:17 +00001672 }
1673
1674 // Okay, if there weren't any loop invariants to be folded, check to see if
1675 // there are multiple AddRec's with the same loop induction variable being
1676 // added together. If so, we can fold them.
1677 for (unsigned OtherIdx = Idx+1;
Dan Gohman32527152010-08-27 20:45:56 +00001678 OtherIdx < Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);
1679 ++OtherIdx)
1680 if (AddRecLoop == cast<SCEVAddRecExpr>(Ops[OtherIdx])->getLoop()) {
1681 // Other + {A,+,B}<L> + {C,+,D}<L> --> Other + {A+C,+,B+D}<L>
1682 SmallVector<const SCEV *, 4> AddRecOps(AddRec->op_begin(),
1683 AddRec->op_end());
1684 for (; OtherIdx != Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);
1685 ++OtherIdx)
1686 if (const SCEVAddRecExpr *AR =
1687 dyn_cast<SCEVAddRecExpr>(Ops[OtherIdx]))
1688 if (AR->getLoop() == AddRecLoop) {
1689 for (unsigned i = 0, e = AR->getNumOperands(); i != e; ++i) {
1690 if (i >= AddRecOps.size()) {
1691 AddRecOps.append(AR->op_begin()+i, AR->op_end());
1692 break;
1693 }
1694 AddRecOps[i] = getAddExpr(AddRecOps[i], AR->getOperand(i));
1695 }
1696 Ops.erase(Ops.begin() + OtherIdx); --OtherIdx;
Chris Lattner53e677a2004-04-02 20:23:17 +00001697 }
Dan Gohman32527152010-08-27 20:45:56 +00001698 Ops[Idx] = getAddRecExpr(AddRecOps, AddRecLoop);
1699 return getAddExpr(Ops);
Chris Lattner53e677a2004-04-02 20:23:17 +00001700 }
1701
1702 // Otherwise couldn't fold anything into this recurrence. Move onto the
1703 // next one.
1704 }
1705
1706 // Okay, it looks like we really DO need an add expr. Check to see if we
1707 // already have one, otherwise create a new one.
Dan Gohman1c343752009-06-27 21:21:31 +00001708 FoldingSetNodeID ID;
1709 ID.AddInteger(scAddExpr);
1710 ID.AddInteger(Ops.size());
1711 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
1712 ID.AddPointer(Ops[i]);
1713 void *IP = 0;
Dan Gohmana10756e2010-01-21 02:09:26 +00001714 SCEVAddExpr *S =
1715 static_cast<SCEVAddExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
1716 if (!S) {
Dan Gohmanf9e64722010-03-18 01:17:13 +00001717 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
1718 std::uninitialized_copy(Ops.begin(), Ops.end(), O);
Dan Gohman95531882010-03-18 18:49:47 +00001719 S = new (SCEVAllocator) SCEVAddExpr(ID.Intern(SCEVAllocator),
1720 O, Ops.size());
Dan Gohmana10756e2010-01-21 02:09:26 +00001721 UniqueSCEVs.InsertNode(S, IP);
1722 }
Dan Gohman3645b012009-10-09 00:10:36 +00001723 if (HasNUW) S->setHasNoUnsignedWrap(true);
1724 if (HasNSW) S->setHasNoSignedWrap(true);
Dan Gohman1c343752009-06-27 21:21:31 +00001725 return S;
Chris Lattner53e677a2004-04-02 20:23:17 +00001726}
1727
Dan Gohman6c0866c2009-05-24 23:45:28 +00001728/// getMulExpr - Get a canonical multiply expression, or something simpler if
1729/// possible.
Dan Gohman3645b012009-10-09 00:10:36 +00001730const SCEV *ScalarEvolution::getMulExpr(SmallVectorImpl<const SCEV *> &Ops,
1731 bool HasNUW, bool HasNSW) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001732 assert(!Ops.empty() && "Cannot get empty mul!");
Dan Gohmana10756e2010-01-21 02:09:26 +00001733 if (Ops.size() == 1) return Ops[0];
Dan Gohmanf78a9782009-05-18 15:44:58 +00001734#ifndef NDEBUG
Dan Gohmanc4f77982010-08-16 16:13:54 +00001735 const Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
Dan Gohmanf78a9782009-05-18 15:44:58 +00001736 for (unsigned i = 1, e = Ops.size(); i != e; ++i)
Dan Gohmanc4f77982010-08-16 16:13:54 +00001737 assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
Dan Gohmanf78a9782009-05-18 15:44:58 +00001738 "SCEVMulExpr operand types don't match!");
1739#endif
Chris Lattner53e677a2004-04-02 20:23:17 +00001740
Dan Gohmana10756e2010-01-21 02:09:26 +00001741 // If HasNSW is true and all the operands are non-negative, infer HasNUW.
1742 if (!HasNUW && HasNSW) {
1743 bool All = true;
Dan Gohman2d16fc52010-08-16 16:27:53 +00001744 for (SmallVectorImpl<const SCEV *>::const_iterator I = Ops.begin(),
1745 E = Ops.end(); I != E; ++I)
1746 if (!isKnownNonNegative(*I)) {
Dan Gohmana10756e2010-01-21 02:09:26 +00001747 All = false;
1748 break;
1749 }
1750 if (All) HasNUW = true;
1751 }
1752
Chris Lattner53e677a2004-04-02 20:23:17 +00001753 // Sort by complexity, this groups all similar expression types together.
Dan Gohman72861302009-05-07 14:39:04 +00001754 GroupByComplexity(Ops, LI);
Chris Lattner53e677a2004-04-02 20:23:17 +00001755
1756 // If there are any constants, fold them together.
1757 unsigned Idx = 0;
Dan Gohman622ed672009-05-04 22:02:23 +00001758 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001759
1760 // C1*(C2+V) -> C1*C2 + C1*V
1761 if (Ops.size() == 2)
Dan Gohman622ed672009-05-04 22:02:23 +00001762 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1]))
Chris Lattner53e677a2004-04-02 20:23:17 +00001763 if (Add->getNumOperands() == 2 &&
1764 isa<SCEVConstant>(Add->getOperand(0)))
Dan Gohman246b2562007-10-22 18:31:58 +00001765 return getAddExpr(getMulExpr(LHSC, Add->getOperand(0)),
1766 getMulExpr(LHSC, Add->getOperand(1)));
Chris Lattner53e677a2004-04-02 20:23:17 +00001767
Chris Lattner53e677a2004-04-02 20:23:17 +00001768 ++Idx;
Dan Gohman622ed672009-05-04 22:02:23 +00001769 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001770 // We found two constants, fold them together!
Owen Andersoneed707b2009-07-24 23:12:02 +00001771 ConstantInt *Fold = ConstantInt::get(getContext(),
1772 LHSC->getValue()->getValue() *
Nick Lewycky3e630762008-02-20 06:48:22 +00001773 RHSC->getValue()->getValue());
1774 Ops[0] = getConstant(Fold);
1775 Ops.erase(Ops.begin()+1); // Erase the folded element
1776 if (Ops.size() == 1) return Ops[0];
1777 LHSC = cast<SCEVConstant>(Ops[0]);
Chris Lattner53e677a2004-04-02 20:23:17 +00001778 }
1779
1780 // If we are left with a constant one being multiplied, strip it off.
1781 if (cast<SCEVConstant>(Ops[0])->getValue()->equalsInt(1)) {
1782 Ops.erase(Ops.begin());
1783 --Idx;
Reid Spencercae57542007-03-02 00:28:52 +00001784 } else if (cast<SCEVConstant>(Ops[0])->getValue()->isZero()) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001785 // If we have a multiply of zero, it will always be zero.
1786 return Ops[0];
Dan Gohmana10756e2010-01-21 02:09:26 +00001787 } else if (Ops[0]->isAllOnesValue()) {
1788 // If we have a mul by -1 of an add, try distributing the -1 among the
1789 // add operands.
1790 if (Ops.size() == 2)
1791 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1])) {
1792 SmallVector<const SCEV *, 4> NewOps;
1793 bool AnyFolded = false;
1794 for (SCEVAddRecExpr::op_iterator I = Add->op_begin(), E = Add->op_end();
1795 I != E; ++I) {
1796 const SCEV *Mul = getMulExpr(Ops[0], *I);
1797 if (!isa<SCEVMulExpr>(Mul)) AnyFolded = true;
1798 NewOps.push_back(Mul);
1799 }
1800 if (AnyFolded)
1801 return getAddExpr(NewOps);
1802 }
Chris Lattner53e677a2004-04-02 20:23:17 +00001803 }
Dan Gohman3ab13122010-04-13 16:49:23 +00001804
1805 if (Ops.size() == 1)
1806 return Ops[0];
Chris Lattner53e677a2004-04-02 20:23:17 +00001807 }
1808
1809 // Skip over the add expression until we get to a multiply.
1810 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr)
1811 ++Idx;
1812
Chris Lattner53e677a2004-04-02 20:23:17 +00001813 // If there are mul operands inline them all into this expression.
1814 if (Idx < Ops.size()) {
1815 bool DeletedMul = false;
Dan Gohman622ed672009-05-04 22:02:23 +00001816 while (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[Idx])) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001817 // If we have an mul, expand the mul operands onto the end of the operands
1818 // list.
Chris Lattner53e677a2004-04-02 20:23:17 +00001819 Ops.erase(Ops.begin()+Idx);
Dan Gohman403a8cd2010-06-21 19:47:52 +00001820 Ops.append(Mul->op_begin(), Mul->op_end());
Chris Lattner53e677a2004-04-02 20:23:17 +00001821 DeletedMul = true;
1822 }
1823
1824 // If we deleted at least one mul, we added operands to the end of the list,
1825 // and they are not necessarily sorted. Recurse to resort and resimplify
Dan Gohman3f46a3a2010-03-01 17:49:51 +00001826 // any operands we just acquired.
Chris Lattner53e677a2004-04-02 20:23:17 +00001827 if (DeletedMul)
Dan Gohman246b2562007-10-22 18:31:58 +00001828 return getMulExpr(Ops);
Chris Lattner53e677a2004-04-02 20:23:17 +00001829 }
1830
1831 // If there are any add recurrences in the operands list, see if any other
1832 // added values are loop invariant. If so, we can fold them into the
1833 // recurrence.
1834 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr)
1835 ++Idx;
1836
1837 // Scan over all recurrences, trying to fold loop invariants into them.
1838 for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) {
1839 // Scan all of the other operands to this mul and add them to the vector if
1840 // they are loop invariant w.r.t. the recurrence.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001841 SmallVector<const SCEV *, 8> LIOps;
Dan Gohman35738ac2009-05-04 22:30:44 +00001842 const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]);
Chris Lattner53e677a2004-04-02 20:23:17 +00001843 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
1844 if (Ops[i]->isLoopInvariant(AddRec->getLoop())) {
1845 LIOps.push_back(Ops[i]);
1846 Ops.erase(Ops.begin()+i);
1847 --i; --e;
1848 }
1849
1850 // If we found some loop invariants, fold them into the recurrence.
1851 if (!LIOps.empty()) {
Dan Gohman8dae1382008-09-14 17:21:12 +00001852 // NLI * LI * {Start,+,Step} --> NLI * {LI*Start,+,LI*Step}
Dan Gohman0bba49c2009-07-07 17:06:11 +00001853 SmallVector<const SCEV *, 4> NewOps;
Chris Lattner53e677a2004-04-02 20:23:17 +00001854 NewOps.reserve(AddRec->getNumOperands());
Dan Gohman27ed6a42010-06-17 23:34:09 +00001855 const SCEV *Scale = getMulExpr(LIOps);
1856 for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i)
1857 NewOps.push_back(getMulExpr(Scale, AddRec->getOperand(i)));
Chris Lattner53e677a2004-04-02 20:23:17 +00001858
Dan Gohmanb9f96512010-06-30 07:16:37 +00001859 // Build the new addrec. Propagate the NUW and NSW flags if both the
1860 // outer mul and the inner addrec are guaranteed to have no overflow.
Dan Gohmana10756e2010-01-21 02:09:26 +00001861 const SCEV *NewRec = getAddRecExpr(NewOps, AddRec->getLoop(),
1862 HasNUW && AddRec->hasNoUnsignedWrap(),
Dan Gohmanb9f96512010-06-30 07:16:37 +00001863 HasNSW && AddRec->hasNoSignedWrap());
Chris Lattner53e677a2004-04-02 20:23:17 +00001864
1865 // If all of the other operands were loop invariant, we are done.
1866 if (Ops.size() == 1) return NewRec;
1867
1868 // Otherwise, multiply the folded AddRec by the non-liv parts.
1869 for (unsigned i = 0;; ++i)
1870 if (Ops[i] == AddRec) {
1871 Ops[i] = NewRec;
1872 break;
1873 }
Dan Gohman246b2562007-10-22 18:31:58 +00001874 return getMulExpr(Ops);
Chris Lattner53e677a2004-04-02 20:23:17 +00001875 }
1876
1877 // Okay, if there weren't any loop invariants to be folded, check to see if
1878 // there are multiple AddRec's with the same loop induction variable being
1879 // multiplied together. If so, we can fold them.
1880 for (unsigned OtherIdx = Idx+1;
1881 OtherIdx < Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);++OtherIdx)
1882 if (OtherIdx != Idx) {
Dan Gohman35738ac2009-05-04 22:30:44 +00001883 const SCEVAddRecExpr *OtherAddRec = cast<SCEVAddRecExpr>(Ops[OtherIdx]);
Chris Lattner53e677a2004-04-02 20:23:17 +00001884 if (AddRec->getLoop() == OtherAddRec->getLoop()) {
1885 // F * G --> {A,+,B} * {C,+,D} --> {A*C,+,F*D + G*B + B*D}
Dan Gohman35738ac2009-05-04 22:30:44 +00001886 const SCEVAddRecExpr *F = AddRec, *G = OtherAddRec;
Dan Gohman0c5e95d2010-08-16 16:34:09 +00001887 const SCEV *NewStart = getMulExpr(F->getStart(), G->getStart());
Dan Gohman0bba49c2009-07-07 17:06:11 +00001888 const SCEV *B = F->getStepRecurrence(*this);
1889 const SCEV *D = G->getStepRecurrence(*this);
1890 const SCEV *NewStep = getAddExpr(getMulExpr(F, D),
Dan Gohman0c5e95d2010-08-16 16:34:09 +00001891 getMulExpr(G, B),
1892 getMulExpr(B, D));
Dan Gohman0bba49c2009-07-07 17:06:11 +00001893 const SCEV *NewAddRec = getAddRecExpr(NewStart, NewStep,
Dan Gohman0c5e95d2010-08-16 16:34:09 +00001894 F->getLoop());
Chris Lattner53e677a2004-04-02 20:23:17 +00001895 if (Ops.size() == 2) return NewAddRec;
1896
1897 Ops.erase(Ops.begin()+Idx);
1898 Ops.erase(Ops.begin()+OtherIdx-1);
1899 Ops.push_back(NewAddRec);
Dan Gohman246b2562007-10-22 18:31:58 +00001900 return getMulExpr(Ops);
Chris Lattner53e677a2004-04-02 20:23:17 +00001901 }
1902 }
1903
1904 // Otherwise couldn't fold anything into this recurrence. Move onto the
1905 // next one.
1906 }
1907
1908 // Okay, it looks like we really DO need an mul expr. Check to see if we
1909 // already have one, otherwise create a new one.
Dan Gohman1c343752009-06-27 21:21:31 +00001910 FoldingSetNodeID ID;
1911 ID.AddInteger(scMulExpr);
1912 ID.AddInteger(Ops.size());
1913 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
1914 ID.AddPointer(Ops[i]);
1915 void *IP = 0;
Dan Gohmana10756e2010-01-21 02:09:26 +00001916 SCEVMulExpr *S =
1917 static_cast<SCEVMulExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
1918 if (!S) {
Dan Gohmanf9e64722010-03-18 01:17:13 +00001919 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
1920 std::uninitialized_copy(Ops.begin(), Ops.end(), O);
Dan Gohman95531882010-03-18 18:49:47 +00001921 S = new (SCEVAllocator) SCEVMulExpr(ID.Intern(SCEVAllocator),
1922 O, Ops.size());
Dan Gohmana10756e2010-01-21 02:09:26 +00001923 UniqueSCEVs.InsertNode(S, IP);
1924 }
Dan Gohman3645b012009-10-09 00:10:36 +00001925 if (HasNUW) S->setHasNoUnsignedWrap(true);
1926 if (HasNSW) S->setHasNoSignedWrap(true);
Dan Gohman1c343752009-06-27 21:21:31 +00001927 return S;
Chris Lattner53e677a2004-04-02 20:23:17 +00001928}
1929
Andreas Bolka8a11c982009-08-07 22:55:26 +00001930/// getUDivExpr - Get a canonical unsigned division expression, or something
1931/// simpler if possible.
Dan Gohman9311ef62009-06-24 14:49:00 +00001932const SCEV *ScalarEvolution::getUDivExpr(const SCEV *LHS,
1933 const SCEV *RHS) {
Dan Gohmanf78a9782009-05-18 15:44:58 +00001934 assert(getEffectiveSCEVType(LHS->getType()) ==
1935 getEffectiveSCEVType(RHS->getType()) &&
1936 "SCEVUDivExpr operand types don't match!");
1937
Dan Gohman622ed672009-05-04 22:02:23 +00001938 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001939 if (RHSC->getValue()->equalsInt(1))
Dan Gohman4c0d5d52009-08-20 16:42:55 +00001940 return LHS; // X udiv 1 --> x
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00001941 // If the denominator is zero, the result of the udiv is undefined. Don't
1942 // try to analyze it, because the resolution chosen here may differ from
1943 // the resolution chosen in other parts of the compiler.
1944 if (!RHSC->getValue()->isZero()) {
1945 // Determine if the division can be folded into the operands of
1946 // its operands.
1947 // TODO: Generalize this to non-constants by using known-bits information.
1948 const Type *Ty = LHS->getType();
1949 unsigned LZ = RHSC->getValue()->getValue().countLeadingZeros();
Dan Gohmanddd3a882010-08-04 19:52:50 +00001950 unsigned MaxShiftAmt = getTypeSizeInBits(Ty) - LZ - 1;
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00001951 // For non-power-of-two values, effectively round the value up to the
1952 // nearest power of two.
1953 if (!RHSC->getValue()->getValue().isPowerOf2())
1954 ++MaxShiftAmt;
1955 const IntegerType *ExtTy =
1956 IntegerType::get(getContext(), getTypeSizeInBits(Ty) + MaxShiftAmt);
1957 // {X,+,N}/C --> {X/C,+,N/C} if safe and N/C can be folded.
1958 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(LHS))
1959 if (const SCEVConstant *Step =
1960 dyn_cast<SCEVConstant>(AR->getStepRecurrence(*this)))
1961 if (!Step->getValue()->getValue()
1962 .urem(RHSC->getValue()->getValue()) &&
1963 getZeroExtendExpr(AR, ExtTy) ==
1964 getAddRecExpr(getZeroExtendExpr(AR->getStart(), ExtTy),
1965 getZeroExtendExpr(Step, ExtTy),
1966 AR->getLoop())) {
1967 SmallVector<const SCEV *, 4> Operands;
1968 for (unsigned i = 0, e = AR->getNumOperands(); i != e; ++i)
1969 Operands.push_back(getUDivExpr(AR->getOperand(i), RHS));
1970 return getAddRecExpr(Operands, AR->getLoop());
Dan Gohman185cf032009-05-08 20:18:49 +00001971 }
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00001972 // (A*B)/C --> A*(B/C) if safe and B/C can be folded.
1973 if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(LHS)) {
1974 SmallVector<const SCEV *, 4> Operands;
1975 for (unsigned i = 0, e = M->getNumOperands(); i != e; ++i)
1976 Operands.push_back(getZeroExtendExpr(M->getOperand(i), ExtTy));
1977 if (getZeroExtendExpr(M, ExtTy) == getMulExpr(Operands))
1978 // Find an operand that's safely divisible.
1979 for (unsigned i = 0, e = M->getNumOperands(); i != e; ++i) {
1980 const SCEV *Op = M->getOperand(i);
1981 const SCEV *Div = getUDivExpr(Op, RHSC);
1982 if (!isa<SCEVUDivExpr>(Div) && getMulExpr(Div, RHSC) == Op) {
1983 Operands = SmallVector<const SCEV *, 4>(M->op_begin(),
1984 M->op_end());
1985 Operands[i] = Div;
1986 return getMulExpr(Operands);
1987 }
1988 }
Dan Gohman185cf032009-05-08 20:18:49 +00001989 }
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00001990 // (A+B)/C --> (A/C + B/C) if safe and A/C and B/C can be folded.
1991 if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(LHS)) {
1992 SmallVector<const SCEV *, 4> Operands;
1993 for (unsigned i = 0, e = A->getNumOperands(); i != e; ++i)
1994 Operands.push_back(getZeroExtendExpr(A->getOperand(i), ExtTy));
1995 if (getZeroExtendExpr(A, ExtTy) == getAddExpr(Operands)) {
1996 Operands.clear();
1997 for (unsigned i = 0, e = A->getNumOperands(); i != e; ++i) {
1998 const SCEV *Op = getUDivExpr(A->getOperand(i), RHS);
1999 if (isa<SCEVUDivExpr>(Op) ||
2000 getMulExpr(Op, RHS) != A->getOperand(i))
2001 break;
2002 Operands.push_back(Op);
2003 }
2004 if (Operands.size() == A->getNumOperands())
2005 return getAddExpr(Operands);
2006 }
2007 }
Dan Gohman185cf032009-05-08 20:18:49 +00002008
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00002009 // Fold if both operands are constant.
2010 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
2011 Constant *LHSCV = LHSC->getValue();
2012 Constant *RHSCV = RHSC->getValue();
2013 return getConstant(cast<ConstantInt>(ConstantExpr::getUDiv(LHSCV,
2014 RHSCV)));
2015 }
Chris Lattner53e677a2004-04-02 20:23:17 +00002016 }
2017 }
2018
Dan Gohman1c343752009-06-27 21:21:31 +00002019 FoldingSetNodeID ID;
2020 ID.AddInteger(scUDivExpr);
2021 ID.AddPointer(LHS);
2022 ID.AddPointer(RHS);
2023 void *IP = 0;
2024 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
Dan Gohman95531882010-03-18 18:49:47 +00002025 SCEV *S = new (SCEVAllocator) SCEVUDivExpr(ID.Intern(SCEVAllocator),
2026 LHS, RHS);
Dan Gohman1c343752009-06-27 21:21:31 +00002027 UniqueSCEVs.InsertNode(S, IP);
2028 return S;
Chris Lattner53e677a2004-04-02 20:23:17 +00002029}
2030
2031
Dan Gohman6c0866c2009-05-24 23:45:28 +00002032/// getAddRecExpr - Get an add recurrence expression for the specified loop.
2033/// Simplify the expression as much as possible.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002034const SCEV *ScalarEvolution::getAddRecExpr(const SCEV *Start,
Dan Gohman3645b012009-10-09 00:10:36 +00002035 const SCEV *Step, const Loop *L,
2036 bool HasNUW, bool HasNSW) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00002037 SmallVector<const SCEV *, 4> Operands;
Chris Lattner53e677a2004-04-02 20:23:17 +00002038 Operands.push_back(Start);
Dan Gohman622ed672009-05-04 22:02:23 +00002039 if (const SCEVAddRecExpr *StepChrec = dyn_cast<SCEVAddRecExpr>(Step))
Chris Lattner53e677a2004-04-02 20:23:17 +00002040 if (StepChrec->getLoop() == L) {
Dan Gohman403a8cd2010-06-21 19:47:52 +00002041 Operands.append(StepChrec->op_begin(), StepChrec->op_end());
Dan Gohman246b2562007-10-22 18:31:58 +00002042 return getAddRecExpr(Operands, L);
Chris Lattner53e677a2004-04-02 20:23:17 +00002043 }
2044
2045 Operands.push_back(Step);
Dan Gohman3645b012009-10-09 00:10:36 +00002046 return getAddRecExpr(Operands, L, HasNUW, HasNSW);
Chris Lattner53e677a2004-04-02 20:23:17 +00002047}
2048
Dan Gohman6c0866c2009-05-24 23:45:28 +00002049/// getAddRecExpr - Get an add recurrence expression for the specified loop.
2050/// Simplify the expression as much as possible.
Dan Gohman64a845e2009-06-24 04:48:43 +00002051const SCEV *
Dan Gohman0bba49c2009-07-07 17:06:11 +00002052ScalarEvolution::getAddRecExpr(SmallVectorImpl<const SCEV *> &Operands,
Dan Gohman3645b012009-10-09 00:10:36 +00002053 const Loop *L,
2054 bool HasNUW, bool HasNSW) {
Chris Lattner53e677a2004-04-02 20:23:17 +00002055 if (Operands.size() == 1) return Operands[0];
Dan Gohmanf78a9782009-05-18 15:44:58 +00002056#ifndef NDEBUG
Dan Gohmanc4f77982010-08-16 16:13:54 +00002057 const Type *ETy = getEffectiveSCEVType(Operands[0]->getType());
Dan Gohmanf78a9782009-05-18 15:44:58 +00002058 for (unsigned i = 1, e = Operands.size(); i != e; ++i)
Dan Gohmanc4f77982010-08-16 16:13:54 +00002059 assert(getEffectiveSCEVType(Operands[i]->getType()) == ETy &&
Dan Gohmanf78a9782009-05-18 15:44:58 +00002060 "SCEVAddRecExpr operand types don't match!");
2061#endif
Chris Lattner53e677a2004-04-02 20:23:17 +00002062
Dan Gohmancfeb6a42008-06-18 16:23:07 +00002063 if (Operands.back()->isZero()) {
2064 Operands.pop_back();
Dan Gohman3645b012009-10-09 00:10:36 +00002065 return getAddRecExpr(Operands, L, HasNUW, HasNSW); // {X,+,0} --> X
Dan Gohmancfeb6a42008-06-18 16:23:07 +00002066 }
Chris Lattner53e677a2004-04-02 20:23:17 +00002067
Dan Gohmanbc028532010-02-19 18:49:22 +00002068 // It's tempting to want to call getMaxBackedgeTakenCount count here and
2069 // use that information to infer NUW and NSW flags. However, computing a
2070 // BE count requires calling getAddRecExpr, so we may not yet have a
2071 // meaningful BE count at this point (and if we don't, we'd be stuck
2072 // with a SCEVCouldNotCompute as the cached BE count).
2073
Dan Gohmana10756e2010-01-21 02:09:26 +00002074 // If HasNSW is true and all the operands are non-negative, infer HasNUW.
2075 if (!HasNUW && HasNSW) {
2076 bool All = true;
Dan Gohman2d16fc52010-08-16 16:27:53 +00002077 for (SmallVectorImpl<const SCEV *>::const_iterator I = Operands.begin(),
2078 E = Operands.end(); I != E; ++I)
2079 if (!isKnownNonNegative(*I)) {
Dan Gohmana10756e2010-01-21 02:09:26 +00002080 All = false;
2081 break;
2082 }
2083 if (All) HasNUW = true;
2084 }
2085
Dan Gohmand9cc7492008-08-08 18:33:12 +00002086 // Canonicalize nested AddRecs in by nesting them in order of loop depth.
Dan Gohman622ed672009-05-04 22:02:23 +00002087 if (const SCEVAddRecExpr *NestedAR = dyn_cast<SCEVAddRecExpr>(Operands[0])) {
Dan Gohman5d984912009-12-18 01:14:11 +00002088 const Loop *NestedLoop = NestedAR->getLoop();
Dan Gohman9cba9782010-08-13 20:23:25 +00002089 if (L->contains(NestedLoop) ?
Dan Gohmana10756e2010-01-21 02:09:26 +00002090 (L->getLoopDepth() < NestedLoop->getLoopDepth()) :
Dan Gohman9cba9782010-08-13 20:23:25 +00002091 (!NestedLoop->contains(L) &&
Dan Gohmana10756e2010-01-21 02:09:26 +00002092 DT->dominates(L->getHeader(), NestedLoop->getHeader()))) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00002093 SmallVector<const SCEV *, 4> NestedOperands(NestedAR->op_begin(),
Dan Gohman5d984912009-12-18 01:14:11 +00002094 NestedAR->op_end());
Dan Gohmand9cc7492008-08-08 18:33:12 +00002095 Operands[0] = NestedAR->getStart();
Dan Gohman9a80b452009-06-26 22:36:20 +00002096 // AddRecs require their operands be loop-invariant with respect to their
2097 // loops. Don't perform this transformation if it would break this
2098 // requirement.
2099 bool AllInvariant = true;
2100 for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2101 if (!Operands[i]->isLoopInvariant(L)) {
2102 AllInvariant = false;
2103 break;
2104 }
2105 if (AllInvariant) {
2106 NestedOperands[0] = getAddRecExpr(Operands, L);
2107 AllInvariant = true;
2108 for (unsigned i = 0, e = NestedOperands.size(); i != e; ++i)
2109 if (!NestedOperands[i]->isLoopInvariant(NestedLoop)) {
2110 AllInvariant = false;
2111 break;
2112 }
2113 if (AllInvariant)
2114 // Ok, both add recurrences are valid after the transformation.
Dan Gohman3645b012009-10-09 00:10:36 +00002115 return getAddRecExpr(NestedOperands, NestedLoop, HasNUW, HasNSW);
Dan Gohman9a80b452009-06-26 22:36:20 +00002116 }
2117 // Reset Operands to its original state.
2118 Operands[0] = NestedAR;
Dan Gohmand9cc7492008-08-08 18:33:12 +00002119 }
2120 }
2121
Dan Gohman67847532010-01-19 22:27:22 +00002122 // Okay, it looks like we really DO need an addrec expr. Check to see if we
2123 // already have one, otherwise create a new one.
Dan Gohman1c343752009-06-27 21:21:31 +00002124 FoldingSetNodeID ID;
2125 ID.AddInteger(scAddRecExpr);
2126 ID.AddInteger(Operands.size());
2127 for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2128 ID.AddPointer(Operands[i]);
2129 ID.AddPointer(L);
2130 void *IP = 0;
Dan Gohmana10756e2010-01-21 02:09:26 +00002131 SCEVAddRecExpr *S =
2132 static_cast<SCEVAddRecExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
2133 if (!S) {
Dan Gohmanf9e64722010-03-18 01:17:13 +00002134 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Operands.size());
2135 std::uninitialized_copy(Operands.begin(), Operands.end(), O);
Dan Gohman95531882010-03-18 18:49:47 +00002136 S = new (SCEVAllocator) SCEVAddRecExpr(ID.Intern(SCEVAllocator),
2137 O, Operands.size(), L);
Dan Gohmana10756e2010-01-21 02:09:26 +00002138 UniqueSCEVs.InsertNode(S, IP);
2139 }
Dan Gohman3645b012009-10-09 00:10:36 +00002140 if (HasNUW) S->setHasNoUnsignedWrap(true);
2141 if (HasNSW) S->setHasNoSignedWrap(true);
Dan Gohman1c343752009-06-27 21:21:31 +00002142 return S;
Chris Lattner53e677a2004-04-02 20:23:17 +00002143}
2144
Dan Gohman9311ef62009-06-24 14:49:00 +00002145const SCEV *ScalarEvolution::getSMaxExpr(const SCEV *LHS,
2146 const SCEV *RHS) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00002147 SmallVector<const SCEV *, 2> Ops;
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002148 Ops.push_back(LHS);
2149 Ops.push_back(RHS);
2150 return getSMaxExpr(Ops);
2151}
2152
Dan Gohman0bba49c2009-07-07 17:06:11 +00002153const SCEV *
2154ScalarEvolution::getSMaxExpr(SmallVectorImpl<const SCEV *> &Ops) {
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002155 assert(!Ops.empty() && "Cannot get empty smax!");
2156 if (Ops.size() == 1) return Ops[0];
Dan Gohmanf78a9782009-05-18 15:44:58 +00002157#ifndef NDEBUG
Dan Gohmanc4f77982010-08-16 16:13:54 +00002158 const Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
Dan Gohmanf78a9782009-05-18 15:44:58 +00002159 for (unsigned i = 1, e = Ops.size(); i != e; ++i)
Dan Gohmanc4f77982010-08-16 16:13:54 +00002160 assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
Dan Gohmanf78a9782009-05-18 15:44:58 +00002161 "SCEVSMaxExpr operand types don't match!");
2162#endif
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002163
2164 // Sort by complexity, this groups all similar expression types together.
Dan Gohman72861302009-05-07 14:39:04 +00002165 GroupByComplexity(Ops, LI);
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002166
2167 // If there are any constants, fold them together.
2168 unsigned Idx = 0;
Dan Gohman622ed672009-05-04 22:02:23 +00002169 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002170 ++Idx;
2171 assert(Idx < Ops.size());
Dan Gohman622ed672009-05-04 22:02:23 +00002172 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002173 // We found two constants, fold them together!
Owen Andersoneed707b2009-07-24 23:12:02 +00002174 ConstantInt *Fold = ConstantInt::get(getContext(),
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002175 APIntOps::smax(LHSC->getValue()->getValue(),
2176 RHSC->getValue()->getValue()));
Nick Lewycky3e630762008-02-20 06:48:22 +00002177 Ops[0] = getConstant(Fold);
2178 Ops.erase(Ops.begin()+1); // Erase the folded element
2179 if (Ops.size() == 1) return Ops[0];
2180 LHSC = cast<SCEVConstant>(Ops[0]);
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002181 }
2182
Dan Gohmane5aceed2009-06-24 14:46:22 +00002183 // If we are left with a constant minimum-int, strip it off.
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002184 if (cast<SCEVConstant>(Ops[0])->getValue()->isMinValue(true)) {
2185 Ops.erase(Ops.begin());
2186 --Idx;
Dan Gohmane5aceed2009-06-24 14:46:22 +00002187 } else if (cast<SCEVConstant>(Ops[0])->getValue()->isMaxValue(true)) {
2188 // If we have an smax with a constant maximum-int, it will always be
2189 // maximum-int.
2190 return Ops[0];
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002191 }
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002192
Dan Gohman3ab13122010-04-13 16:49:23 +00002193 if (Ops.size() == 1) return Ops[0];
2194 }
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002195
2196 // Find the first SMax
2197 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scSMaxExpr)
2198 ++Idx;
2199
2200 // Check to see if one of the operands is an SMax. If so, expand its operands
2201 // onto our operand list, and recurse to simplify.
2202 if (Idx < Ops.size()) {
2203 bool DeletedSMax = false;
Dan Gohman622ed672009-05-04 22:02:23 +00002204 while (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(Ops[Idx])) {
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002205 Ops.erase(Ops.begin()+Idx);
Dan Gohman403a8cd2010-06-21 19:47:52 +00002206 Ops.append(SMax->op_begin(), SMax->op_end());
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002207 DeletedSMax = true;
2208 }
2209
2210 if (DeletedSMax)
2211 return getSMaxExpr(Ops);
2212 }
2213
2214 // Okay, check to see if the same value occurs in the operand list twice. If
2215 // so, delete one. Since we sorted the list, these values are required to
2216 // be adjacent.
2217 for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
Dan Gohman28287792010-04-13 16:51:03 +00002218 // X smax Y smax Y --> X smax Y
2219 // X smax Y --> X, if X is always greater than Y
2220 if (Ops[i] == Ops[i+1] ||
2221 isKnownPredicate(ICmpInst::ICMP_SGE, Ops[i], Ops[i+1])) {
2222 Ops.erase(Ops.begin()+i+1, Ops.begin()+i+2);
2223 --i; --e;
2224 } else if (isKnownPredicate(ICmpInst::ICMP_SLE, Ops[i], Ops[i+1])) {
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002225 Ops.erase(Ops.begin()+i, Ops.begin()+i+1);
2226 --i; --e;
2227 }
2228
2229 if (Ops.size() == 1) return Ops[0];
2230
2231 assert(!Ops.empty() && "Reduced smax down to nothing!");
2232
Nick Lewycky3e630762008-02-20 06:48:22 +00002233 // Okay, it looks like we really DO need an smax expr. Check to see if we
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002234 // already have one, otherwise create a new one.
Dan Gohman1c343752009-06-27 21:21:31 +00002235 FoldingSetNodeID ID;
2236 ID.AddInteger(scSMaxExpr);
2237 ID.AddInteger(Ops.size());
2238 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2239 ID.AddPointer(Ops[i]);
2240 void *IP = 0;
2241 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
Dan Gohmanf9e64722010-03-18 01:17:13 +00002242 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
2243 std::uninitialized_copy(Ops.begin(), Ops.end(), O);
Dan Gohman95531882010-03-18 18:49:47 +00002244 SCEV *S = new (SCEVAllocator) SCEVSMaxExpr(ID.Intern(SCEVAllocator),
2245 O, Ops.size());
Dan Gohman1c343752009-06-27 21:21:31 +00002246 UniqueSCEVs.InsertNode(S, IP);
2247 return S;
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002248}
2249
Dan Gohman9311ef62009-06-24 14:49:00 +00002250const SCEV *ScalarEvolution::getUMaxExpr(const SCEV *LHS,
2251 const SCEV *RHS) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00002252 SmallVector<const SCEV *, 2> Ops;
Nick Lewycky3e630762008-02-20 06:48:22 +00002253 Ops.push_back(LHS);
2254 Ops.push_back(RHS);
2255 return getUMaxExpr(Ops);
2256}
2257
Dan Gohman0bba49c2009-07-07 17:06:11 +00002258const SCEV *
2259ScalarEvolution::getUMaxExpr(SmallVectorImpl<const SCEV *> &Ops) {
Nick Lewycky3e630762008-02-20 06:48:22 +00002260 assert(!Ops.empty() && "Cannot get empty umax!");
2261 if (Ops.size() == 1) return Ops[0];
Dan Gohmanf78a9782009-05-18 15:44:58 +00002262#ifndef NDEBUG
Dan Gohmanc4f77982010-08-16 16:13:54 +00002263 const Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
Dan Gohmanf78a9782009-05-18 15:44:58 +00002264 for (unsigned i = 1, e = Ops.size(); i != e; ++i)
Dan Gohmanc4f77982010-08-16 16:13:54 +00002265 assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
Dan Gohmanf78a9782009-05-18 15:44:58 +00002266 "SCEVUMaxExpr operand types don't match!");
2267#endif
Nick Lewycky3e630762008-02-20 06:48:22 +00002268
2269 // Sort by complexity, this groups all similar expression types together.
Dan Gohman72861302009-05-07 14:39:04 +00002270 GroupByComplexity(Ops, LI);
Nick Lewycky3e630762008-02-20 06:48:22 +00002271
2272 // If there are any constants, fold them together.
2273 unsigned Idx = 0;
Dan Gohman622ed672009-05-04 22:02:23 +00002274 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
Nick Lewycky3e630762008-02-20 06:48:22 +00002275 ++Idx;
2276 assert(Idx < Ops.size());
Dan Gohman622ed672009-05-04 22:02:23 +00002277 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
Nick Lewycky3e630762008-02-20 06:48:22 +00002278 // We found two constants, fold them together!
Owen Andersoneed707b2009-07-24 23:12:02 +00002279 ConstantInt *Fold = ConstantInt::get(getContext(),
Nick Lewycky3e630762008-02-20 06:48:22 +00002280 APIntOps::umax(LHSC->getValue()->getValue(),
2281 RHSC->getValue()->getValue()));
2282 Ops[0] = getConstant(Fold);
2283 Ops.erase(Ops.begin()+1); // Erase the folded element
2284 if (Ops.size() == 1) return Ops[0];
2285 LHSC = cast<SCEVConstant>(Ops[0]);
2286 }
2287
Dan Gohmane5aceed2009-06-24 14:46:22 +00002288 // If we are left with a constant minimum-int, strip it off.
Nick Lewycky3e630762008-02-20 06:48:22 +00002289 if (cast<SCEVConstant>(Ops[0])->getValue()->isMinValue(false)) {
2290 Ops.erase(Ops.begin());
2291 --Idx;
Dan Gohmane5aceed2009-06-24 14:46:22 +00002292 } else if (cast<SCEVConstant>(Ops[0])->getValue()->isMaxValue(false)) {
2293 // If we have an umax with a constant maximum-int, it will always be
2294 // maximum-int.
2295 return Ops[0];
Nick Lewycky3e630762008-02-20 06:48:22 +00002296 }
Nick Lewycky3e630762008-02-20 06:48:22 +00002297
Dan Gohman3ab13122010-04-13 16:49:23 +00002298 if (Ops.size() == 1) return Ops[0];
2299 }
Nick Lewycky3e630762008-02-20 06:48:22 +00002300
2301 // Find the first UMax
2302 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scUMaxExpr)
2303 ++Idx;
2304
2305 // Check to see if one of the operands is a UMax. If so, expand its operands
2306 // onto our operand list, and recurse to simplify.
2307 if (Idx < Ops.size()) {
2308 bool DeletedUMax = false;
Dan Gohman622ed672009-05-04 22:02:23 +00002309 while (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(Ops[Idx])) {
Nick Lewycky3e630762008-02-20 06:48:22 +00002310 Ops.erase(Ops.begin()+Idx);
Dan Gohman403a8cd2010-06-21 19:47:52 +00002311 Ops.append(UMax->op_begin(), UMax->op_end());
Nick Lewycky3e630762008-02-20 06:48:22 +00002312 DeletedUMax = true;
2313 }
2314
2315 if (DeletedUMax)
2316 return getUMaxExpr(Ops);
2317 }
2318
2319 // Okay, check to see if the same value occurs in the operand list twice. If
2320 // so, delete one. Since we sorted the list, these values are required to
2321 // be adjacent.
2322 for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
Dan Gohman28287792010-04-13 16:51:03 +00002323 // X umax Y umax Y --> X umax Y
2324 // X umax Y --> X, if X is always greater than Y
2325 if (Ops[i] == Ops[i+1] ||
2326 isKnownPredicate(ICmpInst::ICMP_UGE, Ops[i], Ops[i+1])) {
2327 Ops.erase(Ops.begin()+i+1, Ops.begin()+i+2);
2328 --i; --e;
2329 } else if (isKnownPredicate(ICmpInst::ICMP_ULE, Ops[i], Ops[i+1])) {
Nick Lewycky3e630762008-02-20 06:48:22 +00002330 Ops.erase(Ops.begin()+i, Ops.begin()+i+1);
2331 --i; --e;
2332 }
2333
2334 if (Ops.size() == 1) return Ops[0];
2335
2336 assert(!Ops.empty() && "Reduced umax down to nothing!");
2337
2338 // Okay, it looks like we really DO need a umax expr. Check to see if we
2339 // already have one, otherwise create a new one.
Dan Gohman1c343752009-06-27 21:21:31 +00002340 FoldingSetNodeID ID;
2341 ID.AddInteger(scUMaxExpr);
2342 ID.AddInteger(Ops.size());
2343 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2344 ID.AddPointer(Ops[i]);
2345 void *IP = 0;
2346 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
Dan Gohmanf9e64722010-03-18 01:17:13 +00002347 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
2348 std::uninitialized_copy(Ops.begin(), Ops.end(), O);
Dan Gohman95531882010-03-18 18:49:47 +00002349 SCEV *S = new (SCEVAllocator) SCEVUMaxExpr(ID.Intern(SCEVAllocator),
2350 O, Ops.size());
Dan Gohman1c343752009-06-27 21:21:31 +00002351 UniqueSCEVs.InsertNode(S, IP);
2352 return S;
Nick Lewycky3e630762008-02-20 06:48:22 +00002353}
2354
Dan Gohman9311ef62009-06-24 14:49:00 +00002355const SCEV *ScalarEvolution::getSMinExpr(const SCEV *LHS,
2356 const SCEV *RHS) {
Dan Gohmanf9a9a992009-06-22 03:18:45 +00002357 // ~smax(~x, ~y) == smin(x, y).
2358 return getNotSCEV(getSMaxExpr(getNotSCEV(LHS), getNotSCEV(RHS)));
2359}
2360
Dan Gohman9311ef62009-06-24 14:49:00 +00002361const SCEV *ScalarEvolution::getUMinExpr(const SCEV *LHS,
2362 const SCEV *RHS) {
Dan Gohmanf9a9a992009-06-22 03:18:45 +00002363 // ~umax(~x, ~y) == umin(x, y)
2364 return getNotSCEV(getUMaxExpr(getNotSCEV(LHS), getNotSCEV(RHS)));
2365}
2366
Dan Gohman4f8eea82010-02-01 18:27:38 +00002367const SCEV *ScalarEvolution::getSizeOfExpr(const Type *AllocTy) {
Dan Gohman6ab10f62010-04-12 23:03:26 +00002368 // If we have TargetData, we can bypass creating a target-independent
2369 // constant expression and then folding it back into a ConstantInt.
2370 // This is just a compile-time optimization.
2371 if (TD)
2372 return getConstant(TD->getIntPtrType(getContext()),
2373 TD->getTypeAllocSize(AllocTy));
2374
Dan Gohman4f8eea82010-02-01 18:27:38 +00002375 Constant *C = ConstantExpr::getSizeOf(AllocTy);
2376 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
Dan Gohman70001222010-05-28 16:12:08 +00002377 if (Constant *Folded = ConstantFoldConstantExpression(CE, TD))
2378 C = Folded;
Dan Gohman4f8eea82010-02-01 18:27:38 +00002379 const Type *Ty = getEffectiveSCEVType(PointerType::getUnqual(AllocTy));
2380 return getTruncateOrZeroExtend(getSCEV(C), Ty);
2381}
2382
2383const SCEV *ScalarEvolution::getAlignOfExpr(const Type *AllocTy) {
2384 Constant *C = ConstantExpr::getAlignOf(AllocTy);
2385 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
Dan Gohman70001222010-05-28 16:12:08 +00002386 if (Constant *Folded = ConstantFoldConstantExpression(CE, TD))
2387 C = Folded;
Dan Gohman4f8eea82010-02-01 18:27:38 +00002388 const Type *Ty = getEffectiveSCEVType(PointerType::getUnqual(AllocTy));
2389 return getTruncateOrZeroExtend(getSCEV(C), Ty);
2390}
2391
2392const SCEV *ScalarEvolution::getOffsetOfExpr(const StructType *STy,
2393 unsigned FieldNo) {
Dan Gohman6ab10f62010-04-12 23:03:26 +00002394 // If we have TargetData, we can bypass creating a target-independent
2395 // constant expression and then folding it back into a ConstantInt.
2396 // This is just a compile-time optimization.
2397 if (TD)
2398 return getConstant(TD->getIntPtrType(getContext()),
2399 TD->getStructLayout(STy)->getElementOffset(FieldNo));
2400
Dan Gohman0f5efe52010-01-28 02:15:55 +00002401 Constant *C = ConstantExpr::getOffsetOf(STy, FieldNo);
2402 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
Dan Gohman70001222010-05-28 16:12:08 +00002403 if (Constant *Folded = ConstantFoldConstantExpression(CE, TD))
2404 C = Folded;
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002405 const Type *Ty = getEffectiveSCEVType(PointerType::getUnqual(STy));
Dan Gohman0f5efe52010-01-28 02:15:55 +00002406 return getTruncateOrZeroExtend(getSCEV(C), Ty);
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002407}
2408
Dan Gohman4f8eea82010-02-01 18:27:38 +00002409const SCEV *ScalarEvolution::getOffsetOfExpr(const Type *CTy,
2410 Constant *FieldNo) {
2411 Constant *C = ConstantExpr::getOffsetOf(CTy, FieldNo);
Dan Gohman0f5efe52010-01-28 02:15:55 +00002412 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
Dan Gohman70001222010-05-28 16:12:08 +00002413 if (Constant *Folded = ConstantFoldConstantExpression(CE, TD))
2414 C = Folded;
Dan Gohman4f8eea82010-02-01 18:27:38 +00002415 const Type *Ty = getEffectiveSCEVType(PointerType::getUnqual(CTy));
Dan Gohman0f5efe52010-01-28 02:15:55 +00002416 return getTruncateOrZeroExtend(getSCEV(C), Ty);
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002417}
2418
Dan Gohman0bba49c2009-07-07 17:06:11 +00002419const SCEV *ScalarEvolution::getUnknown(Value *V) {
Dan Gohman6bbcba12009-06-24 00:54:57 +00002420 // Don't attempt to do anything other than create a SCEVUnknown object
2421 // here. createSCEV only calls getUnknown after checking for all other
2422 // interesting possibilities, and any other code that calls getUnknown
2423 // is doing so in order to hide a value from SCEV canonicalization.
2424
Dan Gohman1c343752009-06-27 21:21:31 +00002425 FoldingSetNodeID ID;
2426 ID.AddInteger(scUnknown);
2427 ID.AddPointer(V);
2428 void *IP = 0;
Dan Gohmanab37f502010-08-02 23:49:30 +00002429 if (SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) {
2430 assert(cast<SCEVUnknown>(S)->getValue() == V &&
2431 "Stale SCEVUnknown in uniquing map!");
2432 return S;
2433 }
2434 SCEV *S = new (SCEVAllocator) SCEVUnknown(ID.Intern(SCEVAllocator), V, this,
2435 FirstUnknown);
2436 FirstUnknown = cast<SCEVUnknown>(S);
Dan Gohman1c343752009-06-27 21:21:31 +00002437 UniqueSCEVs.InsertNode(S, IP);
2438 return S;
Chris Lattner0a7f98c2004-04-15 15:07:24 +00002439}
2440
Chris Lattner53e677a2004-04-02 20:23:17 +00002441//===----------------------------------------------------------------------===//
Chris Lattner53e677a2004-04-02 20:23:17 +00002442// Basic SCEV Analysis and PHI Idiom Recognition Code
2443//
2444
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002445/// isSCEVable - Test if values of the given type are analyzable within
2446/// the SCEV framework. This primarily includes integer types, and it
2447/// can optionally include pointer types if the ScalarEvolution class
2448/// has access to target-specific information.
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002449bool ScalarEvolution::isSCEVable(const Type *Ty) const {
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002450 // Integers and pointers are always SCEVable.
Duncan Sands1df98592010-02-16 11:11:14 +00002451 return Ty->isIntegerTy() || Ty->isPointerTy();
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002452}
2453
2454/// getTypeSizeInBits - Return the size in bits of the specified type,
2455/// for which isSCEVable must return true.
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002456uint64_t ScalarEvolution::getTypeSizeInBits(const Type *Ty) const {
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002457 assert(isSCEVable(Ty) && "Type is not SCEVable!");
2458
2459 // If we have a TargetData, use it!
2460 if (TD)
2461 return TD->getTypeSizeInBits(Ty);
2462
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002463 // Integer types have fixed sizes.
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00002464 if (Ty->isIntegerTy())
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002465 return Ty->getPrimitiveSizeInBits();
2466
2467 // The only other support type is pointer. Without TargetData, conservatively
2468 // assume pointers are 64-bit.
Duncan Sands1df98592010-02-16 11:11:14 +00002469 assert(Ty->isPointerTy() && "isSCEVable permitted a non-SCEVable type!");
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002470 return 64;
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002471}
2472
2473/// getEffectiveSCEVType - Return a type with the same bitwidth as
2474/// the given type and which represents how SCEV will treat the given
2475/// type, for which isSCEVable must return true. For pointer types,
2476/// this is the pointer-sized integer type.
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002477const Type *ScalarEvolution::getEffectiveSCEVType(const Type *Ty) const {
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002478 assert(isSCEVable(Ty) && "Type is not SCEVable!");
2479
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00002480 if (Ty->isIntegerTy())
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002481 return Ty;
2482
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002483 // The only other support type is pointer.
Duncan Sands1df98592010-02-16 11:11:14 +00002484 assert(Ty->isPointerTy() && "Unexpected non-pointer non-integer type!");
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002485 if (TD) return TD->getIntPtrType(getContext());
2486
2487 // Without TargetData, conservatively assume pointers are 64-bit.
2488 return Type::getInt64Ty(getContext());
Dan Gohman2d1be872009-04-16 03:18:22 +00002489}
Chris Lattner53e677a2004-04-02 20:23:17 +00002490
Dan Gohman0bba49c2009-07-07 17:06:11 +00002491const SCEV *ScalarEvolution::getCouldNotCompute() {
Dan Gohman1c343752009-06-27 21:21:31 +00002492 return &CouldNotCompute;
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +00002493}
2494
Chris Lattner53e677a2004-04-02 20:23:17 +00002495/// getSCEV - Return an existing SCEV if it exists, otherwise analyze the
2496/// expression and create a new one.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002497const SCEV *ScalarEvolution::getSCEV(Value *V) {
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002498 assert(isSCEVable(V->getType()) && "Value is not SCEVable!");
Chris Lattner53e677a2004-04-02 20:23:17 +00002499
Dan Gohmane8ac3f32010-08-27 18:55:03 +00002500 ValueExprMapType::const_iterator I = ValueExprMap.find(V);
2501 if (I != ValueExprMap.end()) return I->second;
Dan Gohman0bba49c2009-07-07 17:06:11 +00002502 const SCEV *S = createSCEV(V);
Dan Gohman619d3322010-08-16 16:31:39 +00002503
2504 // The process of creating a SCEV for V may have caused other SCEVs
2505 // to have been created, so it's necessary to insert the new entry
2506 // from scratch, rather than trying to remember the insert position
2507 // above.
Dan Gohmane8ac3f32010-08-27 18:55:03 +00002508 ValueExprMap.insert(std::make_pair(SCEVCallbackVH(V, this), S));
Chris Lattner53e677a2004-04-02 20:23:17 +00002509 return S;
2510}
2511
Dan Gohman2d1be872009-04-16 03:18:22 +00002512/// getNegativeSCEV - Return a SCEV corresponding to -V = -1*V
2513///
Dan Gohman0bba49c2009-07-07 17:06:11 +00002514const SCEV *ScalarEvolution::getNegativeSCEV(const SCEV *V) {
Dan Gohman622ed672009-05-04 22:02:23 +00002515 if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
Owen Anderson0a5372e2009-07-13 04:09:18 +00002516 return getConstant(
Owen Andersonbaf3c402009-07-29 18:55:55 +00002517 cast<ConstantInt>(ConstantExpr::getNeg(VC->getValue())));
Dan Gohman2d1be872009-04-16 03:18:22 +00002518
2519 const Type *Ty = V->getType();
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002520 Ty = getEffectiveSCEVType(Ty);
Owen Anderson73c6b712009-07-13 20:58:05 +00002521 return getMulExpr(V,
Owen Andersona7235ea2009-07-31 20:28:14 +00002522 getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty))));
Dan Gohman2d1be872009-04-16 03:18:22 +00002523}
2524
2525/// getNotSCEV - Return a SCEV corresponding to ~V = -1-V
Dan Gohman0bba49c2009-07-07 17:06:11 +00002526const SCEV *ScalarEvolution::getNotSCEV(const SCEV *V) {
Dan Gohman622ed672009-05-04 22:02:23 +00002527 if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
Owen Anderson73c6b712009-07-13 20:58:05 +00002528 return getConstant(
Owen Andersonbaf3c402009-07-29 18:55:55 +00002529 cast<ConstantInt>(ConstantExpr::getNot(VC->getValue())));
Dan Gohman2d1be872009-04-16 03:18:22 +00002530
2531 const Type *Ty = V->getType();
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002532 Ty = getEffectiveSCEVType(Ty);
Owen Anderson73c6b712009-07-13 20:58:05 +00002533 const SCEV *AllOnes =
Owen Andersona7235ea2009-07-31 20:28:14 +00002534 getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty)));
Dan Gohman2d1be872009-04-16 03:18:22 +00002535 return getMinusSCEV(AllOnes, V);
2536}
2537
2538/// getMinusSCEV - Return a SCEV corresponding to LHS - RHS.
2539///
Dan Gohman9311ef62009-06-24 14:49:00 +00002540const SCEV *ScalarEvolution::getMinusSCEV(const SCEV *LHS,
2541 const SCEV *RHS) {
Dan Gohmaneb4152c2010-07-20 16:53:00 +00002542 // Fast path: X - X --> 0.
2543 if (LHS == RHS)
2544 return getConstant(LHS->getType(), 0);
2545
Dan Gohman2d1be872009-04-16 03:18:22 +00002546 // X - Y --> X + -Y
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002547 return getAddExpr(LHS, getNegativeSCEV(RHS));
Dan Gohman2d1be872009-04-16 03:18:22 +00002548}
2549
2550/// getTruncateOrZeroExtend - Return a SCEV corresponding to a conversion of the
2551/// input value to the specified type. If the type must be extended, it is zero
2552/// extended.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002553const SCEV *
2554ScalarEvolution::getTruncateOrZeroExtend(const SCEV *V,
Nick Lewycky5cd28fa2009-04-23 05:15:08 +00002555 const Type *Ty) {
Dan Gohman2d1be872009-04-16 03:18:22 +00002556 const Type *SrcTy = V->getType();
Duncan Sands1df98592010-02-16 11:11:14 +00002557 assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2558 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
Dan Gohman2d1be872009-04-16 03:18:22 +00002559 "Cannot truncate or zero extend with non-integer arguments!");
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002560 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
Dan Gohman2d1be872009-04-16 03:18:22 +00002561 return V; // No conversion
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002562 if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty))
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002563 return getTruncateExpr(V, Ty);
2564 return getZeroExtendExpr(V, Ty);
Dan Gohman2d1be872009-04-16 03:18:22 +00002565}
2566
2567/// getTruncateOrSignExtend - Return a SCEV corresponding to a conversion of the
2568/// input value to the specified type. If the type must be extended, it is sign
2569/// extended.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002570const SCEV *
2571ScalarEvolution::getTruncateOrSignExtend(const SCEV *V,
Nick Lewycky5cd28fa2009-04-23 05:15:08 +00002572 const Type *Ty) {
Dan Gohman2d1be872009-04-16 03:18:22 +00002573 const Type *SrcTy = V->getType();
Duncan Sands1df98592010-02-16 11:11:14 +00002574 assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2575 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
Dan Gohman2d1be872009-04-16 03:18:22 +00002576 "Cannot truncate or zero extend with non-integer arguments!");
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002577 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
Dan Gohman2d1be872009-04-16 03:18:22 +00002578 return V; // No conversion
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002579 if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty))
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002580 return getTruncateExpr(V, Ty);
2581 return getSignExtendExpr(V, Ty);
Dan Gohman2d1be872009-04-16 03:18:22 +00002582}
2583
Dan Gohman467c4302009-05-13 03:46:30 +00002584/// getNoopOrZeroExtend - Return a SCEV corresponding to a conversion of the
2585/// input value to the specified type. If the type must be extended, it is zero
2586/// extended. The conversion must not be narrowing.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002587const SCEV *
2588ScalarEvolution::getNoopOrZeroExtend(const SCEV *V, const Type *Ty) {
Dan Gohman467c4302009-05-13 03:46:30 +00002589 const Type *SrcTy = V->getType();
Duncan Sands1df98592010-02-16 11:11:14 +00002590 assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2591 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
Dan Gohman467c4302009-05-13 03:46:30 +00002592 "Cannot noop or zero extend with non-integer arguments!");
2593 assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
2594 "getNoopOrZeroExtend cannot truncate!");
2595 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2596 return V; // No conversion
2597 return getZeroExtendExpr(V, Ty);
2598}
2599
2600/// getNoopOrSignExtend - Return a SCEV corresponding to a conversion of the
2601/// input value to the specified type. If the type must be extended, it is sign
2602/// extended. The conversion must not be narrowing.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002603const SCEV *
2604ScalarEvolution::getNoopOrSignExtend(const SCEV *V, const Type *Ty) {
Dan Gohman467c4302009-05-13 03:46:30 +00002605 const Type *SrcTy = V->getType();
Duncan Sands1df98592010-02-16 11:11:14 +00002606 assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2607 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
Dan Gohman467c4302009-05-13 03:46:30 +00002608 "Cannot noop or sign extend with non-integer arguments!");
2609 assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
2610 "getNoopOrSignExtend cannot truncate!");
2611 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2612 return V; // No conversion
2613 return getSignExtendExpr(V, Ty);
2614}
2615
Dan Gohman2ce84c8d2009-06-13 15:56:47 +00002616/// getNoopOrAnyExtend - Return a SCEV corresponding to a conversion of
2617/// the input value to the specified type. If the type must be extended,
2618/// it is extended with unspecified bits. The conversion must not be
2619/// narrowing.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002620const SCEV *
2621ScalarEvolution::getNoopOrAnyExtend(const SCEV *V, const Type *Ty) {
Dan Gohman2ce84c8d2009-06-13 15:56:47 +00002622 const Type *SrcTy = V->getType();
Duncan Sands1df98592010-02-16 11:11:14 +00002623 assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2624 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
Dan Gohman2ce84c8d2009-06-13 15:56:47 +00002625 "Cannot noop or any extend with non-integer arguments!");
2626 assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
2627 "getNoopOrAnyExtend cannot truncate!");
2628 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2629 return V; // No conversion
2630 return getAnyExtendExpr(V, Ty);
2631}
2632
Dan Gohman467c4302009-05-13 03:46:30 +00002633/// getTruncateOrNoop - Return a SCEV corresponding to a conversion of the
2634/// input value to the specified type. The conversion must not be widening.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002635const SCEV *
2636ScalarEvolution::getTruncateOrNoop(const SCEV *V, const Type *Ty) {
Dan Gohman467c4302009-05-13 03:46:30 +00002637 const Type *SrcTy = V->getType();
Duncan Sands1df98592010-02-16 11:11:14 +00002638 assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2639 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
Dan Gohman467c4302009-05-13 03:46:30 +00002640 "Cannot truncate or noop with non-integer arguments!");
2641 assert(getTypeSizeInBits(SrcTy) >= getTypeSizeInBits(Ty) &&
2642 "getTruncateOrNoop cannot extend!");
2643 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2644 return V; // No conversion
2645 return getTruncateExpr(V, Ty);
2646}
2647
Dan Gohmana334aa72009-06-22 00:31:57 +00002648/// getUMaxFromMismatchedTypes - Promote the operands to the wider of
2649/// the types using zero-extension, and then perform a umax operation
2650/// with them.
Dan Gohman9311ef62009-06-24 14:49:00 +00002651const SCEV *ScalarEvolution::getUMaxFromMismatchedTypes(const SCEV *LHS,
2652 const SCEV *RHS) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00002653 const SCEV *PromotedLHS = LHS;
2654 const SCEV *PromotedRHS = RHS;
Dan Gohmana334aa72009-06-22 00:31:57 +00002655
2656 if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType()))
2657 PromotedRHS = getZeroExtendExpr(RHS, LHS->getType());
2658 else
2659 PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType());
2660
2661 return getUMaxExpr(PromotedLHS, PromotedRHS);
2662}
2663
Dan Gohmanc9759e82009-06-22 15:03:27 +00002664/// getUMinFromMismatchedTypes - Promote the operands to the wider of
2665/// the types using zero-extension, and then perform a umin operation
2666/// with them.
Dan Gohman9311ef62009-06-24 14:49:00 +00002667const SCEV *ScalarEvolution::getUMinFromMismatchedTypes(const SCEV *LHS,
2668 const SCEV *RHS) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00002669 const SCEV *PromotedLHS = LHS;
2670 const SCEV *PromotedRHS = RHS;
Dan Gohmanc9759e82009-06-22 15:03:27 +00002671
2672 if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType()))
2673 PromotedRHS = getZeroExtendExpr(RHS, LHS->getType());
2674 else
2675 PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType());
2676
2677 return getUMinExpr(PromotedLHS, PromotedRHS);
2678}
2679
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002680/// PushDefUseChildren - Push users of the given Instruction
2681/// onto the given Worklist.
2682static void
2683PushDefUseChildren(Instruction *I,
2684 SmallVectorImpl<Instruction *> &Worklist) {
2685 // Push the def-use children onto the Worklist stack.
2686 for (Value::use_iterator UI = I->use_begin(), UE = I->use_end();
2687 UI != UE; ++UI)
Gabor Greif96f1d8e2010-07-22 13:36:47 +00002688 Worklist.push_back(cast<Instruction>(*UI));
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002689}
2690
2691/// ForgetSymbolicValue - This looks up computed SCEV values for all
2692/// instructions that depend on the given instruction and removes them from
Dan Gohmane8ac3f32010-08-27 18:55:03 +00002693/// the ValueExprMapType map if they reference SymName. This is used during PHI
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002694/// resolution.
Dan Gohman64a845e2009-06-24 04:48:43 +00002695void
Dan Gohman85669632010-02-25 06:57:05 +00002696ScalarEvolution::ForgetSymbolicName(Instruction *PN, const SCEV *SymName) {
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002697 SmallVector<Instruction *, 16> Worklist;
Dan Gohman85669632010-02-25 06:57:05 +00002698 PushDefUseChildren(PN, Worklist);
Chris Lattner53e677a2004-04-02 20:23:17 +00002699
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002700 SmallPtrSet<Instruction *, 8> Visited;
Dan Gohman85669632010-02-25 06:57:05 +00002701 Visited.insert(PN);
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002702 while (!Worklist.empty()) {
Dan Gohman85669632010-02-25 06:57:05 +00002703 Instruction *I = Worklist.pop_back_val();
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002704 if (!Visited.insert(I)) continue;
Chris Lattner4dc534c2005-02-13 04:37:18 +00002705
Dan Gohmane8ac3f32010-08-27 18:55:03 +00002706 ValueExprMapType::iterator It =
2707 ValueExprMap.find(static_cast<Value *>(I));
2708 if (It != ValueExprMap.end()) {
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002709 // Short-circuit the def-use traversal if the symbolic name
2710 // ceases to appear in expressions.
Dan Gohman50922bb2010-02-15 10:28:37 +00002711 if (It->second != SymName && !It->second->hasOperand(SymName))
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002712 continue;
Chris Lattner4dc534c2005-02-13 04:37:18 +00002713
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002714 // SCEVUnknown for a PHI either means that it has an unrecognized
Dan Gohman85669632010-02-25 06:57:05 +00002715 // structure, it's a PHI that's in the progress of being computed
2716 // by createNodeForPHI, or it's a single-value PHI. In the first case,
2717 // additional loop trip count information isn't going to change anything.
2718 // In the second case, createNodeForPHI will perform the necessary
2719 // updates on its own when it gets to that point. In the third, we do
2720 // want to forget the SCEVUnknown.
2721 if (!isa<PHINode>(I) ||
2722 !isa<SCEVUnknown>(It->second) ||
2723 (I != PN && It->second == SymName)) {
Dan Gohman42214892009-08-31 21:15:23 +00002724 ValuesAtScopes.erase(It->second);
Dan Gohmane8ac3f32010-08-27 18:55:03 +00002725 ValueExprMap.erase(It);
Dan Gohman42214892009-08-31 21:15:23 +00002726 }
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002727 }
2728
2729 PushDefUseChildren(I, Worklist);
2730 }
Chris Lattner4dc534c2005-02-13 04:37:18 +00002731}
Chris Lattner53e677a2004-04-02 20:23:17 +00002732
2733/// createNodeForPHI - PHI nodes have two cases. Either the PHI node exists in
2734/// a loop header, making it a potential recurrence, or it doesn't.
2735///
Dan Gohman0bba49c2009-07-07 17:06:11 +00002736const SCEV *ScalarEvolution::createNodeForPHI(PHINode *PN) {
Dan Gohman27dead42010-04-12 07:49:36 +00002737 if (const Loop *L = LI->getLoopFor(PN->getParent()))
2738 if (L->getHeader() == PN->getParent()) {
2739 // The loop may have multiple entrances or multiple exits; we can analyze
2740 // this phi as an addrec if it has a unique entry value and a unique
2741 // backedge value.
2742 Value *BEValueV = 0, *StartValueV = 0;
2743 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
2744 Value *V = PN->getIncomingValue(i);
2745 if (L->contains(PN->getIncomingBlock(i))) {
2746 if (!BEValueV) {
2747 BEValueV = V;
2748 } else if (BEValueV != V) {
2749 BEValueV = 0;
2750 break;
2751 }
2752 } else if (!StartValueV) {
2753 StartValueV = V;
2754 } else if (StartValueV != V) {
2755 StartValueV = 0;
2756 break;
2757 }
2758 }
2759 if (BEValueV && StartValueV) {
Chris Lattner53e677a2004-04-02 20:23:17 +00002760 // While we are analyzing this PHI node, handle its value symbolically.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002761 const SCEV *SymbolicName = getUnknown(PN);
Dan Gohmane8ac3f32010-08-27 18:55:03 +00002762 assert(ValueExprMap.find(PN) == ValueExprMap.end() &&
Chris Lattner53e677a2004-04-02 20:23:17 +00002763 "PHI node already processed?");
Dan Gohmane8ac3f32010-08-27 18:55:03 +00002764 ValueExprMap.insert(std::make_pair(SCEVCallbackVH(PN, this), SymbolicName));
Chris Lattner53e677a2004-04-02 20:23:17 +00002765
2766 // Using this symbolic name for the PHI, analyze the value coming around
2767 // the back-edge.
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002768 const SCEV *BEValue = getSCEV(BEValueV);
Chris Lattner53e677a2004-04-02 20:23:17 +00002769
2770 // NOTE: If BEValue is loop invariant, we know that the PHI node just
2771 // has a special value for the first iteration of the loop.
2772
2773 // If the value coming around the backedge is an add with the symbolic
2774 // value we just inserted, then we found a simple induction variable!
Dan Gohman622ed672009-05-04 22:02:23 +00002775 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(BEValue)) {
Chris Lattner53e677a2004-04-02 20:23:17 +00002776 // If there is a single occurrence of the symbolic value, replace it
2777 // with a recurrence.
2778 unsigned FoundIndex = Add->getNumOperands();
2779 for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
2780 if (Add->getOperand(i) == SymbolicName)
2781 if (FoundIndex == e) {
2782 FoundIndex = i;
2783 break;
2784 }
2785
2786 if (FoundIndex != Add->getNumOperands()) {
2787 // Create an add with everything but the specified operand.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002788 SmallVector<const SCEV *, 8> Ops;
Chris Lattner53e677a2004-04-02 20:23:17 +00002789 for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
2790 if (i != FoundIndex)
2791 Ops.push_back(Add->getOperand(i));
Dan Gohman0bba49c2009-07-07 17:06:11 +00002792 const SCEV *Accum = getAddExpr(Ops);
Chris Lattner53e677a2004-04-02 20:23:17 +00002793
2794 // This is not a valid addrec if the step amount is varying each
2795 // loop iteration, but is not itself an addrec in this loop.
2796 if (Accum->isLoopInvariant(L) ||
2797 (isa<SCEVAddRecExpr>(Accum) &&
2798 cast<SCEVAddRecExpr>(Accum)->getLoop() == L)) {
Dan Gohmana10756e2010-01-21 02:09:26 +00002799 bool HasNUW = false;
2800 bool HasNSW = false;
2801
2802 // If the increment doesn't overflow, then neither the addrec nor
2803 // the post-increment will overflow.
2804 if (const AddOperator *OBO = dyn_cast<AddOperator>(BEValueV)) {
2805 if (OBO->hasNoUnsignedWrap())
2806 HasNUW = true;
2807 if (OBO->hasNoSignedWrap())
2808 HasNSW = true;
2809 }
2810
Dan Gohman27dead42010-04-12 07:49:36 +00002811 const SCEV *StartVal = getSCEV(StartValueV);
Dan Gohmana10756e2010-01-21 02:09:26 +00002812 const SCEV *PHISCEV =
2813 getAddRecExpr(StartVal, Accum, L, HasNUW, HasNSW);
Dan Gohmaneb490a72009-07-25 01:22:26 +00002814
Dan Gohmana10756e2010-01-21 02:09:26 +00002815 // Since the no-wrap flags are on the increment, they apply to the
2816 // post-incremented value as well.
2817 if (Accum->isLoopInvariant(L))
2818 (void)getAddRecExpr(getAddExpr(StartVal, Accum),
2819 Accum, L, HasNUW, HasNSW);
Chris Lattner53e677a2004-04-02 20:23:17 +00002820
2821 // Okay, for the entire analysis of this edge we assumed the PHI
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002822 // to be symbolic. We now need to go back and purge all of the
2823 // entries for the scalars that use the symbolic expression.
2824 ForgetSymbolicName(PN, SymbolicName);
Dan Gohmane8ac3f32010-08-27 18:55:03 +00002825 ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV;
Chris Lattner53e677a2004-04-02 20:23:17 +00002826 return PHISCEV;
2827 }
2828 }
Dan Gohman622ed672009-05-04 22:02:23 +00002829 } else if (const SCEVAddRecExpr *AddRec =
2830 dyn_cast<SCEVAddRecExpr>(BEValue)) {
Chris Lattner97156e72006-04-26 18:34:07 +00002831 // Otherwise, this could be a loop like this:
2832 // i = 0; for (j = 1; ..; ++j) { .... i = j; }
2833 // In this case, j = {1,+,1} and BEValue is j.
2834 // Because the other in-value of i (0) fits the evolution of BEValue
2835 // i really is an addrec evolution.
2836 if (AddRec->getLoop() == L && AddRec->isAffine()) {
Dan Gohman27dead42010-04-12 07:49:36 +00002837 const SCEV *StartVal = getSCEV(StartValueV);
Chris Lattner97156e72006-04-26 18:34:07 +00002838
2839 // If StartVal = j.start - j.stride, we can use StartVal as the
2840 // initial step of the addrec evolution.
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002841 if (StartVal == getMinusSCEV(AddRec->getOperand(0),
Dan Gohman5ee60f72010-04-11 23:44:58 +00002842 AddRec->getOperand(1))) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00002843 const SCEV *PHISCEV =
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002844 getAddRecExpr(StartVal, AddRec->getOperand(1), L);
Chris Lattner97156e72006-04-26 18:34:07 +00002845
2846 // Okay, for the entire analysis of this edge we assumed the PHI
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002847 // to be symbolic. We now need to go back and purge all of the
2848 // entries for the scalars that use the symbolic expression.
2849 ForgetSymbolicName(PN, SymbolicName);
Dan Gohmane8ac3f32010-08-27 18:55:03 +00002850 ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV;
Chris Lattner97156e72006-04-26 18:34:07 +00002851 return PHISCEV;
2852 }
2853 }
Chris Lattner53e677a2004-04-02 20:23:17 +00002854 }
Chris Lattner53e677a2004-04-02 20:23:17 +00002855 }
Dan Gohman27dead42010-04-12 07:49:36 +00002856 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +00002857
Dan Gohman85669632010-02-25 06:57:05 +00002858 // If the PHI has a single incoming value, follow that value, unless the
2859 // PHI's incoming blocks are in a different loop, in which case doing so
2860 // risks breaking LCSSA form. Instcombine would normally zap these, but
2861 // it doesn't have DominatorTree information, so it may miss cases.
2862 if (Value *V = PN->hasConstantValue(DT)) {
2863 bool AllSameLoop = true;
2864 Loop *PNLoop = LI->getLoopFor(PN->getParent());
2865 for (size_t i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
2866 if (LI->getLoopFor(PN->getIncomingBlock(i)) != PNLoop) {
2867 AllSameLoop = false;
2868 break;
2869 }
2870 if (AllSameLoop)
2871 return getSCEV(V);
2872 }
Dan Gohmana653fc52009-07-14 14:06:25 +00002873
Chris Lattner53e677a2004-04-02 20:23:17 +00002874 // If it's not a loop phi, we can't handle it yet.
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002875 return getUnknown(PN);
Chris Lattner53e677a2004-04-02 20:23:17 +00002876}
2877
Dan Gohman26466c02009-05-08 20:26:55 +00002878/// createNodeForGEP - Expand GEP instructions into add and multiply
2879/// operations. This allows them to be analyzed by regular SCEV code.
2880///
Dan Gohmand281ed22009-12-18 02:09:29 +00002881const SCEV *ScalarEvolution::createNodeForGEP(GEPOperator *GEP) {
Dan Gohman26466c02009-05-08 20:26:55 +00002882
Dan Gohmanb9f96512010-06-30 07:16:37 +00002883 // Don't blindly transfer the inbounds flag from the GEP instruction to the
2884 // Add expression, because the Instruction may be guarded by control flow
2885 // and the no-overflow bits may not be valid for the expression in any
Dan Gohman70eff632010-06-30 17:27:11 +00002886 // context.
Dan Gohman7a642572010-06-29 01:41:41 +00002887
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002888 const Type *IntPtrTy = getEffectiveSCEVType(GEP->getType());
Dan Gohmane810b0d2009-05-08 20:36:47 +00002889 Value *Base = GEP->getOperand(0);
Dan Gohmanc63a6272009-05-09 00:14:52 +00002890 // Don't attempt to analyze GEPs over unsized objects.
2891 if (!cast<PointerType>(Base->getType())->getElementType()->isSized())
2892 return getUnknown(GEP);
Dan Gohmandeff6212010-05-03 22:09:21 +00002893 const SCEV *TotalOffset = getConstant(IntPtrTy, 0);
Dan Gohmane810b0d2009-05-08 20:36:47 +00002894 gep_type_iterator GTI = gep_type_begin(GEP);
Oscar Fuentesee56c422010-08-02 06:00:15 +00002895 for (GetElementPtrInst::op_iterator I = llvm::next(GEP->op_begin()),
Dan Gohmane810b0d2009-05-08 20:36:47 +00002896 E = GEP->op_end();
Dan Gohman26466c02009-05-08 20:26:55 +00002897 I != E; ++I) {
2898 Value *Index = *I;
2899 // Compute the (potentially symbolic) offset in bytes for this index.
2900 if (const StructType *STy = dyn_cast<StructType>(*GTI++)) {
2901 // For a struct, add the member offset.
Dan Gohman26466c02009-05-08 20:26:55 +00002902 unsigned FieldNo = cast<ConstantInt>(Index)->getZExtValue();
Dan Gohmanb9f96512010-06-30 07:16:37 +00002903 const SCEV *FieldOffset = getOffsetOfExpr(STy, FieldNo);
2904
Dan Gohmanb9f96512010-06-30 07:16:37 +00002905 // Add the field offset to the running total offset.
Dan Gohman70eff632010-06-30 17:27:11 +00002906 TotalOffset = getAddExpr(TotalOffset, FieldOffset);
Dan Gohman26466c02009-05-08 20:26:55 +00002907 } else {
2908 // For an array, add the element offset, explicitly scaled.
Dan Gohmanb9f96512010-06-30 07:16:37 +00002909 const SCEV *ElementSize = getSizeOfExpr(*GTI);
2910 const SCEV *IndexS = getSCEV(Index);
Dan Gohman3f46a3a2010-03-01 17:49:51 +00002911 // Getelementptr indices are signed.
Dan Gohmanb9f96512010-06-30 07:16:37 +00002912 IndexS = getTruncateOrSignExtend(IndexS, IntPtrTy);
2913
Dan Gohmanb9f96512010-06-30 07:16:37 +00002914 // Multiply the index by the element size to compute the element offset.
Dan Gohman70eff632010-06-30 17:27:11 +00002915 const SCEV *LocalOffset = getMulExpr(IndexS, ElementSize);
Dan Gohmanb9f96512010-06-30 07:16:37 +00002916
2917 // Add the element offset to the running total offset.
Dan Gohman70eff632010-06-30 17:27:11 +00002918 TotalOffset = getAddExpr(TotalOffset, LocalOffset);
Dan Gohman26466c02009-05-08 20:26:55 +00002919 }
2920 }
Dan Gohmanb9f96512010-06-30 07:16:37 +00002921
2922 // Get the SCEV for the GEP base.
2923 const SCEV *BaseS = getSCEV(Base);
2924
Dan Gohmanb9f96512010-06-30 07:16:37 +00002925 // Add the total offset from all the GEP indices to the base.
Dan Gohman70eff632010-06-30 17:27:11 +00002926 return getAddExpr(BaseS, TotalOffset);
Dan Gohman26466c02009-05-08 20:26:55 +00002927}
2928
Nick Lewycky83bb0052007-11-22 07:59:40 +00002929/// GetMinTrailingZeros - Determine the minimum number of zero bits that S is
2930/// guaranteed to end in (at every loop iteration). It is, at the same time,
2931/// the minimum number of times S is divisible by 2. For example, given {4,+,8}
2932/// it returns 2. If S is guaranteed to be 0, it returns the bitwidth of S.
Dan Gohman2c364ad2009-06-19 23:29:04 +00002933uint32_t
Dan Gohman0bba49c2009-07-07 17:06:11 +00002934ScalarEvolution::GetMinTrailingZeros(const SCEV *S) {
Dan Gohman622ed672009-05-04 22:02:23 +00002935 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
Chris Lattner8314a0c2007-11-23 22:36:49 +00002936 return C->getValue()->getValue().countTrailingZeros();
Chris Lattnera17f0392006-12-12 02:26:09 +00002937
Dan Gohman622ed672009-05-04 22:02:23 +00002938 if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(S))
Dan Gohman2c364ad2009-06-19 23:29:04 +00002939 return std::min(GetMinTrailingZeros(T->getOperand()),
2940 (uint32_t)getTypeSizeInBits(T->getType()));
Nick Lewycky83bb0052007-11-22 07:59:40 +00002941
Dan Gohman622ed672009-05-04 22:02:23 +00002942 if (const SCEVZeroExtendExpr *E = dyn_cast<SCEVZeroExtendExpr>(S)) {
Dan Gohman2c364ad2009-06-19 23:29:04 +00002943 uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
2944 return OpRes == getTypeSizeInBits(E->getOperand()->getType()) ?
2945 getTypeSizeInBits(E->getType()) : OpRes;
Nick Lewycky83bb0052007-11-22 07:59:40 +00002946 }
2947
Dan Gohman622ed672009-05-04 22:02:23 +00002948 if (const SCEVSignExtendExpr *E = dyn_cast<SCEVSignExtendExpr>(S)) {
Dan Gohman2c364ad2009-06-19 23:29:04 +00002949 uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
2950 return OpRes == getTypeSizeInBits(E->getOperand()->getType()) ?
2951 getTypeSizeInBits(E->getType()) : OpRes;
Nick Lewycky83bb0052007-11-22 07:59:40 +00002952 }
2953
Dan Gohman622ed672009-05-04 22:02:23 +00002954 if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(S)) {
Nick Lewycky83bb0052007-11-22 07:59:40 +00002955 // The result is the min of all operands results.
Dan Gohman2c364ad2009-06-19 23:29:04 +00002956 uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
Nick Lewycky83bb0052007-11-22 07:59:40 +00002957 for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
Dan Gohman2c364ad2009-06-19 23:29:04 +00002958 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
Nick Lewycky83bb0052007-11-22 07:59:40 +00002959 return MinOpRes;
Chris Lattnera17f0392006-12-12 02:26:09 +00002960 }
2961
Dan Gohman622ed672009-05-04 22:02:23 +00002962 if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(S)) {
Nick Lewycky83bb0052007-11-22 07:59:40 +00002963 // The result is the sum of all operands results.
Dan Gohman2c364ad2009-06-19 23:29:04 +00002964 uint32_t SumOpRes = GetMinTrailingZeros(M->getOperand(0));
2965 uint32_t BitWidth = getTypeSizeInBits(M->getType());
Nick Lewycky83bb0052007-11-22 07:59:40 +00002966 for (unsigned i = 1, e = M->getNumOperands();
2967 SumOpRes != BitWidth && i != e; ++i)
Dan Gohman2c364ad2009-06-19 23:29:04 +00002968 SumOpRes = std::min(SumOpRes + GetMinTrailingZeros(M->getOperand(i)),
Nick Lewycky83bb0052007-11-22 07:59:40 +00002969 BitWidth);
2970 return SumOpRes;
Chris Lattnera17f0392006-12-12 02:26:09 +00002971 }
Nick Lewycky83bb0052007-11-22 07:59:40 +00002972
Dan Gohman622ed672009-05-04 22:02:23 +00002973 if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(S)) {
Nick Lewycky83bb0052007-11-22 07:59:40 +00002974 // The result is the min of all operands results.
Dan Gohman2c364ad2009-06-19 23:29:04 +00002975 uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
Nick Lewycky83bb0052007-11-22 07:59:40 +00002976 for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
Dan Gohman2c364ad2009-06-19 23:29:04 +00002977 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
Nick Lewycky83bb0052007-11-22 07:59:40 +00002978 return MinOpRes;
Chris Lattnera17f0392006-12-12 02:26:09 +00002979 }
Nick Lewycky83bb0052007-11-22 07:59:40 +00002980
Dan Gohman622ed672009-05-04 22:02:23 +00002981 if (const SCEVSMaxExpr *M = dyn_cast<SCEVSMaxExpr>(S)) {
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002982 // The result is the min of all operands results.
Dan Gohman2c364ad2009-06-19 23:29:04 +00002983 uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002984 for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
Dan Gohman2c364ad2009-06-19 23:29:04 +00002985 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002986 return MinOpRes;
2987 }
2988
Dan Gohman622ed672009-05-04 22:02:23 +00002989 if (const SCEVUMaxExpr *M = dyn_cast<SCEVUMaxExpr>(S)) {
Nick Lewycky3e630762008-02-20 06:48:22 +00002990 // The result is the min of all operands results.
Dan Gohman2c364ad2009-06-19 23:29:04 +00002991 uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
Nick Lewycky3e630762008-02-20 06:48:22 +00002992 for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
Dan Gohman2c364ad2009-06-19 23:29:04 +00002993 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
Nick Lewycky3e630762008-02-20 06:48:22 +00002994 return MinOpRes;
2995 }
2996
Dan Gohman2c364ad2009-06-19 23:29:04 +00002997 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
2998 // For a SCEVUnknown, ask ValueTracking.
2999 unsigned BitWidth = getTypeSizeInBits(U->getType());
3000 APInt Mask = APInt::getAllOnesValue(BitWidth);
3001 APInt Zeros(BitWidth, 0), Ones(BitWidth, 0);
3002 ComputeMaskedBits(U->getValue(), Mask, Zeros, Ones);
3003 return Zeros.countTrailingOnes();
3004 }
3005
3006 // SCEVUDivExpr
Nick Lewycky83bb0052007-11-22 07:59:40 +00003007 return 0;
Chris Lattnera17f0392006-12-12 02:26:09 +00003008}
Chris Lattner53e677a2004-04-02 20:23:17 +00003009
Dan Gohman85b05a22009-07-13 21:35:55 +00003010/// getUnsignedRange - Determine the unsigned range for a particular SCEV.
3011///
3012ConstantRange
3013ScalarEvolution::getUnsignedRange(const SCEV *S) {
Dan Gohman2c364ad2009-06-19 23:29:04 +00003014
3015 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
Dan Gohman85b05a22009-07-13 21:35:55 +00003016 return ConstantRange(C->getValue()->getValue());
Dan Gohman2c364ad2009-06-19 23:29:04 +00003017
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003018 unsigned BitWidth = getTypeSizeInBits(S->getType());
3019 ConstantRange ConservativeResult(BitWidth, /*isFullSet=*/true);
3020
3021 // If the value has known zeros, the maximum unsigned value will have those
3022 // known zeros as well.
3023 uint32_t TZ = GetMinTrailingZeros(S);
3024 if (TZ != 0)
3025 ConservativeResult =
3026 ConstantRange(APInt::getMinValue(BitWidth),
3027 APInt::getMaxValue(BitWidth).lshr(TZ).shl(TZ) + 1);
3028
Dan Gohman85b05a22009-07-13 21:35:55 +00003029 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
3030 ConstantRange X = getUnsignedRange(Add->getOperand(0));
3031 for (unsigned i = 1, e = Add->getNumOperands(); i != e; ++i)
3032 X = X.add(getUnsignedRange(Add->getOperand(i)));
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003033 return ConservativeResult.intersectWith(X);
Dan Gohman85b05a22009-07-13 21:35:55 +00003034 }
3035
3036 if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) {
3037 ConstantRange X = getUnsignedRange(Mul->getOperand(0));
3038 for (unsigned i = 1, e = Mul->getNumOperands(); i != e; ++i)
3039 X = X.multiply(getUnsignedRange(Mul->getOperand(i)));
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003040 return ConservativeResult.intersectWith(X);
Dan Gohman85b05a22009-07-13 21:35:55 +00003041 }
3042
3043 if (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(S)) {
3044 ConstantRange X = getUnsignedRange(SMax->getOperand(0));
3045 for (unsigned i = 1, e = SMax->getNumOperands(); i != e; ++i)
3046 X = X.smax(getUnsignedRange(SMax->getOperand(i)));
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003047 return ConservativeResult.intersectWith(X);
Dan Gohman85b05a22009-07-13 21:35:55 +00003048 }
3049
3050 if (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(S)) {
3051 ConstantRange X = getUnsignedRange(UMax->getOperand(0));
3052 for (unsigned i = 1, e = UMax->getNumOperands(); i != e; ++i)
3053 X = X.umax(getUnsignedRange(UMax->getOperand(i)));
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003054 return ConservativeResult.intersectWith(X);
Dan Gohman85b05a22009-07-13 21:35:55 +00003055 }
3056
3057 if (const SCEVUDivExpr *UDiv = dyn_cast<SCEVUDivExpr>(S)) {
3058 ConstantRange X = getUnsignedRange(UDiv->getLHS());
3059 ConstantRange Y = getUnsignedRange(UDiv->getRHS());
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003060 return ConservativeResult.intersectWith(X.udiv(Y));
Dan Gohman85b05a22009-07-13 21:35:55 +00003061 }
3062
3063 if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) {
3064 ConstantRange X = getUnsignedRange(ZExt->getOperand());
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003065 return ConservativeResult.intersectWith(X.zeroExtend(BitWidth));
Dan Gohman85b05a22009-07-13 21:35:55 +00003066 }
3067
3068 if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) {
3069 ConstantRange X = getUnsignedRange(SExt->getOperand());
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003070 return ConservativeResult.intersectWith(X.signExtend(BitWidth));
Dan Gohman85b05a22009-07-13 21:35:55 +00003071 }
3072
3073 if (const SCEVTruncateExpr *Trunc = dyn_cast<SCEVTruncateExpr>(S)) {
3074 ConstantRange X = getUnsignedRange(Trunc->getOperand());
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003075 return ConservativeResult.intersectWith(X.truncate(BitWidth));
Dan Gohman85b05a22009-07-13 21:35:55 +00003076 }
3077
Dan Gohman85b05a22009-07-13 21:35:55 +00003078 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(S)) {
Dan Gohmana10756e2010-01-21 02:09:26 +00003079 // If there's no unsigned wrap, the value will never be less than its
3080 // initial value.
3081 if (AddRec->hasNoUnsignedWrap())
3082 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(AddRec->getStart()))
Dan Gohmanbca091d2010-04-12 23:08:18 +00003083 if (!C->getValue()->isZero())
Dan Gohmanbc7129f2010-04-11 22:12:18 +00003084 ConservativeResult =
Dan Gohman8a18d6b2010-06-30 06:58:35 +00003085 ConservativeResult.intersectWith(
3086 ConstantRange(C->getValue()->getValue(), APInt(BitWidth, 0)));
Dan Gohman85b05a22009-07-13 21:35:55 +00003087
3088 // TODO: non-affine addrec
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003089 if (AddRec->isAffine()) {
Dan Gohman85b05a22009-07-13 21:35:55 +00003090 const Type *Ty = AddRec->getType();
3091 const SCEV *MaxBECount = getMaxBackedgeTakenCount(AddRec->getLoop());
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003092 if (!isa<SCEVCouldNotCompute>(MaxBECount) &&
3093 getTypeSizeInBits(MaxBECount->getType()) <= BitWidth) {
Dan Gohman85b05a22009-07-13 21:35:55 +00003094 MaxBECount = getNoopOrZeroExtend(MaxBECount, Ty);
3095
3096 const SCEV *Start = AddRec->getStart();
Dan Gohman646e0472010-04-12 07:39:33 +00003097 const SCEV *Step = AddRec->getStepRecurrence(*this);
Dan Gohman85b05a22009-07-13 21:35:55 +00003098
3099 ConstantRange StartRange = getUnsignedRange(Start);
Dan Gohman646e0472010-04-12 07:39:33 +00003100 ConstantRange StepRange = getSignedRange(Step);
3101 ConstantRange MaxBECountRange = getUnsignedRange(MaxBECount);
3102 ConstantRange EndRange =
3103 StartRange.add(MaxBECountRange.multiply(StepRange));
3104
3105 // Check for overflow. This must be done with ConstantRange arithmetic
3106 // because we could be called from within the ScalarEvolution overflow
3107 // checking code.
3108 ConstantRange ExtStartRange = StartRange.zextOrTrunc(BitWidth*2+1);
3109 ConstantRange ExtStepRange = StepRange.sextOrTrunc(BitWidth*2+1);
3110 ConstantRange ExtMaxBECountRange =
3111 MaxBECountRange.zextOrTrunc(BitWidth*2+1);
3112 ConstantRange ExtEndRange = EndRange.zextOrTrunc(BitWidth*2+1);
3113 if (ExtStartRange.add(ExtMaxBECountRange.multiply(ExtStepRange)) !=
3114 ExtEndRange)
3115 return ConservativeResult;
3116
Dan Gohman85b05a22009-07-13 21:35:55 +00003117 APInt Min = APIntOps::umin(StartRange.getUnsignedMin(),
3118 EndRange.getUnsignedMin());
3119 APInt Max = APIntOps::umax(StartRange.getUnsignedMax(),
3120 EndRange.getUnsignedMax());
3121 if (Min.isMinValue() && Max.isMaxValue())
Dan Gohmana10756e2010-01-21 02:09:26 +00003122 return ConservativeResult;
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003123 return ConservativeResult.intersectWith(ConstantRange(Min, Max+1));
Dan Gohman85b05a22009-07-13 21:35:55 +00003124 }
3125 }
Dan Gohmana10756e2010-01-21 02:09:26 +00003126
3127 return ConservativeResult;
Dan Gohman2c364ad2009-06-19 23:29:04 +00003128 }
3129
3130 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
3131 // For a SCEVUnknown, ask ValueTracking.
Dan Gohman2c364ad2009-06-19 23:29:04 +00003132 APInt Mask = APInt::getAllOnesValue(BitWidth);
3133 APInt Zeros(BitWidth, 0), Ones(BitWidth, 0);
3134 ComputeMaskedBits(U->getValue(), Mask, Zeros, Ones, TD);
Dan Gohman746f3b12009-07-20 22:34:18 +00003135 if (Ones == ~Zeros + 1)
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003136 return ConservativeResult;
3137 return ConservativeResult.intersectWith(ConstantRange(Ones, ~Zeros + 1));
Dan Gohman2c364ad2009-06-19 23:29:04 +00003138 }
3139
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003140 return ConservativeResult;
Dan Gohman2c364ad2009-06-19 23:29:04 +00003141}
3142
Dan Gohman85b05a22009-07-13 21:35:55 +00003143/// getSignedRange - Determine the signed range for a particular SCEV.
3144///
3145ConstantRange
3146ScalarEvolution::getSignedRange(const SCEV *S) {
Dan Gohman2c364ad2009-06-19 23:29:04 +00003147
Dan Gohman85b05a22009-07-13 21:35:55 +00003148 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
3149 return ConstantRange(C->getValue()->getValue());
3150
Dan Gohman52fddd32010-01-26 04:40:18 +00003151 unsigned BitWidth = getTypeSizeInBits(S->getType());
3152 ConstantRange ConservativeResult(BitWidth, /*isFullSet=*/true);
3153
3154 // If the value has known zeros, the maximum signed value will have those
3155 // known zeros as well.
3156 uint32_t TZ = GetMinTrailingZeros(S);
3157 if (TZ != 0)
3158 ConservativeResult =
3159 ConstantRange(APInt::getSignedMinValue(BitWidth),
3160 APInt::getSignedMaxValue(BitWidth).ashr(TZ).shl(TZ) + 1);
3161
Dan Gohman85b05a22009-07-13 21:35:55 +00003162 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
3163 ConstantRange X = getSignedRange(Add->getOperand(0));
3164 for (unsigned i = 1, e = Add->getNumOperands(); i != e; ++i)
3165 X = X.add(getSignedRange(Add->getOperand(i)));
Dan Gohman52fddd32010-01-26 04:40:18 +00003166 return ConservativeResult.intersectWith(X);
Dan Gohman2c364ad2009-06-19 23:29:04 +00003167 }
3168
Dan Gohman85b05a22009-07-13 21:35:55 +00003169 if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) {
3170 ConstantRange X = getSignedRange(Mul->getOperand(0));
3171 for (unsigned i = 1, e = Mul->getNumOperands(); i != e; ++i)
3172 X = X.multiply(getSignedRange(Mul->getOperand(i)));
Dan Gohman52fddd32010-01-26 04:40:18 +00003173 return ConservativeResult.intersectWith(X);
Dan Gohman2c364ad2009-06-19 23:29:04 +00003174 }
3175
Dan Gohman85b05a22009-07-13 21:35:55 +00003176 if (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(S)) {
3177 ConstantRange X = getSignedRange(SMax->getOperand(0));
3178 for (unsigned i = 1, e = SMax->getNumOperands(); i != e; ++i)
3179 X = X.smax(getSignedRange(SMax->getOperand(i)));
Dan Gohman52fddd32010-01-26 04:40:18 +00003180 return ConservativeResult.intersectWith(X);
Dan Gohman85b05a22009-07-13 21:35:55 +00003181 }
Dan Gohman62849c02009-06-24 01:05:09 +00003182
Dan Gohman85b05a22009-07-13 21:35:55 +00003183 if (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(S)) {
3184 ConstantRange X = getSignedRange(UMax->getOperand(0));
3185 for (unsigned i = 1, e = UMax->getNumOperands(); i != e; ++i)
3186 X = X.umax(getSignedRange(UMax->getOperand(i)));
Dan Gohman52fddd32010-01-26 04:40:18 +00003187 return ConservativeResult.intersectWith(X);
Dan Gohman85b05a22009-07-13 21:35:55 +00003188 }
Dan Gohman62849c02009-06-24 01:05:09 +00003189
Dan Gohman85b05a22009-07-13 21:35:55 +00003190 if (const SCEVUDivExpr *UDiv = dyn_cast<SCEVUDivExpr>(S)) {
3191 ConstantRange X = getSignedRange(UDiv->getLHS());
3192 ConstantRange Y = getSignedRange(UDiv->getRHS());
Dan Gohman52fddd32010-01-26 04:40:18 +00003193 return ConservativeResult.intersectWith(X.udiv(Y));
Dan Gohman85b05a22009-07-13 21:35:55 +00003194 }
Dan Gohman62849c02009-06-24 01:05:09 +00003195
Dan Gohman85b05a22009-07-13 21:35:55 +00003196 if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) {
3197 ConstantRange X = getSignedRange(ZExt->getOperand());
Dan Gohman52fddd32010-01-26 04:40:18 +00003198 return ConservativeResult.intersectWith(X.zeroExtend(BitWidth));
Dan Gohman85b05a22009-07-13 21:35:55 +00003199 }
3200
3201 if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) {
3202 ConstantRange X = getSignedRange(SExt->getOperand());
Dan Gohman52fddd32010-01-26 04:40:18 +00003203 return ConservativeResult.intersectWith(X.signExtend(BitWidth));
Dan Gohman85b05a22009-07-13 21:35:55 +00003204 }
3205
3206 if (const SCEVTruncateExpr *Trunc = dyn_cast<SCEVTruncateExpr>(S)) {
3207 ConstantRange X = getSignedRange(Trunc->getOperand());
Dan Gohman52fddd32010-01-26 04:40:18 +00003208 return ConservativeResult.intersectWith(X.truncate(BitWidth));
Dan Gohman85b05a22009-07-13 21:35:55 +00003209 }
3210
Dan Gohman85b05a22009-07-13 21:35:55 +00003211 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(S)) {
Dan Gohmana10756e2010-01-21 02:09:26 +00003212 // If there's no signed wrap, and all the operands have the same sign or
3213 // zero, the value won't ever change sign.
3214 if (AddRec->hasNoSignedWrap()) {
3215 bool AllNonNeg = true;
3216 bool AllNonPos = true;
3217 for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
3218 if (!isKnownNonNegative(AddRec->getOperand(i))) AllNonNeg = false;
3219 if (!isKnownNonPositive(AddRec->getOperand(i))) AllNonPos = false;
3220 }
Dan Gohmana10756e2010-01-21 02:09:26 +00003221 if (AllNonNeg)
Dan Gohman52fddd32010-01-26 04:40:18 +00003222 ConservativeResult = ConservativeResult.intersectWith(
3223 ConstantRange(APInt(BitWidth, 0),
3224 APInt::getSignedMinValue(BitWidth)));
Dan Gohmana10756e2010-01-21 02:09:26 +00003225 else if (AllNonPos)
Dan Gohman52fddd32010-01-26 04:40:18 +00003226 ConservativeResult = ConservativeResult.intersectWith(
3227 ConstantRange(APInt::getSignedMinValue(BitWidth),
3228 APInt(BitWidth, 1)));
Dan Gohmana10756e2010-01-21 02:09:26 +00003229 }
Dan Gohman85b05a22009-07-13 21:35:55 +00003230
3231 // TODO: non-affine addrec
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003232 if (AddRec->isAffine()) {
Dan Gohman85b05a22009-07-13 21:35:55 +00003233 const Type *Ty = AddRec->getType();
3234 const SCEV *MaxBECount = getMaxBackedgeTakenCount(AddRec->getLoop());
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003235 if (!isa<SCEVCouldNotCompute>(MaxBECount) &&
3236 getTypeSizeInBits(MaxBECount->getType()) <= BitWidth) {
Dan Gohman85b05a22009-07-13 21:35:55 +00003237 MaxBECount = getNoopOrZeroExtend(MaxBECount, Ty);
3238
3239 const SCEV *Start = AddRec->getStart();
Dan Gohman646e0472010-04-12 07:39:33 +00003240 const SCEV *Step = AddRec->getStepRecurrence(*this);
Dan Gohman85b05a22009-07-13 21:35:55 +00003241
3242 ConstantRange StartRange = getSignedRange(Start);
Dan Gohman646e0472010-04-12 07:39:33 +00003243 ConstantRange StepRange = getSignedRange(Step);
3244 ConstantRange MaxBECountRange = getUnsignedRange(MaxBECount);
3245 ConstantRange EndRange =
3246 StartRange.add(MaxBECountRange.multiply(StepRange));
3247
3248 // Check for overflow. This must be done with ConstantRange arithmetic
3249 // because we could be called from within the ScalarEvolution overflow
3250 // checking code.
3251 ConstantRange ExtStartRange = StartRange.sextOrTrunc(BitWidth*2+1);
3252 ConstantRange ExtStepRange = StepRange.sextOrTrunc(BitWidth*2+1);
3253 ConstantRange ExtMaxBECountRange =
3254 MaxBECountRange.zextOrTrunc(BitWidth*2+1);
3255 ConstantRange ExtEndRange = EndRange.sextOrTrunc(BitWidth*2+1);
3256 if (ExtStartRange.add(ExtMaxBECountRange.multiply(ExtStepRange)) !=
3257 ExtEndRange)
3258 return ConservativeResult;
3259
Dan Gohman85b05a22009-07-13 21:35:55 +00003260 APInt Min = APIntOps::smin(StartRange.getSignedMin(),
3261 EndRange.getSignedMin());
3262 APInt Max = APIntOps::smax(StartRange.getSignedMax(),
3263 EndRange.getSignedMax());
3264 if (Min.isMinSignedValue() && Max.isMaxSignedValue())
Dan Gohmana10756e2010-01-21 02:09:26 +00003265 return ConservativeResult;
Dan Gohman52fddd32010-01-26 04:40:18 +00003266 return ConservativeResult.intersectWith(ConstantRange(Min, Max+1));
Dan Gohman62849c02009-06-24 01:05:09 +00003267 }
Dan Gohman62849c02009-06-24 01:05:09 +00003268 }
Dan Gohmana10756e2010-01-21 02:09:26 +00003269
3270 return ConservativeResult;
Dan Gohman62849c02009-06-24 01:05:09 +00003271 }
3272
Dan Gohman2c364ad2009-06-19 23:29:04 +00003273 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
3274 // For a SCEVUnknown, ask ValueTracking.
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00003275 if (!U->getValue()->getType()->isIntegerTy() && !TD)
Dan Gohman52fddd32010-01-26 04:40:18 +00003276 return ConservativeResult;
Dan Gohman85b05a22009-07-13 21:35:55 +00003277 unsigned NS = ComputeNumSignBits(U->getValue(), TD);
3278 if (NS == 1)
Dan Gohman52fddd32010-01-26 04:40:18 +00003279 return ConservativeResult;
3280 return ConservativeResult.intersectWith(
Dan Gohman85b05a22009-07-13 21:35:55 +00003281 ConstantRange(APInt::getSignedMinValue(BitWidth).ashr(NS - 1),
Dan Gohman52fddd32010-01-26 04:40:18 +00003282 APInt::getSignedMaxValue(BitWidth).ashr(NS - 1)+1));
Dan Gohman2c364ad2009-06-19 23:29:04 +00003283 }
3284
Dan Gohman52fddd32010-01-26 04:40:18 +00003285 return ConservativeResult;
Dan Gohman2c364ad2009-06-19 23:29:04 +00003286}
3287
Chris Lattner53e677a2004-04-02 20:23:17 +00003288/// createSCEV - We know that there is no SCEV for the specified value.
3289/// Analyze the expression.
3290///
Dan Gohman0bba49c2009-07-07 17:06:11 +00003291const SCEV *ScalarEvolution::createSCEV(Value *V) {
Dan Gohmanaf79fb52009-04-21 01:07:12 +00003292 if (!isSCEVable(V->getType()))
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003293 return getUnknown(V);
Dan Gohman2d1be872009-04-16 03:18:22 +00003294
Dan Gohman6c459a22008-06-22 19:56:46 +00003295 unsigned Opcode = Instruction::UserOp1;
Dan Gohman4ecbca52010-03-09 23:46:50 +00003296 if (Instruction *I = dyn_cast<Instruction>(V)) {
Dan Gohman6c459a22008-06-22 19:56:46 +00003297 Opcode = I->getOpcode();
Dan Gohman4ecbca52010-03-09 23:46:50 +00003298
3299 // Don't attempt to analyze instructions in blocks that aren't
3300 // reachable. Such instructions don't matter, and they aren't required
3301 // to obey basic rules for definitions dominating uses which this
3302 // analysis depends on.
3303 if (!DT->isReachableFromEntry(I->getParent()))
3304 return getUnknown(V);
3305 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
Dan Gohman6c459a22008-06-22 19:56:46 +00003306 Opcode = CE->getOpcode();
Dan Gohman6bbcba12009-06-24 00:54:57 +00003307 else if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
3308 return getConstant(CI);
3309 else if (isa<ConstantPointerNull>(V))
Dan Gohmandeff6212010-05-03 22:09:21 +00003310 return getConstant(V->getType(), 0);
Dan Gohman26812322009-08-25 17:49:57 +00003311 else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
3312 return GA->mayBeOverridden() ? getUnknown(V) : getSCEV(GA->getAliasee());
Dan Gohman6c459a22008-06-22 19:56:46 +00003313 else
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003314 return getUnknown(V);
Chris Lattner2811f2a2007-04-02 05:41:38 +00003315
Dan Gohmanca178902009-07-17 20:47:02 +00003316 Operator *U = cast<Operator>(V);
Dan Gohman6c459a22008-06-22 19:56:46 +00003317 switch (Opcode) {
Dan Gohmand3f171d2010-08-16 16:03:49 +00003318 case Instruction::Add: {
3319 // The simple thing to do would be to just call getSCEV on both operands
3320 // and call getAddExpr with the result. However if we're looking at a
3321 // bunch of things all added together, this can be quite inefficient,
3322 // because it leads to N-1 getAddExpr calls for N ultimate operands.
3323 // Instead, gather up all the operands and make a single getAddExpr call.
3324 // LLVM IR canonical form means we need only traverse the left operands.
3325 SmallVector<const SCEV *, 4> AddOps;
3326 AddOps.push_back(getSCEV(U->getOperand(1)));
3327 for (Value *Op = U->getOperand(0);
3328 Op->getValueID() == Instruction::Add + Value::InstructionVal;
3329 Op = U->getOperand(0)) {
3330 U = cast<Operator>(Op);
3331 AddOps.push_back(getSCEV(U->getOperand(1)));
3332 }
3333 AddOps.push_back(getSCEV(U->getOperand(0)));
3334 return getAddExpr(AddOps);
3335 }
3336 case Instruction::Mul: {
3337 // See the Add code above.
3338 SmallVector<const SCEV *, 4> MulOps;
3339 MulOps.push_back(getSCEV(U->getOperand(1)));
3340 for (Value *Op = U->getOperand(0);
3341 Op->getValueID() == Instruction::Mul + Value::InstructionVal;
3342 Op = U->getOperand(0)) {
3343 U = cast<Operator>(Op);
3344 MulOps.push_back(getSCEV(U->getOperand(1)));
3345 }
3346 MulOps.push_back(getSCEV(U->getOperand(0)));
3347 return getMulExpr(MulOps);
3348 }
Dan Gohman6c459a22008-06-22 19:56:46 +00003349 case Instruction::UDiv:
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003350 return getUDivExpr(getSCEV(U->getOperand(0)),
3351 getSCEV(U->getOperand(1)));
Dan Gohman6c459a22008-06-22 19:56:46 +00003352 case Instruction::Sub:
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003353 return getMinusSCEV(getSCEV(U->getOperand(0)),
3354 getSCEV(U->getOperand(1)));
Dan Gohman4ee29af2009-04-21 02:26:00 +00003355 case Instruction::And:
3356 // For an expression like x&255 that merely masks off the high bits,
3357 // use zext(trunc(x)) as the SCEV expression.
3358 if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
Dan Gohman2c73d5f2009-04-25 17:05:40 +00003359 if (CI->isNullValue())
3360 return getSCEV(U->getOperand(1));
Dan Gohmand6c32952009-04-27 01:41:10 +00003361 if (CI->isAllOnesValue())
3362 return getSCEV(U->getOperand(0));
Dan Gohman4ee29af2009-04-21 02:26:00 +00003363 const APInt &A = CI->getValue();
Dan Gohman61ffa8e2009-06-16 19:52:01 +00003364
3365 // Instcombine's ShrinkDemandedConstant may strip bits out of
3366 // constants, obscuring what would otherwise be a low-bits mask.
3367 // Use ComputeMaskedBits to compute what ShrinkDemandedConstant
3368 // knew about to reconstruct a low-bits mask value.
3369 unsigned LZ = A.countLeadingZeros();
3370 unsigned BitWidth = A.getBitWidth();
3371 APInt AllOnes = APInt::getAllOnesValue(BitWidth);
3372 APInt KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
3373 ComputeMaskedBits(U->getOperand(0), AllOnes, KnownZero, KnownOne, TD);
3374
3375 APInt EffectiveMask = APInt::getLowBitsSet(BitWidth, BitWidth - LZ);
3376
Dan Gohmanfc3641b2009-06-17 23:54:37 +00003377 if (LZ != 0 && !((~A & ~KnownZero) & EffectiveMask))
Dan Gohman4ee29af2009-04-21 02:26:00 +00003378 return
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003379 getZeroExtendExpr(getTruncateExpr(getSCEV(U->getOperand(0)),
Owen Anderson1d0be152009-08-13 21:58:54 +00003380 IntegerType::get(getContext(), BitWidth - LZ)),
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003381 U->getType());
Dan Gohman4ee29af2009-04-21 02:26:00 +00003382 }
3383 break;
Dan Gohman61ffa8e2009-06-16 19:52:01 +00003384
Dan Gohman6c459a22008-06-22 19:56:46 +00003385 case Instruction::Or:
3386 // If the RHS of the Or is a constant, we may have something like:
3387 // X*4+1 which got turned into X*4|1. Handle this as an Add so loop
3388 // optimizations will transparently handle this case.
3389 //
3390 // In order for this transformation to be safe, the LHS must be of the
3391 // form X*(2^n) and the Or constant must be less than 2^n.
3392 if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00003393 const SCEV *LHS = getSCEV(U->getOperand(0));
Dan Gohman6c459a22008-06-22 19:56:46 +00003394 const APInt &CIVal = CI->getValue();
Dan Gohman2c364ad2009-06-19 23:29:04 +00003395 if (GetMinTrailingZeros(LHS) >=
Dan Gohman1f96e672009-09-17 18:05:20 +00003396 (CIVal.getBitWidth() - CIVal.countLeadingZeros())) {
3397 // Build a plain add SCEV.
3398 const SCEV *S = getAddExpr(LHS, getSCEV(CI));
3399 // If the LHS of the add was an addrec and it has no-wrap flags,
3400 // transfer the no-wrap flags, since an or won't introduce a wrap.
3401 if (const SCEVAddRecExpr *NewAR = dyn_cast<SCEVAddRecExpr>(S)) {
3402 const SCEVAddRecExpr *OldAR = cast<SCEVAddRecExpr>(LHS);
3403 if (OldAR->hasNoUnsignedWrap())
3404 const_cast<SCEVAddRecExpr *>(NewAR)->setHasNoUnsignedWrap(true);
3405 if (OldAR->hasNoSignedWrap())
3406 const_cast<SCEVAddRecExpr *>(NewAR)->setHasNoSignedWrap(true);
3407 }
3408 return S;
3409 }
Chris Lattner53e677a2004-04-02 20:23:17 +00003410 }
Dan Gohman6c459a22008-06-22 19:56:46 +00003411 break;
3412 case Instruction::Xor:
Dan Gohman6c459a22008-06-22 19:56:46 +00003413 if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
Nick Lewycky01eaf802008-07-07 06:15:49 +00003414 // If the RHS of the xor is a signbit, then this is just an add.
3415 // Instcombine turns add of signbit into xor as a strength reduction step.
Dan Gohman6c459a22008-06-22 19:56:46 +00003416 if (CI->getValue().isSignBit())
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003417 return getAddExpr(getSCEV(U->getOperand(0)),
3418 getSCEV(U->getOperand(1)));
Nick Lewycky01eaf802008-07-07 06:15:49 +00003419
3420 // If the RHS of xor is -1, then this is a not operation.
Dan Gohman0bac95e2009-05-18 16:17:44 +00003421 if (CI->isAllOnesValue())
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003422 return getNotSCEV(getSCEV(U->getOperand(0)));
Dan Gohman10978bd2009-05-18 16:29:04 +00003423
3424 // Model xor(and(x, C), C) as and(~x, C), if C is a low-bits mask.
3425 // This is a variant of the check for xor with -1, and it handles
3426 // the case where instcombine has trimmed non-demanded bits out
3427 // of an xor with -1.
3428 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U->getOperand(0)))
3429 if (ConstantInt *LCI = dyn_cast<ConstantInt>(BO->getOperand(1)))
3430 if (BO->getOpcode() == Instruction::And &&
3431 LCI->getValue() == CI->getValue())
3432 if (const SCEVZeroExtendExpr *Z =
Dan Gohman3034c102009-06-17 01:22:39 +00003433 dyn_cast<SCEVZeroExtendExpr>(getSCEV(U->getOperand(0)))) {
Dan Gohman82052832009-06-18 00:00:20 +00003434 const Type *UTy = U->getType();
Dan Gohman0bba49c2009-07-07 17:06:11 +00003435 const SCEV *Z0 = Z->getOperand();
Dan Gohman82052832009-06-18 00:00:20 +00003436 const Type *Z0Ty = Z0->getType();
3437 unsigned Z0TySize = getTypeSizeInBits(Z0Ty);
3438
Dan Gohman3f46a3a2010-03-01 17:49:51 +00003439 // If C is a low-bits mask, the zero extend is serving to
Dan Gohman82052832009-06-18 00:00:20 +00003440 // mask off the high bits. Complement the operand and
3441 // re-apply the zext.
3442 if (APIntOps::isMask(Z0TySize, CI->getValue()))
3443 return getZeroExtendExpr(getNotSCEV(Z0), UTy);
3444
3445 // If C is a single bit, it may be in the sign-bit position
3446 // before the zero-extend. In this case, represent the xor
3447 // using an add, which is equivalent, and re-apply the zext.
3448 APInt Trunc = APInt(CI->getValue()).trunc(Z0TySize);
3449 if (APInt(Trunc).zext(getTypeSizeInBits(UTy)) == CI->getValue() &&
3450 Trunc.isSignBit())
3451 return getZeroExtendExpr(getAddExpr(Z0, getConstant(Trunc)),
3452 UTy);
Dan Gohman3034c102009-06-17 01:22:39 +00003453 }
Dan Gohman6c459a22008-06-22 19:56:46 +00003454 }
3455 break;
3456
3457 case Instruction::Shl:
3458 // Turn shift left of a constant amount into a multiply.
3459 if (ConstantInt *SA = dyn_cast<ConstantInt>(U->getOperand(1))) {
Dan Gohman4f8eea82010-02-01 18:27:38 +00003460 uint32_t BitWidth = cast<IntegerType>(U->getType())->getBitWidth();
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00003461
3462 // If the shift count is not less than the bitwidth, the result of
3463 // the shift is undefined. Don't try to analyze it, because the
3464 // resolution chosen here may differ from the resolution chosen in
3465 // other parts of the compiler.
3466 if (SA->getValue().uge(BitWidth))
3467 break;
3468
Owen Andersoneed707b2009-07-24 23:12:02 +00003469 Constant *X = ConstantInt::get(getContext(),
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00003470 APInt(BitWidth, 1).shl(SA->getZExtValue()));
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003471 return getMulExpr(getSCEV(U->getOperand(0)), getSCEV(X));
Dan Gohman6c459a22008-06-22 19:56:46 +00003472 }
3473 break;
3474
Nick Lewycky01eaf802008-07-07 06:15:49 +00003475 case Instruction::LShr:
Nick Lewycky789558d2009-01-13 09:18:58 +00003476 // Turn logical shift right of a constant into a unsigned divide.
Nick Lewycky01eaf802008-07-07 06:15:49 +00003477 if (ConstantInt *SA = dyn_cast<ConstantInt>(U->getOperand(1))) {
Dan Gohman4f8eea82010-02-01 18:27:38 +00003478 uint32_t BitWidth = cast<IntegerType>(U->getType())->getBitWidth();
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00003479
3480 // If the shift count is not less than the bitwidth, the result of
3481 // the shift is undefined. Don't try to analyze it, because the
3482 // resolution chosen here may differ from the resolution chosen in
3483 // other parts of the compiler.
3484 if (SA->getValue().uge(BitWidth))
3485 break;
3486
Owen Andersoneed707b2009-07-24 23:12:02 +00003487 Constant *X = ConstantInt::get(getContext(),
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00003488 APInt(BitWidth, 1).shl(SA->getZExtValue()));
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003489 return getUDivExpr(getSCEV(U->getOperand(0)), getSCEV(X));
Nick Lewycky01eaf802008-07-07 06:15:49 +00003490 }
3491 break;
3492
Dan Gohman4ee29af2009-04-21 02:26:00 +00003493 case Instruction::AShr:
3494 // For a two-shift sext-inreg, use sext(trunc(x)) as the SCEV expression.
3495 if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1)))
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00003496 if (Operator *L = dyn_cast<Operator>(U->getOperand(0)))
Dan Gohman4ee29af2009-04-21 02:26:00 +00003497 if (L->getOpcode() == Instruction::Shl &&
3498 L->getOperand(1) == U->getOperand(1)) {
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00003499 uint64_t BitWidth = getTypeSizeInBits(U->getType());
3500
3501 // If the shift count is not less than the bitwidth, the result of
3502 // the shift is undefined. Don't try to analyze it, because the
3503 // resolution chosen here may differ from the resolution chosen in
3504 // other parts of the compiler.
3505 if (CI->getValue().uge(BitWidth))
3506 break;
3507
Dan Gohman2c73d5f2009-04-25 17:05:40 +00003508 uint64_t Amt = BitWidth - CI->getZExtValue();
3509 if (Amt == BitWidth)
3510 return getSCEV(L->getOperand(0)); // shift by zero --> noop
Dan Gohman4ee29af2009-04-21 02:26:00 +00003511 return
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003512 getSignExtendExpr(getTruncateExpr(getSCEV(L->getOperand(0)),
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00003513 IntegerType::get(getContext(),
3514 Amt)),
3515 U->getType());
Dan Gohman4ee29af2009-04-21 02:26:00 +00003516 }
3517 break;
3518
Dan Gohman6c459a22008-06-22 19:56:46 +00003519 case Instruction::Trunc:
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003520 return getTruncateExpr(getSCEV(U->getOperand(0)), U->getType());
Dan Gohman6c459a22008-06-22 19:56:46 +00003521
3522 case Instruction::ZExt:
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003523 return getZeroExtendExpr(getSCEV(U->getOperand(0)), U->getType());
Dan Gohman6c459a22008-06-22 19:56:46 +00003524
3525 case Instruction::SExt:
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003526 return getSignExtendExpr(getSCEV(U->getOperand(0)), U->getType());
Dan Gohman6c459a22008-06-22 19:56:46 +00003527
3528 case Instruction::BitCast:
3529 // BitCasts are no-op casts so we just eliminate the cast.
Dan Gohmanaf79fb52009-04-21 01:07:12 +00003530 if (isSCEVable(U->getType()) && isSCEVable(U->getOperand(0)->getType()))
Dan Gohman6c459a22008-06-22 19:56:46 +00003531 return getSCEV(U->getOperand(0));
3532 break;
3533
Dan Gohman4f8eea82010-02-01 18:27:38 +00003534 // It's tempting to handle inttoptr and ptrtoint as no-ops, however this can
3535 // lead to pointer expressions which cannot safely be expanded to GEPs,
3536 // because ScalarEvolution doesn't respect the GEP aliasing rules when
3537 // simplifying integer expressions.
Dan Gohman2d1be872009-04-16 03:18:22 +00003538
Dan Gohman26466c02009-05-08 20:26:55 +00003539 case Instruction::GetElementPtr:
Dan Gohmand281ed22009-12-18 02:09:29 +00003540 return createNodeForGEP(cast<GEPOperator>(U));
Dan Gohman2d1be872009-04-16 03:18:22 +00003541
Dan Gohman6c459a22008-06-22 19:56:46 +00003542 case Instruction::PHI:
3543 return createNodeForPHI(cast<PHINode>(U));
3544
3545 case Instruction::Select:
3546 // This could be a smax or umax that was lowered earlier.
3547 // Try to recover it.
3548 if (ICmpInst *ICI = dyn_cast<ICmpInst>(U->getOperand(0))) {
3549 Value *LHS = ICI->getOperand(0);
3550 Value *RHS = ICI->getOperand(1);
3551 switch (ICI->getPredicate()) {
3552 case ICmpInst::ICMP_SLT:
3553 case ICmpInst::ICMP_SLE:
3554 std::swap(LHS, RHS);
3555 // fall through
3556 case ICmpInst::ICMP_SGT:
3557 case ICmpInst::ICMP_SGE:
Dan Gohman9f93d302010-04-24 03:09:42 +00003558 // a >s b ? a+x : b+x -> smax(a, b)+x
3559 // a >s b ? b+x : a+x -> smin(a, b)+x
3560 if (LHS->getType() == U->getType()) {
3561 const SCEV *LS = getSCEV(LHS);
3562 const SCEV *RS = getSCEV(RHS);
3563 const SCEV *LA = getSCEV(U->getOperand(1));
3564 const SCEV *RA = getSCEV(U->getOperand(2));
3565 const SCEV *LDiff = getMinusSCEV(LA, LS);
3566 const SCEV *RDiff = getMinusSCEV(RA, RS);
3567 if (LDiff == RDiff)
3568 return getAddExpr(getSMaxExpr(LS, RS), LDiff);
3569 LDiff = getMinusSCEV(LA, RS);
3570 RDiff = getMinusSCEV(RA, LS);
3571 if (LDiff == RDiff)
3572 return getAddExpr(getSMinExpr(LS, RS), LDiff);
3573 }
Dan Gohman6c459a22008-06-22 19:56:46 +00003574 break;
3575 case ICmpInst::ICMP_ULT:
3576 case ICmpInst::ICMP_ULE:
3577 std::swap(LHS, RHS);
3578 // fall through
3579 case ICmpInst::ICMP_UGT:
3580 case ICmpInst::ICMP_UGE:
Dan Gohman9f93d302010-04-24 03:09:42 +00003581 // a >u b ? a+x : b+x -> umax(a, b)+x
3582 // a >u b ? b+x : a+x -> umin(a, b)+x
3583 if (LHS->getType() == U->getType()) {
3584 const SCEV *LS = getSCEV(LHS);
3585 const SCEV *RS = getSCEV(RHS);
3586 const SCEV *LA = getSCEV(U->getOperand(1));
3587 const SCEV *RA = getSCEV(U->getOperand(2));
3588 const SCEV *LDiff = getMinusSCEV(LA, LS);
3589 const SCEV *RDiff = getMinusSCEV(RA, RS);
3590 if (LDiff == RDiff)
3591 return getAddExpr(getUMaxExpr(LS, RS), LDiff);
3592 LDiff = getMinusSCEV(LA, RS);
3593 RDiff = getMinusSCEV(RA, LS);
3594 if (LDiff == RDiff)
3595 return getAddExpr(getUMinExpr(LS, RS), LDiff);
3596 }
Dan Gohman6c459a22008-06-22 19:56:46 +00003597 break;
Dan Gohman30fb5122009-06-18 20:21:07 +00003598 case ICmpInst::ICMP_NE:
Dan Gohman9f93d302010-04-24 03:09:42 +00003599 // n != 0 ? n+x : 1+x -> umax(n, 1)+x
3600 if (LHS->getType() == U->getType() &&
Dan Gohman30fb5122009-06-18 20:21:07 +00003601 isa<ConstantInt>(RHS) &&
Dan Gohman9f93d302010-04-24 03:09:42 +00003602 cast<ConstantInt>(RHS)->isZero()) {
3603 const SCEV *One = getConstant(LHS->getType(), 1);
3604 const SCEV *LS = getSCEV(LHS);
3605 const SCEV *LA = getSCEV(U->getOperand(1));
3606 const SCEV *RA = getSCEV(U->getOperand(2));
3607 const SCEV *LDiff = getMinusSCEV(LA, LS);
3608 const SCEV *RDiff = getMinusSCEV(RA, One);
3609 if (LDiff == RDiff)
Dan Gohman58a85b92010-08-13 20:17:14 +00003610 return getAddExpr(getUMaxExpr(One, LS), LDiff);
Dan Gohman9f93d302010-04-24 03:09:42 +00003611 }
Dan Gohman30fb5122009-06-18 20:21:07 +00003612 break;
3613 case ICmpInst::ICMP_EQ:
Dan Gohman9f93d302010-04-24 03:09:42 +00003614 // n == 0 ? 1+x : n+x -> umax(n, 1)+x
3615 if (LHS->getType() == U->getType() &&
Dan Gohman30fb5122009-06-18 20:21:07 +00003616 isa<ConstantInt>(RHS) &&
Dan Gohman9f93d302010-04-24 03:09:42 +00003617 cast<ConstantInt>(RHS)->isZero()) {
3618 const SCEV *One = getConstant(LHS->getType(), 1);
3619 const SCEV *LS = getSCEV(LHS);
3620 const SCEV *LA = getSCEV(U->getOperand(1));
3621 const SCEV *RA = getSCEV(U->getOperand(2));
3622 const SCEV *LDiff = getMinusSCEV(LA, One);
3623 const SCEV *RDiff = getMinusSCEV(RA, LS);
3624 if (LDiff == RDiff)
Dan Gohman58a85b92010-08-13 20:17:14 +00003625 return getAddExpr(getUMaxExpr(One, LS), LDiff);
Dan Gohman9f93d302010-04-24 03:09:42 +00003626 }
Dan Gohman30fb5122009-06-18 20:21:07 +00003627 break;
Dan Gohman6c459a22008-06-22 19:56:46 +00003628 default:
3629 break;
3630 }
3631 }
3632
3633 default: // We cannot analyze this expression.
3634 break;
Chris Lattner53e677a2004-04-02 20:23:17 +00003635 }
3636
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003637 return getUnknown(V);
Chris Lattner53e677a2004-04-02 20:23:17 +00003638}
3639
3640
3641
3642//===----------------------------------------------------------------------===//
3643// Iteration Count Computation Code
3644//
3645
Dan Gohman46bdfb02009-02-24 18:55:53 +00003646/// getBackedgeTakenCount - If the specified loop has a predictable
3647/// backedge-taken count, return it, otherwise return a SCEVCouldNotCompute
3648/// object. The backedge-taken count is the number of times the loop header
3649/// will be branched to from within the loop. This is one less than the
3650/// trip count of the loop, since it doesn't count the first iteration,
3651/// when the header is branched to from outside the loop.
3652///
3653/// Note that it is not valid to call this method on a loop without a
3654/// loop-invariant backedge-taken count (see
3655/// hasLoopInvariantBackedgeTakenCount).
3656///
Dan Gohman0bba49c2009-07-07 17:06:11 +00003657const SCEV *ScalarEvolution::getBackedgeTakenCount(const Loop *L) {
Dan Gohmana1af7572009-04-30 20:47:05 +00003658 return getBackedgeTakenInfo(L).Exact;
3659}
3660
3661/// getMaxBackedgeTakenCount - Similar to getBackedgeTakenCount, except
3662/// return the least SCEV value that is known never to be less than the
3663/// actual backedge taken count.
Dan Gohman0bba49c2009-07-07 17:06:11 +00003664const SCEV *ScalarEvolution::getMaxBackedgeTakenCount(const Loop *L) {
Dan Gohmana1af7572009-04-30 20:47:05 +00003665 return getBackedgeTakenInfo(L).Max;
3666}
3667
Dan Gohman59ae6b92009-07-08 19:23:34 +00003668/// PushLoopPHIs - Push PHI nodes in the header of the given loop
3669/// onto the given Worklist.
3670static void
3671PushLoopPHIs(const Loop *L, SmallVectorImpl<Instruction *> &Worklist) {
3672 BasicBlock *Header = L->getHeader();
3673
3674 // Push all Loop-header PHIs onto the Worklist stack.
3675 for (BasicBlock::iterator I = Header->begin();
3676 PHINode *PN = dyn_cast<PHINode>(I); ++I)
3677 Worklist.push_back(PN);
3678}
3679
Dan Gohmana1af7572009-04-30 20:47:05 +00003680const ScalarEvolution::BackedgeTakenInfo &
3681ScalarEvolution::getBackedgeTakenInfo(const Loop *L) {
Dan Gohman01ecca22009-04-27 20:16:15 +00003682 // Initially insert a CouldNotCompute for this loop. If the insertion
Dan Gohman3f46a3a2010-03-01 17:49:51 +00003683 // succeeds, proceed to actually compute a backedge-taken count and
Dan Gohman01ecca22009-04-27 20:16:15 +00003684 // update the value. The temporary CouldNotCompute value tells SCEV
3685 // code elsewhere that it shouldn't attempt to request a new
3686 // backedge-taken count, which could result in infinite recursion.
Dan Gohman5d984912009-12-18 01:14:11 +00003687 std::pair<std::map<const Loop *, BackedgeTakenInfo>::iterator, bool> Pair =
Dan Gohman01ecca22009-04-27 20:16:15 +00003688 BackedgeTakenCounts.insert(std::make_pair(L, getCouldNotCompute()));
3689 if (Pair.second) {
Dan Gohman93dacad2010-01-26 16:46:18 +00003690 BackedgeTakenInfo BECount = ComputeBackedgeTakenCount(L);
3691 if (BECount.Exact != getCouldNotCompute()) {
3692 assert(BECount.Exact->isLoopInvariant(L) &&
3693 BECount.Max->isLoopInvariant(L) &&
3694 "Computed backedge-taken count isn't loop invariant for loop!");
Chris Lattner53e677a2004-04-02 20:23:17 +00003695 ++NumTripCountsComputed;
Dan Gohman01ecca22009-04-27 20:16:15 +00003696
Dan Gohman01ecca22009-04-27 20:16:15 +00003697 // Update the value in the map.
Dan Gohman93dacad2010-01-26 16:46:18 +00003698 Pair.first->second = BECount;
Dan Gohmana334aa72009-06-22 00:31:57 +00003699 } else {
Dan Gohman93dacad2010-01-26 16:46:18 +00003700 if (BECount.Max != getCouldNotCompute())
Dan Gohmana334aa72009-06-22 00:31:57 +00003701 // Update the value in the map.
Dan Gohman93dacad2010-01-26 16:46:18 +00003702 Pair.first->second = BECount;
Dan Gohmana334aa72009-06-22 00:31:57 +00003703 if (isa<PHINode>(L->getHeader()->begin()))
3704 // Only count loops that have phi nodes as not being computable.
3705 ++NumTripCountsNotComputed;
Chris Lattner53e677a2004-04-02 20:23:17 +00003706 }
Dan Gohmana1af7572009-04-30 20:47:05 +00003707
3708 // Now that we know more about the trip count for this loop, forget any
3709 // existing SCEV values for PHI nodes in this loop since they are only
Dan Gohman59ae6b92009-07-08 19:23:34 +00003710 // conservative estimates made without the benefit of trip count
Dan Gohman4c7279a2009-10-31 15:04:55 +00003711 // information. This is similar to the code in forgetLoop, except that
3712 // it handles SCEVUnknown PHI nodes specially.
Dan Gohman93dacad2010-01-26 16:46:18 +00003713 if (BECount.hasAnyInfo()) {
Dan Gohman59ae6b92009-07-08 19:23:34 +00003714 SmallVector<Instruction *, 16> Worklist;
3715 PushLoopPHIs(L, Worklist);
3716
3717 SmallPtrSet<Instruction *, 8> Visited;
3718 while (!Worklist.empty()) {
3719 Instruction *I = Worklist.pop_back_val();
3720 if (!Visited.insert(I)) continue;
3721
Dan Gohmane8ac3f32010-08-27 18:55:03 +00003722 ValueExprMapType::iterator It =
3723 ValueExprMap.find(static_cast<Value *>(I));
3724 if (It != ValueExprMap.end()) {
Dan Gohman59ae6b92009-07-08 19:23:34 +00003725 // SCEVUnknown for a PHI either means that it has an unrecognized
3726 // structure, or it's a PHI that's in the progress of being computed
Dan Gohmanba701882009-07-13 22:04:06 +00003727 // by createNodeForPHI. In the former case, additional loop trip
3728 // count information isn't going to change anything. In the later
3729 // case, createNodeForPHI will perform the necessary updates on its
3730 // own when it gets to that point.
Dan Gohman42214892009-08-31 21:15:23 +00003731 if (!isa<PHINode>(I) || !isa<SCEVUnknown>(It->second)) {
3732 ValuesAtScopes.erase(It->second);
Dan Gohmane8ac3f32010-08-27 18:55:03 +00003733 ValueExprMap.erase(It);
Dan Gohman42214892009-08-31 21:15:23 +00003734 }
Dan Gohman59ae6b92009-07-08 19:23:34 +00003735 if (PHINode *PN = dyn_cast<PHINode>(I))
3736 ConstantEvolutionLoopExitValue.erase(PN);
3737 }
3738
3739 PushDefUseChildren(I, Worklist);
3740 }
3741 }
Chris Lattner53e677a2004-04-02 20:23:17 +00003742 }
Dan Gohman01ecca22009-04-27 20:16:15 +00003743 return Pair.first->second;
Chris Lattner53e677a2004-04-02 20:23:17 +00003744}
3745
Dan Gohman4c7279a2009-10-31 15:04:55 +00003746/// forgetLoop - This method should be called by the client when it has
3747/// changed a loop in a way that may effect ScalarEvolution's ability to
3748/// compute a trip count, or if the loop is deleted.
3749void ScalarEvolution::forgetLoop(const Loop *L) {
3750 // Drop any stored trip count value.
Dan Gohman46bdfb02009-02-24 18:55:53 +00003751 BackedgeTakenCounts.erase(L);
Dan Gohmanfb7d35f2009-05-02 17:43:35 +00003752
Dan Gohman4c7279a2009-10-31 15:04:55 +00003753 // Drop information about expressions based on loop-header PHIs.
Dan Gohman35738ac2009-05-04 22:30:44 +00003754 SmallVector<Instruction *, 16> Worklist;
Dan Gohman59ae6b92009-07-08 19:23:34 +00003755 PushLoopPHIs(L, Worklist);
Dan Gohman35738ac2009-05-04 22:30:44 +00003756
Dan Gohman59ae6b92009-07-08 19:23:34 +00003757 SmallPtrSet<Instruction *, 8> Visited;
Dan Gohman35738ac2009-05-04 22:30:44 +00003758 while (!Worklist.empty()) {
3759 Instruction *I = Worklist.pop_back_val();
Dan Gohman59ae6b92009-07-08 19:23:34 +00003760 if (!Visited.insert(I)) continue;
3761
Dan Gohmane8ac3f32010-08-27 18:55:03 +00003762 ValueExprMapType::iterator It = ValueExprMap.find(static_cast<Value *>(I));
3763 if (It != ValueExprMap.end()) {
Dan Gohman42214892009-08-31 21:15:23 +00003764 ValuesAtScopes.erase(It->second);
Dan Gohmane8ac3f32010-08-27 18:55:03 +00003765 ValueExprMap.erase(It);
Dan Gohman59ae6b92009-07-08 19:23:34 +00003766 if (PHINode *PN = dyn_cast<PHINode>(I))
3767 ConstantEvolutionLoopExitValue.erase(PN);
3768 }
3769
3770 PushDefUseChildren(I, Worklist);
Dan Gohman35738ac2009-05-04 22:30:44 +00003771 }
Dan Gohman60f8a632009-02-17 20:49:49 +00003772}
3773
Eric Christophere6cbfa62010-07-29 01:25:38 +00003774/// forgetValue - This method should be called by the client when it has
3775/// changed a value in a way that may effect its value, or which may
3776/// disconnect it from a def-use chain linking it to a loop.
3777void ScalarEvolution::forgetValue(Value *V) {
Dale Johannesen45a2d7d2010-02-19 07:14:22 +00003778 Instruction *I = dyn_cast<Instruction>(V);
3779 if (!I) return;
3780
3781 // Drop information about expressions based on loop-header PHIs.
3782 SmallVector<Instruction *, 16> Worklist;
3783 Worklist.push_back(I);
3784
3785 SmallPtrSet<Instruction *, 8> Visited;
3786 while (!Worklist.empty()) {
3787 I = Worklist.pop_back_val();
3788 if (!Visited.insert(I)) continue;
3789
Dan Gohmane8ac3f32010-08-27 18:55:03 +00003790 ValueExprMapType::iterator It = ValueExprMap.find(static_cast<Value *>(I));
3791 if (It != ValueExprMap.end()) {
Dale Johannesen45a2d7d2010-02-19 07:14:22 +00003792 ValuesAtScopes.erase(It->second);
Dan Gohmane8ac3f32010-08-27 18:55:03 +00003793 ValueExprMap.erase(It);
Dale Johannesen45a2d7d2010-02-19 07:14:22 +00003794 if (PHINode *PN = dyn_cast<PHINode>(I))
3795 ConstantEvolutionLoopExitValue.erase(PN);
3796 }
3797
3798 PushDefUseChildren(I, Worklist);
3799 }
3800}
3801
Dan Gohman46bdfb02009-02-24 18:55:53 +00003802/// ComputeBackedgeTakenCount - Compute the number of times the backedge
3803/// of the specified loop will execute.
Dan Gohmana1af7572009-04-30 20:47:05 +00003804ScalarEvolution::BackedgeTakenInfo
3805ScalarEvolution::ComputeBackedgeTakenCount(const Loop *L) {
Dan Gohman5d984912009-12-18 01:14:11 +00003806 SmallVector<BasicBlock *, 8> ExitingBlocks;
Dan Gohmana334aa72009-06-22 00:31:57 +00003807 L->getExitingBlocks(ExitingBlocks);
Chris Lattner53e677a2004-04-02 20:23:17 +00003808
Dan Gohmana334aa72009-06-22 00:31:57 +00003809 // Examine all exits and pick the most conservative values.
Dan Gohman0bba49c2009-07-07 17:06:11 +00003810 const SCEV *BECount = getCouldNotCompute();
3811 const SCEV *MaxBECount = getCouldNotCompute();
Dan Gohmana334aa72009-06-22 00:31:57 +00003812 bool CouldNotComputeBECount = false;
Dan Gohmana334aa72009-06-22 00:31:57 +00003813 for (unsigned i = 0, e = ExitingBlocks.size(); i != e; ++i) {
3814 BackedgeTakenInfo NewBTI =
3815 ComputeBackedgeTakenCountFromExit(L, ExitingBlocks[i]);
Chris Lattner53e677a2004-04-02 20:23:17 +00003816
Dan Gohman1c343752009-06-27 21:21:31 +00003817 if (NewBTI.Exact == getCouldNotCompute()) {
Dan Gohmana334aa72009-06-22 00:31:57 +00003818 // We couldn't compute an exact value for this exit, so
Dan Gohmand32f5bf2009-06-22 21:10:22 +00003819 // we won't be able to compute an exact value for the loop.
Dan Gohmana334aa72009-06-22 00:31:57 +00003820 CouldNotComputeBECount = true;
Dan Gohman1c343752009-06-27 21:21:31 +00003821 BECount = getCouldNotCompute();
Dan Gohmana334aa72009-06-22 00:31:57 +00003822 } else if (!CouldNotComputeBECount) {
Dan Gohman1c343752009-06-27 21:21:31 +00003823 if (BECount == getCouldNotCompute())
Dan Gohmana334aa72009-06-22 00:31:57 +00003824 BECount = NewBTI.Exact;
Dan Gohmana334aa72009-06-22 00:31:57 +00003825 else
Dan Gohman40a5a1b2009-06-24 01:18:18 +00003826 BECount = getUMinFromMismatchedTypes(BECount, NewBTI.Exact);
Dan Gohmana334aa72009-06-22 00:31:57 +00003827 }
Dan Gohman1c343752009-06-27 21:21:31 +00003828 if (MaxBECount == getCouldNotCompute())
Dan Gohman40a5a1b2009-06-24 01:18:18 +00003829 MaxBECount = NewBTI.Max;
Dan Gohman1c343752009-06-27 21:21:31 +00003830 else if (NewBTI.Max != getCouldNotCompute())
Dan Gohman40a5a1b2009-06-24 01:18:18 +00003831 MaxBECount = getUMinFromMismatchedTypes(MaxBECount, NewBTI.Max);
Dan Gohmana334aa72009-06-22 00:31:57 +00003832 }
3833
3834 return BackedgeTakenInfo(BECount, MaxBECount);
3835}
3836
3837/// ComputeBackedgeTakenCountFromExit - Compute the number of times the backedge
3838/// of the specified loop will execute if it exits via the specified block.
3839ScalarEvolution::BackedgeTakenInfo
3840ScalarEvolution::ComputeBackedgeTakenCountFromExit(const Loop *L,
3841 BasicBlock *ExitingBlock) {
3842
3843 // Okay, we've chosen an exiting block. See what condition causes us to
3844 // exit at this block.
Chris Lattner53e677a2004-04-02 20:23:17 +00003845 //
3846 // FIXME: we should be able to handle switch instructions (with a single exit)
Chris Lattner53e677a2004-04-02 20:23:17 +00003847 BranchInst *ExitBr = dyn_cast<BranchInst>(ExitingBlock->getTerminator());
Dan Gohman1c343752009-06-27 21:21:31 +00003848 if (ExitBr == 0) return getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00003849 assert(ExitBr->isConditional() && "If unconditional, it can't be in loop!");
Dan Gohman64a845e2009-06-24 04:48:43 +00003850
Chris Lattner8b0e3602007-01-07 02:24:26 +00003851 // At this point, we know we have a conditional branch that determines whether
3852 // the loop is exited. However, we don't know if the branch is executed each
3853 // time through the loop. If not, then the execution count of the branch will
3854 // not be equal to the trip count of the loop.
3855 //
3856 // Currently we check for this by checking to see if the Exit branch goes to
3857 // the loop header. If so, we know it will always execute the same number of
Chris Lattner192e4032007-01-14 01:24:47 +00003858 // times as the loop. We also handle the case where the exit block *is* the
Dan Gohmana334aa72009-06-22 00:31:57 +00003859 // loop header. This is common for un-rotated loops.
3860 //
3861 // If both of those tests fail, walk up the unique predecessor chain to the
3862 // header, stopping if there is an edge that doesn't exit the loop. If the
3863 // header is reached, the execution count of the branch will be equal to the
3864 // trip count of the loop.
3865 //
3866 // More extensive analysis could be done to handle more cases here.
3867 //
Chris Lattner8b0e3602007-01-07 02:24:26 +00003868 if (ExitBr->getSuccessor(0) != L->getHeader() &&
Chris Lattner192e4032007-01-14 01:24:47 +00003869 ExitBr->getSuccessor(1) != L->getHeader() &&
Dan Gohmana334aa72009-06-22 00:31:57 +00003870 ExitBr->getParent() != L->getHeader()) {
3871 // The simple checks failed, try climbing the unique predecessor chain
3872 // up to the header.
3873 bool Ok = false;
3874 for (BasicBlock *BB = ExitBr->getParent(); BB; ) {
3875 BasicBlock *Pred = BB->getUniquePredecessor();
3876 if (!Pred)
Dan Gohman1c343752009-06-27 21:21:31 +00003877 return getCouldNotCompute();
Dan Gohmana334aa72009-06-22 00:31:57 +00003878 TerminatorInst *PredTerm = Pred->getTerminator();
3879 for (unsigned i = 0, e = PredTerm->getNumSuccessors(); i != e; ++i) {
3880 BasicBlock *PredSucc = PredTerm->getSuccessor(i);
3881 if (PredSucc == BB)
3882 continue;
3883 // If the predecessor has a successor that isn't BB and isn't
3884 // outside the loop, assume the worst.
3885 if (L->contains(PredSucc))
Dan Gohman1c343752009-06-27 21:21:31 +00003886 return getCouldNotCompute();
Dan Gohmana334aa72009-06-22 00:31:57 +00003887 }
3888 if (Pred == L->getHeader()) {
3889 Ok = true;
3890 break;
3891 }
3892 BB = Pred;
3893 }
3894 if (!Ok)
Dan Gohman1c343752009-06-27 21:21:31 +00003895 return getCouldNotCompute();
Dan Gohmana334aa72009-06-22 00:31:57 +00003896 }
3897
Dan Gohman3f46a3a2010-03-01 17:49:51 +00003898 // Proceed to the next level to examine the exit condition expression.
Dan Gohmana334aa72009-06-22 00:31:57 +00003899 return ComputeBackedgeTakenCountFromExitCond(L, ExitBr->getCondition(),
3900 ExitBr->getSuccessor(0),
3901 ExitBr->getSuccessor(1));
3902}
3903
3904/// ComputeBackedgeTakenCountFromExitCond - Compute the number of times the
3905/// backedge of the specified loop will execute if its exit condition
3906/// were a conditional branch of ExitCond, TBB, and FBB.
3907ScalarEvolution::BackedgeTakenInfo
3908ScalarEvolution::ComputeBackedgeTakenCountFromExitCond(const Loop *L,
3909 Value *ExitCond,
3910 BasicBlock *TBB,
3911 BasicBlock *FBB) {
Dan Gohman40a5a1b2009-06-24 01:18:18 +00003912 // Check if the controlling expression for this loop is an And or Or.
Dan Gohmana334aa72009-06-22 00:31:57 +00003913 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(ExitCond)) {
3914 if (BO->getOpcode() == Instruction::And) {
3915 // Recurse on the operands of the and.
3916 BackedgeTakenInfo BTI0 =
3917 ComputeBackedgeTakenCountFromExitCond(L, BO->getOperand(0), TBB, FBB);
3918 BackedgeTakenInfo BTI1 =
3919 ComputeBackedgeTakenCountFromExitCond(L, BO->getOperand(1), TBB, FBB);
Dan Gohman0bba49c2009-07-07 17:06:11 +00003920 const SCEV *BECount = getCouldNotCompute();
3921 const SCEV *MaxBECount = getCouldNotCompute();
Dan Gohmana334aa72009-06-22 00:31:57 +00003922 if (L->contains(TBB)) {
3923 // Both conditions must be true for the loop to continue executing.
3924 // Choose the less conservative count.
Dan Gohman1c343752009-06-27 21:21:31 +00003925 if (BTI0.Exact == getCouldNotCompute() ||
3926 BTI1.Exact == getCouldNotCompute())
3927 BECount = getCouldNotCompute();
Dan Gohman60e9b072009-06-22 15:09:28 +00003928 else
3929 BECount = getUMinFromMismatchedTypes(BTI0.Exact, BTI1.Exact);
Dan Gohman1c343752009-06-27 21:21:31 +00003930 if (BTI0.Max == getCouldNotCompute())
Dan Gohmana334aa72009-06-22 00:31:57 +00003931 MaxBECount = BTI1.Max;
Dan Gohman1c343752009-06-27 21:21:31 +00003932 else if (BTI1.Max == getCouldNotCompute())
Dan Gohmana334aa72009-06-22 00:31:57 +00003933 MaxBECount = BTI0.Max;
Dan Gohman60e9b072009-06-22 15:09:28 +00003934 else
3935 MaxBECount = getUMinFromMismatchedTypes(BTI0.Max, BTI1.Max);
Dan Gohmana334aa72009-06-22 00:31:57 +00003936 } else {
Dan Gohman4ee87392010-08-11 00:12:36 +00003937 // Both conditions must be true at the same time for the loop to exit.
3938 // For now, be conservative.
Dan Gohmana334aa72009-06-22 00:31:57 +00003939 assert(L->contains(FBB) && "Loop block has no successor in loop!");
Dan Gohman4ee87392010-08-11 00:12:36 +00003940 if (BTI0.Max == BTI1.Max)
3941 MaxBECount = BTI0.Max;
3942 if (BTI0.Exact == BTI1.Exact)
3943 BECount = BTI0.Exact;
Dan Gohmana334aa72009-06-22 00:31:57 +00003944 }
3945
3946 return BackedgeTakenInfo(BECount, MaxBECount);
3947 }
3948 if (BO->getOpcode() == Instruction::Or) {
3949 // Recurse on the operands of the or.
3950 BackedgeTakenInfo BTI0 =
3951 ComputeBackedgeTakenCountFromExitCond(L, BO->getOperand(0), TBB, FBB);
3952 BackedgeTakenInfo BTI1 =
3953 ComputeBackedgeTakenCountFromExitCond(L, BO->getOperand(1), TBB, FBB);
Dan Gohman0bba49c2009-07-07 17:06:11 +00003954 const SCEV *BECount = getCouldNotCompute();
3955 const SCEV *MaxBECount = getCouldNotCompute();
Dan Gohmana334aa72009-06-22 00:31:57 +00003956 if (L->contains(FBB)) {
3957 // Both conditions must be false for the loop to continue executing.
3958 // Choose the less conservative count.
Dan Gohman1c343752009-06-27 21:21:31 +00003959 if (BTI0.Exact == getCouldNotCompute() ||
3960 BTI1.Exact == getCouldNotCompute())
3961 BECount = getCouldNotCompute();
Dan Gohman60e9b072009-06-22 15:09:28 +00003962 else
3963 BECount = getUMinFromMismatchedTypes(BTI0.Exact, BTI1.Exact);
Dan Gohman1c343752009-06-27 21:21:31 +00003964 if (BTI0.Max == getCouldNotCompute())
Dan Gohmana334aa72009-06-22 00:31:57 +00003965 MaxBECount = BTI1.Max;
Dan Gohman1c343752009-06-27 21:21:31 +00003966 else if (BTI1.Max == getCouldNotCompute())
Dan Gohmana334aa72009-06-22 00:31:57 +00003967 MaxBECount = BTI0.Max;
Dan Gohman60e9b072009-06-22 15:09:28 +00003968 else
3969 MaxBECount = getUMinFromMismatchedTypes(BTI0.Max, BTI1.Max);
Dan Gohmana334aa72009-06-22 00:31:57 +00003970 } else {
Dan Gohman4ee87392010-08-11 00:12:36 +00003971 // Both conditions must be false at the same time for the loop to exit.
3972 // For now, be conservative.
Dan Gohmana334aa72009-06-22 00:31:57 +00003973 assert(L->contains(TBB) && "Loop block has no successor in loop!");
Dan Gohman4ee87392010-08-11 00:12:36 +00003974 if (BTI0.Max == BTI1.Max)
3975 MaxBECount = BTI0.Max;
3976 if (BTI0.Exact == BTI1.Exact)
3977 BECount = BTI0.Exact;
Dan Gohmana334aa72009-06-22 00:31:57 +00003978 }
3979
3980 return BackedgeTakenInfo(BECount, MaxBECount);
3981 }
3982 }
3983
3984 // With an icmp, it may be feasible to compute an exact backedge-taken count.
Dan Gohman3f46a3a2010-03-01 17:49:51 +00003985 // Proceed to the next level to examine the icmp.
Dan Gohmana334aa72009-06-22 00:31:57 +00003986 if (ICmpInst *ExitCondICmp = dyn_cast<ICmpInst>(ExitCond))
3987 return ComputeBackedgeTakenCountFromExitCondICmp(L, ExitCondICmp, TBB, FBB);
Reid Spencere4d87aa2006-12-23 06:05:41 +00003988
Dan Gohman00cb5b72010-02-19 18:12:07 +00003989 // Check for a constant condition. These are normally stripped out by
3990 // SimplifyCFG, but ScalarEvolution may be used by a pass which wishes to
3991 // preserve the CFG and is temporarily leaving constant conditions
3992 // in place.
3993 if (ConstantInt *CI = dyn_cast<ConstantInt>(ExitCond)) {
3994 if (L->contains(FBB) == !CI->getZExtValue())
3995 // The backedge is always taken.
3996 return getCouldNotCompute();
3997 else
3998 // The backedge is never taken.
Dan Gohmandeff6212010-05-03 22:09:21 +00003999 return getConstant(CI->getType(), 0);
Dan Gohman00cb5b72010-02-19 18:12:07 +00004000 }
4001
Eli Friedman361e54d2009-05-09 12:32:42 +00004002 // If it's not an integer or pointer comparison then compute it the hard way.
Dan Gohmana334aa72009-06-22 00:31:57 +00004003 return ComputeBackedgeTakenCountExhaustively(L, ExitCond, !L->contains(TBB));
4004}
4005
4006/// ComputeBackedgeTakenCountFromExitCondICmp - Compute the number of times the
4007/// backedge of the specified loop will execute if its exit condition
4008/// were a conditional branch of the ICmpInst ExitCond, TBB, and FBB.
4009ScalarEvolution::BackedgeTakenInfo
4010ScalarEvolution::ComputeBackedgeTakenCountFromExitCondICmp(const Loop *L,
4011 ICmpInst *ExitCond,
4012 BasicBlock *TBB,
4013 BasicBlock *FBB) {
Chris Lattner53e677a2004-04-02 20:23:17 +00004014
Reid Spencere4d87aa2006-12-23 06:05:41 +00004015 // If the condition was exit on true, convert the condition to exit on false
4016 ICmpInst::Predicate Cond;
Dan Gohmana334aa72009-06-22 00:31:57 +00004017 if (!L->contains(FBB))
Reid Spencere4d87aa2006-12-23 06:05:41 +00004018 Cond = ExitCond->getPredicate();
Chris Lattner673e02b2004-10-12 01:49:27 +00004019 else
Reid Spencere4d87aa2006-12-23 06:05:41 +00004020 Cond = ExitCond->getInversePredicate();
Chris Lattner673e02b2004-10-12 01:49:27 +00004021
4022 // Handle common loops like: for (X = "string"; *X; ++X)
4023 if (LoadInst *LI = dyn_cast<LoadInst>(ExitCond->getOperand(0)))
4024 if (Constant *RHS = dyn_cast<Constant>(ExitCond->getOperand(1))) {
Dan Gohmanf6d009f2010-02-24 17:31:30 +00004025 BackedgeTakenInfo ItCnt =
Dan Gohman46bdfb02009-02-24 18:55:53 +00004026 ComputeLoadConstantCompareBackedgeTakenCount(LI, RHS, L, Cond);
Dan Gohmanf6d009f2010-02-24 17:31:30 +00004027 if (ItCnt.hasAnyInfo())
4028 return ItCnt;
Chris Lattner673e02b2004-10-12 01:49:27 +00004029 }
4030
Dan Gohman0bba49c2009-07-07 17:06:11 +00004031 const SCEV *LHS = getSCEV(ExitCond->getOperand(0));
4032 const SCEV *RHS = getSCEV(ExitCond->getOperand(1));
Chris Lattner53e677a2004-04-02 20:23:17 +00004033
4034 // Try to evaluate any dependencies out of the loop.
Dan Gohmand594e6f2009-05-24 23:25:42 +00004035 LHS = getSCEVAtScope(LHS, L);
4036 RHS = getSCEVAtScope(RHS, L);
Chris Lattner53e677a2004-04-02 20:23:17 +00004037
Dan Gohman64a845e2009-06-24 04:48:43 +00004038 // At this point, we would like to compute how many iterations of the
Reid Spencere4d87aa2006-12-23 06:05:41 +00004039 // loop the predicate will return true for these inputs.
Dan Gohman70ff4cf2008-09-16 18:52:57 +00004040 if (LHS->isLoopInvariant(L) && !RHS->isLoopInvariant(L)) {
4041 // If there is a loop-invariant, force it into the RHS.
Chris Lattner53e677a2004-04-02 20:23:17 +00004042 std::swap(LHS, RHS);
Reid Spencere4d87aa2006-12-23 06:05:41 +00004043 Cond = ICmpInst::getSwappedPredicate(Cond);
Chris Lattner53e677a2004-04-02 20:23:17 +00004044 }
4045
Dan Gohman03557dc2010-05-03 16:35:17 +00004046 // Simplify the operands before analyzing them.
4047 (void)SimplifyICmpOperands(Cond, LHS, RHS);
4048
Chris Lattner53e677a2004-04-02 20:23:17 +00004049 // If we have a comparison of a chrec against a constant, try to use value
4050 // ranges to answer this query.
Dan Gohman622ed672009-05-04 22:02:23 +00004051 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS))
4052 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS))
Chris Lattner53e677a2004-04-02 20:23:17 +00004053 if (AddRec->getLoop() == L) {
Eli Friedman361e54d2009-05-09 12:32:42 +00004054 // Form the constant range.
4055 ConstantRange CompRange(
4056 ICmpInst::makeConstantRange(Cond, RHSC->getValue()->getValue()));
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004057
Dan Gohman0bba49c2009-07-07 17:06:11 +00004058 const SCEV *Ret = AddRec->getNumIterationsInRange(CompRange, *this);
Eli Friedman361e54d2009-05-09 12:32:42 +00004059 if (!isa<SCEVCouldNotCompute>(Ret)) return Ret;
Chris Lattner53e677a2004-04-02 20:23:17 +00004060 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004061
Chris Lattner53e677a2004-04-02 20:23:17 +00004062 switch (Cond) {
Reid Spencere4d87aa2006-12-23 06:05:41 +00004063 case ICmpInst::ICMP_NE: { // while (X != Y)
Chris Lattner53e677a2004-04-02 20:23:17 +00004064 // Convert to: while (X-Y != 0)
Dan Gohmanf6d009f2010-02-24 17:31:30 +00004065 BackedgeTakenInfo BTI = HowFarToZero(getMinusSCEV(LHS, RHS), L);
4066 if (BTI.hasAnyInfo()) return BTI;
Chris Lattner53e677a2004-04-02 20:23:17 +00004067 break;
Reid Spencere4d87aa2006-12-23 06:05:41 +00004068 }
Dan Gohman4c0d5d52009-08-20 16:42:55 +00004069 case ICmpInst::ICMP_EQ: { // while (X == Y)
4070 // Convert to: while (X-Y == 0)
Dan Gohmanf6d009f2010-02-24 17:31:30 +00004071 BackedgeTakenInfo BTI = HowFarToNonZero(getMinusSCEV(LHS, RHS), L);
4072 if (BTI.hasAnyInfo()) return BTI;
Chris Lattner53e677a2004-04-02 20:23:17 +00004073 break;
Reid Spencere4d87aa2006-12-23 06:05:41 +00004074 }
4075 case ICmpInst::ICMP_SLT: {
Dan Gohmana1af7572009-04-30 20:47:05 +00004076 BackedgeTakenInfo BTI = HowManyLessThans(LHS, RHS, L, true);
4077 if (BTI.hasAnyInfo()) return BTI;
Chris Lattnerdb25de42005-08-15 23:33:51 +00004078 break;
Reid Spencere4d87aa2006-12-23 06:05:41 +00004079 }
4080 case ICmpInst::ICMP_SGT: {
Dan Gohmana1af7572009-04-30 20:47:05 +00004081 BackedgeTakenInfo BTI = HowManyLessThans(getNotSCEV(LHS),
4082 getNotSCEV(RHS), L, true);
4083 if (BTI.hasAnyInfo()) return BTI;
Nick Lewyckyd6dac0e2007-08-06 19:21:00 +00004084 break;
4085 }
4086 case ICmpInst::ICMP_ULT: {
Dan Gohmana1af7572009-04-30 20:47:05 +00004087 BackedgeTakenInfo BTI = HowManyLessThans(LHS, RHS, L, false);
4088 if (BTI.hasAnyInfo()) return BTI;
Nick Lewyckyd6dac0e2007-08-06 19:21:00 +00004089 break;
4090 }
4091 case ICmpInst::ICMP_UGT: {
Dan Gohmana1af7572009-04-30 20:47:05 +00004092 BackedgeTakenInfo BTI = HowManyLessThans(getNotSCEV(LHS),
4093 getNotSCEV(RHS), L, false);
4094 if (BTI.hasAnyInfo()) return BTI;
Chris Lattnerdb25de42005-08-15 23:33:51 +00004095 break;
Reid Spencere4d87aa2006-12-23 06:05:41 +00004096 }
Chris Lattner53e677a2004-04-02 20:23:17 +00004097 default:
Chris Lattnerd18d9dc2004-04-02 20:26:46 +00004098#if 0
David Greene25e0e872009-12-23 22:18:14 +00004099 dbgs() << "ComputeBackedgeTakenCount ";
Chris Lattner53e677a2004-04-02 20:23:17 +00004100 if (ExitCond->getOperand(0)->getType()->isUnsigned())
David Greene25e0e872009-12-23 22:18:14 +00004101 dbgs() << "[unsigned] ";
4102 dbgs() << *LHS << " "
Dan Gohman64a845e2009-06-24 04:48:43 +00004103 << Instruction::getOpcodeName(Instruction::ICmp)
Reid Spencere4d87aa2006-12-23 06:05:41 +00004104 << " " << *RHS << "\n";
Chris Lattnerd18d9dc2004-04-02 20:26:46 +00004105#endif
Chris Lattnere34c0b42004-04-03 00:43:03 +00004106 break;
Chris Lattner53e677a2004-04-02 20:23:17 +00004107 }
Dan Gohman46bdfb02009-02-24 18:55:53 +00004108 return
Dan Gohmana334aa72009-06-22 00:31:57 +00004109 ComputeBackedgeTakenCountExhaustively(L, ExitCond, !L->contains(TBB));
Chris Lattner7980fb92004-04-17 18:36:24 +00004110}
4111
Chris Lattner673e02b2004-10-12 01:49:27 +00004112static ConstantInt *
Dan Gohman246b2562007-10-22 18:31:58 +00004113EvaluateConstantChrecAtConstant(const SCEVAddRecExpr *AddRec, ConstantInt *C,
4114 ScalarEvolution &SE) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00004115 const SCEV *InVal = SE.getConstant(C);
4116 const SCEV *Val = AddRec->evaluateAtIteration(InVal, SE);
Chris Lattner673e02b2004-10-12 01:49:27 +00004117 assert(isa<SCEVConstant>(Val) &&
4118 "Evaluation of SCEV at constant didn't fold correctly?");
4119 return cast<SCEVConstant>(Val)->getValue();
4120}
4121
4122/// GetAddressedElementFromGlobal - Given a global variable with an initializer
4123/// and a GEP expression (missing the pointer index) indexing into it, return
4124/// the addressed element of the initializer or null if the index expression is
4125/// invalid.
4126static Constant *
Nick Lewyckyc6501b12009-11-23 03:26:09 +00004127GetAddressedElementFromGlobal(GlobalVariable *GV,
Chris Lattner673e02b2004-10-12 01:49:27 +00004128 const std::vector<ConstantInt*> &Indices) {
4129 Constant *Init = GV->getInitializer();
4130 for (unsigned i = 0, e = Indices.size(); i != e; ++i) {
Reid Spencerb83eb642006-10-20 07:07:24 +00004131 uint64_t Idx = Indices[i]->getZExtValue();
Chris Lattner673e02b2004-10-12 01:49:27 +00004132 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Init)) {
4133 assert(Idx < CS->getNumOperands() && "Bad struct index!");
4134 Init = cast<Constant>(CS->getOperand(Idx));
4135 } else if (ConstantArray *CA = dyn_cast<ConstantArray>(Init)) {
4136 if (Idx >= CA->getNumOperands()) return 0; // Bogus program
4137 Init = cast<Constant>(CA->getOperand(Idx));
4138 } else if (isa<ConstantAggregateZero>(Init)) {
4139 if (const StructType *STy = dyn_cast<StructType>(Init->getType())) {
4140 assert(Idx < STy->getNumElements() && "Bad struct index!");
Owen Andersona7235ea2009-07-31 20:28:14 +00004141 Init = Constant::getNullValue(STy->getElementType(Idx));
Chris Lattner673e02b2004-10-12 01:49:27 +00004142 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Init->getType())) {
4143 if (Idx >= ATy->getNumElements()) return 0; // Bogus program
Owen Andersona7235ea2009-07-31 20:28:14 +00004144 Init = Constant::getNullValue(ATy->getElementType());
Chris Lattner673e02b2004-10-12 01:49:27 +00004145 } else {
Torok Edwinc23197a2009-07-14 16:55:14 +00004146 llvm_unreachable("Unknown constant aggregate type!");
Chris Lattner673e02b2004-10-12 01:49:27 +00004147 }
4148 return 0;
4149 } else {
4150 return 0; // Unknown initializer type
4151 }
4152 }
4153 return Init;
4154}
4155
Dan Gohman46bdfb02009-02-24 18:55:53 +00004156/// ComputeLoadConstantCompareBackedgeTakenCount - Given an exit condition of
4157/// 'icmp op load X, cst', try to see if we can compute the backedge
4158/// execution count.
Dan Gohmanf6d009f2010-02-24 17:31:30 +00004159ScalarEvolution::BackedgeTakenInfo
Dan Gohman64a845e2009-06-24 04:48:43 +00004160ScalarEvolution::ComputeLoadConstantCompareBackedgeTakenCount(
4161 LoadInst *LI,
4162 Constant *RHS,
4163 const Loop *L,
4164 ICmpInst::Predicate predicate) {
Dan Gohman1c343752009-06-27 21:21:31 +00004165 if (LI->isVolatile()) return getCouldNotCompute();
Chris Lattner673e02b2004-10-12 01:49:27 +00004166
4167 // Check to see if the loaded pointer is a getelementptr of a global.
Dan Gohmanf6d009f2010-02-24 17:31:30 +00004168 // TODO: Use SCEV instead of manually grubbing with GEPs.
Chris Lattner673e02b2004-10-12 01:49:27 +00004169 GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(LI->getOperand(0));
Dan Gohman1c343752009-06-27 21:21:31 +00004170 if (!GEP) return getCouldNotCompute();
Chris Lattner673e02b2004-10-12 01:49:27 +00004171
4172 // Make sure that it is really a constant global we are gepping, with an
4173 // initializer, and make sure the first IDX is really 0.
4174 GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0));
Dan Gohman82555732009-08-19 18:20:44 +00004175 if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer() ||
Chris Lattner673e02b2004-10-12 01:49:27 +00004176 GEP->getNumOperands() < 3 || !isa<Constant>(GEP->getOperand(1)) ||
4177 !cast<Constant>(GEP->getOperand(1))->isNullValue())
Dan Gohman1c343752009-06-27 21:21:31 +00004178 return getCouldNotCompute();
Chris Lattner673e02b2004-10-12 01:49:27 +00004179
4180 // Okay, we allow one non-constant index into the GEP instruction.
4181 Value *VarIdx = 0;
4182 std::vector<ConstantInt*> Indexes;
4183 unsigned VarIdxNum = 0;
4184 for (unsigned i = 2, e = GEP->getNumOperands(); i != e; ++i)
4185 if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
4186 Indexes.push_back(CI);
4187 } else if (!isa<ConstantInt>(GEP->getOperand(i))) {
Dan Gohman1c343752009-06-27 21:21:31 +00004188 if (VarIdx) return getCouldNotCompute(); // Multiple non-constant idx's.
Chris Lattner673e02b2004-10-12 01:49:27 +00004189 VarIdx = GEP->getOperand(i);
4190 VarIdxNum = i-2;
4191 Indexes.push_back(0);
4192 }
4193
4194 // Okay, we know we have a (load (gep GV, 0, X)) comparison with a constant.
4195 // Check to see if X is a loop variant variable value now.
Dan Gohman0bba49c2009-07-07 17:06:11 +00004196 const SCEV *Idx = getSCEV(VarIdx);
Dan Gohmand594e6f2009-05-24 23:25:42 +00004197 Idx = getSCEVAtScope(Idx, L);
Chris Lattner673e02b2004-10-12 01:49:27 +00004198
4199 // We can only recognize very limited forms of loop index expressions, in
4200 // particular, only affine AddRec's like {C1,+,C2}.
Dan Gohman35738ac2009-05-04 22:30:44 +00004201 const SCEVAddRecExpr *IdxExpr = dyn_cast<SCEVAddRecExpr>(Idx);
Chris Lattner673e02b2004-10-12 01:49:27 +00004202 if (!IdxExpr || !IdxExpr->isAffine() || IdxExpr->isLoopInvariant(L) ||
4203 !isa<SCEVConstant>(IdxExpr->getOperand(0)) ||
4204 !isa<SCEVConstant>(IdxExpr->getOperand(1)))
Dan Gohman1c343752009-06-27 21:21:31 +00004205 return getCouldNotCompute();
Chris Lattner673e02b2004-10-12 01:49:27 +00004206
4207 unsigned MaxSteps = MaxBruteForceIterations;
4208 for (unsigned IterationNum = 0; IterationNum != MaxSteps; ++IterationNum) {
Owen Andersoneed707b2009-07-24 23:12:02 +00004209 ConstantInt *ItCst = ConstantInt::get(
Owen Anderson9adc0ab2009-07-14 23:09:55 +00004210 cast<IntegerType>(IdxExpr->getType()), IterationNum);
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004211 ConstantInt *Val = EvaluateConstantChrecAtConstant(IdxExpr, ItCst, *this);
Chris Lattner673e02b2004-10-12 01:49:27 +00004212
4213 // Form the GEP offset.
4214 Indexes[VarIdxNum] = Val;
4215
Nick Lewyckyc6501b12009-11-23 03:26:09 +00004216 Constant *Result = GetAddressedElementFromGlobal(GV, Indexes);
Chris Lattner673e02b2004-10-12 01:49:27 +00004217 if (Result == 0) break; // Cannot compute!
4218
4219 // Evaluate the condition for this iteration.
Reid Spencere4d87aa2006-12-23 06:05:41 +00004220 Result = ConstantExpr::getICmp(predicate, Result, RHS);
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00004221 if (!isa<ConstantInt>(Result)) break; // Couldn't decide for sure
Reid Spencere8019bb2007-03-01 07:25:48 +00004222 if (cast<ConstantInt>(Result)->getValue().isMinValue()) {
Chris Lattner673e02b2004-10-12 01:49:27 +00004223#if 0
David Greene25e0e872009-12-23 22:18:14 +00004224 dbgs() << "\n***\n*** Computed loop count " << *ItCst
Dan Gohmanb7ef7292009-04-21 00:47:46 +00004225 << "\n*** From global " << *GV << "*** BB: " << *L->getHeader()
4226 << "***\n";
Chris Lattner673e02b2004-10-12 01:49:27 +00004227#endif
4228 ++NumArrayLenItCounts;
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004229 return getConstant(ItCst); // Found terminating iteration!
Chris Lattner673e02b2004-10-12 01:49:27 +00004230 }
4231 }
Dan Gohman1c343752009-06-27 21:21:31 +00004232 return getCouldNotCompute();
Chris Lattner673e02b2004-10-12 01:49:27 +00004233}
4234
4235
Chris Lattner3221ad02004-04-17 22:58:41 +00004236/// CanConstantFold - Return true if we can constant fold an instruction of the
4237/// specified type, assuming that all operands were constants.
4238static bool CanConstantFold(const Instruction *I) {
Reid Spencer832254e2007-02-02 02:16:23 +00004239 if (isa<BinaryOperator>(I) || isa<CmpInst>(I) ||
Chris Lattner3221ad02004-04-17 22:58:41 +00004240 isa<SelectInst>(I) || isa<CastInst>(I) || isa<GetElementPtrInst>(I))
4241 return true;
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004242
Chris Lattner3221ad02004-04-17 22:58:41 +00004243 if (const CallInst *CI = dyn_cast<CallInst>(I))
4244 if (const Function *F = CI->getCalledFunction())
Dan Gohmanfa9b80e2008-01-31 01:05:10 +00004245 return canConstantFoldCallTo(F);
Chris Lattner3221ad02004-04-17 22:58:41 +00004246 return false;
Chris Lattner7980fb92004-04-17 18:36:24 +00004247}
4248
Chris Lattner3221ad02004-04-17 22:58:41 +00004249/// getConstantEvolvingPHI - Given an LLVM value and a loop, return a PHI node
4250/// in the loop that V is derived from. We allow arbitrary operations along the
4251/// way, but the operands of an operation must either be constants or a value
4252/// derived from a constant PHI. If this expression does not fit with these
4253/// constraints, return null.
4254static PHINode *getConstantEvolvingPHI(Value *V, const Loop *L) {
4255 // If this is not an instruction, or if this is an instruction outside of the
4256 // loop, it can't be derived from a loop PHI.
4257 Instruction *I = dyn_cast<Instruction>(V);
Dan Gohman92329c72009-12-18 01:24:09 +00004258 if (I == 0 || !L->contains(I)) return 0;
Chris Lattner3221ad02004-04-17 22:58:41 +00004259
Anton Korobeynikovae9f3a32008-02-20 11:08:44 +00004260 if (PHINode *PN = dyn_cast<PHINode>(I)) {
Chris Lattner3221ad02004-04-17 22:58:41 +00004261 if (L->getHeader() == I->getParent())
4262 return PN;
4263 else
4264 // We don't currently keep track of the control flow needed to evaluate
4265 // PHIs, so we cannot handle PHIs inside of loops.
4266 return 0;
Anton Korobeynikovae9f3a32008-02-20 11:08:44 +00004267 }
Chris Lattner3221ad02004-04-17 22:58:41 +00004268
4269 // If we won't be able to constant fold this expression even if the operands
4270 // are constants, return early.
4271 if (!CanConstantFold(I)) return 0;
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004272
Chris Lattner3221ad02004-04-17 22:58:41 +00004273 // Otherwise, we can evaluate this instruction if all of its operands are
4274 // constant or derived from a PHI node themselves.
4275 PHINode *PHI = 0;
4276 for (unsigned Op = 0, e = I->getNumOperands(); Op != e; ++Op)
Dan Gohman9d4588f2010-06-22 13:15:46 +00004277 if (!isa<Constant>(I->getOperand(Op))) {
Chris Lattner3221ad02004-04-17 22:58:41 +00004278 PHINode *P = getConstantEvolvingPHI(I->getOperand(Op), L);
4279 if (P == 0) return 0; // Not evolving from PHI
4280 if (PHI == 0)
4281 PHI = P;
4282 else if (PHI != P)
4283 return 0; // Evolving from multiple different PHIs.
4284 }
4285
4286 // This is a expression evolving from a constant PHI!
4287 return PHI;
4288}
4289
4290/// EvaluateExpression - Given an expression that passes the
4291/// getConstantEvolvingPHI predicate, evaluate its value assuming the PHI node
4292/// in the loop has the value PHIVal. If we can't fold this expression for some
4293/// reason, return null.
Dan Gohman1ba3b6c2009-11-09 23:34:17 +00004294static Constant *EvaluateExpression(Value *V, Constant *PHIVal,
4295 const TargetData *TD) {
Chris Lattner3221ad02004-04-17 22:58:41 +00004296 if (isa<PHINode>(V)) return PHIVal;
Reid Spencere8404342004-07-18 00:18:30 +00004297 if (Constant *C = dyn_cast<Constant>(V)) return C;
Chris Lattner3221ad02004-04-17 22:58:41 +00004298 Instruction *I = cast<Instruction>(V);
4299
Dan Gohman9d4588f2010-06-22 13:15:46 +00004300 std::vector<Constant*> Operands(I->getNumOperands());
Chris Lattner3221ad02004-04-17 22:58:41 +00004301
4302 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
Dan Gohman1ba3b6c2009-11-09 23:34:17 +00004303 Operands[i] = EvaluateExpression(I->getOperand(i), PHIVal, TD);
Chris Lattner3221ad02004-04-17 22:58:41 +00004304 if (Operands[i] == 0) return 0;
4305 }
4306
Chris Lattnerf286f6f2007-12-10 22:53:04 +00004307 if (const CmpInst *CI = dyn_cast<CmpInst>(I))
Chris Lattner8f73dea2009-11-09 23:06:58 +00004308 return ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0],
Dan Gohman1ba3b6c2009-11-09 23:34:17 +00004309 Operands[1], TD);
Chris Lattner8f73dea2009-11-09 23:06:58 +00004310 return ConstantFoldInstOperands(I->getOpcode(), I->getType(),
Dan Gohman1ba3b6c2009-11-09 23:34:17 +00004311 &Operands[0], Operands.size(), TD);
Chris Lattner3221ad02004-04-17 22:58:41 +00004312}
4313
4314/// getConstantEvolutionLoopExitValue - If we know that the specified Phi is
4315/// in the header of its containing loop, we know the loop executes a
4316/// constant number of times, and the PHI node is just a recurrence
4317/// involving constants, fold it.
Dan Gohman64a845e2009-06-24 04:48:43 +00004318Constant *
4319ScalarEvolution::getConstantEvolutionLoopExitValue(PHINode *PN,
Dan Gohman5d984912009-12-18 01:14:11 +00004320 const APInt &BEs,
Dan Gohman64a845e2009-06-24 04:48:43 +00004321 const Loop *L) {
Dan Gohman8d9c7a62010-08-16 16:30:01 +00004322 std::map<PHINode*, Constant*>::const_iterator I =
Chris Lattner3221ad02004-04-17 22:58:41 +00004323 ConstantEvolutionLoopExitValue.find(PN);
4324 if (I != ConstantEvolutionLoopExitValue.end())
4325 return I->second;
4326
Dan Gohmane0567812010-04-08 23:03:40 +00004327 if (BEs.ugt(MaxBruteForceIterations))
Chris Lattner3221ad02004-04-17 22:58:41 +00004328 return ConstantEvolutionLoopExitValue[PN] = 0; // Not going to evaluate it.
4329
4330 Constant *&RetVal = ConstantEvolutionLoopExitValue[PN];
4331
4332 // Since the loop is canonicalized, the PHI node must have two entries. One
4333 // entry must be a constant (coming in from outside of the loop), and the
4334 // second must be derived from the same PHI.
4335 bool SecondIsBackedge = L->contains(PN->getIncomingBlock(1));
4336 Constant *StartCST =
4337 dyn_cast<Constant>(PN->getIncomingValue(!SecondIsBackedge));
4338 if (StartCST == 0)
4339 return RetVal = 0; // Must be a constant.
4340
4341 Value *BEValue = PN->getIncomingValue(SecondIsBackedge);
Dan Gohman9d4588f2010-06-22 13:15:46 +00004342 if (getConstantEvolvingPHI(BEValue, L) != PN &&
4343 !isa<Constant>(BEValue))
Chris Lattner3221ad02004-04-17 22:58:41 +00004344 return RetVal = 0; // Not derived from same PHI.
4345
4346 // Execute the loop symbolically to determine the exit value.
Dan Gohman46bdfb02009-02-24 18:55:53 +00004347 if (BEs.getActiveBits() >= 32)
Reid Spencere8019bb2007-03-01 07:25:48 +00004348 return RetVal = 0; // More than 2^32-1 iterations?? Not doing it!
Chris Lattner3221ad02004-04-17 22:58:41 +00004349
Dan Gohman46bdfb02009-02-24 18:55:53 +00004350 unsigned NumIterations = BEs.getZExtValue(); // must be in range
Reid Spencere8019bb2007-03-01 07:25:48 +00004351 unsigned IterationNum = 0;
Chris Lattner3221ad02004-04-17 22:58:41 +00004352 for (Constant *PHIVal = StartCST; ; ++IterationNum) {
4353 if (IterationNum == NumIterations)
4354 return RetVal = PHIVal; // Got exit value!
4355
4356 // Compute the value of the PHI node for the next iteration.
Dan Gohman1ba3b6c2009-11-09 23:34:17 +00004357 Constant *NextPHI = EvaluateExpression(BEValue, PHIVal, TD);
Chris Lattner3221ad02004-04-17 22:58:41 +00004358 if (NextPHI == PHIVal)
4359 return RetVal = NextPHI; // Stopped evolving!
4360 if (NextPHI == 0)
4361 return 0; // Couldn't evaluate!
4362 PHIVal = NextPHI;
4363 }
4364}
4365
Dan Gohman07ad19b2009-07-27 16:09:48 +00004366/// ComputeBackedgeTakenCountExhaustively - If the loop is known to execute a
Chris Lattner7980fb92004-04-17 18:36:24 +00004367/// constant number of times (the condition evolves only from constants),
4368/// try to evaluate a few iterations of the loop until we get the exit
4369/// condition gets a value of ExitWhen (true or false). If we cannot
Dan Gohman1c343752009-06-27 21:21:31 +00004370/// evaluate the trip count of the loop, return getCouldNotCompute().
Dan Gohman64a845e2009-06-24 04:48:43 +00004371const SCEV *
4372ScalarEvolution::ComputeBackedgeTakenCountExhaustively(const Loop *L,
4373 Value *Cond,
4374 bool ExitWhen) {
Chris Lattner7980fb92004-04-17 18:36:24 +00004375 PHINode *PN = getConstantEvolvingPHI(Cond, L);
Dan Gohman1c343752009-06-27 21:21:31 +00004376 if (PN == 0) return getCouldNotCompute();
Chris Lattner7980fb92004-04-17 18:36:24 +00004377
Dan Gohmanb92654d2010-06-19 14:17:24 +00004378 // If the loop is canonicalized, the PHI will have exactly two entries.
4379 // That's the only form we support here.
4380 if (PN->getNumIncomingValues() != 2) return getCouldNotCompute();
4381
4382 // One entry must be a constant (coming in from outside of the loop), and the
Chris Lattner7980fb92004-04-17 18:36:24 +00004383 // second must be derived from the same PHI.
4384 bool SecondIsBackedge = L->contains(PN->getIncomingBlock(1));
4385 Constant *StartCST =
4386 dyn_cast<Constant>(PN->getIncomingValue(!SecondIsBackedge));
Dan Gohman1c343752009-06-27 21:21:31 +00004387 if (StartCST == 0) return getCouldNotCompute(); // Must be a constant.
Chris Lattner7980fb92004-04-17 18:36:24 +00004388
4389 Value *BEValue = PN->getIncomingValue(SecondIsBackedge);
Dan Gohman9d4588f2010-06-22 13:15:46 +00004390 if (getConstantEvolvingPHI(BEValue, L) != PN &&
4391 !isa<Constant>(BEValue))
4392 return getCouldNotCompute(); // Not derived from same PHI.
Chris Lattner7980fb92004-04-17 18:36:24 +00004393
4394 // Okay, we find a PHI node that defines the trip count of this loop. Execute
4395 // the loop symbolically to determine when the condition gets a value of
4396 // "ExitWhen".
4397 unsigned IterationNum = 0;
4398 unsigned MaxIterations = MaxBruteForceIterations; // Limit analysis.
4399 for (Constant *PHIVal = StartCST;
4400 IterationNum != MaxIterations; ++IterationNum) {
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00004401 ConstantInt *CondVal =
Dan Gohman1ba3b6c2009-11-09 23:34:17 +00004402 dyn_cast_or_null<ConstantInt>(EvaluateExpression(Cond, PHIVal, TD));
Chris Lattner3221ad02004-04-17 22:58:41 +00004403
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00004404 // Couldn't symbolically evaluate.
Dan Gohman1c343752009-06-27 21:21:31 +00004405 if (!CondVal) return getCouldNotCompute();
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00004406
Reid Spencere8019bb2007-03-01 07:25:48 +00004407 if (CondVal->getValue() == uint64_t(ExitWhen)) {
Chris Lattner7980fb92004-04-17 18:36:24 +00004408 ++NumBruteForceTripCountsComputed;
Owen Anderson1d0be152009-08-13 21:58:54 +00004409 return getConstant(Type::getInt32Ty(getContext()), IterationNum);
Chris Lattner7980fb92004-04-17 18:36:24 +00004410 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004411
Chris Lattner3221ad02004-04-17 22:58:41 +00004412 // Compute the value of the PHI node for the next iteration.
Dan Gohman1ba3b6c2009-11-09 23:34:17 +00004413 Constant *NextPHI = EvaluateExpression(BEValue, PHIVal, TD);
Chris Lattner3221ad02004-04-17 22:58:41 +00004414 if (NextPHI == 0 || NextPHI == PHIVal)
Dan Gohman1c343752009-06-27 21:21:31 +00004415 return getCouldNotCompute();// Couldn't evaluate or not making progress...
Chris Lattner3221ad02004-04-17 22:58:41 +00004416 PHIVal = NextPHI;
Chris Lattner7980fb92004-04-17 18:36:24 +00004417 }
4418
4419 // Too many iterations were needed to evaluate.
Dan Gohman1c343752009-06-27 21:21:31 +00004420 return getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00004421}
4422
Dan Gohmane7125f42009-09-03 15:00:26 +00004423/// getSCEVAtScope - Return a SCEV expression for the specified value
Dan Gohman66a7e852009-05-08 20:38:54 +00004424/// at the specified scope in the program. The L value specifies a loop
4425/// nest to evaluate the expression at, where null is the top-level or a
4426/// specified loop is immediately inside of the loop.
4427///
4428/// This method can be used to compute the exit value for a variable defined
4429/// in a loop by querying what the value will hold in the parent loop.
4430///
Dan Gohmand594e6f2009-05-24 23:25:42 +00004431/// In the case that a relevant loop exit value cannot be computed, the
4432/// original value V is returned.
Dan Gohman0bba49c2009-07-07 17:06:11 +00004433const SCEV *ScalarEvolution::getSCEVAtScope(const SCEV *V, const Loop *L) {
Dan Gohman42214892009-08-31 21:15:23 +00004434 // Check to see if we've folded this expression at this loop before.
4435 std::map<const Loop *, const SCEV *> &Values = ValuesAtScopes[V];
4436 std::pair<std::map<const Loop *, const SCEV *>::iterator, bool> Pair =
4437 Values.insert(std::make_pair(L, static_cast<const SCEV *>(0)));
4438 if (!Pair.second)
4439 return Pair.first->second ? Pair.first->second : V;
Chris Lattner53e677a2004-04-02 20:23:17 +00004440
Dan Gohman42214892009-08-31 21:15:23 +00004441 // Otherwise compute it.
4442 const SCEV *C = computeSCEVAtScope(V, L);
Dan Gohmana5505cb2009-08-31 21:58:28 +00004443 ValuesAtScopes[V][L] = C;
Dan Gohman42214892009-08-31 21:15:23 +00004444 return C;
4445}
4446
4447const SCEV *ScalarEvolution::computeSCEVAtScope(const SCEV *V, const Loop *L) {
Chris Lattner3221ad02004-04-17 22:58:41 +00004448 if (isa<SCEVConstant>(V)) return V;
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004449
Nick Lewycky3e630762008-02-20 06:48:22 +00004450 // If this instruction is evolved from a constant-evolving PHI, compute the
Chris Lattner3221ad02004-04-17 22:58:41 +00004451 // exit value from the loop without using SCEVs.
Dan Gohman622ed672009-05-04 22:02:23 +00004452 if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(V)) {
Chris Lattner3221ad02004-04-17 22:58:41 +00004453 if (Instruction *I = dyn_cast<Instruction>(SU->getValue())) {
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004454 const Loop *LI = (*this->LI)[I->getParent()];
Chris Lattner3221ad02004-04-17 22:58:41 +00004455 if (LI && LI->getParentLoop() == L) // Looking for loop exit value.
4456 if (PHINode *PN = dyn_cast<PHINode>(I))
4457 if (PN->getParent() == LI->getHeader()) {
4458 // Okay, there is no closed form solution for the PHI node. Check
Dan Gohman46bdfb02009-02-24 18:55:53 +00004459 // to see if the loop that contains it has a known backedge-taken
4460 // count. If so, we may be able to force computation of the exit
4461 // value.
Dan Gohman0bba49c2009-07-07 17:06:11 +00004462 const SCEV *BackedgeTakenCount = getBackedgeTakenCount(LI);
Dan Gohman622ed672009-05-04 22:02:23 +00004463 if (const SCEVConstant *BTCC =
Dan Gohman46bdfb02009-02-24 18:55:53 +00004464 dyn_cast<SCEVConstant>(BackedgeTakenCount)) {
Chris Lattner3221ad02004-04-17 22:58:41 +00004465 // Okay, we know how many times the containing loop executes. If
4466 // this is a constant evolving PHI node, get the final value at
4467 // the specified iteration number.
4468 Constant *RV = getConstantEvolutionLoopExitValue(PN,
Dan Gohman46bdfb02009-02-24 18:55:53 +00004469 BTCC->getValue()->getValue(),
Chris Lattner3221ad02004-04-17 22:58:41 +00004470 LI);
Dan Gohman09987962009-06-29 21:31:18 +00004471 if (RV) return getSCEV(RV);
Chris Lattner3221ad02004-04-17 22:58:41 +00004472 }
4473 }
4474
Reid Spencer09906f32006-12-04 21:33:23 +00004475 // Okay, this is an expression that we cannot symbolically evaluate
Chris Lattner3221ad02004-04-17 22:58:41 +00004476 // into a SCEV. Check to see if it's possible to symbolically evaluate
Reid Spencer09906f32006-12-04 21:33:23 +00004477 // the arguments into constants, and if so, try to constant propagate the
Chris Lattner3221ad02004-04-17 22:58:41 +00004478 // result. This is particularly useful for computing loop exit values.
4479 if (CanConstantFold(I)) {
Dan Gohman11046452010-06-29 23:43:06 +00004480 SmallVector<Constant *, 4> Operands;
4481 bool MadeImprovement = false;
Chris Lattner3221ad02004-04-17 22:58:41 +00004482 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
4483 Value *Op = I->getOperand(i);
4484 if (Constant *C = dyn_cast<Constant>(Op)) {
4485 Operands.push_back(C);
Dan Gohman11046452010-06-29 23:43:06 +00004486 continue;
Chris Lattner3221ad02004-04-17 22:58:41 +00004487 }
Dan Gohman11046452010-06-29 23:43:06 +00004488
4489 // If any of the operands is non-constant and if they are
4490 // non-integer and non-pointer, don't even try to analyze them
4491 // with scev techniques.
4492 if (!isSCEVable(Op->getType()))
4493 return V;
4494
4495 const SCEV *OrigV = getSCEV(Op);
4496 const SCEV *OpV = getSCEVAtScope(OrigV, L);
4497 MadeImprovement |= OrigV != OpV;
4498
4499 Constant *C = 0;
4500 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(OpV))
4501 C = SC->getValue();
4502 if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(OpV))
4503 C = dyn_cast<Constant>(SU->getValue());
4504 if (!C) return V;
4505 if (C->getType() != Op->getType())
4506 C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
4507 Op->getType(),
4508 false),
4509 C, Op->getType());
4510 Operands.push_back(C);
Chris Lattner3221ad02004-04-17 22:58:41 +00004511 }
Dan Gohman64a845e2009-06-24 04:48:43 +00004512
Dan Gohman11046452010-06-29 23:43:06 +00004513 // Check to see if getSCEVAtScope actually made an improvement.
4514 if (MadeImprovement) {
4515 Constant *C = 0;
4516 if (const CmpInst *CI = dyn_cast<CmpInst>(I))
4517 C = ConstantFoldCompareInstOperands(CI->getPredicate(),
4518 Operands[0], Operands[1], TD);
4519 else
4520 C = ConstantFoldInstOperands(I->getOpcode(), I->getType(),
4521 &Operands[0], Operands.size(), TD);
4522 if (!C) return V;
Dan Gohmane177c9a2010-02-24 19:31:47 +00004523 return getSCEV(C);
Dan Gohman11046452010-06-29 23:43:06 +00004524 }
Chris Lattner3221ad02004-04-17 22:58:41 +00004525 }
4526 }
4527
4528 // This is some other type of SCEVUnknown, just return it.
4529 return V;
4530 }
4531
Dan Gohman622ed672009-05-04 22:02:23 +00004532 if (const SCEVCommutativeExpr *Comm = dyn_cast<SCEVCommutativeExpr>(V)) {
Chris Lattner53e677a2004-04-02 20:23:17 +00004533 // Avoid performing the look-up in the common case where the specified
4534 // expression has no loop-variant portions.
4535 for (unsigned i = 0, e = Comm->getNumOperands(); i != e; ++i) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00004536 const SCEV *OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
Chris Lattner53e677a2004-04-02 20:23:17 +00004537 if (OpAtScope != Comm->getOperand(i)) {
Chris Lattner53e677a2004-04-02 20:23:17 +00004538 // Okay, at least one of these operands is loop variant but might be
4539 // foldable. Build a new instance of the folded commutative expression.
Dan Gohman64a845e2009-06-24 04:48:43 +00004540 SmallVector<const SCEV *, 8> NewOps(Comm->op_begin(),
4541 Comm->op_begin()+i);
Chris Lattner53e677a2004-04-02 20:23:17 +00004542 NewOps.push_back(OpAtScope);
4543
4544 for (++i; i != e; ++i) {
4545 OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
Chris Lattner53e677a2004-04-02 20:23:17 +00004546 NewOps.push_back(OpAtScope);
4547 }
4548 if (isa<SCEVAddExpr>(Comm))
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004549 return getAddExpr(NewOps);
Nick Lewyckyc54c5612007-11-25 22:41:31 +00004550 if (isa<SCEVMulExpr>(Comm))
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004551 return getMulExpr(NewOps);
Nick Lewyckyc54c5612007-11-25 22:41:31 +00004552 if (isa<SCEVSMaxExpr>(Comm))
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004553 return getSMaxExpr(NewOps);
Nick Lewycky3e630762008-02-20 06:48:22 +00004554 if (isa<SCEVUMaxExpr>(Comm))
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004555 return getUMaxExpr(NewOps);
Torok Edwinc23197a2009-07-14 16:55:14 +00004556 llvm_unreachable("Unknown commutative SCEV type!");
Chris Lattner53e677a2004-04-02 20:23:17 +00004557 }
4558 }
4559 // If we got here, all operands are loop invariant.
4560 return Comm;
4561 }
4562
Dan Gohman622ed672009-05-04 22:02:23 +00004563 if (const SCEVUDivExpr *Div = dyn_cast<SCEVUDivExpr>(V)) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00004564 const SCEV *LHS = getSCEVAtScope(Div->getLHS(), L);
4565 const SCEV *RHS = getSCEVAtScope(Div->getRHS(), L);
Nick Lewycky789558d2009-01-13 09:18:58 +00004566 if (LHS == Div->getLHS() && RHS == Div->getRHS())
4567 return Div; // must be loop invariant
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004568 return getUDivExpr(LHS, RHS);
Chris Lattner53e677a2004-04-02 20:23:17 +00004569 }
4570
4571 // If this is a loop recurrence for a loop that does not contain L, then we
4572 // are dealing with the final value computed by the loop.
Dan Gohman622ed672009-05-04 22:02:23 +00004573 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V)) {
Dan Gohman11046452010-06-29 23:43:06 +00004574 // First, attempt to evaluate each operand.
4575 // Avoid performing the look-up in the common case where the specified
4576 // expression has no loop-variant portions.
4577 for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
4578 const SCEV *OpAtScope = getSCEVAtScope(AddRec->getOperand(i), L);
4579 if (OpAtScope == AddRec->getOperand(i))
4580 continue;
4581
4582 // Okay, at least one of these operands is loop variant but might be
4583 // foldable. Build a new instance of the folded commutative expression.
4584 SmallVector<const SCEV *, 8> NewOps(AddRec->op_begin(),
4585 AddRec->op_begin()+i);
4586 NewOps.push_back(OpAtScope);
4587 for (++i; i != e; ++i)
4588 NewOps.push_back(getSCEVAtScope(AddRec->getOperand(i), L));
4589
4590 AddRec = cast<SCEVAddRecExpr>(getAddRecExpr(NewOps, AddRec->getLoop()));
4591 break;
4592 }
4593
4594 // If the scope is outside the addrec's loop, evaluate it by using the
4595 // loop exit value of the addrec.
4596 if (!AddRec->getLoop()->contains(L)) {
Chris Lattner53e677a2004-04-02 20:23:17 +00004597 // To evaluate this recurrence, we need to know how many times the AddRec
4598 // loop iterates. Compute this now.
Dan Gohman0bba49c2009-07-07 17:06:11 +00004599 const SCEV *BackedgeTakenCount = getBackedgeTakenCount(AddRec->getLoop());
Dan Gohman1c343752009-06-27 21:21:31 +00004600 if (BackedgeTakenCount == getCouldNotCompute()) return AddRec;
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004601
Eli Friedmanb42a6262008-08-04 23:49:06 +00004602 // Then, evaluate the AddRec.
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004603 return AddRec->evaluateAtIteration(BackedgeTakenCount, *this);
Chris Lattner53e677a2004-04-02 20:23:17 +00004604 }
Dan Gohman11046452010-06-29 23:43:06 +00004605
Dan Gohmand594e6f2009-05-24 23:25:42 +00004606 return AddRec;
Chris Lattner53e677a2004-04-02 20:23:17 +00004607 }
4608
Dan Gohman622ed672009-05-04 22:02:23 +00004609 if (const SCEVZeroExtendExpr *Cast = dyn_cast<SCEVZeroExtendExpr>(V)) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00004610 const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
Dan Gohmaneb3948b2009-04-29 22:29:01 +00004611 if (Op == Cast->getOperand())
4612 return Cast; // must be loop invariant
4613 return getZeroExtendExpr(Op, Cast->getType());
4614 }
4615
Dan Gohman622ed672009-05-04 22:02:23 +00004616 if (const SCEVSignExtendExpr *Cast = dyn_cast<SCEVSignExtendExpr>(V)) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00004617 const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
Dan Gohmaneb3948b2009-04-29 22:29:01 +00004618 if (Op == Cast->getOperand())
4619 return Cast; // must be loop invariant
4620 return getSignExtendExpr(Op, Cast->getType());
4621 }
4622
Dan Gohman622ed672009-05-04 22:02:23 +00004623 if (const SCEVTruncateExpr *Cast = dyn_cast<SCEVTruncateExpr>(V)) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00004624 const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
Dan Gohmaneb3948b2009-04-29 22:29:01 +00004625 if (Op == Cast->getOperand())
4626 return Cast; // must be loop invariant
4627 return getTruncateExpr(Op, Cast->getType());
4628 }
4629
Torok Edwinc23197a2009-07-14 16:55:14 +00004630 llvm_unreachable("Unknown SCEV type!");
Daniel Dunbar8c562e22009-05-18 16:43:04 +00004631 return 0;
Chris Lattner53e677a2004-04-02 20:23:17 +00004632}
4633
Dan Gohman66a7e852009-05-08 20:38:54 +00004634/// getSCEVAtScope - This is a convenience function which does
4635/// getSCEVAtScope(getSCEV(V), L).
Dan Gohman0bba49c2009-07-07 17:06:11 +00004636const SCEV *ScalarEvolution::getSCEVAtScope(Value *V, const Loop *L) {
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004637 return getSCEVAtScope(getSCEV(V), L);
4638}
4639
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004640/// SolveLinEquationWithOverflow - Finds the minimum unsigned root of the
4641/// following equation:
4642///
4643/// A * X = B (mod N)
4644///
4645/// where N = 2^BW and BW is the common bit width of A and B. The signedness of
4646/// A and B isn't important.
4647///
4648/// If the equation does not have a solution, SCEVCouldNotCompute is returned.
Dan Gohman0bba49c2009-07-07 17:06:11 +00004649static const SCEV *SolveLinEquationWithOverflow(const APInt &A, const APInt &B,
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004650 ScalarEvolution &SE) {
4651 uint32_t BW = A.getBitWidth();
4652 assert(BW == B.getBitWidth() && "Bit widths must be the same.");
4653 assert(A != 0 && "A must be non-zero.");
4654
4655 // 1. D = gcd(A, N)
4656 //
4657 // The gcd of A and N may have only one prime factor: 2. The number of
4658 // trailing zeros in A is its multiplicity
4659 uint32_t Mult2 = A.countTrailingZeros();
4660 // D = 2^Mult2
4661
4662 // 2. Check if B is divisible by D.
4663 //
4664 // B is divisible by D if and only if the multiplicity of prime factor 2 for B
4665 // is not less than multiplicity of this prime factor for D.
4666 if (B.countTrailingZeros() < Mult2)
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +00004667 return SE.getCouldNotCompute();
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004668
4669 // 3. Compute I: the multiplicative inverse of (A / D) in arithmetic
4670 // modulo (N / D).
4671 //
4672 // (N / D) may need BW+1 bits in its representation. Hence, we'll use this
4673 // bit width during computations.
4674 APInt AD = A.lshr(Mult2).zext(BW + 1); // AD = A / D
4675 APInt Mod(BW + 1, 0);
4676 Mod.set(BW - Mult2); // Mod = N / D
4677 APInt I = AD.multiplicativeInverse(Mod);
4678
4679 // 4. Compute the minimum unsigned root of the equation:
4680 // I * (B / D) mod (N / D)
4681 APInt Result = (I * B.lshr(Mult2).zext(BW + 1)).urem(Mod);
4682
4683 // The result is guaranteed to be less than 2^BW so we may truncate it to BW
4684 // bits.
4685 return SE.getConstant(Result.trunc(BW));
4686}
Chris Lattner53e677a2004-04-02 20:23:17 +00004687
4688/// SolveQuadraticEquation - Find the roots of the quadratic equation for the
4689/// given quadratic chrec {L,+,M,+,N}. This returns either the two roots (which
4690/// might be the same) or two SCEVCouldNotCompute objects.
4691///
Dan Gohman0bba49c2009-07-07 17:06:11 +00004692static std::pair<const SCEV *,const SCEV *>
Dan Gohman246b2562007-10-22 18:31:58 +00004693SolveQuadraticEquation(const SCEVAddRecExpr *AddRec, ScalarEvolution &SE) {
Chris Lattner53e677a2004-04-02 20:23:17 +00004694 assert(AddRec->getNumOperands() == 3 && "This is not a quadratic chrec!");
Dan Gohman35738ac2009-05-04 22:30:44 +00004695 const SCEVConstant *LC = dyn_cast<SCEVConstant>(AddRec->getOperand(0));
4696 const SCEVConstant *MC = dyn_cast<SCEVConstant>(AddRec->getOperand(1));
4697 const SCEVConstant *NC = dyn_cast<SCEVConstant>(AddRec->getOperand(2));
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004698
Chris Lattner53e677a2004-04-02 20:23:17 +00004699 // We currently can only solve this if the coefficients are constants.
Reid Spencere8019bb2007-03-01 07:25:48 +00004700 if (!LC || !MC || !NC) {
Dan Gohman35738ac2009-05-04 22:30:44 +00004701 const SCEV *CNC = SE.getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00004702 return std::make_pair(CNC, CNC);
4703 }
4704
Reid Spencere8019bb2007-03-01 07:25:48 +00004705 uint32_t BitWidth = LC->getValue()->getValue().getBitWidth();
Chris Lattnerfe560b82007-04-15 19:52:49 +00004706 const APInt &L = LC->getValue()->getValue();
4707 const APInt &M = MC->getValue()->getValue();
4708 const APInt &N = NC->getValue()->getValue();
Reid Spencere8019bb2007-03-01 07:25:48 +00004709 APInt Two(BitWidth, 2);
4710 APInt Four(BitWidth, 4);
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004711
Dan Gohman64a845e2009-06-24 04:48:43 +00004712 {
Reid Spencere8019bb2007-03-01 07:25:48 +00004713 using namespace APIntOps;
Zhou Sheng414de4d2007-04-07 17:48:27 +00004714 const APInt& C = L;
Reid Spencere8019bb2007-03-01 07:25:48 +00004715 // Convert from chrec coefficients to polynomial coefficients AX^2+BX+C
4716 // The B coefficient is M-N/2
4717 APInt B(M);
4718 B -= sdiv(N,Two);
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004719
Reid Spencere8019bb2007-03-01 07:25:48 +00004720 // The A coefficient is N/2
Zhou Sheng414de4d2007-04-07 17:48:27 +00004721 APInt A(N.sdiv(Two));
Chris Lattner53e677a2004-04-02 20:23:17 +00004722
Reid Spencere8019bb2007-03-01 07:25:48 +00004723 // Compute the B^2-4ac term.
4724 APInt SqrtTerm(B);
4725 SqrtTerm *= B;
4726 SqrtTerm -= Four * (A * C);
Chris Lattner53e677a2004-04-02 20:23:17 +00004727
Reid Spencere8019bb2007-03-01 07:25:48 +00004728 // Compute sqrt(B^2-4ac). This is guaranteed to be the nearest
4729 // integer value or else APInt::sqrt() will assert.
4730 APInt SqrtVal(SqrtTerm.sqrt());
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004731
Dan Gohman64a845e2009-06-24 04:48:43 +00004732 // Compute the two solutions for the quadratic formula.
Reid Spencere8019bb2007-03-01 07:25:48 +00004733 // The divisions must be performed as signed divisions.
4734 APInt NegB(-B);
Reid Spencer3e35c8d2007-04-16 02:24:41 +00004735 APInt TwoA( A << 1 );
Nick Lewycky8f4d5eb2008-11-03 02:43:49 +00004736 if (TwoA.isMinValue()) {
Dan Gohman35738ac2009-05-04 22:30:44 +00004737 const SCEV *CNC = SE.getCouldNotCompute();
Nick Lewycky8f4d5eb2008-11-03 02:43:49 +00004738 return std::make_pair(CNC, CNC);
4739 }
4740
Owen Andersone922c022009-07-22 00:24:57 +00004741 LLVMContext &Context = SE.getContext();
Owen Anderson76f600b2009-07-06 22:37:39 +00004742
4743 ConstantInt *Solution1 =
Owen Andersoneed707b2009-07-24 23:12:02 +00004744 ConstantInt::get(Context, (NegB + SqrtVal).sdiv(TwoA));
Owen Anderson76f600b2009-07-06 22:37:39 +00004745 ConstantInt *Solution2 =
Owen Andersoneed707b2009-07-24 23:12:02 +00004746 ConstantInt::get(Context, (NegB - SqrtVal).sdiv(TwoA));
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004747
Dan Gohman64a845e2009-06-24 04:48:43 +00004748 return std::make_pair(SE.getConstant(Solution1),
Dan Gohman246b2562007-10-22 18:31:58 +00004749 SE.getConstant(Solution2));
Reid Spencere8019bb2007-03-01 07:25:48 +00004750 } // end APIntOps namespace
Chris Lattner53e677a2004-04-02 20:23:17 +00004751}
4752
4753/// HowFarToZero - Return the number of times a backedge comparing the specified
Dan Gohman86fbf2f2009-06-06 14:37:11 +00004754/// value to zero will execute. If not computable, return CouldNotCompute.
Dan Gohmanf6d009f2010-02-24 17:31:30 +00004755ScalarEvolution::BackedgeTakenInfo
4756ScalarEvolution::HowFarToZero(const SCEV *V, const Loop *L) {
Chris Lattner53e677a2004-04-02 20:23:17 +00004757 // If the value is a constant
Dan Gohman622ed672009-05-04 22:02:23 +00004758 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
Chris Lattner53e677a2004-04-02 20:23:17 +00004759 // If the value is already zero, the branch will execute zero times.
Reid Spencercae57542007-03-02 00:28:52 +00004760 if (C->getValue()->isZero()) return C;
Dan Gohman1c343752009-06-27 21:21:31 +00004761 return getCouldNotCompute(); // Otherwise it will loop infinitely.
Chris Lattner53e677a2004-04-02 20:23:17 +00004762 }
4763
Dan Gohman35738ac2009-05-04 22:30:44 +00004764 const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V);
Chris Lattner53e677a2004-04-02 20:23:17 +00004765 if (!AddRec || AddRec->getLoop() != L)
Dan Gohman1c343752009-06-27 21:21:31 +00004766 return getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00004767
4768 if (AddRec->isAffine()) {
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004769 // If this is an affine expression, the execution count of this branch is
4770 // the minimum unsigned root of the following equation:
Chris Lattner53e677a2004-04-02 20:23:17 +00004771 //
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004772 // Start + Step*N = 0 (mod 2^BW)
Chris Lattner53e677a2004-04-02 20:23:17 +00004773 //
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004774 // equivalent to:
4775 //
4776 // Step*N = -Start (mod 2^BW)
4777 //
4778 // where BW is the common bit width of Start and Step.
4779
Chris Lattner53e677a2004-04-02 20:23:17 +00004780 // Get the initial value for the loop.
Dan Gohman64a845e2009-06-24 04:48:43 +00004781 const SCEV *Start = getSCEVAtScope(AddRec->getStart(),
4782 L->getParentLoop());
4783 const SCEV *Step = getSCEVAtScope(AddRec->getOperand(1),
4784 L->getParentLoop());
Chris Lattner53e677a2004-04-02 20:23:17 +00004785
Dan Gohman622ed672009-05-04 22:02:23 +00004786 if (const SCEVConstant *StepC = dyn_cast<SCEVConstant>(Step)) {
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004787 // For now we handle only constant steps.
Chris Lattner53e677a2004-04-02 20:23:17 +00004788
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004789 // First, handle unitary steps.
4790 if (StepC->getValue()->equalsInt(1)) // 1*N = -Start (mod 2^BW), so:
Dan Gohman4c0d5d52009-08-20 16:42:55 +00004791 return getNegativeSCEV(Start); // N = -Start (as unsigned)
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004792 if (StepC->getValue()->isAllOnesValue()) // -1*N = -Start (mod 2^BW), so:
4793 return Start; // N = Start (as unsigned)
4794
4795 // Then, try to solve the above equation provided that Start is constant.
Dan Gohman622ed672009-05-04 22:02:23 +00004796 if (const SCEVConstant *StartC = dyn_cast<SCEVConstant>(Start))
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004797 return SolveLinEquationWithOverflow(StepC->getValue()->getValue(),
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004798 -StartC->getValue()->getValue(),
4799 *this);
Chris Lattner53e677a2004-04-02 20:23:17 +00004800 }
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00004801 } else if (AddRec->isQuadratic() && AddRec->getType()->isIntegerTy()) {
Chris Lattner53e677a2004-04-02 20:23:17 +00004802 // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of
4803 // the quadratic equation to solve it.
Dan Gohman0bba49c2009-07-07 17:06:11 +00004804 std::pair<const SCEV *,const SCEV *> Roots = SolveQuadraticEquation(AddRec,
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004805 *this);
Dan Gohman35738ac2009-05-04 22:30:44 +00004806 const SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
4807 const SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
Chris Lattner53e677a2004-04-02 20:23:17 +00004808 if (R1) {
Chris Lattnerd18d9dc2004-04-02 20:26:46 +00004809#if 0
David Greene25e0e872009-12-23 22:18:14 +00004810 dbgs() << "HFTZ: " << *V << " - sol#1: " << *R1
Dan Gohmanb7ef7292009-04-21 00:47:46 +00004811 << " sol#2: " << *R2 << "\n";
Chris Lattnerd18d9dc2004-04-02 20:26:46 +00004812#endif
Chris Lattner53e677a2004-04-02 20:23:17 +00004813 // Pick the smallest positive root value.
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00004814 if (ConstantInt *CB =
Owen Andersonbaf3c402009-07-29 18:55:55 +00004815 dyn_cast<ConstantInt>(ConstantExpr::getICmp(ICmpInst::ICMP_ULT,
Reid Spencere4d87aa2006-12-23 06:05:41 +00004816 R1->getValue(), R2->getValue()))) {
Reid Spencer579dca12007-01-12 04:24:46 +00004817 if (CB->getZExtValue() == false)
Chris Lattner53e677a2004-04-02 20:23:17 +00004818 std::swap(R1, R2); // R1 is the minimum root now.
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004819
Chris Lattner53e677a2004-04-02 20:23:17 +00004820 // We can only use this value if the chrec ends up with an exact zero
4821 // value at this index. When solving for "X*X != 5", for example, we
4822 // should not accept a root of 2.
Dan Gohman0bba49c2009-07-07 17:06:11 +00004823 const SCEV *Val = AddRec->evaluateAtIteration(R1, *this);
Dan Gohmancfeb6a42008-06-18 16:23:07 +00004824 if (Val->isZero())
4825 return R1; // We found a quadratic root!
Chris Lattner53e677a2004-04-02 20:23:17 +00004826 }
4827 }
4828 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004829
Dan Gohman1c343752009-06-27 21:21:31 +00004830 return getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00004831}
4832
4833/// HowFarToNonZero - Return the number of times a backedge checking the
4834/// specified value for nonzero will execute. If not computable, return
Dan Gohman86fbf2f2009-06-06 14:37:11 +00004835/// CouldNotCompute
Dan Gohmanf6d009f2010-02-24 17:31:30 +00004836ScalarEvolution::BackedgeTakenInfo
4837ScalarEvolution::HowFarToNonZero(const SCEV *V, const Loop *L) {
Chris Lattner53e677a2004-04-02 20:23:17 +00004838 // Loops that look like: while (X == 0) are very strange indeed. We don't
4839 // handle them yet except for the trivial case. This could be expanded in the
4840 // future as needed.
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004841
Chris Lattner53e677a2004-04-02 20:23:17 +00004842 // If the value is a constant, check to see if it is known to be non-zero
4843 // already. If so, the backedge will execute zero times.
Dan Gohman622ed672009-05-04 22:02:23 +00004844 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
Nick Lewycky39442af2008-02-21 09:14:53 +00004845 if (!C->getValue()->isNullValue())
Dan Gohmandeff6212010-05-03 22:09:21 +00004846 return getConstant(C->getType(), 0);
Dan Gohman1c343752009-06-27 21:21:31 +00004847 return getCouldNotCompute(); // Otherwise it will loop infinitely.
Chris Lattner53e677a2004-04-02 20:23:17 +00004848 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004849
Chris Lattner53e677a2004-04-02 20:23:17 +00004850 // We could implement others, but I really doubt anyone writes loops like
4851 // this, and if they did, they would already be constant folded.
Dan Gohman1c343752009-06-27 21:21:31 +00004852 return getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00004853}
4854
Dan Gohmanfd6edef2008-09-15 22:18:04 +00004855/// getPredecessorWithUniqueSuccessorForBB - Return a predecessor of BB
4856/// (which may not be an immediate predecessor) which has exactly one
4857/// successor from which BB is reachable, or null if no such block is
4858/// found.
4859///
Dan Gohman005752b2010-04-15 16:19:08 +00004860std::pair<BasicBlock *, BasicBlock *>
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004861ScalarEvolution::getPredecessorWithUniqueSuccessorForBB(BasicBlock *BB) {
Dan Gohman3d739fe2009-04-30 20:48:53 +00004862 // If the block has a unique predecessor, then there is no path from the
4863 // predecessor to the block that does not go through the direct edge
4864 // from the predecessor to the block.
Dan Gohmanfd6edef2008-09-15 22:18:04 +00004865 if (BasicBlock *Pred = BB->getSinglePredecessor())
Dan Gohman005752b2010-04-15 16:19:08 +00004866 return std::make_pair(Pred, BB);
Dan Gohmanfd6edef2008-09-15 22:18:04 +00004867
4868 // A loop's header is defined to be a block that dominates the loop.
Dan Gohman859b4822009-05-18 15:36:09 +00004869 // If the header has a unique predecessor outside the loop, it must be
4870 // a block that has exactly one successor that can reach the loop.
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004871 if (Loop *L = LI->getLoopFor(BB))
Dan Gohman605c14f2010-06-22 23:43:28 +00004872 return std::make_pair(L->getLoopPredecessor(), L->getHeader());
Dan Gohmanfd6edef2008-09-15 22:18:04 +00004873
Dan Gohman005752b2010-04-15 16:19:08 +00004874 return std::pair<BasicBlock *, BasicBlock *>();
Dan Gohmanfd6edef2008-09-15 22:18:04 +00004875}
4876
Dan Gohman763bad12009-06-20 00:35:32 +00004877/// HasSameValue - SCEV structural equivalence is usually sufficient for
4878/// testing whether two expressions are equal, however for the purposes of
4879/// looking for a condition guarding a loop, it can be useful to be a little
4880/// more general, since a front-end may have replicated the controlling
4881/// expression.
4882///
Dan Gohman0bba49c2009-07-07 17:06:11 +00004883static bool HasSameValue(const SCEV *A, const SCEV *B) {
Dan Gohman763bad12009-06-20 00:35:32 +00004884 // Quick check to see if they are the same SCEV.
4885 if (A == B) return true;
4886
4887 // Otherwise, if they're both SCEVUnknown, it's possible that they hold
4888 // two different instructions with the same value. Check for this case.
4889 if (const SCEVUnknown *AU = dyn_cast<SCEVUnknown>(A))
4890 if (const SCEVUnknown *BU = dyn_cast<SCEVUnknown>(B))
4891 if (const Instruction *AI = dyn_cast<Instruction>(AU->getValue()))
4892 if (const Instruction *BI = dyn_cast<Instruction>(BU->getValue()))
Dan Gohman041de422009-08-25 17:56:57 +00004893 if (AI->isIdenticalTo(BI) && !AI->mayReadFromMemory())
Dan Gohman763bad12009-06-20 00:35:32 +00004894 return true;
4895
4896 // Otherwise assume they may have a different value.
4897 return false;
4898}
4899
Dan Gohmane9796502010-04-24 01:28:42 +00004900/// SimplifyICmpOperands - Simplify LHS and RHS in a comparison with
4901/// predicate Pred. Return true iff any changes were made.
4902///
4903bool ScalarEvolution::SimplifyICmpOperands(ICmpInst::Predicate &Pred,
4904 const SCEV *&LHS, const SCEV *&RHS) {
4905 bool Changed = false;
4906
4907 // Canonicalize a constant to the right side.
4908 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
4909 // Check for both operands constant.
4910 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
4911 if (ConstantExpr::getICmp(Pred,
4912 LHSC->getValue(),
4913 RHSC->getValue())->isNullValue())
4914 goto trivially_false;
4915 else
4916 goto trivially_true;
4917 }
4918 // Otherwise swap the operands to put the constant on the right.
4919 std::swap(LHS, RHS);
4920 Pred = ICmpInst::getSwappedPredicate(Pred);
4921 Changed = true;
4922 }
4923
4924 // If we're comparing an addrec with a value which is loop-invariant in the
Dan Gohman3abb69c2010-05-03 17:00:11 +00004925 // addrec's loop, put the addrec on the left. Also make a dominance check,
4926 // as both operands could be addrecs loop-invariant in each other's loop.
4927 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(RHS)) {
4928 const Loop *L = AR->getLoop();
4929 if (LHS->isLoopInvariant(L) && LHS->properlyDominates(L->getHeader(), DT)) {
Dan Gohmane9796502010-04-24 01:28:42 +00004930 std::swap(LHS, RHS);
4931 Pred = ICmpInst::getSwappedPredicate(Pred);
4932 Changed = true;
4933 }
Dan Gohman3abb69c2010-05-03 17:00:11 +00004934 }
Dan Gohmane9796502010-04-24 01:28:42 +00004935
4936 // If there's a constant operand, canonicalize comparisons with boundary
4937 // cases, and canonicalize *-or-equal comparisons to regular comparisons.
4938 if (const SCEVConstant *RC = dyn_cast<SCEVConstant>(RHS)) {
4939 const APInt &RA = RC->getValue()->getValue();
4940 switch (Pred) {
4941 default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
4942 case ICmpInst::ICMP_EQ:
4943 case ICmpInst::ICMP_NE:
4944 break;
4945 case ICmpInst::ICMP_UGE:
4946 if ((RA - 1).isMinValue()) {
4947 Pred = ICmpInst::ICMP_NE;
4948 RHS = getConstant(RA - 1);
4949 Changed = true;
4950 break;
4951 }
4952 if (RA.isMaxValue()) {
4953 Pred = ICmpInst::ICMP_EQ;
4954 Changed = true;
4955 break;
4956 }
4957 if (RA.isMinValue()) goto trivially_true;
4958
4959 Pred = ICmpInst::ICMP_UGT;
4960 RHS = getConstant(RA - 1);
4961 Changed = true;
4962 break;
4963 case ICmpInst::ICMP_ULE:
4964 if ((RA + 1).isMaxValue()) {
4965 Pred = ICmpInst::ICMP_NE;
4966 RHS = getConstant(RA + 1);
4967 Changed = true;
4968 break;
4969 }
4970 if (RA.isMinValue()) {
4971 Pred = ICmpInst::ICMP_EQ;
4972 Changed = true;
4973 break;
4974 }
4975 if (RA.isMaxValue()) goto trivially_true;
4976
4977 Pred = ICmpInst::ICMP_ULT;
4978 RHS = getConstant(RA + 1);
4979 Changed = true;
4980 break;
4981 case ICmpInst::ICMP_SGE:
4982 if ((RA - 1).isMinSignedValue()) {
4983 Pred = ICmpInst::ICMP_NE;
4984 RHS = getConstant(RA - 1);
4985 Changed = true;
4986 break;
4987 }
4988 if (RA.isMaxSignedValue()) {
4989 Pred = ICmpInst::ICMP_EQ;
4990 Changed = true;
4991 break;
4992 }
4993 if (RA.isMinSignedValue()) goto trivially_true;
4994
4995 Pred = ICmpInst::ICMP_SGT;
4996 RHS = getConstant(RA - 1);
4997 Changed = true;
4998 break;
4999 case ICmpInst::ICMP_SLE:
5000 if ((RA + 1).isMaxSignedValue()) {
5001 Pred = ICmpInst::ICMP_NE;
5002 RHS = getConstant(RA + 1);
5003 Changed = true;
5004 break;
5005 }
5006 if (RA.isMinSignedValue()) {
5007 Pred = ICmpInst::ICMP_EQ;
5008 Changed = true;
5009 break;
5010 }
5011 if (RA.isMaxSignedValue()) goto trivially_true;
5012
5013 Pred = ICmpInst::ICMP_SLT;
5014 RHS = getConstant(RA + 1);
5015 Changed = true;
5016 break;
5017 case ICmpInst::ICMP_UGT:
5018 if (RA.isMinValue()) {
5019 Pred = ICmpInst::ICMP_NE;
5020 Changed = true;
5021 break;
5022 }
5023 if ((RA + 1).isMaxValue()) {
5024 Pred = ICmpInst::ICMP_EQ;
5025 RHS = getConstant(RA + 1);
5026 Changed = true;
5027 break;
5028 }
5029 if (RA.isMaxValue()) goto trivially_false;
5030 break;
5031 case ICmpInst::ICMP_ULT:
5032 if (RA.isMaxValue()) {
5033 Pred = ICmpInst::ICMP_NE;
5034 Changed = true;
5035 break;
5036 }
5037 if ((RA - 1).isMinValue()) {
5038 Pred = ICmpInst::ICMP_EQ;
5039 RHS = getConstant(RA - 1);
5040 Changed = true;
5041 break;
5042 }
5043 if (RA.isMinValue()) goto trivially_false;
5044 break;
5045 case ICmpInst::ICMP_SGT:
5046 if (RA.isMinSignedValue()) {
5047 Pred = ICmpInst::ICMP_NE;
5048 Changed = true;
5049 break;
5050 }
5051 if ((RA + 1).isMaxSignedValue()) {
5052 Pred = ICmpInst::ICMP_EQ;
5053 RHS = getConstant(RA + 1);
5054 Changed = true;
5055 break;
5056 }
5057 if (RA.isMaxSignedValue()) goto trivially_false;
5058 break;
5059 case ICmpInst::ICMP_SLT:
5060 if (RA.isMaxSignedValue()) {
5061 Pred = ICmpInst::ICMP_NE;
5062 Changed = true;
5063 break;
5064 }
5065 if ((RA - 1).isMinSignedValue()) {
5066 Pred = ICmpInst::ICMP_EQ;
5067 RHS = getConstant(RA - 1);
5068 Changed = true;
5069 break;
5070 }
5071 if (RA.isMinSignedValue()) goto trivially_false;
5072 break;
5073 }
5074 }
5075
5076 // Check for obvious equality.
5077 if (HasSameValue(LHS, RHS)) {
5078 if (ICmpInst::isTrueWhenEqual(Pred))
5079 goto trivially_true;
5080 if (ICmpInst::isFalseWhenEqual(Pred))
5081 goto trivially_false;
5082 }
5083
Dan Gohman03557dc2010-05-03 16:35:17 +00005084 // If possible, canonicalize GE/LE comparisons to GT/LT comparisons, by
5085 // adding or subtracting 1 from one of the operands.
5086 switch (Pred) {
5087 case ICmpInst::ICMP_SLE:
5088 if (!getSignedRange(RHS).getSignedMax().isMaxSignedValue()) {
5089 RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
5090 /*HasNUW=*/false, /*HasNSW=*/true);
5091 Pred = ICmpInst::ICMP_SLT;
5092 Changed = true;
5093 } else if (!getSignedRange(LHS).getSignedMin().isMinSignedValue()) {
Dan Gohmanf16c6802010-05-03 20:23:47 +00005094 LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS,
Dan Gohman03557dc2010-05-03 16:35:17 +00005095 /*HasNUW=*/false, /*HasNSW=*/true);
5096 Pred = ICmpInst::ICMP_SLT;
5097 Changed = true;
5098 }
5099 break;
5100 case ICmpInst::ICMP_SGE:
5101 if (!getSignedRange(RHS).getSignedMin().isMinSignedValue()) {
Dan Gohmanf16c6802010-05-03 20:23:47 +00005102 RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS,
Dan Gohman03557dc2010-05-03 16:35:17 +00005103 /*HasNUW=*/false, /*HasNSW=*/true);
5104 Pred = ICmpInst::ICMP_SGT;
5105 Changed = true;
5106 } else if (!getSignedRange(LHS).getSignedMax().isMaxSignedValue()) {
5107 LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
5108 /*HasNUW=*/false, /*HasNSW=*/true);
5109 Pred = ICmpInst::ICMP_SGT;
5110 Changed = true;
5111 }
5112 break;
5113 case ICmpInst::ICMP_ULE:
5114 if (!getUnsignedRange(RHS).getUnsignedMax().isMaxValue()) {
Dan Gohmanf16c6802010-05-03 20:23:47 +00005115 RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
Dan Gohman03557dc2010-05-03 16:35:17 +00005116 /*HasNUW=*/true, /*HasNSW=*/false);
5117 Pred = ICmpInst::ICMP_ULT;
5118 Changed = true;
5119 } else if (!getUnsignedRange(LHS).getUnsignedMin().isMinValue()) {
Dan Gohmanf16c6802010-05-03 20:23:47 +00005120 LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS,
Dan Gohman03557dc2010-05-03 16:35:17 +00005121 /*HasNUW=*/true, /*HasNSW=*/false);
5122 Pred = ICmpInst::ICMP_ULT;
5123 Changed = true;
5124 }
5125 break;
5126 case ICmpInst::ICMP_UGE:
5127 if (!getUnsignedRange(RHS).getUnsignedMin().isMinValue()) {
Dan Gohmanf16c6802010-05-03 20:23:47 +00005128 RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS,
Dan Gohman03557dc2010-05-03 16:35:17 +00005129 /*HasNUW=*/true, /*HasNSW=*/false);
5130 Pred = ICmpInst::ICMP_UGT;
5131 Changed = true;
5132 } else if (!getUnsignedRange(LHS).getUnsignedMax().isMaxValue()) {
Dan Gohmanf16c6802010-05-03 20:23:47 +00005133 LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
Dan Gohman03557dc2010-05-03 16:35:17 +00005134 /*HasNUW=*/true, /*HasNSW=*/false);
5135 Pred = ICmpInst::ICMP_UGT;
5136 Changed = true;
5137 }
5138 break;
5139 default:
5140 break;
5141 }
5142
Dan Gohmane9796502010-04-24 01:28:42 +00005143 // TODO: More simplifications are possible here.
5144
5145 return Changed;
5146
5147trivially_true:
5148 // Return 0 == 0.
5149 LHS = RHS = getConstant(Type::getInt1Ty(getContext()), 0);
5150 Pred = ICmpInst::ICMP_EQ;
5151 return true;
5152
5153trivially_false:
5154 // Return 0 != 0.
5155 LHS = RHS = getConstant(Type::getInt1Ty(getContext()), 0);
5156 Pred = ICmpInst::ICMP_NE;
5157 return true;
5158}
5159
Dan Gohman85b05a22009-07-13 21:35:55 +00005160bool ScalarEvolution::isKnownNegative(const SCEV *S) {
5161 return getSignedRange(S).getSignedMax().isNegative();
5162}
5163
5164bool ScalarEvolution::isKnownPositive(const SCEV *S) {
5165 return getSignedRange(S).getSignedMin().isStrictlyPositive();
5166}
5167
5168bool ScalarEvolution::isKnownNonNegative(const SCEV *S) {
5169 return !getSignedRange(S).getSignedMin().isNegative();
5170}
5171
5172bool ScalarEvolution::isKnownNonPositive(const SCEV *S) {
5173 return !getSignedRange(S).getSignedMax().isStrictlyPositive();
5174}
5175
5176bool ScalarEvolution::isKnownNonZero(const SCEV *S) {
5177 return isKnownNegative(S) || isKnownPositive(S);
5178}
5179
5180bool ScalarEvolution::isKnownPredicate(ICmpInst::Predicate Pred,
5181 const SCEV *LHS, const SCEV *RHS) {
Dan Gohmand19bba62010-04-24 01:38:36 +00005182 // Canonicalize the inputs first.
5183 (void)SimplifyICmpOperands(Pred, LHS, RHS);
5184
Dan Gohman53c66ea2010-04-11 22:16:48 +00005185 // If LHS or RHS is an addrec, check to see if the condition is true in
5186 // every iteration of the loop.
5187 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(LHS))
5188 if (isLoopEntryGuardedByCond(
5189 AR->getLoop(), Pred, AR->getStart(), RHS) &&
5190 isLoopBackedgeGuardedByCond(
Dan Gohmanacd8cab2010-05-04 01:12:27 +00005191 AR->getLoop(), Pred, AR->getPostIncExpr(*this), RHS))
Dan Gohman53c66ea2010-04-11 22:16:48 +00005192 return true;
5193 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(RHS))
5194 if (isLoopEntryGuardedByCond(
5195 AR->getLoop(), Pred, LHS, AR->getStart()) &&
5196 isLoopBackedgeGuardedByCond(
Dan Gohmanacd8cab2010-05-04 01:12:27 +00005197 AR->getLoop(), Pred, LHS, AR->getPostIncExpr(*this)))
Dan Gohman53c66ea2010-04-11 22:16:48 +00005198 return true;
Dan Gohman85b05a22009-07-13 21:35:55 +00005199
Dan Gohman53c66ea2010-04-11 22:16:48 +00005200 // Otherwise see what can be done with known constant ranges.
5201 return isKnownPredicateWithRanges(Pred, LHS, RHS);
5202}
5203
5204bool
5205ScalarEvolution::isKnownPredicateWithRanges(ICmpInst::Predicate Pred,
5206 const SCEV *LHS, const SCEV *RHS) {
Dan Gohman85b05a22009-07-13 21:35:55 +00005207 if (HasSameValue(LHS, RHS))
5208 return ICmpInst::isTrueWhenEqual(Pred);
5209
Dan Gohman53c66ea2010-04-11 22:16:48 +00005210 // This code is split out from isKnownPredicate because it is called from
5211 // within isLoopEntryGuardedByCond.
Dan Gohman85b05a22009-07-13 21:35:55 +00005212 switch (Pred) {
5213 default:
Dan Gohman850f7912009-07-16 17:34:36 +00005214 llvm_unreachable("Unexpected ICmpInst::Predicate value!");
Dan Gohman85b05a22009-07-13 21:35:55 +00005215 break;
5216 case ICmpInst::ICMP_SGT:
5217 Pred = ICmpInst::ICMP_SLT;
5218 std::swap(LHS, RHS);
5219 case ICmpInst::ICMP_SLT: {
5220 ConstantRange LHSRange = getSignedRange(LHS);
5221 ConstantRange RHSRange = getSignedRange(RHS);
5222 if (LHSRange.getSignedMax().slt(RHSRange.getSignedMin()))
5223 return true;
5224 if (LHSRange.getSignedMin().sge(RHSRange.getSignedMax()))
5225 return false;
Dan Gohman85b05a22009-07-13 21:35:55 +00005226 break;
5227 }
5228 case ICmpInst::ICMP_SGE:
5229 Pred = ICmpInst::ICMP_SLE;
5230 std::swap(LHS, RHS);
5231 case ICmpInst::ICMP_SLE: {
5232 ConstantRange LHSRange = getSignedRange(LHS);
5233 ConstantRange RHSRange = getSignedRange(RHS);
5234 if (LHSRange.getSignedMax().sle(RHSRange.getSignedMin()))
5235 return true;
5236 if (LHSRange.getSignedMin().sgt(RHSRange.getSignedMax()))
5237 return false;
Dan Gohman85b05a22009-07-13 21:35:55 +00005238 break;
5239 }
5240 case ICmpInst::ICMP_UGT:
5241 Pred = ICmpInst::ICMP_ULT;
5242 std::swap(LHS, RHS);
5243 case ICmpInst::ICMP_ULT: {
5244 ConstantRange LHSRange = getUnsignedRange(LHS);
5245 ConstantRange RHSRange = getUnsignedRange(RHS);
5246 if (LHSRange.getUnsignedMax().ult(RHSRange.getUnsignedMin()))
5247 return true;
5248 if (LHSRange.getUnsignedMin().uge(RHSRange.getUnsignedMax()))
5249 return false;
Dan Gohman85b05a22009-07-13 21:35:55 +00005250 break;
5251 }
5252 case ICmpInst::ICMP_UGE:
5253 Pred = ICmpInst::ICMP_ULE;
5254 std::swap(LHS, RHS);
5255 case ICmpInst::ICMP_ULE: {
5256 ConstantRange LHSRange = getUnsignedRange(LHS);
5257 ConstantRange RHSRange = getUnsignedRange(RHS);
5258 if (LHSRange.getUnsignedMax().ule(RHSRange.getUnsignedMin()))
5259 return true;
5260 if (LHSRange.getUnsignedMin().ugt(RHSRange.getUnsignedMax()))
5261 return false;
Dan Gohman85b05a22009-07-13 21:35:55 +00005262 break;
5263 }
5264 case ICmpInst::ICMP_NE: {
5265 if (getUnsignedRange(LHS).intersectWith(getUnsignedRange(RHS)).isEmptySet())
5266 return true;
5267 if (getSignedRange(LHS).intersectWith(getSignedRange(RHS)).isEmptySet())
5268 return true;
5269
5270 const SCEV *Diff = getMinusSCEV(LHS, RHS);
5271 if (isKnownNonZero(Diff))
5272 return true;
5273 break;
5274 }
5275 case ICmpInst::ICMP_EQ:
Dan Gohmanf117ed42009-07-20 23:54:43 +00005276 // The check at the top of the function catches the case where
5277 // the values are known to be equal.
Dan Gohman85b05a22009-07-13 21:35:55 +00005278 break;
5279 }
5280 return false;
5281}
5282
5283/// isLoopBackedgeGuardedByCond - Test whether the backedge of the loop is
5284/// protected by a conditional between LHS and RHS. This is used to
5285/// to eliminate casts.
5286bool
5287ScalarEvolution::isLoopBackedgeGuardedByCond(const Loop *L,
5288 ICmpInst::Predicate Pred,
5289 const SCEV *LHS, const SCEV *RHS) {
5290 // Interpret a null as meaning no loop, where there is obviously no guard
5291 // (interprocedural conditions notwithstanding).
5292 if (!L) return true;
5293
5294 BasicBlock *Latch = L->getLoopLatch();
5295 if (!Latch)
5296 return false;
5297
5298 BranchInst *LoopContinuePredicate =
5299 dyn_cast<BranchInst>(Latch->getTerminator());
5300 if (!LoopContinuePredicate ||
5301 LoopContinuePredicate->isUnconditional())
5302 return false;
5303
Dan Gohmanaf08a362010-08-10 23:46:30 +00005304 return isImpliedCond(Pred, LHS, RHS,
5305 LoopContinuePredicate->getCondition(),
Dan Gohman0f4b2852009-07-21 23:03:19 +00005306 LoopContinuePredicate->getSuccessor(0) != L->getHeader());
Dan Gohman85b05a22009-07-13 21:35:55 +00005307}
5308
Dan Gohman3948d0b2010-04-11 19:27:13 +00005309/// isLoopEntryGuardedByCond - Test whether entry to the loop is protected
Dan Gohman85b05a22009-07-13 21:35:55 +00005310/// by a conditional between LHS and RHS. This is used to help avoid max
5311/// expressions in loop trip counts, and to eliminate casts.
5312bool
Dan Gohman3948d0b2010-04-11 19:27:13 +00005313ScalarEvolution::isLoopEntryGuardedByCond(const Loop *L,
5314 ICmpInst::Predicate Pred,
5315 const SCEV *LHS, const SCEV *RHS) {
Dan Gohman8ea94522009-05-18 16:03:58 +00005316 // Interpret a null as meaning no loop, where there is obviously no guard
5317 // (interprocedural conditions notwithstanding).
5318 if (!L) return false;
5319
Dan Gohman859b4822009-05-18 15:36:09 +00005320 // Starting at the loop predecessor, climb up the predecessor chain, as long
5321 // as there are predecessors that can be found that have unique successors
Dan Gohmanfd6edef2008-09-15 22:18:04 +00005322 // leading to the original header.
Dan Gohman005752b2010-04-15 16:19:08 +00005323 for (std::pair<BasicBlock *, BasicBlock *>
Dan Gohman605c14f2010-06-22 23:43:28 +00005324 Pair(L->getLoopPredecessor(), L->getHeader());
Dan Gohman005752b2010-04-15 16:19:08 +00005325 Pair.first;
5326 Pair = getPredecessorWithUniqueSuccessorForBB(Pair.first)) {
Dan Gohman38372182008-08-12 20:17:31 +00005327
5328 BranchInst *LoopEntryPredicate =
Dan Gohman005752b2010-04-15 16:19:08 +00005329 dyn_cast<BranchInst>(Pair.first->getTerminator());
Dan Gohman38372182008-08-12 20:17:31 +00005330 if (!LoopEntryPredicate ||
5331 LoopEntryPredicate->isUnconditional())
5332 continue;
5333
Dan Gohmanaf08a362010-08-10 23:46:30 +00005334 if (isImpliedCond(Pred, LHS, RHS,
5335 LoopEntryPredicate->getCondition(),
Dan Gohman005752b2010-04-15 16:19:08 +00005336 LoopEntryPredicate->getSuccessor(0) != Pair.second))
Dan Gohman38372182008-08-12 20:17:31 +00005337 return true;
Nick Lewycky59cff122008-07-12 07:41:32 +00005338 }
5339
Dan Gohman38372182008-08-12 20:17:31 +00005340 return false;
Nick Lewycky59cff122008-07-12 07:41:32 +00005341}
5342
Dan Gohman0f4b2852009-07-21 23:03:19 +00005343/// isImpliedCond - Test whether the condition described by Pred, LHS,
5344/// and RHS is true whenever the given Cond value evaluates to true.
Dan Gohmanaf08a362010-08-10 23:46:30 +00005345bool ScalarEvolution::isImpliedCond(ICmpInst::Predicate Pred,
Dan Gohman0f4b2852009-07-21 23:03:19 +00005346 const SCEV *LHS, const SCEV *RHS,
Dan Gohmanaf08a362010-08-10 23:46:30 +00005347 Value *FoundCondValue,
Dan Gohman0f4b2852009-07-21 23:03:19 +00005348 bool Inverse) {
Dan Gohman3f46a3a2010-03-01 17:49:51 +00005349 // Recursively handle And and Or conditions.
Dan Gohmanaf08a362010-08-10 23:46:30 +00005350 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(FoundCondValue)) {
Dan Gohman40a5a1b2009-06-24 01:18:18 +00005351 if (BO->getOpcode() == Instruction::And) {
5352 if (!Inverse)
Dan Gohmanaf08a362010-08-10 23:46:30 +00005353 return isImpliedCond(Pred, LHS, RHS, BO->getOperand(0), Inverse) ||
5354 isImpliedCond(Pred, LHS, RHS, BO->getOperand(1), Inverse);
Dan Gohman40a5a1b2009-06-24 01:18:18 +00005355 } else if (BO->getOpcode() == Instruction::Or) {
5356 if (Inverse)
Dan Gohmanaf08a362010-08-10 23:46:30 +00005357 return isImpliedCond(Pred, LHS, RHS, BO->getOperand(0), Inverse) ||
5358 isImpliedCond(Pred, LHS, RHS, BO->getOperand(1), Inverse);
Dan Gohman40a5a1b2009-06-24 01:18:18 +00005359 }
5360 }
5361
Dan Gohmanaf08a362010-08-10 23:46:30 +00005362 ICmpInst *ICI = dyn_cast<ICmpInst>(FoundCondValue);
Dan Gohman40a5a1b2009-06-24 01:18:18 +00005363 if (!ICI) return false;
5364
Dan Gohman85b05a22009-07-13 21:35:55 +00005365 // Bail if the ICmp's operands' types are wider than the needed type
5366 // before attempting to call getSCEV on them. This avoids infinite
5367 // recursion, since the analysis of widening casts can require loop
5368 // exit condition information for overflow checking, which would
5369 // lead back here.
5370 if (getTypeSizeInBits(LHS->getType()) <
Dan Gohman0f4b2852009-07-21 23:03:19 +00005371 getTypeSizeInBits(ICI->getOperand(0)->getType()))
Dan Gohman85b05a22009-07-13 21:35:55 +00005372 return false;
5373
Dan Gohman0f4b2852009-07-21 23:03:19 +00005374 // Now that we found a conditional branch that dominates the loop, check to
5375 // see if it is the comparison we are looking for.
5376 ICmpInst::Predicate FoundPred;
5377 if (Inverse)
5378 FoundPred = ICI->getInversePredicate();
5379 else
5380 FoundPred = ICI->getPredicate();
5381
5382 const SCEV *FoundLHS = getSCEV(ICI->getOperand(0));
5383 const SCEV *FoundRHS = getSCEV(ICI->getOperand(1));
Dan Gohman85b05a22009-07-13 21:35:55 +00005384
5385 // Balance the types. The case where FoundLHS' type is wider than
5386 // LHS' type is checked for above.
5387 if (getTypeSizeInBits(LHS->getType()) >
5388 getTypeSizeInBits(FoundLHS->getType())) {
5389 if (CmpInst::isSigned(Pred)) {
5390 FoundLHS = getSignExtendExpr(FoundLHS, LHS->getType());
5391 FoundRHS = getSignExtendExpr(FoundRHS, LHS->getType());
5392 } else {
5393 FoundLHS = getZeroExtendExpr(FoundLHS, LHS->getType());
5394 FoundRHS = getZeroExtendExpr(FoundRHS, LHS->getType());
5395 }
5396 }
5397
Dan Gohman0f4b2852009-07-21 23:03:19 +00005398 // Canonicalize the query to match the way instcombine will have
5399 // canonicalized the comparison.
Dan Gohmand4da5af2010-04-24 01:34:53 +00005400 if (SimplifyICmpOperands(Pred, LHS, RHS))
5401 if (LHS == RHS)
Dan Gohman34c3e362010-05-03 18:00:24 +00005402 return CmpInst::isTrueWhenEqual(Pred);
Dan Gohmand4da5af2010-04-24 01:34:53 +00005403 if (SimplifyICmpOperands(FoundPred, FoundLHS, FoundRHS))
5404 if (FoundLHS == FoundRHS)
Dan Gohman34c3e362010-05-03 18:00:24 +00005405 return CmpInst::isFalseWhenEqual(Pred);
Dan Gohman0f4b2852009-07-21 23:03:19 +00005406
5407 // Check to see if we can make the LHS or RHS match.
5408 if (LHS == FoundRHS || RHS == FoundLHS) {
5409 if (isa<SCEVConstant>(RHS)) {
5410 std::swap(FoundLHS, FoundRHS);
5411 FoundPred = ICmpInst::getSwappedPredicate(FoundPred);
5412 } else {
5413 std::swap(LHS, RHS);
5414 Pred = ICmpInst::getSwappedPredicate(Pred);
5415 }
5416 }
5417
5418 // Check whether the found predicate is the same as the desired predicate.
5419 if (FoundPred == Pred)
5420 return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS);
5421
5422 // Check whether swapping the found predicate makes it the same as the
5423 // desired predicate.
5424 if (ICmpInst::getSwappedPredicate(FoundPred) == Pred) {
5425 if (isa<SCEVConstant>(RHS))
5426 return isImpliedCondOperands(Pred, LHS, RHS, FoundRHS, FoundLHS);
5427 else
5428 return isImpliedCondOperands(ICmpInst::getSwappedPredicate(Pred),
5429 RHS, LHS, FoundLHS, FoundRHS);
5430 }
5431
5432 // Check whether the actual condition is beyond sufficient.
5433 if (FoundPred == ICmpInst::ICMP_EQ)
5434 if (ICmpInst::isTrueWhenEqual(Pred))
5435 if (isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS))
5436 return true;
5437 if (Pred == ICmpInst::ICMP_NE)
5438 if (!ICmpInst::isTrueWhenEqual(FoundPred))
5439 if (isImpliedCondOperands(FoundPred, LHS, RHS, FoundLHS, FoundRHS))
5440 return true;
5441
5442 // Otherwise assume the worst.
5443 return false;
Dan Gohman85b05a22009-07-13 21:35:55 +00005444}
5445
Dan Gohman0f4b2852009-07-21 23:03:19 +00005446/// isImpliedCondOperands - Test whether the condition described by Pred,
Dan Gohman3f46a3a2010-03-01 17:49:51 +00005447/// LHS, and RHS is true whenever the condition described by Pred, FoundLHS,
Dan Gohman0f4b2852009-07-21 23:03:19 +00005448/// and FoundRHS is true.
5449bool ScalarEvolution::isImpliedCondOperands(ICmpInst::Predicate Pred,
5450 const SCEV *LHS, const SCEV *RHS,
5451 const SCEV *FoundLHS,
5452 const SCEV *FoundRHS) {
5453 return isImpliedCondOperandsHelper(Pred, LHS, RHS,
5454 FoundLHS, FoundRHS) ||
5455 // ~x < ~y --> x > y
5456 isImpliedCondOperandsHelper(Pred, LHS, RHS,
5457 getNotSCEV(FoundRHS),
5458 getNotSCEV(FoundLHS));
5459}
5460
5461/// isImpliedCondOperandsHelper - Test whether the condition described by
Dan Gohman3f46a3a2010-03-01 17:49:51 +00005462/// Pred, LHS, and RHS is true whenever the condition described by Pred,
Dan Gohman0f4b2852009-07-21 23:03:19 +00005463/// FoundLHS, and FoundRHS is true.
Dan Gohman85b05a22009-07-13 21:35:55 +00005464bool
Dan Gohman0f4b2852009-07-21 23:03:19 +00005465ScalarEvolution::isImpliedCondOperandsHelper(ICmpInst::Predicate Pred,
5466 const SCEV *LHS, const SCEV *RHS,
5467 const SCEV *FoundLHS,
5468 const SCEV *FoundRHS) {
Dan Gohman85b05a22009-07-13 21:35:55 +00005469 switch (Pred) {
Dan Gohman850f7912009-07-16 17:34:36 +00005470 default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
5471 case ICmpInst::ICMP_EQ:
5472 case ICmpInst::ICMP_NE:
5473 if (HasSameValue(LHS, FoundLHS) && HasSameValue(RHS, FoundRHS))
5474 return true;
5475 break;
Dan Gohman85b05a22009-07-13 21:35:55 +00005476 case ICmpInst::ICMP_SLT:
Dan Gohman850f7912009-07-16 17:34:36 +00005477 case ICmpInst::ICMP_SLE:
Dan Gohman53c66ea2010-04-11 22:16:48 +00005478 if (isKnownPredicateWithRanges(ICmpInst::ICMP_SLE, LHS, FoundLHS) &&
5479 isKnownPredicateWithRanges(ICmpInst::ICMP_SGE, RHS, FoundRHS))
Dan Gohman85b05a22009-07-13 21:35:55 +00005480 return true;
5481 break;
5482 case ICmpInst::ICMP_SGT:
Dan Gohman850f7912009-07-16 17:34:36 +00005483 case ICmpInst::ICMP_SGE:
Dan Gohman53c66ea2010-04-11 22:16:48 +00005484 if (isKnownPredicateWithRanges(ICmpInst::ICMP_SGE, LHS, FoundLHS) &&
5485 isKnownPredicateWithRanges(ICmpInst::ICMP_SLE, RHS, FoundRHS))
Dan Gohman85b05a22009-07-13 21:35:55 +00005486 return true;
5487 break;
5488 case ICmpInst::ICMP_ULT:
Dan Gohman850f7912009-07-16 17:34:36 +00005489 case ICmpInst::ICMP_ULE:
Dan Gohman53c66ea2010-04-11 22:16:48 +00005490 if (isKnownPredicateWithRanges(ICmpInst::ICMP_ULE, LHS, FoundLHS) &&
5491 isKnownPredicateWithRanges(ICmpInst::ICMP_UGE, RHS, FoundRHS))
Dan Gohman85b05a22009-07-13 21:35:55 +00005492 return true;
5493 break;
5494 case ICmpInst::ICMP_UGT:
Dan Gohman850f7912009-07-16 17:34:36 +00005495 case ICmpInst::ICMP_UGE:
Dan Gohman53c66ea2010-04-11 22:16:48 +00005496 if (isKnownPredicateWithRanges(ICmpInst::ICMP_UGE, LHS, FoundLHS) &&
5497 isKnownPredicateWithRanges(ICmpInst::ICMP_ULE, RHS, FoundRHS))
Dan Gohman85b05a22009-07-13 21:35:55 +00005498 return true;
5499 break;
5500 }
5501
5502 return false;
Dan Gohman40a5a1b2009-06-24 01:18:18 +00005503}
5504
Dan Gohman51f53b72009-06-21 23:46:38 +00005505/// getBECount - Subtract the end and start values and divide by the step,
5506/// rounding up, to get the number of times the backedge is executed. Return
5507/// CouldNotCompute if an intermediate computation overflows.
Dan Gohman0bba49c2009-07-07 17:06:11 +00005508const SCEV *ScalarEvolution::getBECount(const SCEV *Start,
Dan Gohmanf5074ec2009-07-13 22:05:32 +00005509 const SCEV *End,
Dan Gohman1f96e672009-09-17 18:05:20 +00005510 const SCEV *Step,
5511 bool NoWrap) {
Dan Gohman52fddd32010-01-26 04:40:18 +00005512 assert(!isKnownNegative(Step) &&
5513 "This code doesn't handle negative strides yet!");
5514
Dan Gohman51f53b72009-06-21 23:46:38 +00005515 const Type *Ty = Start->getType();
Dan Gohmandeff6212010-05-03 22:09:21 +00005516 const SCEV *NegOne = getConstant(Ty, (uint64_t)-1);
Dan Gohman0bba49c2009-07-07 17:06:11 +00005517 const SCEV *Diff = getMinusSCEV(End, Start);
5518 const SCEV *RoundUp = getAddExpr(Step, NegOne);
Dan Gohman51f53b72009-06-21 23:46:38 +00005519
5520 // Add an adjustment to the difference between End and Start so that
5521 // the division will effectively round up.
Dan Gohman0bba49c2009-07-07 17:06:11 +00005522 const SCEV *Add = getAddExpr(Diff, RoundUp);
Dan Gohman51f53b72009-06-21 23:46:38 +00005523
Dan Gohman1f96e672009-09-17 18:05:20 +00005524 if (!NoWrap) {
5525 // Check Add for unsigned overflow.
5526 // TODO: More sophisticated things could be done here.
5527 const Type *WideTy = IntegerType::get(getContext(),
5528 getTypeSizeInBits(Ty) + 1);
5529 const SCEV *EDiff = getZeroExtendExpr(Diff, WideTy);
5530 const SCEV *ERoundUp = getZeroExtendExpr(RoundUp, WideTy);
5531 const SCEV *OperandExtendedAdd = getAddExpr(EDiff, ERoundUp);
5532 if (getZeroExtendExpr(Add, WideTy) != OperandExtendedAdd)
5533 return getCouldNotCompute();
5534 }
Dan Gohman51f53b72009-06-21 23:46:38 +00005535
5536 return getUDivExpr(Add, Step);
5537}
5538
Chris Lattnerdb25de42005-08-15 23:33:51 +00005539/// HowManyLessThans - Return the number of times a backedge containing the
5540/// specified less-than comparison will execute. If not computable, return
Dan Gohman86fbf2f2009-06-06 14:37:11 +00005541/// CouldNotCompute.
Dan Gohman64a845e2009-06-24 04:48:43 +00005542ScalarEvolution::BackedgeTakenInfo
5543ScalarEvolution::HowManyLessThans(const SCEV *LHS, const SCEV *RHS,
5544 const Loop *L, bool isSigned) {
Chris Lattnerdb25de42005-08-15 23:33:51 +00005545 // Only handle: "ADDREC < LoopInvariant".
Dan Gohman1c343752009-06-27 21:21:31 +00005546 if (!RHS->isLoopInvariant(L)) return getCouldNotCompute();
Chris Lattnerdb25de42005-08-15 23:33:51 +00005547
Dan Gohman35738ac2009-05-04 22:30:44 +00005548 const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS);
Chris Lattnerdb25de42005-08-15 23:33:51 +00005549 if (!AddRec || AddRec->getLoop() != L)
Dan Gohman1c343752009-06-27 21:21:31 +00005550 return getCouldNotCompute();
Chris Lattnerdb25de42005-08-15 23:33:51 +00005551
Dan Gohman1f96e672009-09-17 18:05:20 +00005552 // Check to see if we have a flag which makes analysis easy.
5553 bool NoWrap = isSigned ? AddRec->hasNoSignedWrap() :
5554 AddRec->hasNoUnsignedWrap();
5555
Chris Lattnerdb25de42005-08-15 23:33:51 +00005556 if (AddRec->isAffine()) {
Dan Gohmana1af7572009-04-30 20:47:05 +00005557 unsigned BitWidth = getTypeSizeInBits(AddRec->getType());
Dan Gohman0bba49c2009-07-07 17:06:11 +00005558 const SCEV *Step = AddRec->getStepRecurrence(*this);
Dan Gohmana1af7572009-04-30 20:47:05 +00005559
Dan Gohman52fddd32010-01-26 04:40:18 +00005560 if (Step->isZero())
Dan Gohman1c343752009-06-27 21:21:31 +00005561 return getCouldNotCompute();
Dan Gohman52fddd32010-01-26 04:40:18 +00005562 if (Step->isOne()) {
Dan Gohmana1af7572009-04-30 20:47:05 +00005563 // With unit stride, the iteration never steps past the limit value.
Dan Gohman52fddd32010-01-26 04:40:18 +00005564 } else if (isKnownPositive(Step)) {
Dan Gohmanf451cb82010-02-10 16:03:48 +00005565 // Test whether a positive iteration can step past the limit
Dan Gohman52fddd32010-01-26 04:40:18 +00005566 // value and past the maximum value for its type in a single step.
5567 // Note that it's not sufficient to check NoWrap here, because even
5568 // though the value after a wrap is undefined, it's not undefined
5569 // behavior, so if wrap does occur, the loop could either terminate or
Dan Gohman155eec72010-01-26 18:32:54 +00005570 // loop infinitely, but in either case, the loop is guaranteed to
Dan Gohman52fddd32010-01-26 04:40:18 +00005571 // iterate at least until the iteration where the wrapping occurs.
Dan Gohmandeff6212010-05-03 22:09:21 +00005572 const SCEV *One = getConstant(Step->getType(), 1);
Dan Gohman52fddd32010-01-26 04:40:18 +00005573 if (isSigned) {
5574 APInt Max = APInt::getSignedMaxValue(BitWidth);
5575 if ((Max - getSignedRange(getMinusSCEV(Step, One)).getSignedMax())
5576 .slt(getSignedRange(RHS).getSignedMax()))
5577 return getCouldNotCompute();
5578 } else {
5579 APInt Max = APInt::getMaxValue(BitWidth);
5580 if ((Max - getUnsignedRange(getMinusSCEV(Step, One)).getUnsignedMax())
5581 .ult(getUnsignedRange(RHS).getUnsignedMax()))
5582 return getCouldNotCompute();
5583 }
Dan Gohmana1af7572009-04-30 20:47:05 +00005584 } else
Dan Gohman52fddd32010-01-26 04:40:18 +00005585 // TODO: Handle negative strides here and below.
Dan Gohman1c343752009-06-27 21:21:31 +00005586 return getCouldNotCompute();
Chris Lattnerdb25de42005-08-15 23:33:51 +00005587
Dan Gohmana1af7572009-04-30 20:47:05 +00005588 // We know the LHS is of the form {n,+,s} and the RHS is some loop-invariant
5589 // m. So, we count the number of iterations in which {n,+,s} < m is true.
5590 // Note that we cannot simply return max(m-n,0)/s because it's not safe to
Wojciech Matyjewicza65ee032008-02-13 12:21:32 +00005591 // treat m-n as signed nor unsigned due to overflow possibility.
Chris Lattnerdb25de42005-08-15 23:33:51 +00005592
Wojciech Matyjewicz3a4cbe22008-02-13 11:51:34 +00005593 // First, we get the value of the LHS in the first iteration: n
Dan Gohman0bba49c2009-07-07 17:06:11 +00005594 const SCEV *Start = AddRec->getOperand(0);
Wojciech Matyjewicz3a4cbe22008-02-13 11:51:34 +00005595
Dan Gohmana1af7572009-04-30 20:47:05 +00005596 // Determine the minimum constant start value.
Dan Gohman85b05a22009-07-13 21:35:55 +00005597 const SCEV *MinStart = getConstant(isSigned ?
5598 getSignedRange(Start).getSignedMin() :
5599 getUnsignedRange(Start).getUnsignedMin());
Wojciech Matyjewicz3a4cbe22008-02-13 11:51:34 +00005600
Dan Gohmana1af7572009-04-30 20:47:05 +00005601 // If we know that the condition is true in order to enter the loop,
5602 // then we know that it will run exactly (m-n)/s times. Otherwise, we
Dan Gohman6c0866c2009-05-24 23:45:28 +00005603 // only know that it will execute (max(m,n)-n)/s times. In both cases,
5604 // the division must round up.
Dan Gohman0bba49c2009-07-07 17:06:11 +00005605 const SCEV *End = RHS;
Dan Gohman3948d0b2010-04-11 19:27:13 +00005606 if (!isLoopEntryGuardedByCond(L,
5607 isSigned ? ICmpInst::ICMP_SLT :
5608 ICmpInst::ICMP_ULT,
5609 getMinusSCEV(Start, Step), RHS))
Dan Gohmana1af7572009-04-30 20:47:05 +00005610 End = isSigned ? getSMaxExpr(RHS, Start)
5611 : getUMaxExpr(RHS, Start);
5612
5613 // Determine the maximum constant end value.
Dan Gohman85b05a22009-07-13 21:35:55 +00005614 const SCEV *MaxEnd = getConstant(isSigned ?
5615 getSignedRange(End).getSignedMax() :
5616 getUnsignedRange(End).getUnsignedMax());
Dan Gohmana1af7572009-04-30 20:47:05 +00005617
Dan Gohman52fddd32010-01-26 04:40:18 +00005618 // If MaxEnd is within a step of the maximum integer value in its type,
5619 // adjust it down to the minimum value which would produce the same effect.
Dan Gohman3f46a3a2010-03-01 17:49:51 +00005620 // This allows the subsequent ceiling division of (N+(step-1))/step to
Dan Gohman52fddd32010-01-26 04:40:18 +00005621 // compute the correct value.
5622 const SCEV *StepMinusOne = getMinusSCEV(Step,
Dan Gohmandeff6212010-05-03 22:09:21 +00005623 getConstant(Step->getType(), 1));
Dan Gohman52fddd32010-01-26 04:40:18 +00005624 MaxEnd = isSigned ?
5625 getSMinExpr(MaxEnd,
5626 getMinusSCEV(getConstant(APInt::getSignedMaxValue(BitWidth)),
5627 StepMinusOne)) :
5628 getUMinExpr(MaxEnd,
5629 getMinusSCEV(getConstant(APInt::getMaxValue(BitWidth)),
5630 StepMinusOne));
5631
Dan Gohmana1af7572009-04-30 20:47:05 +00005632 // Finally, we subtract these two values and divide, rounding up, to get
5633 // the number of times the backedge is executed.
Dan Gohman1f96e672009-09-17 18:05:20 +00005634 const SCEV *BECount = getBECount(Start, End, Step, NoWrap);
Dan Gohmana1af7572009-04-30 20:47:05 +00005635
5636 // The maximum backedge count is similar, except using the minimum start
5637 // value and the maximum end value.
Dan Gohman1f96e672009-09-17 18:05:20 +00005638 const SCEV *MaxBECount = getBECount(MinStart, MaxEnd, Step, NoWrap);
Dan Gohmana1af7572009-04-30 20:47:05 +00005639
5640 return BackedgeTakenInfo(BECount, MaxBECount);
Chris Lattnerdb25de42005-08-15 23:33:51 +00005641 }
5642
Dan Gohman1c343752009-06-27 21:21:31 +00005643 return getCouldNotCompute();
Chris Lattnerdb25de42005-08-15 23:33:51 +00005644}
5645
Chris Lattner53e677a2004-04-02 20:23:17 +00005646/// getNumIterationsInRange - Return the number of iterations of this loop that
5647/// produce values in the specified constant range. Another way of looking at
5648/// this is that it returns the first iteration number where the value is not in
5649/// the condition, thus computing the exit count. If the iteration count can't
5650/// be computed, an instance of SCEVCouldNotCompute is returned.
Dan Gohman0bba49c2009-07-07 17:06:11 +00005651const SCEV *SCEVAddRecExpr::getNumIterationsInRange(ConstantRange Range,
Dan Gohman64a845e2009-06-24 04:48:43 +00005652 ScalarEvolution &SE) const {
Chris Lattner53e677a2004-04-02 20:23:17 +00005653 if (Range.isFullSet()) // Infinite loop.
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +00005654 return SE.getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00005655
5656 // If the start is a non-zero constant, shift the range to simplify things.
Dan Gohman622ed672009-05-04 22:02:23 +00005657 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(getStart()))
Reid Spencercae57542007-03-02 00:28:52 +00005658 if (!SC->getValue()->isZero()) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00005659 SmallVector<const SCEV *, 4> Operands(op_begin(), op_end());
Dan Gohmandeff6212010-05-03 22:09:21 +00005660 Operands[0] = SE.getConstant(SC->getType(), 0);
Dan Gohman0bba49c2009-07-07 17:06:11 +00005661 const SCEV *Shifted = SE.getAddRecExpr(Operands, getLoop());
Dan Gohman622ed672009-05-04 22:02:23 +00005662 if (const SCEVAddRecExpr *ShiftedAddRec =
5663 dyn_cast<SCEVAddRecExpr>(Shifted))
Chris Lattner53e677a2004-04-02 20:23:17 +00005664 return ShiftedAddRec->getNumIterationsInRange(
Dan Gohman246b2562007-10-22 18:31:58 +00005665 Range.subtract(SC->getValue()->getValue()), SE);
Chris Lattner53e677a2004-04-02 20:23:17 +00005666 // This is strange and shouldn't happen.
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +00005667 return SE.getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00005668 }
5669
5670 // The only time we can solve this is when we have all constant indices.
5671 // Otherwise, we cannot determine the overflow conditions.
5672 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
5673 if (!isa<SCEVConstant>(getOperand(i)))
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +00005674 return SE.getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00005675
5676
5677 // Okay at this point we know that all elements of the chrec are constants and
5678 // that the start element is zero.
5679
5680 // First check to see if the range contains zero. If not, the first
5681 // iteration exits.
Dan Gohmanaf79fb52009-04-21 01:07:12 +00005682 unsigned BitWidth = SE.getTypeSizeInBits(getType());
Dan Gohman2d1be872009-04-16 03:18:22 +00005683 if (!Range.contains(APInt(BitWidth, 0)))
Dan Gohmandeff6212010-05-03 22:09:21 +00005684 return SE.getConstant(getType(), 0);
Misha Brukman2b37d7c2005-04-21 21:13:18 +00005685
Chris Lattner53e677a2004-04-02 20:23:17 +00005686 if (isAffine()) {
5687 // If this is an affine expression then we have this situation:
5688 // Solve {0,+,A} in Range === Ax in Range
5689
Nick Lewyckyeefdebe2007-07-16 02:08:00 +00005690 // We know that zero is in the range. If A is positive then we know that
5691 // the upper value of the range must be the first possible exit value.
5692 // If A is negative then the lower of the range is the last possible loop
5693 // value. Also note that we already checked for a full range.
Dan Gohman2d1be872009-04-16 03:18:22 +00005694 APInt One(BitWidth,1);
Nick Lewyckyeefdebe2007-07-16 02:08:00 +00005695 APInt A = cast<SCEVConstant>(getOperand(1))->getValue()->getValue();
5696 APInt End = A.sge(One) ? (Range.getUpper() - One) : Range.getLower();
Chris Lattner53e677a2004-04-02 20:23:17 +00005697
Nick Lewyckyeefdebe2007-07-16 02:08:00 +00005698 // The exit value should be (End+A)/A.
Nick Lewycky9a2f9312007-09-27 14:12:54 +00005699 APInt ExitVal = (End + A).udiv(A);
Owen Andersoneed707b2009-07-24 23:12:02 +00005700 ConstantInt *ExitValue = ConstantInt::get(SE.getContext(), ExitVal);
Chris Lattner53e677a2004-04-02 20:23:17 +00005701
5702 // Evaluate at the exit value. If we really did fall out of the valid
5703 // range, then we computed our trip count, otherwise wrap around or other
5704 // things must have happened.
Dan Gohman246b2562007-10-22 18:31:58 +00005705 ConstantInt *Val = EvaluateConstantChrecAtConstant(this, ExitValue, SE);
Reid Spencera6e8a952007-03-01 07:54:15 +00005706 if (Range.contains(Val->getValue()))
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +00005707 return SE.getCouldNotCompute(); // Something strange happened
Chris Lattner53e677a2004-04-02 20:23:17 +00005708
5709 // Ensure that the previous value is in the range. This is a sanity check.
Reid Spencer581b0d42007-02-28 19:57:34 +00005710 assert(Range.contains(
Dan Gohman64a845e2009-06-24 04:48:43 +00005711 EvaluateConstantChrecAtConstant(this,
Owen Andersoneed707b2009-07-24 23:12:02 +00005712 ConstantInt::get(SE.getContext(), ExitVal - One), SE)->getValue()) &&
Chris Lattner53e677a2004-04-02 20:23:17 +00005713 "Linear scev computation is off in a bad way!");
Dan Gohman246b2562007-10-22 18:31:58 +00005714 return SE.getConstant(ExitValue);
Chris Lattner53e677a2004-04-02 20:23:17 +00005715 } else if (isQuadratic()) {
5716 // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of the
5717 // quadratic equation to solve it. To do this, we must frame our problem in
5718 // terms of figuring out when zero is crossed, instead of when
5719 // Range.getUpper() is crossed.
Dan Gohman0bba49c2009-07-07 17:06:11 +00005720 SmallVector<const SCEV *, 4> NewOps(op_begin(), op_end());
Dan Gohman246b2562007-10-22 18:31:58 +00005721 NewOps[0] = SE.getNegativeSCEV(SE.getConstant(Range.getUpper()));
Dan Gohman0bba49c2009-07-07 17:06:11 +00005722 const SCEV *NewAddRec = SE.getAddRecExpr(NewOps, getLoop());
Chris Lattner53e677a2004-04-02 20:23:17 +00005723
5724 // Next, solve the constructed addrec
Dan Gohman0bba49c2009-07-07 17:06:11 +00005725 std::pair<const SCEV *,const SCEV *> Roots =
Dan Gohman246b2562007-10-22 18:31:58 +00005726 SolveQuadraticEquation(cast<SCEVAddRecExpr>(NewAddRec), SE);
Dan Gohman35738ac2009-05-04 22:30:44 +00005727 const SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
5728 const SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
Chris Lattner53e677a2004-04-02 20:23:17 +00005729 if (R1) {
5730 // Pick the smallest positive root value.
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00005731 if (ConstantInt *CB =
Owen Andersonbaf3c402009-07-29 18:55:55 +00005732 dyn_cast<ConstantInt>(ConstantExpr::getICmp(ICmpInst::ICMP_ULT,
Owen Anderson76f600b2009-07-06 22:37:39 +00005733 R1->getValue(), R2->getValue()))) {
Reid Spencer579dca12007-01-12 04:24:46 +00005734 if (CB->getZExtValue() == false)
Chris Lattner53e677a2004-04-02 20:23:17 +00005735 std::swap(R1, R2); // R1 is the minimum root now.
Misha Brukman2b37d7c2005-04-21 21:13:18 +00005736
Chris Lattner53e677a2004-04-02 20:23:17 +00005737 // Make sure the root is not off by one. The returned iteration should
5738 // not be in the range, but the previous one should be. When solving
5739 // for "X*X < 5", for example, we should not return a root of 2.
5740 ConstantInt *R1Val = EvaluateConstantChrecAtConstant(this,
Dan Gohman246b2562007-10-22 18:31:58 +00005741 R1->getValue(),
5742 SE);
Reid Spencera6e8a952007-03-01 07:54:15 +00005743 if (Range.contains(R1Val->getValue())) {
Chris Lattner53e677a2004-04-02 20:23:17 +00005744 // The next iteration must be out of the range...
Owen Anderson76f600b2009-07-06 22:37:39 +00005745 ConstantInt *NextVal =
Owen Andersoneed707b2009-07-24 23:12:02 +00005746 ConstantInt::get(SE.getContext(), R1->getValue()->getValue()+1);
Misha Brukman2b37d7c2005-04-21 21:13:18 +00005747
Dan Gohman246b2562007-10-22 18:31:58 +00005748 R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
Reid Spencera6e8a952007-03-01 07:54:15 +00005749 if (!Range.contains(R1Val->getValue()))
Dan Gohman246b2562007-10-22 18:31:58 +00005750 return SE.getConstant(NextVal);
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +00005751 return SE.getCouldNotCompute(); // Something strange happened
Chris Lattner53e677a2004-04-02 20:23:17 +00005752 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +00005753
Chris Lattner53e677a2004-04-02 20:23:17 +00005754 // If R1 was not in the range, then it is a good return value. Make
5755 // sure that R1-1 WAS in the range though, just in case.
Owen Anderson76f600b2009-07-06 22:37:39 +00005756 ConstantInt *NextVal =
Owen Andersoneed707b2009-07-24 23:12:02 +00005757 ConstantInt::get(SE.getContext(), R1->getValue()->getValue()-1);
Dan Gohman246b2562007-10-22 18:31:58 +00005758 R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
Reid Spencera6e8a952007-03-01 07:54:15 +00005759 if (Range.contains(R1Val->getValue()))
Chris Lattner53e677a2004-04-02 20:23:17 +00005760 return R1;
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +00005761 return SE.getCouldNotCompute(); // Something strange happened
Chris Lattner53e677a2004-04-02 20:23:17 +00005762 }
5763 }
5764 }
5765
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +00005766 return SE.getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00005767}
5768
5769
5770
5771//===----------------------------------------------------------------------===//
Dan Gohman35738ac2009-05-04 22:30:44 +00005772// SCEVCallbackVH Class Implementation
5773//===----------------------------------------------------------------------===//
5774
Dan Gohman1959b752009-05-19 19:22:47 +00005775void ScalarEvolution::SCEVCallbackVH::deleted() {
Dan Gohmanddf9f992009-07-13 22:20:53 +00005776 assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
Dan Gohman35738ac2009-05-04 22:30:44 +00005777 if (PHINode *PN = dyn_cast<PHINode>(getValPtr()))
5778 SE->ConstantEvolutionLoopExitValue.erase(PN);
Dan Gohmane8ac3f32010-08-27 18:55:03 +00005779 SE->ValueExprMap.erase(getValPtr());
Dan Gohman35738ac2009-05-04 22:30:44 +00005780 // this now dangles!
5781}
5782
Dan Gohman81f91212010-07-28 01:09:07 +00005783void ScalarEvolution::SCEVCallbackVH::allUsesReplacedWith(Value *V) {
Dan Gohmanddf9f992009-07-13 22:20:53 +00005784 assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
Eric Christophere6cbfa62010-07-29 01:25:38 +00005785
Dan Gohman35738ac2009-05-04 22:30:44 +00005786 // Forget all the expressions associated with users of the old value,
5787 // so that future queries will recompute the expressions using the new
5788 // value.
Dan Gohmanab37f502010-08-02 23:49:30 +00005789 Value *Old = getValPtr();
Dan Gohman35738ac2009-05-04 22:30:44 +00005790 SmallVector<User *, 16> Worklist;
Dan Gohman69fcae92009-07-14 14:34:04 +00005791 SmallPtrSet<User *, 8> Visited;
Dan Gohman35738ac2009-05-04 22:30:44 +00005792 for (Value::use_iterator UI = Old->use_begin(), UE = Old->use_end();
5793 UI != UE; ++UI)
5794 Worklist.push_back(*UI);
5795 while (!Worklist.empty()) {
5796 User *U = Worklist.pop_back_val();
5797 // Deleting the Old value will cause this to dangle. Postpone
5798 // that until everything else is done.
Dan Gohman59846ac2010-07-28 00:28:25 +00005799 if (U == Old)
Dan Gohman35738ac2009-05-04 22:30:44 +00005800 continue;
Dan Gohman69fcae92009-07-14 14:34:04 +00005801 if (!Visited.insert(U))
5802 continue;
Dan Gohman35738ac2009-05-04 22:30:44 +00005803 if (PHINode *PN = dyn_cast<PHINode>(U))
5804 SE->ConstantEvolutionLoopExitValue.erase(PN);
Dan Gohmane8ac3f32010-08-27 18:55:03 +00005805 SE->ValueExprMap.erase(U);
Dan Gohman69fcae92009-07-14 14:34:04 +00005806 for (Value::use_iterator UI = U->use_begin(), UE = U->use_end();
5807 UI != UE; ++UI)
5808 Worklist.push_back(*UI);
Dan Gohman35738ac2009-05-04 22:30:44 +00005809 }
Dan Gohman59846ac2010-07-28 00:28:25 +00005810 // Delete the Old value.
5811 if (PHINode *PN = dyn_cast<PHINode>(Old))
5812 SE->ConstantEvolutionLoopExitValue.erase(PN);
Dan Gohmane8ac3f32010-08-27 18:55:03 +00005813 SE->ValueExprMap.erase(Old);
Dan Gohman59846ac2010-07-28 00:28:25 +00005814 // this now dangles!
Dan Gohman35738ac2009-05-04 22:30:44 +00005815}
5816
Dan Gohman1959b752009-05-19 19:22:47 +00005817ScalarEvolution::SCEVCallbackVH::SCEVCallbackVH(Value *V, ScalarEvolution *se)
Dan Gohman35738ac2009-05-04 22:30:44 +00005818 : CallbackVH(V), SE(se) {}
5819
5820//===----------------------------------------------------------------------===//
Chris Lattner53e677a2004-04-02 20:23:17 +00005821// ScalarEvolution Class Implementation
5822//===----------------------------------------------------------------------===//
5823
Dan Gohmanf8a8be82009-04-21 23:15:49 +00005824ScalarEvolution::ScalarEvolution()
Owen Anderson90c579d2010-08-06 18:33:48 +00005825 : FunctionPass(ID), FirstUnknown(0) {
Dan Gohmanf8a8be82009-04-21 23:15:49 +00005826}
5827
Chris Lattner53e677a2004-04-02 20:23:17 +00005828bool ScalarEvolution::runOnFunction(Function &F) {
Dan Gohmanf8a8be82009-04-21 23:15:49 +00005829 this->F = &F;
5830 LI = &getAnalysis<LoopInfo>();
5831 TD = getAnalysisIfAvailable<TargetData>();
Dan Gohman454d26d2010-02-22 04:11:59 +00005832 DT = &getAnalysis<DominatorTree>();
Chris Lattner53e677a2004-04-02 20:23:17 +00005833 return false;
5834}
5835
5836void ScalarEvolution::releaseMemory() {
Dan Gohmanab37f502010-08-02 23:49:30 +00005837 // Iterate through all the SCEVUnknown instances and call their
5838 // destructors, so that they release their references to their values.
5839 for (SCEVUnknown *U = FirstUnknown; U; U = U->Next)
5840 U->~SCEVUnknown();
5841 FirstUnknown = 0;
5842
Dan Gohmane8ac3f32010-08-27 18:55:03 +00005843 ValueExprMap.clear();
Dan Gohmanf8a8be82009-04-21 23:15:49 +00005844 BackedgeTakenCounts.clear();
5845 ConstantEvolutionLoopExitValue.clear();
Dan Gohman6bce6432009-05-08 20:47:27 +00005846 ValuesAtScopes.clear();
Dan Gohman1c343752009-06-27 21:21:31 +00005847 UniqueSCEVs.clear();
5848 SCEVAllocator.Reset();
Chris Lattner53e677a2004-04-02 20:23:17 +00005849}
5850
5851void ScalarEvolution::getAnalysisUsage(AnalysisUsage &AU) const {
5852 AU.setPreservesAll();
Chris Lattner53e677a2004-04-02 20:23:17 +00005853 AU.addRequiredTransitive<LoopInfo>();
Dan Gohman1cd92752010-01-19 22:21:27 +00005854 AU.addRequiredTransitive<DominatorTree>();
Dan Gohman2d1be872009-04-16 03:18:22 +00005855}
5856
Dan Gohmanf8a8be82009-04-21 23:15:49 +00005857bool ScalarEvolution::hasLoopInvariantBackedgeTakenCount(const Loop *L) {
Dan Gohman46bdfb02009-02-24 18:55:53 +00005858 return !isa<SCEVCouldNotCompute>(getBackedgeTakenCount(L));
Chris Lattner53e677a2004-04-02 20:23:17 +00005859}
5860
Dan Gohmanf8a8be82009-04-21 23:15:49 +00005861static void PrintLoopInfo(raw_ostream &OS, ScalarEvolution *SE,
Chris Lattner53e677a2004-04-02 20:23:17 +00005862 const Loop *L) {
5863 // Print all inner loops first
5864 for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
5865 PrintLoopInfo(OS, SE, *I);
Misha Brukman2b37d7c2005-04-21 21:13:18 +00005866
Dan Gohman30733292010-01-09 18:17:45 +00005867 OS << "Loop ";
5868 WriteAsOperand(OS, L->getHeader(), /*PrintType=*/false);
5869 OS << ": ";
Chris Lattnerf1ab4b42004-04-18 22:14:10 +00005870
Dan Gohman5d984912009-12-18 01:14:11 +00005871 SmallVector<BasicBlock *, 8> ExitBlocks;
Chris Lattnerf1ab4b42004-04-18 22:14:10 +00005872 L->getExitBlocks(ExitBlocks);
5873 if (ExitBlocks.size() != 1)
Nick Lewyckyaeb5e5c2008-01-02 02:49:20 +00005874 OS << "<multiple exits> ";
Chris Lattner53e677a2004-04-02 20:23:17 +00005875
Dan Gohman46bdfb02009-02-24 18:55:53 +00005876 if (SE->hasLoopInvariantBackedgeTakenCount(L)) {
5877 OS << "backedge-taken count is " << *SE->getBackedgeTakenCount(L);
Chris Lattner53e677a2004-04-02 20:23:17 +00005878 } else {
Dan Gohman46bdfb02009-02-24 18:55:53 +00005879 OS << "Unpredictable backedge-taken count. ";
Chris Lattner53e677a2004-04-02 20:23:17 +00005880 }
5881
Dan Gohman30733292010-01-09 18:17:45 +00005882 OS << "\n"
5883 "Loop ";
5884 WriteAsOperand(OS, L->getHeader(), /*PrintType=*/false);
5885 OS << ": ";
Dan Gohmanaa551ae2009-06-24 00:33:16 +00005886
5887 if (!isa<SCEVCouldNotCompute>(SE->getMaxBackedgeTakenCount(L))) {
5888 OS << "max backedge-taken count is " << *SE->getMaxBackedgeTakenCount(L);
5889 } else {
5890 OS << "Unpredictable max backedge-taken count. ";
5891 }
5892
5893 OS << "\n";
Chris Lattner53e677a2004-04-02 20:23:17 +00005894}
5895
Dan Gohman5d984912009-12-18 01:14:11 +00005896void ScalarEvolution::print(raw_ostream &OS, const Module *) const {
Dan Gohman3f46a3a2010-03-01 17:49:51 +00005897 // ScalarEvolution's implementation of the print method is to print
Dan Gohmanf8a8be82009-04-21 23:15:49 +00005898 // out SCEV values of all instructions that are interesting. Doing
5899 // this potentially causes it to create new SCEV objects though,
5900 // which technically conflicts with the const qualifier. This isn't
Dan Gohman1afdc5f2009-07-10 20:25:29 +00005901 // observable from outside the class though, so casting away the
5902 // const isn't dangerous.
Dan Gohman5d984912009-12-18 01:14:11 +00005903 ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
Chris Lattner53e677a2004-04-02 20:23:17 +00005904
Dan Gohman30733292010-01-09 18:17:45 +00005905 OS << "Classifying expressions for: ";
5906 WriteAsOperand(OS, F, /*PrintType=*/false);
5907 OS << "\n";
Chris Lattner53e677a2004-04-02 20:23:17 +00005908 for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
Dan Gohmana189bae2010-05-03 17:03:23 +00005909 if (isSCEVable(I->getType()) && !isa<CmpInst>(*I)) {
Dan Gohmanc902e132009-07-13 23:03:05 +00005910 OS << *I << '\n';
Dan Gohman8dae1382008-09-14 17:21:12 +00005911 OS << " --> ";
Dan Gohman0bba49c2009-07-07 17:06:11 +00005912 const SCEV *SV = SE.getSCEV(&*I);
Chris Lattner53e677a2004-04-02 20:23:17 +00005913 SV->print(OS);
Misha Brukman2b37d7c2005-04-21 21:13:18 +00005914
Dan Gohman0c689c52009-06-19 17:49:54 +00005915 const Loop *L = LI->getLoopFor((*I).getParent());
5916
Dan Gohman0bba49c2009-07-07 17:06:11 +00005917 const SCEV *AtUse = SE.getSCEVAtScope(SV, L);
Dan Gohman0c689c52009-06-19 17:49:54 +00005918 if (AtUse != SV) {
5919 OS << " --> ";
5920 AtUse->print(OS);
5921 }
5922
5923 if (L) {
Dan Gohman9e7d9882009-06-18 00:37:45 +00005924 OS << "\t\t" "Exits: ";
Dan Gohman0bba49c2009-07-07 17:06:11 +00005925 const SCEV *ExitValue = SE.getSCEVAtScope(SV, L->getParentLoop());
Dan Gohmand594e6f2009-05-24 23:25:42 +00005926 if (!ExitValue->isLoopInvariant(L)) {
Chris Lattner53e677a2004-04-02 20:23:17 +00005927 OS << "<<Unknown>>";
5928 } else {
5929 OS << *ExitValue;
5930 }
5931 }
5932
Chris Lattner53e677a2004-04-02 20:23:17 +00005933 OS << "\n";
5934 }
5935
Dan Gohman30733292010-01-09 18:17:45 +00005936 OS << "Determining loop execution counts for: ";
5937 WriteAsOperand(OS, F, /*PrintType=*/false);
5938 OS << "\n";
Dan Gohmanf8a8be82009-04-21 23:15:49 +00005939 for (LoopInfo::iterator I = LI->begin(), E = LI->end(); I != E; ++I)
5940 PrintLoopInfo(OS, &SE, *I);
Chris Lattner53e677a2004-04-02 20:23:17 +00005941}
Dan Gohmanb7ef7292009-04-21 00:47:46 +00005942