blob: 69507beeaae956c4e78dafd8ec03005d739577be [file] [log] [blame]
Nate Begeman36f891b2005-07-30 00:12:19 +00001//===- ScalarEvolutionExpander.cpp - Scalar Evolution Analysis --*- C++ -*-===//
2//
3// 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.
Nate Begeman36f891b2005-07-30 00:12:19 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file contains the implementation of the scalar evolution expander,
11// which is used to generate the code corresponding to a given scalar evolution
12// expression.
13//
14//===----------------------------------------------------------------------===//
15
Nate Begeman36f891b2005-07-30 00:12:19 +000016#include "llvm/Analysis/ScalarEvolutionExpander.h"
Bill Wendlinge8156192006-12-07 01:30:32 +000017#include "llvm/Analysis/LoopInfo.h"
Dale Johannesen8d50ea72010-03-05 21:12:40 +000018#include "llvm/IntrinsicInst.h"
Owen Anderson76f600b2009-07-06 22:37:39 +000019#include "llvm/LLVMContext.h"
Andrew Trickc5701912011-10-07 23:46:21 +000020#include "llvm/Support/Debug.h"
Dan Gohman5be18e82009-05-19 02:15:55 +000021#include "llvm/Target/TargetData.h"
Andrew Trickee98aa82012-01-07 01:12:09 +000022#include "llvm/Target/TargetLowering.h"
Dan Gohman4d8414f2009-06-13 16:25:49 +000023#include "llvm/ADT/STLExtras.h"
Andrew Trickd152d032011-07-16 00:59:39 +000024
Nate Begeman36f891b2005-07-30 00:12:19 +000025using namespace llvm;
26
Gabor Greif19e5ada2010-07-09 16:42:04 +000027/// ReuseOrCreateCast - Arrange for there to be a cast of V to Ty at IP,
Dan Gohman485c43f2010-06-19 13:25:23 +000028/// reusing an existing cast if a suitable one exists, moving an existing
29/// cast if a suitable one exists but isn't in the right place, or
Gabor Greif19e5ada2010-07-09 16:42:04 +000030/// creating a new one.
Chris Lattnerdb125cf2011-07-18 04:54:35 +000031Value *SCEVExpander::ReuseOrCreateCast(Value *V, Type *Ty,
Dan Gohman485c43f2010-06-19 13:25:23 +000032 Instruction::CastOps Op,
33 BasicBlock::iterator IP) {
Rafael Espindola919a5032012-02-22 03:21:39 +000034 // This function must be called with the builder having a valid insertion
35 // point. It doesn't need to be the actual IP where the uses of the returned
36 // cast will be added, but it must dominate such IP.
Rafael Espindola23b6ec92012-02-27 02:13:03 +000037 // We use this precondition to produce a cast that will dominate all its
38 // uses. In particular, this is crucial for the case where the builder's
39 // insertion point *is* the point where we were asked to put the cast.
Rafael Espindola919a5032012-02-22 03:21:39 +000040 // Since we don't know the the builder's insertion point is actually
41 // where the uses will be added (only that it dominates it), we are
42 // not allowed to move it.
43 BasicBlock::iterator BIP = Builder.GetInsertPoint();
44
Rafael Espindola23b6ec92012-02-27 02:13:03 +000045 Instruction *Ret = NULL;
Rafael Espindolaef4c80e2012-02-18 17:22:58 +000046
Dan Gohman485c43f2010-06-19 13:25:23 +000047 // Check to see if there is already a cast!
48 for (Value::use_iterator UI = V->use_begin(), E = V->use_end();
Gabor Greiff64f9cf2010-07-09 16:39:02 +000049 UI != E; ++UI) {
50 User *U = *UI;
51 if (U->getType() == Ty)
Gabor Greif19e5ada2010-07-09 16:42:04 +000052 if (CastInst *CI = dyn_cast<CastInst>(U))
Dan Gohman485c43f2010-06-19 13:25:23 +000053 if (CI->getOpcode() == Op) {
Rafael Espindolab84d5402012-02-22 03:44:46 +000054 // If the cast isn't where we want it, create a new cast at IP.
55 // Likewise, do not reuse a cast at BIP because it must dominate
56 // instructions that might be inserted before BIP.
Rafael Espindola919a5032012-02-22 03:21:39 +000057 if (BasicBlock::iterator(CI) != IP || BIP == IP) {
Dan Gohman485c43f2010-06-19 13:25:23 +000058 // Create a new cast, and leave the old cast in place in case
59 // it is being used as an insert point. Clear its operand
60 // so that it doesn't hold anything live.
Rafael Espindola23b6ec92012-02-27 02:13:03 +000061 Ret = CastInst::Create(Op, V, Ty, "", IP);
62 Ret->takeName(CI);
63 CI->replaceAllUsesWith(Ret);
Dan Gohman485c43f2010-06-19 13:25:23 +000064 CI->setOperand(0, UndefValue::get(V->getType()));
Rafael Espindola23b6ec92012-02-27 02:13:03 +000065 break;
Dan Gohman485c43f2010-06-19 13:25:23 +000066 }
Rafael Espindola23b6ec92012-02-27 02:13:03 +000067 Ret = CI;
68 break;
Dan Gohman485c43f2010-06-19 13:25:23 +000069 }
Gabor Greiff64f9cf2010-07-09 16:39:02 +000070 }
Dan Gohman485c43f2010-06-19 13:25:23 +000071
72 // Create a new cast.
Rafael Espindola23b6ec92012-02-27 02:13:03 +000073 if (!Ret)
74 Ret = CastInst::Create(Op, V, Ty, V->getName(), IP);
75
76 // We assert at the end of the function since IP might point to an
77 // instruction with different dominance properties than a cast
78 // (an invoke for example) and not dominate BIP (but the cast does).
79 assert(SE.DT->dominates(Ret, BIP));
80
81 rememberInstruction(Ret);
82 return Ret;
Dan Gohman485c43f2010-06-19 13:25:23 +000083}
84
Dan Gohman267a3852009-06-27 21:18:18 +000085/// InsertNoopCastOfTo - Insert a cast of V to the specified type,
86/// which must be possible with a noop cast, doing what we can to share
87/// the casts.
Chris Lattnerdb125cf2011-07-18 04:54:35 +000088Value *SCEVExpander::InsertNoopCastOfTo(Value *V, Type *Ty) {
Dan Gohman267a3852009-06-27 21:18:18 +000089 Instruction::CastOps Op = CastInst::getCastOpcode(V, false, Ty, false);
90 assert((Op == Instruction::BitCast ||
91 Op == Instruction::PtrToInt ||
92 Op == Instruction::IntToPtr) &&
93 "InsertNoopCastOfTo cannot perform non-noop casts!");
94 assert(SE.getTypeSizeInBits(V->getType()) == SE.getTypeSizeInBits(Ty) &&
95 "InsertNoopCastOfTo cannot change sizes!");
96
Dan Gohman2d1be872009-04-16 03:18:22 +000097 // Short-circuit unnecessary bitcasts.
Andrew Trick19154f42011-12-14 22:07:19 +000098 if (Op == Instruction::BitCast) {
99 if (V->getType() == Ty)
100 return V;
101 if (CastInst *CI = dyn_cast<CastInst>(V)) {
102 if (CI->getOperand(0)->getType() == Ty)
103 return CI->getOperand(0);
104 }
105 }
Dan Gohmanf04fa482009-04-16 15:52:57 +0000106 // Short-circuit unnecessary inttoptr<->ptrtoint casts.
Dan Gohman267a3852009-06-27 21:18:18 +0000107 if ((Op == Instruction::PtrToInt || Op == Instruction::IntToPtr) &&
Dan Gohman80dcdee2009-05-01 17:00:00 +0000108 SE.getTypeSizeInBits(Ty) == SE.getTypeSizeInBits(V->getType())) {
Dan Gohmanaf79fb52009-04-21 01:07:12 +0000109 if (CastInst *CI = dyn_cast<CastInst>(V))
110 if ((CI->getOpcode() == Instruction::PtrToInt ||
111 CI->getOpcode() == Instruction::IntToPtr) &&
112 SE.getTypeSizeInBits(CI->getType()) ==
113 SE.getTypeSizeInBits(CI->getOperand(0)->getType()))
114 return CI->getOperand(0);
Dan Gohman80dcdee2009-05-01 17:00:00 +0000115 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
116 if ((CE->getOpcode() == Instruction::PtrToInt ||
117 CE->getOpcode() == Instruction::IntToPtr) &&
118 SE.getTypeSizeInBits(CE->getType()) ==
119 SE.getTypeSizeInBits(CE->getOperand(0)->getType()))
120 return CE->getOperand(0);
121 }
Dan Gohmanf04fa482009-04-16 15:52:57 +0000122
Dan Gohman485c43f2010-06-19 13:25:23 +0000123 // Fold a cast of a constant.
Chris Lattnerca1a4be2006-02-04 09:51:53 +0000124 if (Constant *C = dyn_cast<Constant>(V))
Owen Andersonbaf3c402009-07-29 18:55:55 +0000125 return ConstantExpr::getCast(Op, C, Ty);
Dan Gohman4c0d5d52009-08-20 16:42:55 +0000126
Dan Gohman485c43f2010-06-19 13:25:23 +0000127 // Cast the argument at the beginning of the entry block, after
128 // any bitcasts of other arguments.
Chris Lattnerca1a4be2006-02-04 09:51:53 +0000129 if (Argument *A = dyn_cast<Argument>(V)) {
Dan Gohman485c43f2010-06-19 13:25:23 +0000130 BasicBlock::iterator IP = A->getParent()->getEntryBlock().begin();
131 while ((isa<BitCastInst>(IP) &&
132 isa<Argument>(cast<BitCastInst>(IP)->getOperand(0)) &&
133 cast<BitCastInst>(IP)->getOperand(0) != A) ||
Bill Wendlinga4c86ab2011-08-24 21:06:46 +0000134 isa<DbgInfoIntrinsic>(IP) ||
135 isa<LandingPadInst>(IP))
Dan Gohman485c43f2010-06-19 13:25:23 +0000136 ++IP;
137 return ReuseOrCreateCast(A, Ty, Op, IP);
Chris Lattnerca1a4be2006-02-04 09:51:53 +0000138 }
Wojciech Matyjewicz39131872008-02-09 18:30:13 +0000139
Dan Gohman485c43f2010-06-19 13:25:23 +0000140 // Cast the instruction immediately after the instruction.
Chris Lattnerca1a4be2006-02-04 09:51:53 +0000141 Instruction *I = cast<Instruction>(V);
Chris Lattnerca1a4be2006-02-04 09:51:53 +0000142 BasicBlock::iterator IP = I; ++IP;
143 if (InvokeInst *II = dyn_cast<InvokeInst>(I))
144 IP = II->getNormalDest()->begin();
Rafael Espindolaef4c80e2012-02-18 17:22:58 +0000145 while (isa<PHINode>(IP) || isa<LandingPadInst>(IP))
Bill Wendlinga4c86ab2011-08-24 21:06:46 +0000146 ++IP;
Dan Gohman485c43f2010-06-19 13:25:23 +0000147 return ReuseOrCreateCast(I, Ty, Op, IP);
Chris Lattnerca1a4be2006-02-04 09:51:53 +0000148}
149
Chris Lattner7fec90e2007-04-13 05:04:18 +0000150/// InsertBinop - Insert the specified binary operator, doing a small amount
151/// of work to avoid inserting an obviously redundant operation.
Dan Gohman267a3852009-06-27 21:18:18 +0000152Value *SCEVExpander::InsertBinop(Instruction::BinaryOps Opcode,
153 Value *LHS, Value *RHS) {
Dan Gohman0f0eb182007-06-15 19:21:55 +0000154 // Fold a binop with constant operands.
155 if (Constant *CLHS = dyn_cast<Constant>(LHS))
156 if (Constant *CRHS = dyn_cast<Constant>(RHS))
Owen Andersonbaf3c402009-07-29 18:55:55 +0000157 return ConstantExpr::get(Opcode, CLHS, CRHS);
Dan Gohman0f0eb182007-06-15 19:21:55 +0000158
Chris Lattner7fec90e2007-04-13 05:04:18 +0000159 // Do a quick scan to see if we have this binop nearby. If so, reuse it.
160 unsigned ScanLimit = 6;
Dan Gohman267a3852009-06-27 21:18:18 +0000161 BasicBlock::iterator BlockBegin = Builder.GetInsertBlock()->begin();
162 // Scanning starts from the last instruction before the insertion point.
163 BasicBlock::iterator IP = Builder.GetInsertPoint();
164 if (IP != BlockBegin) {
Wojciech Matyjewicz8a087692008-06-15 19:07:39 +0000165 --IP;
166 for (; ScanLimit; --IP, --ScanLimit) {
Dale Johannesen8d50ea72010-03-05 21:12:40 +0000167 // Don't count dbg.value against the ScanLimit, to avoid perturbing the
168 // generated code.
169 if (isa<DbgInfoIntrinsic>(IP))
170 ScanLimit++;
Dan Gohman5be18e82009-05-19 02:15:55 +0000171 if (IP->getOpcode() == (unsigned)Opcode && IP->getOperand(0) == LHS &&
172 IP->getOperand(1) == RHS)
173 return IP;
Wojciech Matyjewicz8a087692008-06-15 19:07:39 +0000174 if (IP == BlockBegin) break;
175 }
Chris Lattner7fec90e2007-04-13 05:04:18 +0000176 }
Dan Gohman267a3852009-06-27 21:18:18 +0000177
Dan Gohman087bd1e2010-03-03 05:29:13 +0000178 // Save the original insertion point so we can restore it when we're done.
179 BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
180 BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
181
182 // Move the insertion point out of as many loops as we can.
183 while (const Loop *L = SE.LI->getLoopFor(Builder.GetInsertBlock())) {
184 if (!L->isLoopInvariant(LHS) || !L->isLoopInvariant(RHS)) break;
185 BasicBlock *Preheader = L->getLoopPreheader();
186 if (!Preheader) break;
187
188 // Ok, move up a level.
189 Builder.SetInsertPoint(Preheader, Preheader->getTerminator());
190 }
191
Wojciech Matyjewicz8a087692008-06-15 19:07:39 +0000192 // If we haven't found this binop, insert it.
Benjamin Kramera9390a42011-09-27 20:39:19 +0000193 Instruction *BO = cast<Instruction>(Builder.CreateBinOp(Opcode, LHS, RHS));
Devang Pateldf3ad662011-06-22 20:56:56 +0000194 BO->setDebugLoc(SaveInsertPt->getDebugLoc());
Dan Gohmana10756e2010-01-21 02:09:26 +0000195 rememberInstruction(BO);
Dan Gohman087bd1e2010-03-03 05:29:13 +0000196
197 // Restore the original insert point.
198 if (SaveInsertBB)
199 restoreInsertPoint(SaveInsertBB, SaveInsertPt);
200
Dan Gohmancf5ab822009-05-01 17:13:31 +0000201 return BO;
Chris Lattner7fec90e2007-04-13 05:04:18 +0000202}
203
Dan Gohman4a4f7672009-05-27 02:00:53 +0000204/// FactorOutConstant - Test if S is divisible by Factor, using signed
Dan Gohman453aa4f2009-05-24 18:06:31 +0000205/// division. If so, update S with Factor divided out and return true.
Dan Gohman3f46a3a2010-03-01 17:49:51 +0000206/// S need not be evenly divisible if a reasonable remainder can be
Dan Gohman4a4f7672009-05-27 02:00:53 +0000207/// computed.
Dan Gohman453aa4f2009-05-24 18:06:31 +0000208/// TODO: When ScalarEvolution gets a SCEVSDivExpr, this can be made
209/// unnecessary; in its place, just signed-divide Ops[i] by the scale and
210/// check to see if the divide was folded.
Dan Gohman0bba49c2009-07-07 17:06:11 +0000211static bool FactorOutConstant(const SCEV *&S,
212 const SCEV *&Remainder,
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000213 const SCEV *Factor,
214 ScalarEvolution &SE,
215 const TargetData *TD) {
Dan Gohman453aa4f2009-05-24 18:06:31 +0000216 // Everything is divisible by one.
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000217 if (Factor->isOne())
Dan Gohman453aa4f2009-05-24 18:06:31 +0000218 return true;
219
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000220 // x/x == 1.
221 if (S == Factor) {
Dan Gohmandeff6212010-05-03 22:09:21 +0000222 S = SE.getConstant(S->getType(), 1);
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000223 return true;
224 }
225
Dan Gohman453aa4f2009-05-24 18:06:31 +0000226 // For a Constant, check for a multiple of the given factor.
Dan Gohman4a4f7672009-05-27 02:00:53 +0000227 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S)) {
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000228 // 0/x == 0.
229 if (C->isZero())
Dan Gohman453aa4f2009-05-24 18:06:31 +0000230 return true;
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000231 // Check for divisibility.
232 if (const SCEVConstant *FC = dyn_cast<SCEVConstant>(Factor)) {
233 ConstantInt *CI =
234 ConstantInt::get(SE.getContext(),
235 C->getValue()->getValue().sdiv(
236 FC->getValue()->getValue()));
237 // If the quotient is zero and the remainder is non-zero, reject
238 // the value at this scale. It will be considered for subsequent
239 // smaller scales.
240 if (!CI->isZero()) {
241 const SCEV *Div = SE.getConstant(CI);
242 S = Div;
243 Remainder =
244 SE.getAddExpr(Remainder,
245 SE.getConstant(C->getValue()->getValue().srem(
246 FC->getValue()->getValue())));
247 return true;
248 }
Dan Gohman453aa4f2009-05-24 18:06:31 +0000249 }
Dan Gohman4a4f7672009-05-27 02:00:53 +0000250 }
Dan Gohman453aa4f2009-05-24 18:06:31 +0000251
252 // In a Mul, check if there is a constant operand which is a multiple
253 // of the given factor.
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000254 if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(S)) {
255 if (TD) {
256 // With TargetData, the size is known. Check if there is a constant
257 // operand which is a multiple of the given factor. If so, we can
258 // factor it.
259 const SCEVConstant *FC = cast<SCEVConstant>(Factor);
260 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(M->getOperand(0)))
261 if (!C->getValue()->getValue().srem(FC->getValue()->getValue())) {
Dan Gohmanf9e64722010-03-18 01:17:13 +0000262 SmallVector<const SCEV *, 4> NewMulOps(M->op_begin(), M->op_end());
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000263 NewMulOps[0] =
264 SE.getConstant(C->getValue()->getValue().sdiv(
265 FC->getValue()->getValue()));
266 S = SE.getMulExpr(NewMulOps);
267 return true;
268 }
269 } else {
270 // Without TargetData, check if Factor can be factored out of any of the
271 // Mul's operands. If so, we can just remove it.
272 for (unsigned i = 0, e = M->getNumOperands(); i != e; ++i) {
273 const SCEV *SOp = M->getOperand(i);
Dan Gohmandeff6212010-05-03 22:09:21 +0000274 const SCEV *Remainder = SE.getConstant(SOp->getType(), 0);
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000275 if (FactorOutConstant(SOp, Remainder, Factor, SE, TD) &&
276 Remainder->isZero()) {
Dan Gohmanf9e64722010-03-18 01:17:13 +0000277 SmallVector<const SCEV *, 4> NewMulOps(M->op_begin(), M->op_end());
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000278 NewMulOps[i] = SOp;
279 S = SE.getMulExpr(NewMulOps);
280 return true;
281 }
Dan Gohman453aa4f2009-05-24 18:06:31 +0000282 }
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000283 }
284 }
Dan Gohman453aa4f2009-05-24 18:06:31 +0000285
286 // In an AddRec, check if both start and step are divisible.
287 if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(S)) {
Dan Gohman0bba49c2009-07-07 17:06:11 +0000288 const SCEV *Step = A->getStepRecurrence(SE);
Dan Gohmandeff6212010-05-03 22:09:21 +0000289 const SCEV *StepRem = SE.getConstant(Step->getType(), 0);
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000290 if (!FactorOutConstant(Step, StepRem, Factor, SE, TD))
Dan Gohman4a4f7672009-05-27 02:00:53 +0000291 return false;
292 if (!StepRem->isZero())
293 return false;
Dan Gohman0bba49c2009-07-07 17:06:11 +0000294 const SCEV *Start = A->getStart();
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000295 if (!FactorOutConstant(Start, Remainder, Factor, SE, TD))
Dan Gohman453aa4f2009-05-24 18:06:31 +0000296 return false;
Andrew Trick3228cc22011-03-14 16:50:06 +0000297 // FIXME: can use A->getNoWrapFlags(FlagNW)
298 S = SE.getAddRecExpr(Start, Step, A->getLoop(), SCEV::FlagAnyWrap);
Dan Gohman453aa4f2009-05-24 18:06:31 +0000299 return true;
300 }
301
302 return false;
303}
304
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000305/// SimplifyAddOperands - Sort and simplify a list of add operands. NumAddRecs
306/// is the number of SCEVAddRecExprs present, which are kept at the end of
307/// the list.
308///
309static void SimplifyAddOperands(SmallVectorImpl<const SCEV *> &Ops,
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000310 Type *Ty,
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000311 ScalarEvolution &SE) {
312 unsigned NumAddRecs = 0;
313 for (unsigned i = Ops.size(); i > 0 && isa<SCEVAddRecExpr>(Ops[i-1]); --i)
314 ++NumAddRecs;
315 // Group Ops into non-addrecs and addrecs.
316 SmallVector<const SCEV *, 8> NoAddRecs(Ops.begin(), Ops.end() - NumAddRecs);
317 SmallVector<const SCEV *, 8> AddRecs(Ops.end() - NumAddRecs, Ops.end());
318 // Let ScalarEvolution sort and simplify the non-addrecs list.
319 const SCEV *Sum = NoAddRecs.empty() ?
Dan Gohmandeff6212010-05-03 22:09:21 +0000320 SE.getConstant(Ty, 0) :
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000321 SE.getAddExpr(NoAddRecs);
322 // If it returned an add, use the operands. Otherwise it simplified
323 // the sum into a single value, so just use that.
Dan Gohmanf9e64722010-03-18 01:17:13 +0000324 Ops.clear();
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000325 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Sum))
Dan Gohman403a8cd2010-06-21 19:47:52 +0000326 Ops.append(Add->op_begin(), Add->op_end());
Dan Gohmanf9e64722010-03-18 01:17:13 +0000327 else if (!Sum->isZero())
328 Ops.push_back(Sum);
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000329 // Then append the addrecs.
Dan Gohman403a8cd2010-06-21 19:47:52 +0000330 Ops.append(AddRecs.begin(), AddRecs.end());
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000331}
332
333/// SplitAddRecs - Flatten a list of add operands, moving addrec start values
334/// out to the top level. For example, convert {a + b,+,c} to a, b, {0,+,d}.
335/// This helps expose more opportunities for folding parts of the expressions
336/// into GEP indices.
337///
338static void SplitAddRecs(SmallVectorImpl<const SCEV *> &Ops,
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000339 Type *Ty,
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000340 ScalarEvolution &SE) {
341 // Find the addrecs.
342 SmallVector<const SCEV *, 8> AddRecs;
343 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
344 while (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(Ops[i])) {
345 const SCEV *Start = A->getStart();
346 if (Start->isZero()) break;
Dan Gohmandeff6212010-05-03 22:09:21 +0000347 const SCEV *Zero = SE.getConstant(Ty, 0);
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000348 AddRecs.push_back(SE.getAddRecExpr(Zero,
349 A->getStepRecurrence(SE),
Andrew Trick3228cc22011-03-14 16:50:06 +0000350 A->getLoop(),
351 // FIXME: A->getNoWrapFlags(FlagNW)
352 SCEV::FlagAnyWrap));
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000353 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Start)) {
354 Ops[i] = Zero;
Dan Gohman403a8cd2010-06-21 19:47:52 +0000355 Ops.append(Add->op_begin(), Add->op_end());
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000356 e += Add->getNumOperands();
357 } else {
358 Ops[i] = Start;
359 }
360 }
361 if (!AddRecs.empty()) {
362 // Add the addrecs onto the end of the list.
Dan Gohman403a8cd2010-06-21 19:47:52 +0000363 Ops.append(AddRecs.begin(), AddRecs.end());
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000364 // Resort the operand list, moving any constants to the front.
365 SimplifyAddOperands(Ops, Ty, SE);
366 }
367}
368
Dan Gohman4c0d5d52009-08-20 16:42:55 +0000369/// expandAddToGEP - Expand an addition expression with a pointer type into
370/// a GEP instead of using ptrtoint+arithmetic+inttoptr. This helps
371/// BasicAliasAnalysis and other passes analyze the result. See the rules
372/// for getelementptr vs. inttoptr in
373/// http://llvm.org/docs/LangRef.html#pointeraliasing
374/// for details.
Dan Gohman13c5e352009-07-20 17:44:17 +0000375///
Dan Gohman3abf9052010-01-19 22:26:02 +0000376/// Design note: The correctness of using getelementptr here depends on
Dan Gohman4c0d5d52009-08-20 16:42:55 +0000377/// ScalarEvolution not recognizing inttoptr and ptrtoint operators, as
378/// they may introduce pointer arithmetic which may not be safely converted
379/// into getelementptr.
Dan Gohman453aa4f2009-05-24 18:06:31 +0000380///
381/// Design note: It might seem desirable for this function to be more
382/// loop-aware. If some of the indices are loop-invariant while others
383/// aren't, it might seem desirable to emit multiple GEPs, keeping the
384/// loop-invariant portions of the overall computation outside the loop.
385/// However, there are a few reasons this is not done here. Hoisting simple
386/// arithmetic is a low-level optimization that often isn't very
387/// important until late in the optimization process. In fact, passes
388/// like InstructionCombining will combine GEPs, even if it means
389/// pushing loop-invariant computation down into loops, so even if the
390/// GEPs were split here, the work would quickly be undone. The
391/// LoopStrengthReduction pass, which is usually run quite late (and
392/// after the last InstructionCombining pass), takes care of hoisting
393/// loop-invariant portions of expressions, after considering what
394/// can be folded using target addressing modes.
395///
Dan Gohman0bba49c2009-07-07 17:06:11 +0000396Value *SCEVExpander::expandAddToGEP(const SCEV *const *op_begin,
397 const SCEV *const *op_end,
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000398 PointerType *PTy,
399 Type *Ty,
Dan Gohman5be18e82009-05-19 02:15:55 +0000400 Value *V) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000401 Type *ElTy = PTy->getElementType();
Dan Gohman5be18e82009-05-19 02:15:55 +0000402 SmallVector<Value *, 4> GepIndices;
Dan Gohman0bba49c2009-07-07 17:06:11 +0000403 SmallVector<const SCEV *, 8> Ops(op_begin, op_end);
Dan Gohman5be18e82009-05-19 02:15:55 +0000404 bool AnyNonZeroIndices = false;
Dan Gohman5be18e82009-05-19 02:15:55 +0000405
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000406 // Split AddRecs up into parts as either of the parts may be usable
407 // without the other.
408 SplitAddRecs(Ops, Ty, SE);
409
Bob Wilsoneb356992009-12-04 01:33:04 +0000410 // Descend down the pointer's type and attempt to convert the other
Dan Gohman5be18e82009-05-19 02:15:55 +0000411 // operands into GEP indices, at each level. The first index in a GEP
412 // indexes into the array implied by the pointer operand; the rest of
413 // the indices index into the element or field type selected by the
414 // preceding index.
415 for (;;) {
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000416 // If the scale size is not 0, attempt to factor out a scale for
417 // array indexing.
Dan Gohman0bba49c2009-07-07 17:06:11 +0000418 SmallVector<const SCEV *, 8> ScaledOps;
Dan Gohman150dfa82010-01-28 06:32:46 +0000419 if (ElTy->isSized()) {
Dan Gohman4f8eea82010-02-01 18:27:38 +0000420 const SCEV *ElSize = SE.getSizeOfExpr(ElTy);
Dan Gohman150dfa82010-01-28 06:32:46 +0000421 if (!ElSize->isZero()) {
422 SmallVector<const SCEV *, 8> NewOps;
423 for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
424 const SCEV *Op = Ops[i];
Dan Gohmandeff6212010-05-03 22:09:21 +0000425 const SCEV *Remainder = SE.getConstant(Ty, 0);
Dan Gohman150dfa82010-01-28 06:32:46 +0000426 if (FactorOutConstant(Op, Remainder, ElSize, SE, SE.TD)) {
427 // Op now has ElSize factored out.
428 ScaledOps.push_back(Op);
429 if (!Remainder->isZero())
430 NewOps.push_back(Remainder);
431 AnyNonZeroIndices = true;
432 } else {
433 // The operand was not divisible, so add it to the list of operands
434 // we'll scan next iteration.
435 NewOps.push_back(Ops[i]);
436 }
Dan Gohman5be18e82009-05-19 02:15:55 +0000437 }
Dan Gohman150dfa82010-01-28 06:32:46 +0000438 // If we made any changes, update Ops.
439 if (!ScaledOps.empty()) {
440 Ops = NewOps;
441 SimplifyAddOperands(Ops, Ty, SE);
442 }
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000443 }
Dan Gohman5be18e82009-05-19 02:15:55 +0000444 }
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000445
446 // Record the scaled array index for this level of the type. If
447 // we didn't find any operands that could be factored, tentatively
448 // assume that element zero was selected (since the zero offset
449 // would obviously be folded away).
Dan Gohman5be18e82009-05-19 02:15:55 +0000450 Value *Scaled = ScaledOps.empty() ?
Owen Andersona7235ea2009-07-31 20:28:14 +0000451 Constant::getNullValue(Ty) :
Dan Gohman5be18e82009-05-19 02:15:55 +0000452 expandCodeFor(SE.getAddExpr(ScaledOps), Ty);
453 GepIndices.push_back(Scaled);
454
455 // Collect struct field index operands.
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000456 while (StructType *STy = dyn_cast<StructType>(ElTy)) {
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000457 bool FoundFieldNo = false;
458 // An empty struct has no fields.
459 if (STy->getNumElements() == 0) break;
460 if (SE.TD) {
461 // With TargetData, field offsets are known. See if a constant offset
462 // falls within any of the struct fields.
463 if (Ops.empty()) break;
Dan Gohman5be18e82009-05-19 02:15:55 +0000464 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[0]))
465 if (SE.getTypeSizeInBits(C->getType()) <= 64) {
466 const StructLayout &SL = *SE.TD->getStructLayout(STy);
467 uint64_t FullOffset = C->getValue()->getZExtValue();
468 if (FullOffset < SL.getSizeInBytes()) {
469 unsigned ElIdx = SL.getElementContainingOffset(FullOffset);
Owen Anderson1d0be152009-08-13 21:58:54 +0000470 GepIndices.push_back(
471 ConstantInt::get(Type::getInt32Ty(Ty->getContext()), ElIdx));
Dan Gohman5be18e82009-05-19 02:15:55 +0000472 ElTy = STy->getTypeAtIndex(ElIdx);
473 Ops[0] =
Dan Gohman6de29f82009-06-15 22:12:54 +0000474 SE.getConstant(Ty, FullOffset - SL.getElementOffset(ElIdx));
Dan Gohman5be18e82009-05-19 02:15:55 +0000475 AnyNonZeroIndices = true;
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000476 FoundFieldNo = true;
Dan Gohman5be18e82009-05-19 02:15:55 +0000477 }
478 }
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000479 } else {
Dan Gohman0f5efe52010-01-28 02:15:55 +0000480 // Without TargetData, just check for an offsetof expression of the
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000481 // appropriate struct type.
482 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
Dan Gohman0f5efe52010-01-28 02:15:55 +0000483 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(Ops[i])) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000484 Type *CTy;
Dan Gohman0f5efe52010-01-28 02:15:55 +0000485 Constant *FieldNo;
Dan Gohman4f8eea82010-02-01 18:27:38 +0000486 if (U->isOffsetOf(CTy, FieldNo) && CTy == STy) {
Dan Gohman0f5efe52010-01-28 02:15:55 +0000487 GepIndices.push_back(FieldNo);
488 ElTy =
489 STy->getTypeAtIndex(cast<ConstantInt>(FieldNo)->getZExtValue());
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000490 Ops[i] = SE.getConstant(Ty, 0);
491 AnyNonZeroIndices = true;
492 FoundFieldNo = true;
493 break;
494 }
Dan Gohman0f5efe52010-01-28 02:15:55 +0000495 }
Dan Gohman5be18e82009-05-19 02:15:55 +0000496 }
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000497 // If no struct field offsets were found, tentatively assume that
498 // field zero was selected (since the zero offset would obviously
499 // be folded away).
500 if (!FoundFieldNo) {
501 ElTy = STy->getTypeAtIndex(0u);
502 GepIndices.push_back(
503 Constant::getNullValue(Type::getInt32Ty(Ty->getContext())));
504 }
Dan Gohman5be18e82009-05-19 02:15:55 +0000505 }
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000506
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000507 if (ArrayType *ATy = dyn_cast<ArrayType>(ElTy))
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000508 ElTy = ATy->getElementType();
509 else
510 break;
Dan Gohman5be18e82009-05-19 02:15:55 +0000511 }
512
Dan Gohman3f46a3a2010-03-01 17:49:51 +0000513 // If none of the operands were convertible to proper GEP indices, cast
Dan Gohman5be18e82009-05-19 02:15:55 +0000514 // the base to i8* and do an ugly getelementptr with that. It's still
515 // better than ptrtoint+arithmetic+inttoptr at least.
516 if (!AnyNonZeroIndices) {
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000517 // Cast the base to i8*.
Dan Gohman5be18e82009-05-19 02:15:55 +0000518 V = InsertNoopCastOfTo(V,
Duncan Sandsac53a0b2009-10-06 15:40:36 +0000519 Type::getInt8PtrTy(Ty->getContext(), PTy->getAddressSpace()));
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000520
Rafael Espindola705b48d2012-02-21 03:51:14 +0000521 assert(!isa<Instruction>(V) ||
Rafael Espindolac9ae8cc2012-02-26 02:19:19 +0000522 SE.DT->dominates(cast<Instruction>(V), Builder.GetInsertPoint()));
Rafael Espindola4b045782012-02-21 01:19:51 +0000523
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000524 // Expand the operands for a plain byte offset.
Dan Gohman92fcdca2009-06-09 17:18:38 +0000525 Value *Idx = expandCodeFor(SE.getAddExpr(Ops), Ty);
Dan Gohman5be18e82009-05-19 02:15:55 +0000526
527 // Fold a GEP with constant operands.
528 if (Constant *CLHS = dyn_cast<Constant>(V))
529 if (Constant *CRHS = dyn_cast<Constant>(Idx))
Jay Foaddab3d292011-07-21 14:31:17 +0000530 return ConstantExpr::getGetElementPtr(CLHS, CRHS);
Dan Gohman5be18e82009-05-19 02:15:55 +0000531
532 // Do a quick scan to see if we have this GEP nearby. If so, reuse it.
533 unsigned ScanLimit = 6;
Dan Gohman267a3852009-06-27 21:18:18 +0000534 BasicBlock::iterator BlockBegin = Builder.GetInsertBlock()->begin();
535 // Scanning starts from the last instruction before the insertion point.
536 BasicBlock::iterator IP = Builder.GetInsertPoint();
537 if (IP != BlockBegin) {
Dan Gohman5be18e82009-05-19 02:15:55 +0000538 --IP;
539 for (; ScanLimit; --IP, --ScanLimit) {
Dale Johannesen8d50ea72010-03-05 21:12:40 +0000540 // Don't count dbg.value against the ScanLimit, to avoid perturbing the
541 // generated code.
542 if (isa<DbgInfoIntrinsic>(IP))
543 ScanLimit++;
Dan Gohman5be18e82009-05-19 02:15:55 +0000544 if (IP->getOpcode() == Instruction::GetElementPtr &&
545 IP->getOperand(0) == V && IP->getOperand(1) == Idx)
546 return IP;
547 if (IP == BlockBegin) break;
548 }
549 }
550
Dan Gohman087bd1e2010-03-03 05:29:13 +0000551 // Save the original insertion point so we can restore it when we're done.
552 BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
553 BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
554
555 // Move the insertion point out of as many loops as we can.
556 while (const Loop *L = SE.LI->getLoopFor(Builder.GetInsertBlock())) {
557 if (!L->isLoopInvariant(V) || !L->isLoopInvariant(Idx)) break;
558 BasicBlock *Preheader = L->getLoopPreheader();
559 if (!Preheader) break;
560
561 // Ok, move up a level.
562 Builder.SetInsertPoint(Preheader, Preheader->getTerminator());
563 }
564
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000565 // Emit a GEP.
566 Value *GEP = Builder.CreateGEP(V, Idx, "uglygep");
Dan Gohmana10756e2010-01-21 02:09:26 +0000567 rememberInstruction(GEP);
Dan Gohman087bd1e2010-03-03 05:29:13 +0000568
569 // Restore the original insert point.
570 if (SaveInsertBB)
571 restoreInsertPoint(SaveInsertBB, SaveInsertPt);
572
Dan Gohman5be18e82009-05-19 02:15:55 +0000573 return GEP;
574 }
575
Dan Gohman087bd1e2010-03-03 05:29:13 +0000576 // Save the original insertion point so we can restore it when we're done.
577 BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
578 BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
579
580 // Move the insertion point out of as many loops as we can.
581 while (const Loop *L = SE.LI->getLoopFor(Builder.GetInsertBlock())) {
582 if (!L->isLoopInvariant(V)) break;
583
584 bool AnyIndexNotLoopInvariant = false;
585 for (SmallVectorImpl<Value *>::const_iterator I = GepIndices.begin(),
586 E = GepIndices.end(); I != E; ++I)
587 if (!L->isLoopInvariant(*I)) {
588 AnyIndexNotLoopInvariant = true;
589 break;
590 }
591 if (AnyIndexNotLoopInvariant)
592 break;
593
594 BasicBlock *Preheader = L->getLoopPreheader();
595 if (!Preheader) break;
596
597 // Ok, move up a level.
598 Builder.SetInsertPoint(Preheader, Preheader->getTerminator());
599 }
600
Dan Gohmand6aa02d2009-07-28 01:40:03 +0000601 // Insert a pretty getelementptr. Note that this GEP is not marked inbounds,
602 // because ScalarEvolution may have changed the address arithmetic to
603 // compute a value which is beyond the end of the allocated object.
Dan Gohmana10756e2010-01-21 02:09:26 +0000604 Value *Casted = V;
605 if (V->getType() != PTy)
606 Casted = InsertNoopCastOfTo(Casted, PTy);
607 Value *GEP = Builder.CreateGEP(Casted,
Jay Foad0a2a60a2011-07-22 08:16:57 +0000608 GepIndices,
Dan Gohman267a3852009-06-27 21:18:18 +0000609 "scevgep");
Dan Gohman5be18e82009-05-19 02:15:55 +0000610 Ops.push_back(SE.getUnknown(GEP));
Dan Gohmana10756e2010-01-21 02:09:26 +0000611 rememberInstruction(GEP);
Dan Gohman087bd1e2010-03-03 05:29:13 +0000612
613 // Restore the original insert point.
614 if (SaveInsertBB)
615 restoreInsertPoint(SaveInsertBB, SaveInsertPt);
616
Dan Gohman5be18e82009-05-19 02:15:55 +0000617 return expand(SE.getAddExpr(Ops));
618}
619
Dan Gohman087bd1e2010-03-03 05:29:13 +0000620/// PickMostRelevantLoop - Given two loops pick the one that's most relevant for
621/// SCEV expansion. If they are nested, this is the most nested. If they are
622/// neighboring, pick the later.
623static const Loop *PickMostRelevantLoop(const Loop *A, const Loop *B,
624 DominatorTree &DT) {
625 if (!A) return B;
626 if (!B) return A;
627 if (A->contains(B)) return B;
628 if (B->contains(A)) return A;
629 if (DT.dominates(A->getHeader(), B->getHeader())) return B;
630 if (DT.dominates(B->getHeader(), A->getHeader())) return A;
631 return A; // Arbitrarily break the tie.
632}
633
Dan Gohman9c9fcfc2010-11-18 00:34:22 +0000634/// getRelevantLoop - Get the most relevant loop associated with the given
Dan Gohman087bd1e2010-03-03 05:29:13 +0000635/// expression, according to PickMostRelevantLoop.
Dan Gohman9c9fcfc2010-11-18 00:34:22 +0000636const Loop *SCEVExpander::getRelevantLoop(const SCEV *S) {
637 // Test whether we've already computed the most relevant loop for this SCEV.
638 std::pair<DenseMap<const SCEV *, const Loop *>::iterator, bool> Pair =
639 RelevantLoops.insert(std::make_pair(S, static_cast<const Loop *>(0)));
640 if (!Pair.second)
641 return Pair.first->second;
642
Dan Gohman087bd1e2010-03-03 05:29:13 +0000643 if (isa<SCEVConstant>(S))
Dan Gohman9c9fcfc2010-11-18 00:34:22 +0000644 // A constant has no relevant loops.
Dan Gohman087bd1e2010-03-03 05:29:13 +0000645 return 0;
646 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
647 if (const Instruction *I = dyn_cast<Instruction>(U->getValue()))
Dan Gohman9c9fcfc2010-11-18 00:34:22 +0000648 return Pair.first->second = SE.LI->getLoopFor(I->getParent());
649 // A non-instruction has no relevant loops.
Dan Gohman087bd1e2010-03-03 05:29:13 +0000650 return 0;
651 }
652 if (const SCEVNAryExpr *N = dyn_cast<SCEVNAryExpr>(S)) {
653 const Loop *L = 0;
654 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S))
655 L = AR->getLoop();
656 for (SCEVNAryExpr::op_iterator I = N->op_begin(), E = N->op_end();
657 I != E; ++I)
Dan Gohman9c9fcfc2010-11-18 00:34:22 +0000658 L = PickMostRelevantLoop(L, getRelevantLoop(*I), *SE.DT);
659 return RelevantLoops[N] = L;
Dan Gohman087bd1e2010-03-03 05:29:13 +0000660 }
Dan Gohman9c9fcfc2010-11-18 00:34:22 +0000661 if (const SCEVCastExpr *C = dyn_cast<SCEVCastExpr>(S)) {
662 const Loop *Result = getRelevantLoop(C->getOperand());
663 return RelevantLoops[C] = Result;
664 }
665 if (const SCEVUDivExpr *D = dyn_cast<SCEVUDivExpr>(S)) {
666 const Loop *Result =
667 PickMostRelevantLoop(getRelevantLoop(D->getLHS()),
668 getRelevantLoop(D->getRHS()),
669 *SE.DT);
670 return RelevantLoops[D] = Result;
671 }
Dan Gohman087bd1e2010-03-03 05:29:13 +0000672 llvm_unreachable("Unexpected SCEV type!");
673}
674
Dan Gohmanb3579832010-04-15 17:08:50 +0000675namespace {
676
Dan Gohman087bd1e2010-03-03 05:29:13 +0000677/// LoopCompare - Compare loops by PickMostRelevantLoop.
678class LoopCompare {
679 DominatorTree &DT;
680public:
681 explicit LoopCompare(DominatorTree &dt) : DT(dt) {}
682
683 bool operator()(std::pair<const Loop *, const SCEV *> LHS,
684 std::pair<const Loop *, const SCEV *> RHS) const {
Dan Gohmanbb5d9272010-07-15 23:38:13 +0000685 // Keep pointer operands sorted at the end.
686 if (LHS.second->getType()->isPointerTy() !=
687 RHS.second->getType()->isPointerTy())
688 return LHS.second->getType()->isPointerTy();
689
Dan Gohman087bd1e2010-03-03 05:29:13 +0000690 // Compare loops with PickMostRelevantLoop.
691 if (LHS.first != RHS.first)
692 return PickMostRelevantLoop(LHS.first, RHS.first, DT) != LHS.first;
693
694 // If one operand is a non-constant negative and the other is not,
695 // put the non-constant negative on the right so that a sub can
696 // be used instead of a negate and add.
Andrew Trickf8fd8412012-01-07 00:27:31 +0000697 if (LHS.second->isNonConstantNegative()) {
698 if (!RHS.second->isNonConstantNegative())
Dan Gohman087bd1e2010-03-03 05:29:13 +0000699 return false;
Andrew Trickf8fd8412012-01-07 00:27:31 +0000700 } else if (RHS.second->isNonConstantNegative())
Dan Gohman087bd1e2010-03-03 05:29:13 +0000701 return true;
702
703 // Otherwise they are equivalent according to this comparison.
704 return false;
705 }
706};
707
Dan Gohmanb3579832010-04-15 17:08:50 +0000708}
709
Dan Gohman890f92b2009-04-18 17:56:28 +0000710Value *SCEVExpander::visitAddExpr(const SCEVAddExpr *S) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000711 Type *Ty = SE.getEffectiveSCEVType(S->getType());
Dan Gohmanc70c3772009-09-26 16:11:57 +0000712
Dan Gohman087bd1e2010-03-03 05:29:13 +0000713 // Collect all the add operands in a loop, along with their associated loops.
714 // Iterate in reverse so that constants are emitted last, all else equal, and
715 // so that pointer operands are inserted first, which the code below relies on
716 // to form more involved GEPs.
717 SmallVector<std::pair<const Loop *, const SCEV *>, 8> OpsAndLoops;
718 for (std::reverse_iterator<SCEVAddExpr::op_iterator> I(S->op_end()),
719 E(S->op_begin()); I != E; ++I)
Dan Gohman9c9fcfc2010-11-18 00:34:22 +0000720 OpsAndLoops.push_back(std::make_pair(getRelevantLoop(*I), *I));
Dan Gohmanc70c3772009-09-26 16:11:57 +0000721
Dan Gohman087bd1e2010-03-03 05:29:13 +0000722 // Sort by loop. Use a stable sort so that constants follow non-constants and
723 // pointer operands precede non-pointer operands.
724 std::stable_sort(OpsAndLoops.begin(), OpsAndLoops.end(), LoopCompare(*SE.DT));
Dan Gohman5be18e82009-05-19 02:15:55 +0000725
Dan Gohman087bd1e2010-03-03 05:29:13 +0000726 // Emit instructions to add all the operands. Hoist as much as possible
727 // out of loops, and form meaningful getelementptrs where possible.
728 Value *Sum = 0;
729 for (SmallVectorImpl<std::pair<const Loop *, const SCEV *> >::iterator
730 I = OpsAndLoops.begin(), E = OpsAndLoops.end(); I != E; ) {
731 const Loop *CurLoop = I->first;
732 const SCEV *Op = I->second;
733 if (!Sum) {
734 // This is the first operand. Just expand it.
735 Sum = expand(Op);
736 ++I;
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000737 } else if (PointerType *PTy = dyn_cast<PointerType>(Sum->getType())) {
Dan Gohman087bd1e2010-03-03 05:29:13 +0000738 // The running sum expression is a pointer. Try to form a getelementptr
739 // at this level with that as the base.
740 SmallVector<const SCEV *, 4> NewOps;
Dan Gohmanbb5d9272010-07-15 23:38:13 +0000741 for (; I != E && I->first == CurLoop; ++I) {
742 // If the operand is SCEVUnknown and not instructions, peek through
743 // it, to enable more of it to be folded into the GEP.
744 const SCEV *X = I->second;
745 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(X))
746 if (!isa<Instruction>(U->getValue()))
747 X = SE.getSCEV(U->getValue());
748 NewOps.push_back(X);
749 }
Dan Gohman087bd1e2010-03-03 05:29:13 +0000750 Sum = expandAddToGEP(NewOps.begin(), NewOps.end(), PTy, Ty, Sum);
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000751 } else if (PointerType *PTy = dyn_cast<PointerType>(Op->getType())) {
Dan Gohman087bd1e2010-03-03 05:29:13 +0000752 // The running sum is an integer, and there's a pointer at this level.
Dan Gohmanf8d05782010-04-09 19:14:31 +0000753 // Try to form a getelementptr. If the running sum is instructions,
754 // use a SCEVUnknown to avoid re-analyzing them.
Dan Gohman087bd1e2010-03-03 05:29:13 +0000755 SmallVector<const SCEV *, 4> NewOps;
Dan Gohmanf8d05782010-04-09 19:14:31 +0000756 NewOps.push_back(isa<Instruction>(Sum) ? SE.getUnknown(Sum) :
757 SE.getSCEV(Sum));
Dan Gohman087bd1e2010-03-03 05:29:13 +0000758 for (++I; I != E && I->first == CurLoop; ++I)
759 NewOps.push_back(I->second);
760 Sum = expandAddToGEP(NewOps.begin(), NewOps.end(), PTy, Ty, expand(Op));
Andrew Trickf8fd8412012-01-07 00:27:31 +0000761 } else if (Op->isNonConstantNegative()) {
Dan Gohman087bd1e2010-03-03 05:29:13 +0000762 // Instead of doing a negate and add, just do a subtract.
Dan Gohmaned78dba2010-03-03 04:36:42 +0000763 Value *W = expandCodeFor(SE.getNegativeSCEV(Op), Ty);
Dan Gohman087bd1e2010-03-03 05:29:13 +0000764 Sum = InsertNoopCastOfTo(Sum, Ty);
765 Sum = InsertBinop(Instruction::Sub, Sum, W);
766 ++I;
Dan Gohmaned78dba2010-03-03 04:36:42 +0000767 } else {
Dan Gohman087bd1e2010-03-03 05:29:13 +0000768 // A simple add.
Dan Gohmaned78dba2010-03-03 04:36:42 +0000769 Value *W = expandCodeFor(Op, Ty);
Dan Gohman087bd1e2010-03-03 05:29:13 +0000770 Sum = InsertNoopCastOfTo(Sum, Ty);
771 // Canonicalize a constant to the RHS.
772 if (isa<Constant>(Sum)) std::swap(Sum, W);
773 Sum = InsertBinop(Instruction::Add, Sum, W);
774 ++I;
Dan Gohmaned78dba2010-03-03 04:36:42 +0000775 }
776 }
Dan Gohman087bd1e2010-03-03 05:29:13 +0000777
778 return Sum;
Dan Gohmane24fa642008-06-18 16:37:11 +0000779}
Dan Gohman5be18e82009-05-19 02:15:55 +0000780
Dan Gohman890f92b2009-04-18 17:56:28 +0000781Value *SCEVExpander::visitMulExpr(const SCEVMulExpr *S) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000782 Type *Ty = SE.getEffectiveSCEVType(S->getType());
Nate Begeman36f891b2005-07-30 00:12:19 +0000783
Dan Gohman087bd1e2010-03-03 05:29:13 +0000784 // Collect all the mul operands in a loop, along with their associated loops.
785 // Iterate in reverse so that constants are emitted last, all else equal.
786 SmallVector<std::pair<const Loop *, const SCEV *>, 8> OpsAndLoops;
787 for (std::reverse_iterator<SCEVMulExpr::op_iterator> I(S->op_end()),
788 E(S->op_begin()); I != E; ++I)
Dan Gohman9c9fcfc2010-11-18 00:34:22 +0000789 OpsAndLoops.push_back(std::make_pair(getRelevantLoop(*I), *I));
Nate Begeman36f891b2005-07-30 00:12:19 +0000790
Dan Gohman087bd1e2010-03-03 05:29:13 +0000791 // Sort by loop. Use a stable sort so that constants follow non-constants.
792 std::stable_sort(OpsAndLoops.begin(), OpsAndLoops.end(), LoopCompare(*SE.DT));
793
794 // Emit instructions to mul all the operands. Hoist as much as possible
795 // out of loops.
796 Value *Prod = 0;
797 for (SmallVectorImpl<std::pair<const Loop *, const SCEV *> >::iterator
798 I = OpsAndLoops.begin(), E = OpsAndLoops.end(); I != E; ) {
799 const SCEV *Op = I->second;
800 if (!Prod) {
801 // This is the first operand. Just expand it.
802 Prod = expand(Op);
803 ++I;
804 } else if (Op->isAllOnesValue()) {
805 // Instead of doing a multiply by negative one, just do a negate.
806 Prod = InsertNoopCastOfTo(Prod, Ty);
807 Prod = InsertBinop(Instruction::Sub, Constant::getNullValue(Ty), Prod);
808 ++I;
809 } else {
810 // A simple mul.
811 Value *W = expandCodeFor(Op, Ty);
812 Prod = InsertNoopCastOfTo(Prod, Ty);
813 // Canonicalize a constant to the RHS.
814 if (isa<Constant>(Prod)) std::swap(Prod, W);
815 Prod = InsertBinop(Instruction::Mul, Prod, W);
816 ++I;
817 }
Dan Gohman2d1be872009-04-16 03:18:22 +0000818 }
819
Dan Gohman087bd1e2010-03-03 05:29:13 +0000820 return Prod;
Nate Begeman36f891b2005-07-30 00:12:19 +0000821}
822
Dan Gohman890f92b2009-04-18 17:56:28 +0000823Value *SCEVExpander::visitUDivExpr(const SCEVUDivExpr *S) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000824 Type *Ty = SE.getEffectiveSCEVType(S->getType());
Dan Gohman2d1be872009-04-16 03:18:22 +0000825
Dan Gohman92fcdca2009-06-09 17:18:38 +0000826 Value *LHS = expandCodeFor(S->getLHS(), Ty);
Dan Gohman890f92b2009-04-18 17:56:28 +0000827 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(S->getRHS())) {
Nick Lewycky6177fd42008-07-08 05:05:37 +0000828 const APInt &RHS = SC->getValue()->getValue();
829 if (RHS.isPowerOf2())
830 return InsertBinop(Instruction::LShr, LHS,
Owen Andersoneed707b2009-07-24 23:12:02 +0000831 ConstantInt::get(Ty, RHS.logBase2()));
Nick Lewycky6177fd42008-07-08 05:05:37 +0000832 }
833
Dan Gohman92fcdca2009-06-09 17:18:38 +0000834 Value *RHS = expandCodeFor(S->getRHS(), Ty);
Dan Gohman267a3852009-06-27 21:18:18 +0000835 return InsertBinop(Instruction::UDiv, LHS, RHS);
Nick Lewycky6177fd42008-07-08 05:05:37 +0000836}
837
Dan Gohman453aa4f2009-05-24 18:06:31 +0000838/// Move parts of Base into Rest to leave Base with the minimal
839/// expression that provides a pointer operand suitable for a
840/// GEP expansion.
Dan Gohman0bba49c2009-07-07 17:06:11 +0000841static void ExposePointerBase(const SCEV *&Base, const SCEV *&Rest,
Dan Gohman453aa4f2009-05-24 18:06:31 +0000842 ScalarEvolution &SE) {
843 while (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(Base)) {
844 Base = A->getStart();
845 Rest = SE.getAddExpr(Rest,
Dan Gohmandeff6212010-05-03 22:09:21 +0000846 SE.getAddRecExpr(SE.getConstant(A->getType(), 0),
Dan Gohman453aa4f2009-05-24 18:06:31 +0000847 A->getStepRecurrence(SE),
Andrew Trick3228cc22011-03-14 16:50:06 +0000848 A->getLoop(),
849 // FIXME: A->getNoWrapFlags(FlagNW)
850 SCEV::FlagAnyWrap));
Dan Gohman453aa4f2009-05-24 18:06:31 +0000851 }
852 if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(Base)) {
853 Base = A->getOperand(A->getNumOperands()-1);
Dan Gohman0bba49c2009-07-07 17:06:11 +0000854 SmallVector<const SCEV *, 8> NewAddOps(A->op_begin(), A->op_end());
Dan Gohman453aa4f2009-05-24 18:06:31 +0000855 NewAddOps.back() = Rest;
856 Rest = SE.getAddExpr(NewAddOps);
857 ExposePointerBase(Base, Rest, SE);
858 }
859}
860
Andrew Trickc5701912011-10-07 23:46:21 +0000861/// Determine if this is a well-behaved chain of instructions leading back to
862/// the PHI. If so, it may be reused by expanded expressions.
863bool SCEVExpander::isNormalAddRecExprPHI(PHINode *PN, Instruction *IncV,
864 const Loop *L) {
865 if (IncV->getNumOperands() == 0 || isa<PHINode>(IncV) ||
866 (isa<CastInst>(IncV) && !isa<BitCastInst>(IncV)))
867 return false;
868 // If any of the operands don't dominate the insert position, bail.
869 // Addrec operands are always loop-invariant, so this can only happen
870 // if there are instructions which haven't been hoisted.
871 if (L == IVIncInsertLoop) {
872 for (User::op_iterator OI = IncV->op_begin()+1,
873 OE = IncV->op_end(); OI != OE; ++OI)
874 if (Instruction *OInst = dyn_cast<Instruction>(OI))
875 if (!SE.DT->dominates(OInst, IVIncInsertPos))
876 return false;
877 }
878 // Advance to the next instruction.
879 IncV = dyn_cast<Instruction>(IncV->getOperand(0));
880 if (!IncV)
881 return false;
882
883 if (IncV->mayHaveSideEffects())
884 return false;
885
886 if (IncV != PN)
887 return true;
888
889 return isNormalAddRecExprPHI(PN, IncV, L);
890}
891
Andrew Trickb5c26ef2012-01-20 07:41:13 +0000892/// getIVIncOperand returns an induction variable increment's induction
893/// variable operand.
894///
895/// If allowScale is set, any type of GEP is allowed as long as the nonIV
896/// operands dominate InsertPos.
897///
898/// If allowScale is not set, ensure that a GEP increment conforms to one of the
899/// simple patterns generated by getAddRecExprPHILiterally and
900/// expandAddtoGEP. If the pattern isn't recognized, return NULL.
901Instruction *SCEVExpander::getIVIncOperand(Instruction *IncV,
902 Instruction *InsertPos,
903 bool allowScale) {
904 if (IncV == InsertPos)
905 return NULL;
906
907 switch (IncV->getOpcode()) {
908 default:
909 return NULL;
910 // Check for a simple Add/Sub or GEP of a loop invariant step.
911 case Instruction::Add:
912 case Instruction::Sub: {
913 Instruction *OInst = dyn_cast<Instruction>(IncV->getOperand(1));
Rafael Espindolac9ae8cc2012-02-26 02:19:19 +0000914 if (!OInst || SE.DT->dominates(OInst, InsertPos))
Andrew Trickb5c26ef2012-01-20 07:41:13 +0000915 return dyn_cast<Instruction>(IncV->getOperand(0));
916 return NULL;
917 }
918 case Instruction::BitCast:
919 return dyn_cast<Instruction>(IncV->getOperand(0));
920 case Instruction::GetElementPtr:
921 for (Instruction::op_iterator I = IncV->op_begin()+1, E = IncV->op_end();
922 I != E; ++I) {
923 if (isa<Constant>(*I))
924 continue;
925 if (Instruction *OInst = dyn_cast<Instruction>(*I)) {
Rafael Espindolac9ae8cc2012-02-26 02:19:19 +0000926 if (!SE.DT->dominates(OInst, InsertPos))
Andrew Trickb5c26ef2012-01-20 07:41:13 +0000927 return NULL;
928 }
929 if (allowScale) {
930 // allow any kind of GEP as long as it can be hoisted.
931 continue;
932 }
933 // This must be a pointer addition of constants (pretty), which is already
934 // handled, or some number of address-size elements (ugly). Ugly geps
935 // have 2 operands. i1* is used by the expander to represent an
936 // address-size element.
937 if (IncV->getNumOperands() != 2)
938 return NULL;
939 unsigned AS = cast<PointerType>(IncV->getType())->getAddressSpace();
940 if (IncV->getType() != Type::getInt1PtrTy(SE.getContext(), AS)
941 && IncV->getType() != Type::getInt8PtrTy(SE.getContext(), AS))
942 return NULL;
943 break;
944 }
945 return dyn_cast<Instruction>(IncV->getOperand(0));
946 }
947}
948
949/// hoistStep - Attempt to hoist a simple IV increment above InsertPos to make
950/// it available to other uses in this loop. Recursively hoist any operands,
951/// until we reach a value that dominates InsertPos.
952bool SCEVExpander::hoistIVInc(Instruction *IncV, Instruction *InsertPos) {
Rafael Espindolac9ae8cc2012-02-26 02:19:19 +0000953 if (SE.DT->dominates(IncV, InsertPos))
Andrew Trickb5c26ef2012-01-20 07:41:13 +0000954 return true;
955
956 // InsertPos must itself dominate IncV so that IncV's new position satisfies
957 // its existing users.
958 if (!SE.DT->dominates(InsertPos->getParent(), IncV->getParent()))
959 return false;
960
961 // Check that the chain of IV operands leading back to Phi can be hoisted.
962 SmallVector<Instruction*, 4> IVIncs;
963 for(;;) {
964 Instruction *Oper = getIVIncOperand(IncV, InsertPos, /*allowScale*/true);
965 if (!Oper)
966 return false;
967 // IncV is safe to hoist.
968 IVIncs.push_back(IncV);
969 IncV = Oper;
Rafael Espindolac9ae8cc2012-02-26 02:19:19 +0000970 if (SE.DT->dominates(IncV, InsertPos))
Andrew Trickb5c26ef2012-01-20 07:41:13 +0000971 break;
972 }
973 for (SmallVectorImpl<Instruction*>::reverse_iterator I = IVIncs.rbegin(),
974 E = IVIncs.rend(); I != E; ++I) {
975 (*I)->moveBefore(InsertPos);
976 }
977 return true;
978}
979
Andrew Trickc5701912011-10-07 23:46:21 +0000980/// Determine if this cyclic phi is in a form that would have been generated by
981/// LSR. We don't care if the phi was actually expanded in this pass, as long
982/// as it is in a low-cost form, for example, no implied multiplication. This
983/// should match any patterns generated by getAddRecExprPHILiterally and
984/// expandAddtoGEP.
985bool SCEVExpander::isExpandedAddRecExprPHI(PHINode *PN, Instruction *IncV,
Andrew Trick365c9f12011-10-15 06:19:55 +0000986 const Loop *L) {
Andrew Trickb5c26ef2012-01-20 07:41:13 +0000987 for(Instruction *IVOper = IncV;
988 (IVOper = getIVIncOperand(IVOper, L->getLoopPreheader()->getTerminator(),
989 /*allowScale=*/false));) {
990 if (IVOper == PN)
991 return true;
Andrew Trickc5701912011-10-07 23:46:21 +0000992 }
Andrew Trickb5c26ef2012-01-20 07:41:13 +0000993 return false;
Andrew Trickc5701912011-10-07 23:46:21 +0000994}
995
Andrew Trick553fe052011-11-30 06:07:54 +0000996/// expandIVInc - Expand an IV increment at Builder's current InsertPos.
997/// Typically this is the LatchBlock terminator or IVIncInsertPos, but we may
998/// need to materialize IV increments elsewhere to handle difficult situations.
999Value *SCEVExpander::expandIVInc(PHINode *PN, Value *StepV, const Loop *L,
1000 Type *ExpandTy, Type *IntTy,
1001 bool useSubtract) {
1002 Value *IncV;
1003 // If the PHI is a pointer, use a GEP, otherwise use an add or sub.
1004 if (ExpandTy->isPointerTy()) {
1005 PointerType *GEPPtrTy = cast<PointerType>(ExpandTy);
1006 // If the step isn't constant, don't use an implicitly scaled GEP, because
1007 // that would require a multiply inside the loop.
1008 if (!isa<ConstantInt>(StepV))
1009 GEPPtrTy = PointerType::get(Type::getInt1Ty(SE.getContext()),
1010 GEPPtrTy->getAddressSpace());
1011 const SCEV *const StepArray[1] = { SE.getSCEV(StepV) };
1012 IncV = expandAddToGEP(StepArray, StepArray+1, GEPPtrTy, IntTy, PN);
1013 if (IncV->getType() != PN->getType()) {
1014 IncV = Builder.CreateBitCast(IncV, PN->getType());
1015 rememberInstruction(IncV);
1016 }
1017 } else {
1018 IncV = useSubtract ?
1019 Builder.CreateSub(PN, StepV, Twine(IVName) + ".iv.next") :
1020 Builder.CreateAdd(PN, StepV, Twine(IVName) + ".iv.next");
1021 rememberInstruction(IncV);
1022 }
1023 return IncV;
1024}
1025
Dan Gohmana10756e2010-01-21 02:09:26 +00001026/// getAddRecExprPHILiterally - Helper for expandAddRecExprLiterally. Expand
1027/// the base addrec, which is the addrec without any non-loop-dominating
1028/// values, and return the PHI.
1029PHINode *
1030SCEVExpander::getAddRecExprPHILiterally(const SCEVAddRecExpr *Normalized,
1031 const Loop *L,
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001032 Type *ExpandTy,
1033 Type *IntTy) {
Benjamin Kramer93a896e2011-07-16 22:26:27 +00001034 assert((!IVIncInsertLoop||IVIncInsertPos) && "Uninitialized insert position");
Andrew Trickd152d032011-07-16 00:59:39 +00001035
Dan Gohmana10756e2010-01-21 02:09:26 +00001036 // Reuse a previously-inserted PHI, if present.
Andrew Trickc5701912011-10-07 23:46:21 +00001037 BasicBlock *LatchBlock = L->getLoopLatch();
1038 if (LatchBlock) {
1039 for (BasicBlock::iterator I = L->getHeader()->begin();
1040 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
1041 if (!SE.isSCEVable(PN->getType()) ||
1042 (SE.getEffectiveSCEVType(PN->getType()) !=
1043 SE.getEffectiveSCEVType(Normalized->getType())) ||
1044 SE.getSCEV(PN) != Normalized)
1045 continue;
Dan Gohman22e62192010-02-16 00:20:08 +00001046
Andrew Trickc5701912011-10-07 23:46:21 +00001047 Instruction *IncV =
1048 cast<Instruction>(PN->getIncomingValueForBlock(LatchBlock));
Dan Gohman22e62192010-02-16 00:20:08 +00001049
Andrew Trickc5701912011-10-07 23:46:21 +00001050 if (LSRMode) {
Andrew Trick365c9f12011-10-15 06:19:55 +00001051 if (!isExpandedAddRecExprPHI(PN, IncV, L))
Andrew Trickc5701912011-10-07 23:46:21 +00001052 continue;
Andrew Trickb5c26ef2012-01-20 07:41:13 +00001053 if (L == IVIncInsertLoop && !hoistIVInc(IncV, IVIncInsertPos))
1054 continue;
Dan Gohman572645c2010-02-12 10:34:29 +00001055 }
Andrew Trickc5701912011-10-07 23:46:21 +00001056 else {
1057 if (!isNormalAddRecExprPHI(PN, IncV, L))
1058 continue;
Andrew Trickb5c26ef2012-01-20 07:41:13 +00001059 if (L == IVIncInsertLoop)
1060 do {
1061 if (SE.DT->dominates(IncV, IVIncInsertPos))
1062 break;
1063 // Make sure the increment is where we want it. But don't move it
1064 // down past a potential existing post-inc user.
1065 IncV->moveBefore(IVIncInsertPos);
1066 IVIncInsertPos = IncV;
1067 IncV = cast<Instruction>(IncV->getOperand(0));
1068 } while (IncV != PN);
Andrew Trickc5701912011-10-07 23:46:21 +00001069 }
1070 // Ok, the add recurrence looks usable.
1071 // Remember this PHI, even in post-inc mode.
1072 InsertedValues.insert(PN);
1073 // Remember the increment.
1074 rememberInstruction(IncV);
Andrew Trickc5701912011-10-07 23:46:21 +00001075 return PN;
1076 }
1077 }
Dan Gohmana10756e2010-01-21 02:09:26 +00001078
1079 // Save the original insertion point so we can restore it when we're done.
1080 BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
1081 BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
1082
Andrew Trickba3c0bc2011-12-20 01:42:24 +00001083 // Another AddRec may need to be recursively expanded below. For example, if
1084 // this AddRec is quadratic, the StepV may itself be an AddRec in this
1085 // loop. Remove this loop from the PostIncLoops set before expanding such
1086 // AddRecs. Otherwise, we cannot find a valid position for the step
1087 // (i.e. StepV can never dominate its loop header). Ideally, we could do
1088 // SavedIncLoops.swap(PostIncLoops), but we generally have a single element,
1089 // so it's not worth implementing SmallPtrSet::swap.
1090 PostIncLoopSet SavedPostIncLoops = PostIncLoops;
1091 PostIncLoops.clear();
1092
Dan Gohmana10756e2010-01-21 02:09:26 +00001093 // Expand code for the start value.
1094 Value *StartV = expandCodeFor(Normalized->getStart(), ExpandTy,
1095 L->getHeader()->begin());
1096
Andrew Trickd152d032011-07-16 00:59:39 +00001097 // StartV must be hoisted into L's preheader to dominate the new phi.
Benjamin Kramer93a896e2011-07-16 22:26:27 +00001098 assert(!isa<Instruction>(StartV) ||
1099 SE.DT->properlyDominates(cast<Instruction>(StartV)->getParent(),
1100 L->getHeader()));
Andrew Trickd152d032011-07-16 00:59:39 +00001101
Andrew Trick553fe052011-11-30 06:07:54 +00001102 // Expand code for the step value. Do this before creating the PHI so that PHI
1103 // reuse code doesn't see an incomplete PHI.
Dan Gohmana10756e2010-01-21 02:09:26 +00001104 const SCEV *Step = Normalized->getStepRecurrence(SE);
Andrew Trick553fe052011-11-30 06:07:54 +00001105 // If the stride is negative, insert a sub instead of an add for the increment
1106 // (unless it's a constant, because subtracts of constants are canonicalized
1107 // to adds).
Andrew Trickf8fd8412012-01-07 00:27:31 +00001108 bool useSubtract = !ExpandTy->isPointerTy() && Step->isNonConstantNegative();
Andrew Trick553fe052011-11-30 06:07:54 +00001109 if (useSubtract)
Dan Gohmana10756e2010-01-21 02:09:26 +00001110 Step = SE.getNegativeSCEV(Step);
Andrew Trick553fe052011-11-30 06:07:54 +00001111 // Expand the step somewhere that dominates the loop header.
Dan Gohmana10756e2010-01-21 02:09:26 +00001112 Value *StepV = expandCodeFor(Step, IntTy, L->getHeader()->begin());
1113
1114 // Create the PHI.
Jay Foadd8b4fb42011-03-30 11:19:20 +00001115 BasicBlock *Header = L->getHeader();
1116 Builder.SetInsertPoint(Header, Header->begin());
1117 pred_iterator HPB = pred_begin(Header), HPE = pred_end(Header);
Andrew Trick5e7645b2011-06-28 05:07:32 +00001118 PHINode *PN = Builder.CreatePHI(ExpandTy, std::distance(HPB, HPE),
Andrew Trickdc8e5462011-06-28 05:41:52 +00001119 Twine(IVName) + ".iv");
Dan Gohmana10756e2010-01-21 02:09:26 +00001120 rememberInstruction(PN);
1121
1122 // Create the step instructions and populate the PHI.
Jay Foadd8b4fb42011-03-30 11:19:20 +00001123 for (pred_iterator HPI = HPB; HPI != HPE; ++HPI) {
Dan Gohmana10756e2010-01-21 02:09:26 +00001124 BasicBlock *Pred = *HPI;
1125
1126 // Add a start value.
1127 if (!L->contains(Pred)) {
1128 PN->addIncoming(StartV, Pred);
1129 continue;
1130 }
1131
Andrew Trick553fe052011-11-30 06:07:54 +00001132 // Create a step value and add it to the PHI.
1133 // If IVIncInsertLoop is non-null and equal to the addrec's loop, insert the
1134 // instructions at IVIncInsertPos.
Dan Gohmana10756e2010-01-21 02:09:26 +00001135 Instruction *InsertPos = L == IVIncInsertLoop ?
1136 IVIncInsertPos : Pred->getTerminator();
Devang Patelc5ecbdc2011-07-05 21:48:22 +00001137 Builder.SetInsertPoint(InsertPos);
Andrew Trick553fe052011-11-30 06:07:54 +00001138 Value *IncV = expandIVInc(PN, StepV, L, ExpandTy, IntTy, useSubtract);
1139
Dan Gohmana10756e2010-01-21 02:09:26 +00001140 PN->addIncoming(IncV, Pred);
1141 }
1142
1143 // Restore the original insert point.
1144 if (SaveInsertBB)
Dan Gohman45598552010-02-15 00:21:43 +00001145 restoreInsertPoint(SaveInsertBB, SaveInsertPt);
Dan Gohmana10756e2010-01-21 02:09:26 +00001146
Andrew Trickba3c0bc2011-12-20 01:42:24 +00001147 // After expanding subexpressions, restore the PostIncLoops set so the caller
1148 // can ensure that IVIncrement dominates the current uses.
1149 PostIncLoops = SavedPostIncLoops;
1150
Dan Gohmana10756e2010-01-21 02:09:26 +00001151 // Remember this PHI, even in post-inc mode.
1152 InsertedValues.insert(PN);
1153
1154 return PN;
1155}
1156
1157Value *SCEVExpander::expandAddRecExprLiterally(const SCEVAddRecExpr *S) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001158 Type *STy = S->getType();
1159 Type *IntTy = SE.getEffectiveSCEVType(STy);
Dan Gohmana10756e2010-01-21 02:09:26 +00001160 const Loop *L = S->getLoop();
1161
1162 // Determine a normalized form of this expression, which is the expression
1163 // before any post-inc adjustment is made.
1164 const SCEVAddRecExpr *Normalized = S;
Dan Gohman448db1c2010-04-07 22:27:08 +00001165 if (PostIncLoops.count(L)) {
1166 PostIncLoopSet Loops;
1167 Loops.insert(L);
1168 Normalized =
1169 cast<SCEVAddRecExpr>(TransformForPostIncUse(Normalize, S, 0, 0,
1170 Loops, SE, *SE.DT));
Dan Gohmana10756e2010-01-21 02:09:26 +00001171 }
1172
1173 // Strip off any non-loop-dominating component from the addrec start.
1174 const SCEV *Start = Normalized->getStart();
1175 const SCEV *PostLoopOffset = 0;
Dan Gohmandc0e8fb2010-11-17 21:41:58 +00001176 if (!SE.properlyDominates(Start, L->getHeader())) {
Dan Gohmana10756e2010-01-21 02:09:26 +00001177 PostLoopOffset = Start;
Dan Gohmandeff6212010-05-03 22:09:21 +00001178 Start = SE.getConstant(Normalized->getType(), 0);
Andrew Trick3228cc22011-03-14 16:50:06 +00001179 Normalized = cast<SCEVAddRecExpr>(
1180 SE.getAddRecExpr(Start, Normalized->getStepRecurrence(SE),
1181 Normalized->getLoop(),
1182 // FIXME: Normalized->getNoWrapFlags(FlagNW)
1183 SCEV::FlagAnyWrap));
Dan Gohmana10756e2010-01-21 02:09:26 +00001184 }
1185
1186 // Strip off any non-loop-dominating component from the addrec step.
1187 const SCEV *Step = Normalized->getStepRecurrence(SE);
1188 const SCEV *PostLoopScale = 0;
Dan Gohmandc0e8fb2010-11-17 21:41:58 +00001189 if (!SE.dominates(Step, L->getHeader())) {
Dan Gohmana10756e2010-01-21 02:09:26 +00001190 PostLoopScale = Step;
Dan Gohmandeff6212010-05-03 22:09:21 +00001191 Step = SE.getConstant(Normalized->getType(), 1);
Dan Gohmana10756e2010-01-21 02:09:26 +00001192 Normalized =
1193 cast<SCEVAddRecExpr>(SE.getAddRecExpr(Start, Step,
Andrew Trick3228cc22011-03-14 16:50:06 +00001194 Normalized->getLoop(),
1195 // FIXME: Normalized
1196 // ->getNoWrapFlags(FlagNW)
1197 SCEV::FlagAnyWrap));
Dan Gohmana10756e2010-01-21 02:09:26 +00001198 }
1199
1200 // Expand the core addrec. If we need post-loop scaling, force it to
1201 // expand to an integer type to avoid the need for additional casting.
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001202 Type *ExpandTy = PostLoopScale ? IntTy : STy;
Dan Gohmana10756e2010-01-21 02:09:26 +00001203 PHINode *PN = getAddRecExprPHILiterally(Normalized, L, ExpandTy, IntTy);
1204
Dan Gohman3f46a3a2010-03-01 17:49:51 +00001205 // Accommodate post-inc mode, if necessary.
Dan Gohmana10756e2010-01-21 02:09:26 +00001206 Value *Result;
Dan Gohman448db1c2010-04-07 22:27:08 +00001207 if (!PostIncLoops.count(L))
Dan Gohmana10756e2010-01-21 02:09:26 +00001208 Result = PN;
1209 else {
1210 // In PostInc mode, use the post-incremented value.
1211 BasicBlock *LatchBlock = L->getLoopLatch();
1212 assert(LatchBlock && "PostInc mode requires a unique loop latch!");
1213 Result = PN->getIncomingValueForBlock(LatchBlock);
Andrew Trick48ba0e42011-10-13 21:55:29 +00001214
1215 // For an expansion to use the postinc form, the client must call
1216 // expandCodeFor with an InsertPoint that is either outside the PostIncLoop
1217 // or dominated by IVIncInsertPos.
Andrew Trick553fe052011-11-30 06:07:54 +00001218 if (isa<Instruction>(Result)
1219 && !SE.DT->dominates(cast<Instruction>(Result),
1220 Builder.GetInsertPoint())) {
1221 // The induction variable's postinc expansion does not dominate this use.
1222 // IVUsers tries to prevent this case, so it is rare. However, it can
1223 // happen when an IVUser outside the loop is not dominated by the latch
1224 // block. Adjusting IVIncInsertPos before expansion begins cannot handle
1225 // all cases. Consider a phi outide whose operand is replaced during
1226 // expansion with the value of the postinc user. Without fundamentally
1227 // changing the way postinc users are tracked, the only remedy is
1228 // inserting an extra IV increment. StepV might fold into PostLoopOffset,
1229 // but hopefully expandCodeFor handles that.
1230 bool useSubtract =
Andrew Trickf8fd8412012-01-07 00:27:31 +00001231 !ExpandTy->isPointerTy() && Step->isNonConstantNegative();
Andrew Trick553fe052011-11-30 06:07:54 +00001232 if (useSubtract)
1233 Step = SE.getNegativeSCEV(Step);
1234 // Expand the step somewhere that dominates the loop header.
1235 BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
1236 BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
1237 Value *StepV = expandCodeFor(Step, IntTy, L->getHeader()->begin());
1238 // Restore the insertion point to the place where the caller has
1239 // determined dominates all uses.
1240 restoreInsertPoint(SaveInsertBB, SaveInsertPt);
1241 Result = expandIVInc(PN, StepV, L, ExpandTy, IntTy, useSubtract);
1242 }
Dan Gohmana10756e2010-01-21 02:09:26 +00001243 }
1244
1245 // Re-apply any non-loop-dominating scale.
1246 if (PostLoopScale) {
Dan Gohman0a799ab2010-02-12 20:39:25 +00001247 Result = InsertNoopCastOfTo(Result, IntTy);
Dan Gohmana10756e2010-01-21 02:09:26 +00001248 Result = Builder.CreateMul(Result,
1249 expandCodeFor(PostLoopScale, IntTy));
1250 rememberInstruction(Result);
1251 }
1252
1253 // Re-apply any non-loop-dominating offset.
1254 if (PostLoopOffset) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001255 if (PointerType *PTy = dyn_cast<PointerType>(ExpandTy)) {
Dan Gohmana10756e2010-01-21 02:09:26 +00001256 const SCEV *const OffsetArray[1] = { PostLoopOffset };
1257 Result = expandAddToGEP(OffsetArray, OffsetArray+1, PTy, IntTy, Result);
1258 } else {
Dan Gohman0a799ab2010-02-12 20:39:25 +00001259 Result = InsertNoopCastOfTo(Result, IntTy);
Dan Gohmana10756e2010-01-21 02:09:26 +00001260 Result = Builder.CreateAdd(Result,
1261 expandCodeFor(PostLoopOffset, IntTy));
1262 rememberInstruction(Result);
1263 }
1264 }
1265
1266 return Result;
1267}
1268
Dan Gohman890f92b2009-04-18 17:56:28 +00001269Value *SCEVExpander::visitAddRecExpr(const SCEVAddRecExpr *S) {
Dan Gohmana10756e2010-01-21 02:09:26 +00001270 if (!CanonicalMode) return expandAddRecExprLiterally(S);
1271
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001272 Type *Ty = SE.getEffectiveSCEVType(S->getType());
Nate Begeman36f891b2005-07-30 00:12:19 +00001273 const Loop *L = S->getLoop();
Nate Begeman36f891b2005-07-30 00:12:19 +00001274
Dan Gohman4d8414f2009-06-13 16:25:49 +00001275 // First check for an existing canonical IV in a suitable type.
1276 PHINode *CanonicalIV = 0;
1277 if (PHINode *PN = L->getCanonicalInductionVariable())
Dan Gohman133e2952010-07-20 16:46:58 +00001278 if (SE.getTypeSizeInBits(PN->getType()) >= SE.getTypeSizeInBits(Ty))
Dan Gohman4d8414f2009-06-13 16:25:49 +00001279 CanonicalIV = PN;
1280
1281 // Rewrite an AddRec in terms of the canonical induction variable, if
1282 // its type is more narrow.
1283 if (CanonicalIV &&
1284 SE.getTypeSizeInBits(CanonicalIV->getType()) >
1285 SE.getTypeSizeInBits(Ty)) {
Dan Gohmanf9e64722010-03-18 01:17:13 +00001286 SmallVector<const SCEV *, 4> NewOps(S->getNumOperands());
1287 for (unsigned i = 0, e = S->getNumOperands(); i != e; ++i)
1288 NewOps[i] = SE.getAnyExtendExpr(S->op_begin()[i], CanonicalIV->getType());
Andrew Trick3228cc22011-03-14 16:50:06 +00001289 Value *V = expand(SE.getAddRecExpr(NewOps, S->getLoop(),
1290 // FIXME: S->getNoWrapFlags(FlagNW)
1291 SCEV::FlagAnyWrap));
Dan Gohman267a3852009-06-27 21:18:18 +00001292 BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
1293 BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
Dan Gohman4d8414f2009-06-13 16:25:49 +00001294 BasicBlock::iterator NewInsertPt =
Chris Lattner7896c9f2009-12-03 00:50:42 +00001295 llvm::next(BasicBlock::iterator(cast<Instruction>(V)));
Bill Wendlinga4c86ab2011-08-24 21:06:46 +00001296 while (isa<PHINode>(NewInsertPt) || isa<DbgInfoIntrinsic>(NewInsertPt) ||
1297 isa<LandingPadInst>(NewInsertPt))
Jim Grosbach08f55d02010-06-16 21:13:38 +00001298 ++NewInsertPt;
Dan Gohman4d8414f2009-06-13 16:25:49 +00001299 V = expandCodeFor(SE.getTruncateExpr(SE.getUnknown(V), Ty), 0,
1300 NewInsertPt);
Dan Gohman45598552010-02-15 00:21:43 +00001301 restoreInsertPoint(SaveInsertBB, SaveInsertPt);
Dan Gohman4d8414f2009-06-13 16:25:49 +00001302 return V;
1303 }
1304
Nate Begeman36f891b2005-07-30 00:12:19 +00001305 // {X,+,F} --> X + {0,+,F}
Dan Gohmancfeb6a42008-06-18 16:23:07 +00001306 if (!S->getStart()->isZero()) {
Dan Gohmanf9e64722010-03-18 01:17:13 +00001307 SmallVector<const SCEV *, 4> NewOps(S->op_begin(), S->op_end());
Dan Gohmandeff6212010-05-03 22:09:21 +00001308 NewOps[0] = SE.getConstant(Ty, 0);
Andrew Trick3228cc22011-03-14 16:50:06 +00001309 // FIXME: can use S->getNoWrapFlags()
1310 const SCEV *Rest = SE.getAddRecExpr(NewOps, L, SCEV::FlagAnyWrap);
Dan Gohman453aa4f2009-05-24 18:06:31 +00001311
1312 // Turn things like ptrtoint+arithmetic+inttoptr into GEP. See the
1313 // comments on expandAddToGEP for details.
Dan Gohmanc40f17b2009-08-18 16:46:41 +00001314 const SCEV *Base = S->getStart();
1315 const SCEV *RestArray[1] = { Rest };
1316 // Dig into the expression to find the pointer base for a GEP.
1317 ExposePointerBase(Base, RestArray[0], SE);
1318 // If we found a pointer, expand the AddRec with a GEP.
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001319 if (PointerType *PTy = dyn_cast<PointerType>(Base->getType())) {
Dan Gohmanc40f17b2009-08-18 16:46:41 +00001320 // Make sure the Base isn't something exotic, such as a multiplied
1321 // or divided pointer value. In those cases, the result type isn't
1322 // actually a pointer type.
1323 if (!isa<SCEVMulExpr>(Base) && !isa<SCEVUDivExpr>(Base)) {
1324 Value *StartV = expand(Base);
1325 assert(StartV->getType() == PTy && "Pointer type mismatch for GEP!");
1326 return expandAddToGEP(RestArray, RestArray+1, PTy, Ty, StartV);
Dan Gohman453aa4f2009-05-24 18:06:31 +00001327 }
1328 }
1329
Dan Gohman40a5a1b2009-06-24 01:18:18 +00001330 // Just do a normal add. Pre-expand the operands to suppress folding.
1331 return expand(SE.getAddExpr(SE.getUnknown(expand(S->getStart())),
1332 SE.getUnknown(expand(Rest))));
Nate Begeman36f891b2005-07-30 00:12:19 +00001333 }
1334
Dan Gohman6ebfd722010-07-26 18:28:14 +00001335 // If we don't yet have a canonical IV, create one.
1336 if (!CanonicalIV) {
Nate Begeman36f891b2005-07-30 00:12:19 +00001337 // Create and insert the PHI node for the induction variable in the
1338 // specified loop.
1339 BasicBlock *Header = L->getHeader();
Jay Foadd8b4fb42011-03-30 11:19:20 +00001340 pred_iterator HPB = pred_begin(Header), HPE = pred_end(Header);
Jay Foad3ecfc862011-03-30 11:28:46 +00001341 CanonicalIV = PHINode::Create(Ty, std::distance(HPB, HPE), "indvar",
1342 Header->begin());
Dan Gohman6ebfd722010-07-26 18:28:14 +00001343 rememberInstruction(CanonicalIV);
Nate Begeman36f891b2005-07-30 00:12:19 +00001344
Owen Andersoneed707b2009-07-24 23:12:02 +00001345 Constant *One = ConstantInt::get(Ty, 1);
Jay Foadd8b4fb42011-03-30 11:19:20 +00001346 for (pred_iterator HPI = HPB; HPI != HPE; ++HPI) {
Gabor Greif76560182010-07-09 15:40:10 +00001347 BasicBlock *HP = *HPI;
1348 if (L->contains(HP)) {
Dan Gohman3abf9052010-01-19 22:26:02 +00001349 // Insert a unit add instruction right before the terminator
1350 // corresponding to the back-edge.
Dan Gohman6ebfd722010-07-26 18:28:14 +00001351 Instruction *Add = BinaryOperator::CreateAdd(CanonicalIV, One,
1352 "indvar.next",
1353 HP->getTerminator());
Devang Pateldf3ad662011-06-22 20:56:56 +00001354 Add->setDebugLoc(HP->getTerminator()->getDebugLoc());
Dan Gohmana10756e2010-01-21 02:09:26 +00001355 rememberInstruction(Add);
Dan Gohman6ebfd722010-07-26 18:28:14 +00001356 CanonicalIV->addIncoming(Add, HP);
Dan Gohman83d57742009-09-27 17:46:40 +00001357 } else {
Dan Gohman6ebfd722010-07-26 18:28:14 +00001358 CanonicalIV->addIncoming(Constant::getNullValue(Ty), HP);
Dan Gohman83d57742009-09-27 17:46:40 +00001359 }
Gabor Greif76560182010-07-09 15:40:10 +00001360 }
Nate Begeman36f891b2005-07-30 00:12:19 +00001361 }
1362
Dan Gohman6ebfd722010-07-26 18:28:14 +00001363 // {0,+,1} --> Insert a canonical induction variable into the loop!
1364 if (S->isAffine() && S->getOperand(1)->isOne()) {
1365 assert(Ty == SE.getEffectiveSCEVType(CanonicalIV->getType()) &&
1366 "IVs with types different from the canonical IV should "
1367 "already have been handled!");
1368 return CanonicalIV;
1369 }
1370
Dan Gohman4d8414f2009-06-13 16:25:49 +00001371 // {0,+,F} --> {0,+,1} * F
Nate Begeman36f891b2005-07-30 00:12:19 +00001372
Chris Lattnerdf14a042005-10-30 06:24:33 +00001373 // If this is a simple linear addrec, emit it now as a special case.
Dan Gohman40a5a1b2009-06-24 01:18:18 +00001374 if (S->isAffine()) // {0,+,F} --> i*F
1375 return
1376 expand(SE.getTruncateOrNoop(
Dan Gohman6ebfd722010-07-26 18:28:14 +00001377 SE.getMulExpr(SE.getUnknown(CanonicalIV),
Dan Gohman40a5a1b2009-06-24 01:18:18 +00001378 SE.getNoopOrAnyExtend(S->getOperand(1),
Dan Gohman6ebfd722010-07-26 18:28:14 +00001379 CanonicalIV->getType())),
Dan Gohman40a5a1b2009-06-24 01:18:18 +00001380 Ty));
Nate Begeman36f891b2005-07-30 00:12:19 +00001381
1382 // If this is a chain of recurrences, turn it into a closed form, using the
1383 // folders, then expandCodeFor the closed form. This allows the folders to
1384 // simplify the expression without having to build a bunch of special code
1385 // into this folder.
Dan Gohman6ebfd722010-07-26 18:28:14 +00001386 const SCEV *IH = SE.getUnknown(CanonicalIV); // Get I as a "symbolic" SCEV.
Nate Begeman36f891b2005-07-30 00:12:19 +00001387
Dan Gohman4d8414f2009-06-13 16:25:49 +00001388 // Promote S up to the canonical IV type, if the cast is foldable.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001389 const SCEV *NewS = S;
Dan Gohman6ebfd722010-07-26 18:28:14 +00001390 const SCEV *Ext = SE.getNoopOrAnyExtend(S, CanonicalIV->getType());
Dan Gohman4d8414f2009-06-13 16:25:49 +00001391 if (isa<SCEVAddRecExpr>(Ext))
1392 NewS = Ext;
1393
Dan Gohman0bba49c2009-07-07 17:06:11 +00001394 const SCEV *V = cast<SCEVAddRecExpr>(NewS)->evaluateAtIteration(IH, SE);
Bill Wendlinge8156192006-12-07 01:30:32 +00001395 //cerr << "Evaluated: " << *this << "\n to: " << *V << "\n";
Nate Begeman36f891b2005-07-30 00:12:19 +00001396
Dan Gohman4d8414f2009-06-13 16:25:49 +00001397 // Truncate the result down to the original type, if needed.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001398 const SCEV *T = SE.getTruncateOrNoop(V, Ty);
Dan Gohman469f3cd2009-06-22 22:08:45 +00001399 return expand(T);
Nate Begeman36f891b2005-07-30 00:12:19 +00001400}
Anton Korobeynikov96fea332007-08-20 21:17:26 +00001401
Dan Gohman890f92b2009-04-18 17:56:28 +00001402Value *SCEVExpander::visitTruncateExpr(const SCEVTruncateExpr *S) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001403 Type *Ty = SE.getEffectiveSCEVType(S->getType());
Dan Gohman92fcdca2009-06-09 17:18:38 +00001404 Value *V = expandCodeFor(S->getOperand(),
1405 SE.getEffectiveSCEVType(S->getOperand()->getType()));
Benjamin Kramera9390a42011-09-27 20:39:19 +00001406 Value *I = Builder.CreateTrunc(V, Ty);
Dan Gohmana10756e2010-01-21 02:09:26 +00001407 rememberInstruction(I);
Dan Gohmancf5ab822009-05-01 17:13:31 +00001408 return I;
Dan Gohman11f6d3b2008-06-22 19:09:18 +00001409}
1410
Dan Gohman890f92b2009-04-18 17:56:28 +00001411Value *SCEVExpander::visitZeroExtendExpr(const SCEVZeroExtendExpr *S) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001412 Type *Ty = SE.getEffectiveSCEVType(S->getType());
Dan Gohman92fcdca2009-06-09 17:18:38 +00001413 Value *V = expandCodeFor(S->getOperand(),
1414 SE.getEffectiveSCEVType(S->getOperand()->getType()));
Benjamin Kramera9390a42011-09-27 20:39:19 +00001415 Value *I = Builder.CreateZExt(V, Ty);
Dan Gohmana10756e2010-01-21 02:09:26 +00001416 rememberInstruction(I);
Dan Gohmancf5ab822009-05-01 17:13:31 +00001417 return I;
Dan Gohman11f6d3b2008-06-22 19:09:18 +00001418}
1419
Dan Gohman890f92b2009-04-18 17:56:28 +00001420Value *SCEVExpander::visitSignExtendExpr(const SCEVSignExtendExpr *S) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001421 Type *Ty = SE.getEffectiveSCEVType(S->getType());
Dan Gohman92fcdca2009-06-09 17:18:38 +00001422 Value *V = expandCodeFor(S->getOperand(),
1423 SE.getEffectiveSCEVType(S->getOperand()->getType()));
Benjamin Kramera9390a42011-09-27 20:39:19 +00001424 Value *I = Builder.CreateSExt(V, Ty);
Dan Gohmana10756e2010-01-21 02:09:26 +00001425 rememberInstruction(I);
Dan Gohmancf5ab822009-05-01 17:13:31 +00001426 return I;
Dan Gohman11f6d3b2008-06-22 19:09:18 +00001427}
1428
Dan Gohman890f92b2009-04-18 17:56:28 +00001429Value *SCEVExpander::visitSMaxExpr(const SCEVSMaxExpr *S) {
Dan Gohman0196dc52009-07-14 20:57:04 +00001430 Value *LHS = expand(S->getOperand(S->getNumOperands()-1));
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001431 Type *Ty = LHS->getType();
Dan Gohman0196dc52009-07-14 20:57:04 +00001432 for (int i = S->getNumOperands()-2; i >= 0; --i) {
1433 // In the case of mixed integer and pointer types, do the
1434 // rest of the comparisons as integer.
1435 if (S->getOperand(i)->getType() != Ty) {
1436 Ty = SE.getEffectiveSCEVType(Ty);
1437 LHS = InsertNoopCastOfTo(LHS, Ty);
1438 }
Dan Gohman92fcdca2009-06-09 17:18:38 +00001439 Value *RHS = expandCodeFor(S->getOperand(i), Ty);
Benjamin Kramera9390a42011-09-27 20:39:19 +00001440 Value *ICmp = Builder.CreateICmpSGT(LHS, RHS);
Dan Gohmana10756e2010-01-21 02:09:26 +00001441 rememberInstruction(ICmp);
Dan Gohman267a3852009-06-27 21:18:18 +00001442 Value *Sel = Builder.CreateSelect(ICmp, LHS, RHS, "smax");
Dan Gohmana10756e2010-01-21 02:09:26 +00001443 rememberInstruction(Sel);
Dan Gohmancf5ab822009-05-01 17:13:31 +00001444 LHS = Sel;
Nick Lewyckyc54c5612007-11-25 22:41:31 +00001445 }
Dan Gohman0196dc52009-07-14 20:57:04 +00001446 // In the case of mixed integer and pointer types, cast the
1447 // final result back to the pointer type.
1448 if (LHS->getType() != S->getType())
1449 LHS = InsertNoopCastOfTo(LHS, S->getType());
Nick Lewyckyc54c5612007-11-25 22:41:31 +00001450 return LHS;
1451}
1452
Dan Gohman890f92b2009-04-18 17:56:28 +00001453Value *SCEVExpander::visitUMaxExpr(const SCEVUMaxExpr *S) {
Dan Gohman0196dc52009-07-14 20:57:04 +00001454 Value *LHS = expand(S->getOperand(S->getNumOperands()-1));
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001455 Type *Ty = LHS->getType();
Dan Gohman0196dc52009-07-14 20:57:04 +00001456 for (int i = S->getNumOperands()-2; i >= 0; --i) {
1457 // In the case of mixed integer and pointer types, do the
1458 // rest of the comparisons as integer.
1459 if (S->getOperand(i)->getType() != Ty) {
1460 Ty = SE.getEffectiveSCEVType(Ty);
1461 LHS = InsertNoopCastOfTo(LHS, Ty);
1462 }
Dan Gohman92fcdca2009-06-09 17:18:38 +00001463 Value *RHS = expandCodeFor(S->getOperand(i), Ty);
Benjamin Kramera9390a42011-09-27 20:39:19 +00001464 Value *ICmp = Builder.CreateICmpUGT(LHS, RHS);
Dan Gohmana10756e2010-01-21 02:09:26 +00001465 rememberInstruction(ICmp);
Dan Gohman267a3852009-06-27 21:18:18 +00001466 Value *Sel = Builder.CreateSelect(ICmp, LHS, RHS, "umax");
Dan Gohmana10756e2010-01-21 02:09:26 +00001467 rememberInstruction(Sel);
Dan Gohmancf5ab822009-05-01 17:13:31 +00001468 LHS = Sel;
Nick Lewycky3e630762008-02-20 06:48:22 +00001469 }
Dan Gohman0196dc52009-07-14 20:57:04 +00001470 // In the case of mixed integer and pointer types, cast the
1471 // final result back to the pointer type.
1472 if (LHS->getType() != S->getType())
1473 LHS = InsertNoopCastOfTo(LHS, S->getType());
Nick Lewycky3e630762008-02-20 06:48:22 +00001474 return LHS;
1475}
1476
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001477Value *SCEVExpander::expandCodeFor(const SCEV *SH, Type *Ty,
Andrew Trickb5c26ef2012-01-20 07:41:13 +00001478 Instruction *IP) {
Dan Gohman6c7ed6b2010-03-19 21:51:03 +00001479 Builder.SetInsertPoint(IP->getParent(), IP);
1480 return expandCodeFor(SH, Ty);
1481}
1482
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001483Value *SCEVExpander::expandCodeFor(const SCEV *SH, Type *Ty) {
Dan Gohman11f6d3b2008-06-22 19:09:18 +00001484 // Expand the code for this SCEV.
Dan Gohman2d1be872009-04-16 03:18:22 +00001485 Value *V = expand(SH);
Dan Gohman5be18e82009-05-19 02:15:55 +00001486 if (Ty) {
1487 assert(SE.getTypeSizeInBits(Ty) == SE.getTypeSizeInBits(SH->getType()) &&
1488 "non-trivial casts should be done with the SCEVs directly!");
1489 V = InsertNoopCastOfTo(V, Ty);
1490 }
1491 return V;
Dan Gohman11f6d3b2008-06-22 19:09:18 +00001492}
1493
Dan Gohman890f92b2009-04-18 17:56:28 +00001494Value *SCEVExpander::expand(const SCEV *S) {
Dan Gohman40a5a1b2009-06-24 01:18:18 +00001495 // Compute an insertion point for this SCEV object. Hoist the instructions
1496 // as far out in the loop nest as possible.
Dan Gohman267a3852009-06-27 21:18:18 +00001497 Instruction *InsertPt = Builder.GetInsertPoint();
1498 for (Loop *L = SE.LI->getLoopFor(Builder.GetInsertBlock()); ;
Dan Gohman40a5a1b2009-06-24 01:18:18 +00001499 L = L->getParentLoop())
Dan Gohman17ead4f2010-11-17 21:23:15 +00001500 if (SE.isLoopInvariant(S, L)) {
Dan Gohman40a5a1b2009-06-24 01:18:18 +00001501 if (!L) break;
Dan Gohmane059ee82010-03-23 21:53:22 +00001502 if (BasicBlock *Preheader = L->getLoopPreheader())
Dan Gohman40a5a1b2009-06-24 01:18:18 +00001503 InsertPt = Preheader->getTerminator();
Andrew Trick0f8cd562012-01-02 21:25:10 +00001504 else {
1505 // LSR sets the insertion point for AddRec start/step values to the
1506 // block start to simplify value reuse, even though it's an invalid
1507 // position. SCEVExpander must correct for this in all cases.
1508 InsertPt = L->getHeader()->getFirstInsertionPt();
1509 }
Dan Gohman40a5a1b2009-06-24 01:18:18 +00001510 } else {
1511 // If the SCEV is computable at this level, insert it into the header
1512 // after the PHIs (and after any other instructions that we've inserted
1513 // there) so that it is guaranteed to dominate any user inside the loop.
Bill Wendling5b6f42f2011-08-16 20:45:24 +00001514 if (L && SE.hasComputableLoopEvolution(S, L) && !PostIncLoops.count(L))
1515 InsertPt = L->getHeader()->getFirstInsertionPt();
Andrew Trickb5c26ef2012-01-20 07:41:13 +00001516 while (InsertPt != Builder.GetInsertPoint()
1517 && (isInsertedInstruction(InsertPt)
1518 || isa<DbgInfoIntrinsic>(InsertPt))) {
Chris Lattner7896c9f2009-12-03 00:50:42 +00001519 InsertPt = llvm::next(BasicBlock::iterator(InsertPt));
Andrew Trickb5c26ef2012-01-20 07:41:13 +00001520 }
Dan Gohman40a5a1b2009-06-24 01:18:18 +00001521 break;
1522 }
Dan Gohman40a5a1b2009-06-24 01:18:18 +00001523
Dan Gohman667d7872009-06-26 22:53:46 +00001524 // Check to see if we already expanded this here.
1525 std::map<std::pair<const SCEV *, Instruction *>,
1526 AssertingVH<Value> >::iterator I =
1527 InsertedExpressions.find(std::make_pair(S, InsertPt));
Dan Gohman267a3852009-06-27 21:18:18 +00001528 if (I != InsertedExpressions.end())
Dan Gohman667d7872009-06-26 22:53:46 +00001529 return I->second;
Dan Gohman267a3852009-06-27 21:18:18 +00001530
1531 BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
1532 BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
1533 Builder.SetInsertPoint(InsertPt->getParent(), InsertPt);
Dan Gohman667d7872009-06-26 22:53:46 +00001534
1535 // Expand the expression into instructions.
Anton Korobeynikov96fea332007-08-20 21:17:26 +00001536 Value *V = visit(S);
Dan Gohman40a5a1b2009-06-24 01:18:18 +00001537
Dan Gohman667d7872009-06-26 22:53:46 +00001538 // Remember the expanded value for this SCEV at this location.
Andrew Trick48ba0e42011-10-13 21:55:29 +00001539 //
1540 // This is independent of PostIncLoops. The mapped value simply materializes
1541 // the expression at this insertion point. If the mapped value happened to be
1542 // a postinc expansion, it could be reused by a non postinc user, but only if
1543 // its insertion point was already at the head of the loop.
1544 InsertedExpressions[std::make_pair(S, InsertPt)] = V;
Dan Gohman667d7872009-06-26 22:53:46 +00001545
Dan Gohman45598552010-02-15 00:21:43 +00001546 restoreInsertPoint(SaveInsertBB, SaveInsertPt);
Anton Korobeynikov96fea332007-08-20 21:17:26 +00001547 return V;
1548}
Dan Gohman1d09de32009-06-05 16:35:53 +00001549
Dan Gohman1d826a72010-02-14 03:12:47 +00001550void SCEVExpander::rememberInstruction(Value *I) {
Dan Gohman25fcaff2010-06-05 00:33:07 +00001551 if (!PostIncLoops.empty())
1552 InsertedPostIncValues.insert(I);
1553 else
Dan Gohman1d826a72010-02-14 03:12:47 +00001554 InsertedValues.insert(I);
Dan Gohman1d826a72010-02-14 03:12:47 +00001555}
1556
Dan Gohman45598552010-02-15 00:21:43 +00001557void SCEVExpander::restoreInsertPoint(BasicBlock *BB, BasicBlock::iterator I) {
Dan Gohman45598552010-02-15 00:21:43 +00001558 Builder.SetInsertPoint(BB, I);
1559}
1560
Dan Gohman1d09de32009-06-05 16:35:53 +00001561/// getOrInsertCanonicalInductionVariable - This method returns the
1562/// canonical induction variable of the specified type for the specified
1563/// loop (inserting one if there is none). A canonical induction variable
1564/// starts at zero and steps by one on each iteration.
Dan Gohman7c58dbd2010-07-20 16:44:52 +00001565PHINode *
Dan Gohman1d09de32009-06-05 16:35:53 +00001566SCEVExpander::getOrInsertCanonicalInductionVariable(const Loop *L,
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001567 Type *Ty) {
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00001568 assert(Ty->isIntegerTy() && "Can only insert integer induction variables!");
Dan Gohman133e2952010-07-20 16:46:58 +00001569
1570 // Build a SCEV for {0,+,1}<L>.
Andrew Trick3228cc22011-03-14 16:50:06 +00001571 // Conservatively use FlagAnyWrap for now.
Dan Gohmandeff6212010-05-03 22:09:21 +00001572 const SCEV *H = SE.getAddRecExpr(SE.getConstant(Ty, 0),
Andrew Trick3228cc22011-03-14 16:50:06 +00001573 SE.getConstant(Ty, 1), L, SCEV::FlagAnyWrap);
Dan Gohman133e2952010-07-20 16:46:58 +00001574
1575 // Emit code for it.
Dan Gohman267a3852009-06-27 21:18:18 +00001576 BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
1577 BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
Dan Gohman7c58dbd2010-07-20 16:44:52 +00001578 PHINode *V = cast<PHINode>(expandCodeFor(H, 0, L->getHeader()->begin()));
Dan Gohman267a3852009-06-27 21:18:18 +00001579 if (SaveInsertBB)
Dan Gohman45598552010-02-15 00:21:43 +00001580 restoreInsertPoint(SaveInsertBB, SaveInsertPt);
Dan Gohman133e2952010-07-20 16:46:58 +00001581
Dan Gohman40a5a1b2009-06-24 01:18:18 +00001582 return V;
Dan Gohman1d09de32009-06-05 16:35:53 +00001583}
Andrew Trick20449412011-10-11 02:28:51 +00001584
Andrew Trick139f3332012-01-07 01:29:21 +00001585/// Sort values by integer width for replaceCongruentIVs.
1586static bool width_descending(Value *lhs, Value *rhs) {
Andrew Trickee98aa82012-01-07 01:12:09 +00001587 // Put pointers at the back and make sure pointer < pointer = false.
1588 if (!lhs->getType()->isIntegerTy() || !rhs->getType()->isIntegerTy())
1589 return rhs->getType()->isIntegerTy() && !lhs->getType()->isIntegerTy();
1590 return rhs->getType()->getPrimitiveSizeInBits()
1591 < lhs->getType()->getPrimitiveSizeInBits();
1592}
1593
Andrew Trick20449412011-10-11 02:28:51 +00001594/// replaceCongruentIVs - Check for congruent phis in this loop header and
1595/// replace them with their most canonical representative. Return the number of
1596/// phis eliminated.
1597///
1598/// This does not depend on any SCEVExpander state but should be used in
1599/// the same context that SCEVExpander is used.
1600unsigned SCEVExpander::replaceCongruentIVs(Loop *L, const DominatorTree *DT,
Andrew Trickee98aa82012-01-07 01:12:09 +00001601 SmallVectorImpl<WeakVH> &DeadInsts,
1602 const TargetLowering *TLI) {
1603 // Find integer phis in order of increasing width.
1604 SmallVector<PHINode*, 8> Phis;
1605 for (BasicBlock::iterator I = L->getHeader()->begin();
1606 PHINode *Phi = dyn_cast<PHINode>(I); ++I) {
1607 Phis.push_back(Phi);
1608 }
1609 if (TLI)
1610 std::sort(Phis.begin(), Phis.end(), width_descending);
1611
Andrew Trick20449412011-10-11 02:28:51 +00001612 unsigned NumElim = 0;
1613 DenseMap<const SCEV *, PHINode *> ExprToIVMap;
Andrew Trickee98aa82012-01-07 01:12:09 +00001614 // Process phis from wide to narrow. Mapping wide phis to the their truncation
1615 // so narrow phis can reuse them.
1616 for (SmallVectorImpl<PHINode*>::const_iterator PIter = Phis.begin(),
1617 PEnd = Phis.end(); PIter != PEnd; ++PIter) {
1618 PHINode *Phi = *PIter;
1619
Andrew Trick20449412011-10-11 02:28:51 +00001620 if (!SE.isSCEVable(Phi->getType()))
1621 continue;
1622
1623 PHINode *&OrigPhiRef = ExprToIVMap[SE.getSCEV(Phi)];
1624 if (!OrigPhiRef) {
1625 OrigPhiRef = Phi;
Andrew Trickee98aa82012-01-07 01:12:09 +00001626 if (Phi->getType()->isIntegerTy() && TLI
1627 && TLI->isTruncateFree(Phi->getType(), Phis.back()->getType())) {
1628 // This phi can be freely truncated to the narrowest phi type. Map the
1629 // truncated expression to it so it will be reused for narrow types.
1630 const SCEV *TruncExpr =
1631 SE.getTruncateExpr(SE.getSCEV(Phi), Phis.back()->getType());
1632 ExprToIVMap[TruncExpr] = Phi;
1633 }
Andrew Trick20449412011-10-11 02:28:51 +00001634 continue;
1635 }
1636
Andrew Trickee98aa82012-01-07 01:12:09 +00001637 // Replacing a pointer phi with an integer phi or vice-versa doesn't make
1638 // sense.
1639 if (OrigPhiRef->getType()->isPointerTy() != Phi->getType()->isPointerTy())
Andrew Trick20449412011-10-11 02:28:51 +00001640 continue;
1641
1642 if (BasicBlock *LatchBlock = L->getLoopLatch()) {
1643 Instruction *OrigInc =
1644 cast<Instruction>(OrigPhiRef->getIncomingValueForBlock(LatchBlock));
1645 Instruction *IsomorphicInc =
1646 cast<Instruction>(Phi->getIncomingValueForBlock(LatchBlock));
1647
Andrew Trickee98aa82012-01-07 01:12:09 +00001648 // If this phi has the same width but is more canonical, replace the
Andrew Trickb5c26ef2012-01-20 07:41:13 +00001649 // original with it. As part of the "more canonical" determination,
1650 // respect a prior decision to use an IV chain.
Andrew Trickee98aa82012-01-07 01:12:09 +00001651 if (OrigPhiRef->getType() == Phi->getType()
Andrew Trickb5c26ef2012-01-20 07:41:13 +00001652 && !(ChainedPhis.count(Phi)
1653 || isExpandedAddRecExprPHI(OrigPhiRef, OrigInc, L))
1654 && (ChainedPhis.count(Phi)
1655 || isExpandedAddRecExprPHI(Phi, IsomorphicInc, L))) {
Andrew Trick20449412011-10-11 02:28:51 +00001656 std::swap(OrigPhiRef, Phi);
1657 std::swap(OrigInc, IsomorphicInc);
1658 }
1659 // Replacing the congruent phi is sufficient because acyclic redundancy
1660 // elimination, CSE/GVN, should handle the rest. However, once SCEV proves
1661 // that a phi is congruent, it's often the head of an IV user cycle that
Andrew Trick139f3332012-01-07 01:29:21 +00001662 // is isomorphic with the original phi. It's worth eagerly cleaning up the
1663 // common case of a single IV increment so that DeleteDeadPHIs can remove
1664 // cycles that had postinc uses.
Andrew Trickee98aa82012-01-07 01:12:09 +00001665 const SCEV *TruncExpr = SE.getTruncateOrNoop(SE.getSCEV(OrigInc),
1666 IsomorphicInc->getType());
1667 if (OrigInc != IsomorphicInc
Andrew Trick64925c52012-01-10 01:45:08 +00001668 && TruncExpr == SE.getSCEV(IsomorphicInc)
Andrew Trickb5c26ef2012-01-20 07:41:13 +00001669 && ((isa<PHINode>(OrigInc) && isa<PHINode>(IsomorphicInc))
1670 || hoistIVInc(OrigInc, IsomorphicInc))) {
Andrew Trick20449412011-10-11 02:28:51 +00001671 DEBUG_WITH_TYPE(DebugType, dbgs()
1672 << "INDVARS: Eliminated congruent iv.inc: "
1673 << *IsomorphicInc << '\n');
Andrew Trickee98aa82012-01-07 01:12:09 +00001674 Value *NewInc = OrigInc;
1675 if (OrigInc->getType() != IsomorphicInc->getType()) {
Andrew Trickdd1f22f2012-01-14 03:17:23 +00001676 Instruction *IP = isa<PHINode>(OrigInc)
1677 ? (Instruction*)L->getHeader()->getFirstInsertionPt()
1678 : OrigInc->getNextNode();
1679 IRBuilder<> Builder(IP);
Andrew Trickee98aa82012-01-07 01:12:09 +00001680 Builder.SetCurrentDebugLocation(IsomorphicInc->getDebugLoc());
1681 NewInc = Builder.
1682 CreateTruncOrBitCast(OrigInc, IsomorphicInc->getType(), IVName);
1683 }
1684 IsomorphicInc->replaceAllUsesWith(NewInc);
Andrew Trick20449412011-10-11 02:28:51 +00001685 DeadInsts.push_back(IsomorphicInc);
1686 }
1687 }
1688 DEBUG_WITH_TYPE(DebugType, dbgs()
1689 << "INDVARS: Eliminated congruent iv: " << *Phi << '\n');
1690 ++NumElim;
Andrew Trickee98aa82012-01-07 01:12:09 +00001691 Value *NewIV = OrigPhiRef;
1692 if (OrigPhiRef->getType() != Phi->getType()) {
1693 IRBuilder<> Builder(L->getHeader()->getFirstInsertionPt());
1694 Builder.SetCurrentDebugLocation(Phi->getDebugLoc());
1695 NewIV = Builder.CreateTruncOrBitCast(OrigPhiRef, Phi->getType(), IVName);
1696 }
1697 Phi->replaceAllUsesWith(NewIV);
Andrew Trick20449412011-10-11 02:28:51 +00001698 DeadInsts.push_back(Phi);
1699 }
1700 return NumElim;
1701}