blob: c7ec1bc263d3214a8bba457fcc381db37673a7a2 [file] [log] [blame]
Andrew Trick3ec331e2011-08-10 03:46:27 +00001//===-- SimplifyIndVar.cpp - Induction variable simplification ------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements induction variable simplification. It does
11// not define any actual pass or policy, but provides a single function to
12// simplify a loop's induction variables based on ScalarEvolution.
13//
14//===----------------------------------------------------------------------===//
15
Chandler Carruthed0881b2012-12-03 16:50:05 +000016#include "llvm/Transforms/Utils/SimplifyIndVar.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000017#include "llvm/ADT/STLExtras.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000018#include "llvm/ADT/SmallVector.h"
19#include "llvm/ADT/Statistic.h"
Andrew Trick3ec331e2011-08-10 03:46:27 +000020#include "llvm/Analysis/LoopInfo.h"
21#include "llvm/Analysis/LoopPass.h"
22#include "llvm/Analysis/ScalarEvolutionExpressions.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000023#include "llvm/IR/DataLayout.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000024#include "llvm/IR/Dominators.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000025#include "llvm/IR/IRBuilder.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000026#include "llvm/IR/Instructions.h"
Andrew Trick0ba77a02013-12-23 23:31:49 +000027#include "llvm/IR/IntrinsicInst.h"
Andrew Trick3ec331e2011-08-10 03:46:27 +000028#include "llvm/Support/CommandLine.h"
29#include "llvm/Support/Debug.h"
30#include "llvm/Support/raw_ostream.h"
Andrew Trick3ec331e2011-08-10 03:46:27 +000031
32using namespace llvm;
33
Chandler Carruth964daaa2014-04-22 02:55:47 +000034#define DEBUG_TYPE "indvars"
35
Andrew Trick3ec331e2011-08-10 03:46:27 +000036STATISTIC(NumElimIdentity, "Number of IV identities eliminated");
37STATISTIC(NumElimOperand, "Number of IV operands folded into a use");
38STATISTIC(NumElimRem , "Number of IV remainder operations eliminated");
39STATISTIC(NumElimCmp , "Number of IV comparisons eliminated");
40
41namespace {
Sanjay Patel7777b502014-11-12 18:07:42 +000042 /// This is a utility for simplifying induction variables
Andrew Trick3ec331e2011-08-10 03:46:27 +000043 /// based on ScalarEvolution. It is the primary instrument of the
44 /// IndvarSimplify pass, but it may also be directly invoked to cleanup after
45 /// other loop passes that preserve SCEV.
46 class SimplifyIndvar {
47 Loop *L;
48 LoopInfo *LI;
Andrew Trick3ec331e2011-08-10 03:46:27 +000049 ScalarEvolution *SE;
Sanjoy Das5c8bead2015-10-06 21:44:49 +000050 DominatorTree *DT;
Andrew Trick3ec331e2011-08-10 03:46:27 +000051
52 SmallVectorImpl<WeakVH> &DeadInsts;
53
54 bool Changed;
55
56 public:
Sanjoy Das5c8bead2015-10-06 21:44:49 +000057 SimplifyIndvar(Loop *Loop, ScalarEvolution *SE, DominatorTree *DT,
58 LoopInfo *LI,SmallVectorImpl<WeakVH> &Dead)
59 : L(Loop), LI(LI), SE(SE), DT(DT), DeadInsts(Dead), Changed(false) {
Andrew Tricke629d002011-08-10 04:22:26 +000060 assert(LI && "IV simplification requires LoopInfo");
Andrew Trick3ec331e2011-08-10 03:46:27 +000061 }
62
63 bool hasChanged() const { return Changed; }
64
65 /// Iteratively perform simplification on a worklist of users of the
66 /// specified induction variable. This is the top-level driver that applies
Benjamin Kramerdf005cb2015-08-08 18:27:36 +000067 /// all simplifications to users of an IV.
Craig Topperf40110f2014-04-25 05:29:35 +000068 void simplifyUsers(PHINode *CurrIV, IVVisitor *V = nullptr);
Andrew Trick3ec331e2011-08-10 03:46:27 +000069
Andrew Trick74664d52011-08-10 04:01:31 +000070 Value *foldIVUser(Instruction *UseInst, Instruction *IVOperand);
Andrew Trick3ec331e2011-08-10 03:46:27 +000071
Sanjoy Das088bb0e2015-10-06 21:44:39 +000072 bool eliminateIdentitySCEV(Instruction *UseInst, Instruction *IVOperand);
73
Andrew Trick3ec331e2011-08-10 03:46:27 +000074 bool eliminateIVUser(Instruction *UseInst, Instruction *IVOperand);
75 void eliminateIVComparison(ICmpInst *ICmp, Value *IVOperand);
76 void eliminateIVRemainder(BinaryOperator *Rem, Value *IVOperand,
77 bool IsSigned);
Sanjoy Das7c0ce262015-01-06 19:02:56 +000078 bool strengthenOverflowingOperation(BinaryOperator *OBO, Value *IVOperand);
Andrew Trick0ba77a02013-12-23 23:31:49 +000079
80 Instruction *splitOverflowIntrinsic(Instruction *IVUser,
81 const DominatorTree *DT);
Andrew Trick3ec331e2011-08-10 03:46:27 +000082 };
Alexander Kornienkof00654e2015-06-23 09:49:53 +000083}
Andrew Trick3ec331e2011-08-10 03:46:27 +000084
Sanjay Patel7777b502014-11-12 18:07:42 +000085/// Fold an IV operand into its use. This removes increments of an
Andrew Trick3ec331e2011-08-10 03:46:27 +000086/// aligned IV when used by a instruction that ignores the low bits.
Andrew Trick74664d52011-08-10 04:01:31 +000087///
Andrew Trick7251e412011-09-19 17:54:39 +000088/// IVOperand is guaranteed SCEVable, but UseInst may not be.
89///
Andrew Trick74664d52011-08-10 04:01:31 +000090/// Return the operand of IVOperand for this induction variable if IVOperand can
Andrew Trick6dbb0602011-08-10 18:07:05 +000091/// be folded (in case more folding opportunities have been exposed).
Andrew Trick74664d52011-08-10 04:01:31 +000092/// Otherwise return null.
93Value *SimplifyIndvar::foldIVUser(Instruction *UseInst, Instruction *IVOperand) {
Craig Topperf40110f2014-04-25 05:29:35 +000094 Value *IVSrc = nullptr;
Andrew Trick3ec331e2011-08-10 03:46:27 +000095 unsigned OperIdx = 0;
Craig Topperf40110f2014-04-25 05:29:35 +000096 const SCEV *FoldedExpr = nullptr;
Andrew Trick3ec331e2011-08-10 03:46:27 +000097 switch (UseInst->getOpcode()) {
98 default:
Craig Topperf40110f2014-04-25 05:29:35 +000099 return nullptr;
Andrew Trick3ec331e2011-08-10 03:46:27 +0000100 case Instruction::UDiv:
101 case Instruction::LShr:
102 // We're only interested in the case where we know something about
103 // the numerator and have a constant denominator.
104 if (IVOperand != UseInst->getOperand(OperIdx) ||
105 !isa<ConstantInt>(UseInst->getOperand(1)))
Craig Topperf40110f2014-04-25 05:29:35 +0000106 return nullptr;
Andrew Trick3ec331e2011-08-10 03:46:27 +0000107
108 // Attempt to fold a binary operator with constant operand.
109 // e.g. ((I + 1) >> 2) => I >> 2
Andrew Trick94904582011-11-17 23:36:35 +0000110 if (!isa<BinaryOperator>(IVOperand)
111 || !isa<ConstantInt>(IVOperand->getOperand(1)))
Craig Topperf40110f2014-04-25 05:29:35 +0000112 return nullptr;
Andrew Trick3ec331e2011-08-10 03:46:27 +0000113
114 IVSrc = IVOperand->getOperand(0);
115 // IVSrc must be the (SCEVable) IV, since the other operand is const.
116 assert(SE->isSCEVable(IVSrc->getType()) && "Expect SCEVable IV operand");
117
118 ConstantInt *D = cast<ConstantInt>(UseInst->getOperand(1));
119 if (UseInst->getOpcode() == Instruction::LShr) {
120 // Get a constant for the divisor. See createSCEV.
121 uint32_t BitWidth = cast<IntegerType>(UseInst->getType())->getBitWidth();
122 if (D->getValue().uge(BitWidth))
Craig Topperf40110f2014-04-25 05:29:35 +0000123 return nullptr;
Andrew Trick3ec331e2011-08-10 03:46:27 +0000124
125 D = ConstantInt::get(UseInst->getContext(),
Benjamin Kramerfc3ea6f2013-07-11 16:05:50 +0000126 APInt::getOneBitSet(BitWidth, D->getZExtValue()));
Andrew Trick3ec331e2011-08-10 03:46:27 +0000127 }
128 FoldedExpr = SE->getUDivExpr(SE->getSCEV(IVSrc), SE->getSCEV(D));
129 }
130 // We have something that might fold it's operand. Compare SCEVs.
131 if (!SE->isSCEVable(UseInst->getType()))
Craig Topperf40110f2014-04-25 05:29:35 +0000132 return nullptr;
Andrew Trick3ec331e2011-08-10 03:46:27 +0000133
134 // Bypass the operand if SCEV can prove it has no effect.
135 if (SE->getSCEV(UseInst) != FoldedExpr)
Craig Topperf40110f2014-04-25 05:29:35 +0000136 return nullptr;
Andrew Trick3ec331e2011-08-10 03:46:27 +0000137
138 DEBUG(dbgs() << "INDVARS: Eliminated IV operand: " << *IVOperand
139 << " -> " << *UseInst << '\n');
140
141 UseInst->setOperand(OperIdx, IVSrc);
142 assert(SE->getSCEV(UseInst) == FoldedExpr && "bad SCEV with folded oper");
143
144 ++NumElimOperand;
145 Changed = true;
146 if (IVOperand->use_empty())
Benjamin Kramerf5e2fc42015-05-29 19:43:39 +0000147 DeadInsts.emplace_back(IVOperand);
Andrew Trick74664d52011-08-10 04:01:31 +0000148 return IVSrc;
Andrew Trick3ec331e2011-08-10 03:46:27 +0000149}
150
Sanjay Patel7777b502014-11-12 18:07:42 +0000151/// SimplifyIVUsers helper for eliminating useless
Andrew Trick3ec331e2011-08-10 03:46:27 +0000152/// comparisons against an induction variable.
153void SimplifyIndvar::eliminateIVComparison(ICmpInst *ICmp, Value *IVOperand) {
154 unsigned IVOperIdx = 0;
155 ICmpInst::Predicate Pred = ICmp->getPredicate();
156 if (IVOperand != ICmp->getOperand(0)) {
157 // Swapped
158 assert(IVOperand == ICmp->getOperand(1) && "Can't find IVOperand");
159 IVOperIdx = 1;
160 Pred = ICmpInst::getSwappedPredicate(Pred);
161 }
162
163 // Get the SCEVs for the ICmp operands.
164 const SCEV *S = SE->getSCEV(ICmp->getOperand(IVOperIdx));
165 const SCEV *X = SE->getSCEV(ICmp->getOperand(1 - IVOperIdx));
166
167 // Simplify unnecessary loops away.
168 const Loop *ICmpLoop = LI->getLoopFor(ICmp->getParent());
169 S = SE->getSCEVAtScope(S, ICmpLoop);
170 X = SE->getSCEVAtScope(X, ICmpLoop);
171
Sanjoy Das5dab2052015-07-27 21:42:49 +0000172 ICmpInst::Predicate InvariantPredicate;
173 const SCEV *InvariantLHS, *InvariantRHS;
174
Andrew Trick3ec331e2011-08-10 03:46:27 +0000175 // If the condition is always true or always false, replace it with
176 // a constant value.
Sanjoy Das5dab2052015-07-27 21:42:49 +0000177 if (SE->isKnownPredicate(Pred, S, X)) {
Andrew Trick3ec331e2011-08-10 03:46:27 +0000178 ICmp->replaceAllUsesWith(ConstantInt::getTrue(ICmp->getContext()));
Sanjoy Das5dab2052015-07-27 21:42:49 +0000179 DeadInsts.emplace_back(ICmp);
Sanjoy Dasc18115d2015-08-06 20:43:28 +0000180 DEBUG(dbgs() << "INDVARS: Eliminated comparison: " << *ICmp << '\n');
Sanjoy Das5dab2052015-07-27 21:42:49 +0000181 } else if (SE->isKnownPredicate(ICmpInst::getInversePredicate(Pred), S, X)) {
Andrew Trick3ec331e2011-08-10 03:46:27 +0000182 ICmp->replaceAllUsesWith(ConstantInt::getFalse(ICmp->getContext()));
Sanjoy Das5dab2052015-07-27 21:42:49 +0000183 DeadInsts.emplace_back(ICmp);
Sanjoy Dasc18115d2015-08-06 20:43:28 +0000184 DEBUG(dbgs() << "INDVARS: Eliminated comparison: " << *ICmp << '\n');
Sanjoy Das5dab2052015-07-27 21:42:49 +0000185 } else if (isa<PHINode>(IVOperand) &&
186 SE->isLoopInvariantPredicate(Pred, S, X, ICmpLoop,
187 InvariantPredicate, InvariantLHS,
188 InvariantRHS)) {
189
Benjamin Kramerdf005cb2015-08-08 18:27:36 +0000190 // Rewrite the comparison to a loop invariant comparison if it can be done
Sanjoy Das5dab2052015-07-27 21:42:49 +0000191 // cheaply, where cheaply means "we don't need to emit any new
192 // instructions".
193
194 Value *NewLHS = nullptr, *NewRHS = nullptr;
195
196 if (S == InvariantLHS || X == InvariantLHS)
197 NewLHS =
198 ICmp->getOperand(S == InvariantLHS ? IVOperIdx : (1 - IVOperIdx));
199
200 if (S == InvariantRHS || X == InvariantRHS)
201 NewRHS =
202 ICmp->getOperand(S == InvariantRHS ? IVOperIdx : (1 - IVOperIdx));
203
204 for (Value *Incoming : cast<PHINode>(IVOperand)->incoming_values()) {
205 if (NewLHS && NewRHS)
206 break;
207
208 const SCEV *IncomingS = SE->getSCEV(Incoming);
209
210 if (!NewLHS && IncomingS == InvariantLHS)
211 NewLHS = Incoming;
212 if (!NewRHS && IncomingS == InvariantRHS)
213 NewRHS = Incoming;
214 }
215
216 if (!NewLHS || !NewRHS)
217 // We could not find an existing value to replace either LHS or RHS.
218 // Generating new instructions has subtler tradeoffs, so avoid doing that
219 // for now.
220 return;
221
Sanjoy Dasc18115d2015-08-06 20:43:28 +0000222 DEBUG(dbgs() << "INDVARS: Simplified comparison: " << *ICmp << '\n');
Sanjoy Das5dab2052015-07-27 21:42:49 +0000223 ICmp->setPredicate(InvariantPredicate);
224 ICmp->setOperand(0, NewLHS);
225 ICmp->setOperand(1, NewRHS);
226 } else
Andrew Trick3ec331e2011-08-10 03:46:27 +0000227 return;
228
Andrew Trick3ec331e2011-08-10 03:46:27 +0000229 ++NumElimCmp;
230 Changed = true;
Andrew Trick3ec331e2011-08-10 03:46:27 +0000231}
232
Sanjay Patel7777b502014-11-12 18:07:42 +0000233/// SimplifyIVUsers helper for eliminating useless
Andrew Trick3ec331e2011-08-10 03:46:27 +0000234/// remainder operations operating on an induction variable.
235void SimplifyIndvar::eliminateIVRemainder(BinaryOperator *Rem,
236 Value *IVOperand,
237 bool IsSigned) {
238 // We're only interested in the case where we know something about
239 // the numerator.
240 if (IVOperand != Rem->getOperand(0))
241 return;
242
243 // Get the SCEVs for the ICmp operands.
244 const SCEV *S = SE->getSCEV(Rem->getOperand(0));
245 const SCEV *X = SE->getSCEV(Rem->getOperand(1));
246
247 // Simplify unnecessary loops away.
248 const Loop *ICmpLoop = LI->getLoopFor(Rem->getParent());
249 S = SE->getSCEVAtScope(S, ICmpLoop);
250 X = SE->getSCEVAtScope(X, ICmpLoop);
251
252 // i % n --> i if i is in [0,n).
253 if ((!IsSigned || SE->isKnownNonNegative(S)) &&
254 SE->isKnownPredicate(IsSigned ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT,
255 S, X))
256 Rem->replaceAllUsesWith(Rem->getOperand(0));
257 else {
258 // (i+1) % n --> (i+1)==n?0:(i+1) if i is in [0,n).
Sanjoy Das2aacc0e2015-09-23 01:59:04 +0000259 const SCEV *LessOne = SE->getMinusSCEV(S, SE->getOne(S->getType()));
Andrew Trick3ec331e2011-08-10 03:46:27 +0000260 if (IsSigned && !SE->isKnownNonNegative(LessOne))
261 return;
262
263 if (!SE->isKnownPredicate(IsSigned ?
264 ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT,
265 LessOne, X))
266 return;
267
268 ICmpInst *ICmp = new ICmpInst(Rem, ICmpInst::ICMP_EQ,
Benjamin Kramer547b6c52011-09-27 20:39:19 +0000269 Rem->getOperand(0), Rem->getOperand(1));
Andrew Trick3ec331e2011-08-10 03:46:27 +0000270 SelectInst *Sel =
271 SelectInst::Create(ICmp,
272 ConstantInt::get(Rem->getType(), 0),
273 Rem->getOperand(0), "tmp", Rem);
274 Rem->replaceAllUsesWith(Sel);
275 }
276
Andrew Trick3ec331e2011-08-10 03:46:27 +0000277 DEBUG(dbgs() << "INDVARS: Simplified rem: " << *Rem << '\n');
278 ++NumElimRem;
279 Changed = true;
Benjamin Kramerf5e2fc42015-05-29 19:43:39 +0000280 DeadInsts.emplace_back(Rem);
Andrew Trick3ec331e2011-08-10 03:46:27 +0000281}
282
Sanjoy Das088bb0e2015-10-06 21:44:39 +0000283/// Eliminate an operation that consumes a simple IV and has no observable
284/// side-effect given the range of IV values. IVOperand is guaranteed SCEVable,
285/// but UseInst may not be.
Andrew Trick3ec331e2011-08-10 03:46:27 +0000286bool SimplifyIndvar::eliminateIVUser(Instruction *UseInst,
287 Instruction *IVOperand) {
288 if (ICmpInst *ICmp = dyn_cast<ICmpInst>(UseInst)) {
289 eliminateIVComparison(ICmp, IVOperand);
290 return true;
291 }
292 if (BinaryOperator *Rem = dyn_cast<BinaryOperator>(UseInst)) {
293 bool IsSigned = Rem->getOpcode() == Instruction::SRem;
294 if (IsSigned || Rem->getOpcode() == Instruction::URem) {
295 eliminateIVRemainder(Rem, IVOperand, IsSigned);
296 return true;
297 }
298 }
299
Sanjoy Das088bb0e2015-10-06 21:44:39 +0000300 if (eliminateIdentitySCEV(UseInst, IVOperand))
301 return true;
302
303 return false;
304}
305
306/// Eliminate any operation that SCEV can prove is an identity function.
307bool SimplifyIndvar::eliminateIdentitySCEV(Instruction *UseInst,
308 Instruction *IVOperand) {
Andrew Trick3ec331e2011-08-10 03:46:27 +0000309 if (!SE->isSCEVable(UseInst->getType()) ||
310 (UseInst->getType() != IVOperand->getType()) ||
311 (SE->getSCEV(UseInst) != SE->getSCEV(IVOperand)))
312 return false;
313
Sanjoy Das5c8bead2015-10-06 21:44:49 +0000314 // getSCEV(X) == getSCEV(Y) does not guarantee that X and Y are related in the
315 // dominator tree, even if X is an operand to Y. For instance, in
316 //
317 // %iv = phi i32 {0,+,1}
318 // br %cond, label %left, label %merge
319 //
320 // left:
321 // %X = add i32 %iv, 0
322 // br label %merge
323 //
324 // merge:
325 // %M = phi (%X, %iv)
326 //
327 // getSCEV(%M) == getSCEV(%X) == {0,+,1}, but %X does not dominate %M, and
328 // %M.replaceAllUsesWith(%X) would be incorrect.
329
330 if (isa<PHINode>(UseInst))
331 // If UseInst is not a PHI node then we know that IVOperand dominates
332 // UseInst directly from the legality of SSA.
333 if (!DT || !DT->dominates(IVOperand, UseInst))
334 return false;
335
Andrew Trick3ec331e2011-08-10 03:46:27 +0000336 DEBUG(dbgs() << "INDVARS: Eliminated identity: " << *UseInst << '\n');
337
338 UseInst->replaceAllUsesWith(IVOperand);
339 ++NumElimIdentity;
340 Changed = true;
Benjamin Kramerf5e2fc42015-05-29 19:43:39 +0000341 DeadInsts.emplace_back(UseInst);
Andrew Trick3ec331e2011-08-10 03:46:27 +0000342 return true;
343}
344
Sanjoy Das7c0ce262015-01-06 19:02:56 +0000345/// Annotate BO with nsw / nuw if it provably does not signed-overflow /
346/// unsigned-overflow. Returns true if anything changed, false otherwise.
347bool SimplifyIndvar::strengthenOverflowingOperation(BinaryOperator *BO,
348 Value *IVOperand) {
349
Sanjoy Dasa5397c02015-03-04 22:24:23 +0000350 // Fastpath: we don't have any work to do if `BO` is `nuw` and `nsw`.
Sanjoy Das7c0ce262015-01-06 19:02:56 +0000351 if (BO->hasNoUnsignedWrap() && BO->hasNoSignedWrap())
352 return false;
353
Sanjoy Dasa5397c02015-03-04 22:24:23 +0000354 const SCEV *(ScalarEvolution::*GetExprForBO)(const SCEV *, const SCEV *,
355 SCEV::NoWrapFlags);
Sanjoy Das7c0ce262015-01-06 19:02:56 +0000356
Sanjoy Dasa5397c02015-03-04 22:24:23 +0000357 switch (BO->getOpcode()) {
358 default:
Sanjoy Das7c0ce262015-01-06 19:02:56 +0000359 return false;
360
Sanjoy Dasa5397c02015-03-04 22:24:23 +0000361 case Instruction::Add:
362 GetExprForBO = &ScalarEvolution::getAddExpr;
363 break;
Sanjoy Das7c0ce262015-01-06 19:02:56 +0000364
Sanjoy Dasa5397c02015-03-04 22:24:23 +0000365 case Instruction::Sub:
366 GetExprForBO = &ScalarEvolution::getMinusSCEV;
367 break;
Sanjoy Das7c0ce262015-01-06 19:02:56 +0000368
Sanjoy Dasa5397c02015-03-04 22:24:23 +0000369 case Instruction::Mul:
370 GetExprForBO = &ScalarEvolution::getMulExpr;
371 break;
372 }
Sanjoy Das7c0ce262015-01-06 19:02:56 +0000373
Sanjoy Dasa5397c02015-03-04 22:24:23 +0000374 unsigned BitWidth = cast<IntegerType>(BO->getType())->getBitWidth();
375 Type *WideTy = IntegerType::get(BO->getContext(), BitWidth * 2);
376 const SCEV *LHS = SE->getSCEV(BO->getOperand(0));
377 const SCEV *RHS = SE->getSCEV(BO->getOperand(1));
Sanjoy Das7c0ce262015-01-06 19:02:56 +0000378
Sanjoy Dasa5397c02015-03-04 22:24:23 +0000379 bool Changed = false;
Sanjoy Das7c0ce262015-01-06 19:02:56 +0000380
Sanjoy Dasa5397c02015-03-04 22:24:23 +0000381 if (!BO->hasNoUnsignedWrap()) {
382 const SCEV *ExtendAfterOp = SE->getZeroExtendExpr(SE->getSCEV(BO), WideTy);
383 const SCEV *OpAfterExtend = (SE->*GetExprForBO)(
384 SE->getZeroExtendExpr(LHS, WideTy), SE->getZeroExtendExpr(RHS, WideTy),
385 SCEV::FlagAnyWrap);
386 if (ExtendAfterOp == OpAfterExtend) {
387 BO->setHasNoUnsignedWrap();
388 SE->forgetValue(BO);
389 Changed = true;
Sanjoy Das7c0ce262015-01-06 19:02:56 +0000390 }
391 }
392
Sanjoy Dasa5397c02015-03-04 22:24:23 +0000393 if (!BO->hasNoSignedWrap()) {
394 const SCEV *ExtendAfterOp = SE->getSignExtendExpr(SE->getSCEV(BO), WideTy);
395 const SCEV *OpAfterExtend = (SE->*GetExprForBO)(
396 SE->getSignExtendExpr(LHS, WideTy), SE->getSignExtendExpr(RHS, WideTy),
397 SCEV::FlagAnyWrap);
398 if (ExtendAfterOp == OpAfterExtend) {
399 BO->setHasNoSignedWrap();
400 SE->forgetValue(BO);
Sanjoy Das7c0ce262015-01-06 19:02:56 +0000401 Changed = true;
402 }
403 }
404
405 return Changed;
406}
407
Andrew Trick0ba77a02013-12-23 23:31:49 +0000408/// \brief Split sadd.with.overflow into add + sadd.with.overflow to allow
409/// analysis and optimization.
410///
411/// \return A new value representing the non-overflowing add if possible,
412/// otherwise return the original value.
413Instruction *SimplifyIndvar::splitOverflowIntrinsic(Instruction *IVUser,
414 const DominatorTree *DT) {
415 IntrinsicInst *II = dyn_cast<IntrinsicInst>(IVUser);
416 if (!II || II->getIntrinsicID() != Intrinsic::sadd_with_overflow)
417 return IVUser;
418
419 // Find a branch guarded by the overflow check.
Craig Topperf40110f2014-04-25 05:29:35 +0000420 BranchInst *Branch = nullptr;
421 Instruction *AddVal = nullptr;
Chandler Carruthcdf47882014-03-09 03:16:01 +0000422 for (User *U : II->users()) {
423 if (ExtractValueInst *ExtractInst = dyn_cast<ExtractValueInst>(U)) {
Andrew Trick0ba77a02013-12-23 23:31:49 +0000424 if (ExtractInst->getNumIndices() != 1)
425 continue;
426 if (ExtractInst->getIndices()[0] == 0)
427 AddVal = ExtractInst;
428 else if (ExtractInst->getIndices()[0] == 1 && ExtractInst->hasOneUse())
Chandler Carruthcdf47882014-03-09 03:16:01 +0000429 Branch = dyn_cast<BranchInst>(ExtractInst->user_back());
Andrew Trick0ba77a02013-12-23 23:31:49 +0000430 }
431 }
432 if (!AddVal || !Branch)
433 return IVUser;
434
435 BasicBlock *ContinueBB = Branch->getSuccessor(1);
Benjamin Kramerb6d0bd42014-03-02 12:27:27 +0000436 if (std::next(pred_begin(ContinueBB)) != pred_end(ContinueBB))
Andrew Trick0ba77a02013-12-23 23:31:49 +0000437 return IVUser;
438
439 // Check if all users of the add are provably NSW.
440 bool AllNSW = true;
Chandler Carruthcdf47882014-03-09 03:16:01 +0000441 for (Use &U : AddVal->uses()) {
442 if (Instruction *UseInst = dyn_cast<Instruction>(U.getUser())) {
Andrew Trick0ba77a02013-12-23 23:31:49 +0000443 BasicBlock *UseBB = UseInst->getParent();
444 if (PHINode *PHI = dyn_cast<PHINode>(UseInst))
Chandler Carruthcdf47882014-03-09 03:16:01 +0000445 UseBB = PHI->getIncomingBlock(U);
Andrew Trick0ba77a02013-12-23 23:31:49 +0000446 if (!DT->dominates(ContinueBB, UseBB)) {
447 AllNSW = false;
448 break;
449 }
450 }
451 }
452 if (!AllNSW)
453 return IVUser;
454
455 // Go for it...
456 IRBuilder<> Builder(IVUser);
457 Instruction *AddInst = dyn_cast<Instruction>(
458 Builder.CreateNSWAdd(II->getOperand(0), II->getOperand(1)));
459
460 // The caller expects the new add to have the same form as the intrinsic. The
461 // IV operand position must be the same.
462 assert((AddInst->getOpcode() == Instruction::Add &&
463 AddInst->getOperand(0) == II->getOperand(0)) &&
464 "Bad add instruction created from overflow intrinsic.");
465
466 AddVal->replaceAllUsesWith(AddInst);
Benjamin Kramerf5e2fc42015-05-29 19:43:39 +0000467 DeadInsts.emplace_back(AddVal);
Andrew Trick0ba77a02013-12-23 23:31:49 +0000468 return AddInst;
469}
470
Sanjay Patel7777b502014-11-12 18:07:42 +0000471/// Add all uses of Def to the current IV's worklist.
Andrew Trick3ec331e2011-08-10 03:46:27 +0000472static void pushIVUsers(
473 Instruction *Def,
474 SmallPtrSet<Instruction*,16> &Simplified,
475 SmallVectorImpl< std::pair<Instruction*,Instruction*> > &SimpleIVUsers) {
476
Chandler Carruthcdf47882014-03-09 03:16:01 +0000477 for (User *U : Def->users()) {
478 Instruction *UI = cast<Instruction>(U);
Andrew Trick3ec331e2011-08-10 03:46:27 +0000479
480 // Avoid infinite or exponential worklist processing.
481 // Also ensure unique worklist users.
482 // If Def is a LoopPhi, it may not be in the Simplified set, so check for
483 // self edges first.
David Blaikie70573dc2014-11-19 07:49:26 +0000484 if (UI != Def && Simplified.insert(UI).second)
Chandler Carruthcdf47882014-03-09 03:16:01 +0000485 SimpleIVUsers.push_back(std::make_pair(UI, Def));
Andrew Trick3ec331e2011-08-10 03:46:27 +0000486 }
487}
488
Sanjay Patel7777b502014-11-12 18:07:42 +0000489/// Return true if this instruction generates a simple SCEV
Andrew Trick3ec331e2011-08-10 03:46:27 +0000490/// expression in terms of that IV.
491///
Andrew Trick6dbb0602011-08-10 18:07:05 +0000492/// This is similar to IVUsers' isInteresting() but processes each instruction
Andrew Trick3ec331e2011-08-10 03:46:27 +0000493/// non-recursively when the operand is already known to be a simpleIVUser.
494///
495static bool isSimpleIVUser(Instruction *I, const Loop *L, ScalarEvolution *SE) {
496 if (!SE->isSCEVable(I->getType()))
497 return false;
498
499 // Get the symbolic expression for this instruction.
500 const SCEV *S = SE->getSCEV(I);
501
502 // Only consider affine recurrences.
503 const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S);
504 if (AR && AR->getLoop() == L)
505 return true;
506
507 return false;
508}
509
Sanjay Patel7777b502014-11-12 18:07:42 +0000510/// Iteratively perform simplification on a worklist of users
Andrew Trick3ec331e2011-08-10 03:46:27 +0000511/// of the specified induction variable. Each successive simplification may push
512/// more users which may themselves be candidates for simplification.
513///
514/// This algorithm does not require IVUsers analysis. Instead, it simplifies
515/// instructions in-place during analysis. Rather than rewriting induction
516/// variables bottom-up from their users, it transforms a chain of IVUsers
Benjamin Kramerdf005cb2015-08-08 18:27:36 +0000517/// top-down, updating the IR only when it encounters a clear optimization
518/// opportunity.
Andrew Trick3ec331e2011-08-10 03:46:27 +0000519///
520/// Once DisableIVRewrite is default, LSR will be the only client of IVUsers.
521///
522void SimplifyIndvar::simplifyUsers(PHINode *CurrIV, IVVisitor *V) {
Andrew Trick7251e412011-09-19 17:54:39 +0000523 if (!SE->isSCEVable(CurrIV->getType()))
524 return;
525
Andrew Trick3ec331e2011-08-10 03:46:27 +0000526 // Instructions processed by SimplifyIndvar for CurrIV.
527 SmallPtrSet<Instruction*,16> Simplified;
528
529 // Use-def pairs if IV users waiting to be processed for CurrIV.
530 SmallVector<std::pair<Instruction*, Instruction*>, 8> SimpleIVUsers;
531
532 // Push users of the current LoopPhi. In rare cases, pushIVUsers may be
533 // called multiple times for the same LoopPhi. This is the proper thing to
534 // do for loop header phis that use each other.
535 pushIVUsers(CurrIV, Simplified, SimpleIVUsers);
536
537 while (!SimpleIVUsers.empty()) {
538 std::pair<Instruction*, Instruction*> UseOper =
539 SimpleIVUsers.pop_back_val();
Andrew Trick0ba77a02013-12-23 23:31:49 +0000540 Instruction *UseInst = UseOper.first;
541
Andrew Trick3ec331e2011-08-10 03:46:27 +0000542 // Bypass back edges to avoid extra work.
Andrew Trick0ba77a02013-12-23 23:31:49 +0000543 if (UseInst == CurrIV) continue;
544
545 if (V && V->shouldSplitOverflowInstrinsics()) {
546 UseInst = splitOverflowIntrinsic(UseInst, V->getDomTree());
547 if (!UseInst)
548 continue;
549 }
Andrew Trick3ec331e2011-08-10 03:46:27 +0000550
Andrew Trick74664d52011-08-10 04:01:31 +0000551 Instruction *IVOperand = UseOper.second;
552 for (unsigned N = 0; IVOperand; ++N) {
553 assert(N <= Simplified.size() && "runaway iteration");
Andrew Trick3ec331e2011-08-10 03:46:27 +0000554
Andrew Trick74664d52011-08-10 04:01:31 +0000555 Value *NewOper = foldIVUser(UseOper.first, IVOperand);
556 if (!NewOper)
557 break; // done folding
558 IVOperand = dyn_cast<Instruction>(NewOper);
559 }
560 if (!IVOperand)
561 continue;
562
563 if (eliminateIVUser(UseOper.first, IVOperand)) {
564 pushIVUsers(IVOperand, Simplified, SimpleIVUsers);
Andrew Trick3ec331e2011-08-10 03:46:27 +0000565 continue;
566 }
Sanjoy Das7c0ce262015-01-06 19:02:56 +0000567
568 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(UseOper.first)) {
569 if (isa<OverflowingBinaryOperator>(BO) &&
570 strengthenOverflowingOperation(BO, IVOperand)) {
571 // re-queue uses of the now modified binary operator and fall
572 // through to the checks that remain.
573 pushIVUsers(IVOperand, Simplified, SimpleIVUsers);
574 }
575 }
576
Andrew Trick3ec331e2011-08-10 03:46:27 +0000577 CastInst *Cast = dyn_cast<CastInst>(UseOper.first);
578 if (V && Cast) {
579 V->visitCast(Cast);
580 continue;
581 }
582 if (isSimpleIVUser(UseOper.first, L, SE)) {
583 pushIVUsers(UseOper.first, Simplified, SimpleIVUsers);
584 }
585 }
586}
587
588namespace llvm {
589
David Blaikiea379b1812011-12-20 02:50:00 +0000590void IVVisitor::anchor() { }
591
Sanjay Patel7777b502014-11-12 18:07:42 +0000592/// Simplify instructions that use this induction variable
Andrew Trick3ec331e2011-08-10 03:46:27 +0000593/// by using ScalarEvolution to analyze the IV's recurrence.
Sanjoy Das5c8bead2015-10-06 21:44:49 +0000594bool simplifyUsersOfIV(PHINode *CurrIV, ScalarEvolution *SE, DominatorTree *DT,
595 LPPassManager *LPM, SmallVectorImpl<WeakVH> &Dead, IVVisitor *V)
Andrew Trick3ec331e2011-08-10 03:46:27 +0000596{
Chandler Carruth4f8f3072015-01-17 14:16:18 +0000597 LoopInfo *LI = &LPM->getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
Sanjoy Das5c8bead2015-10-06 21:44:49 +0000598
599 SimplifyIndvar SIV(LI->getLoopFor(CurrIV->getParent()), SE, DT, LI, Dead);
Andrew Trick3ec331e2011-08-10 03:46:27 +0000600 SIV.simplifyUsers(CurrIV, V);
601 return SIV.hasChanged();
602}
603
Sanjay Patel7777b502014-11-12 18:07:42 +0000604/// Simplify users of induction variables within this
Andrew Trick3ec331e2011-08-10 03:46:27 +0000605/// loop. This does not actually change or add IVs.
Sanjoy Das5c8bead2015-10-06 21:44:49 +0000606bool simplifyLoopIVs(Loop *L, ScalarEvolution *SE, DominatorTree *DT,
607 LPPassManager *LPM, SmallVectorImpl<WeakVH> &Dead) {
Andrew Trick3ec331e2011-08-10 03:46:27 +0000608 bool Changed = false;
609 for (BasicBlock::iterator I = L->getHeader()->begin(); isa<PHINode>(I); ++I) {
Sanjoy Das5c8bead2015-10-06 21:44:49 +0000610 Changed |= simplifyUsersOfIV(cast<PHINode>(I), SE, DT, LPM, Dead);
Andrew Trick3ec331e2011-08-10 03:46:27 +0000611 }
612 return Changed;
613}
614
Andrew Trick3ec331e2011-08-10 03:46:27 +0000615} // namespace llvm