DeadCodeElimination: rewrite to be faster
[oota-llvm.git] / lib / Transforms / Scalar / IndVarSimplify.cpp
1 //===- IndVarSimplify.cpp - Induction Variable Elimination ----------------===//
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 transformation analyzes and transforms the induction variables (and
11 // computations derived from them) into simpler forms suitable for subsequent
12 // analysis and transformation.
13 //
14 // If the trip count of a loop is computable, this pass also makes the following
15 // changes:
16 //   1. The exit condition for the loop is canonicalized to compare the
17 //      induction value against the exit value.  This turns loops like:
18 //        'for (i = 7; i*i < 1000; ++i)' into 'for (i = 0; i != 25; ++i)'
19 //   2. Any use outside of the loop of an expression derived from the indvar
20 //      is changed to compute the derived value outside of the loop, eliminating
21 //      the dependence on the exit value of the induction variable.  If the only
22 //      purpose of the loop is to compute the exit value of some derived
23 //      expression, this transformation will make the loop dead.
24 //
25 //===----------------------------------------------------------------------===//
26
27 #include "llvm/Transforms/Scalar.h"
28 #include "llvm/ADT/DenseMap.h"
29 #include "llvm/ADT/SmallVector.h"
30 #include "llvm/ADT/Statistic.h"
31 #include "llvm/Analysis/GlobalsModRef.h"
32 #include "llvm/Analysis/LoopInfo.h"
33 #include "llvm/Analysis/LoopPass.h"
34 #include "llvm/Analysis/ScalarEvolutionExpander.h"
35 #include "llvm/Analysis/ScalarEvolutionAliasAnalysis.h"
36 #include "llvm/Analysis/TargetLibraryInfo.h"
37 #include "llvm/Analysis/TargetTransformInfo.h"
38 #include "llvm/IR/BasicBlock.h"
39 #include "llvm/IR/CFG.h"
40 #include "llvm/IR/Constants.h"
41 #include "llvm/IR/DataLayout.h"
42 #include "llvm/IR/Dominators.h"
43 #include "llvm/IR/Instructions.h"
44 #include "llvm/IR/IntrinsicInst.h"
45 #include "llvm/IR/LLVMContext.h"
46 #include "llvm/IR/PatternMatch.h"
47 #include "llvm/IR/Type.h"
48 #include "llvm/Support/CommandLine.h"
49 #include "llvm/Support/Debug.h"
50 #include "llvm/Support/raw_ostream.h"
51 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
52 #include "llvm/Transforms/Utils/Local.h"
53 #include "llvm/Transforms/Utils/SimplifyIndVar.h"
54 using namespace llvm;
55
56 #define DEBUG_TYPE "indvars"
57
58 STATISTIC(NumWidened     , "Number of indvars widened");
59 STATISTIC(NumReplaced    , "Number of exit values replaced");
60 STATISTIC(NumLFTR        , "Number of loop exit tests replaced");
61 STATISTIC(NumElimExt     , "Number of IV sign/zero extends eliminated");
62 STATISTIC(NumElimIV      , "Number of congruent IVs eliminated");
63
64 // Trip count verification can be enabled by default under NDEBUG if we
65 // implement a strong expression equivalence checker in SCEV. Until then, we
66 // use the verify-indvars flag, which may assert in some cases.
67 static cl::opt<bool> VerifyIndvars(
68   "verify-indvars", cl::Hidden,
69   cl::desc("Verify the ScalarEvolution result after running indvars"));
70
71 static cl::opt<bool> ReduceLiveIVs("liv-reduce", cl::Hidden,
72   cl::desc("Reduce live induction variables."));
73
74 enum ReplaceExitVal { NeverRepl, OnlyCheapRepl, AlwaysRepl };
75
76 static cl::opt<ReplaceExitVal> ReplaceExitValue(
77     "replexitval", cl::Hidden, cl::init(OnlyCheapRepl),
78     cl::desc("Choose the strategy to replace exit value in IndVarSimplify"),
79     cl::values(clEnumValN(NeverRepl, "never", "never replace exit value"),
80                clEnumValN(OnlyCheapRepl, "cheap",
81                           "only replace exit value when the cost is cheap"),
82                clEnumValN(AlwaysRepl, "always",
83                           "always replace exit value whenever possible"),
84                clEnumValEnd));
85
86 namespace {
87 struct RewritePhi;
88 }
89
90 namespace {
91 class IndVarSimplify : public LoopPass {
92   LoopInfo                  *LI;
93   ScalarEvolution           *SE;
94   DominatorTree             *DT;
95   TargetLibraryInfo         *TLI;
96   const TargetTransformInfo *TTI;
97
98   SmallVector<WeakVH, 16> DeadInsts;
99   bool Changed;
100 public:
101
102   static char ID; // Pass identification, replacement for typeid
103   IndVarSimplify()
104     : LoopPass(ID), LI(nullptr), SE(nullptr), DT(nullptr), Changed(false) {
105     initializeIndVarSimplifyPass(*PassRegistry::getPassRegistry());
106   }
107
108   bool runOnLoop(Loop *L, LPPassManager &LPM) override;
109
110   void getAnalysisUsage(AnalysisUsage &AU) const override {
111     AU.addRequired<DominatorTreeWrapperPass>();
112     AU.addRequired<LoopInfoWrapperPass>();
113     AU.addRequired<ScalarEvolutionWrapperPass>();
114     AU.addRequiredID(LoopSimplifyID);
115     AU.addRequiredID(LCSSAID);
116     AU.addPreserved<GlobalsAAWrapperPass>();
117     AU.addPreserved<ScalarEvolutionWrapperPass>();
118     AU.addPreservedID(LoopSimplifyID);
119     AU.addPreservedID(LCSSAID);
120     AU.setPreservesCFG();
121   }
122
123 private:
124   void releaseMemory() override {
125     DeadInsts.clear();
126   }
127
128   bool isValidRewrite(Value *FromVal, Value *ToVal);
129
130   void HandleFloatingPointIV(Loop *L, PHINode *PH);
131   void RewriteNonIntegerIVs(Loop *L);
132
133   void SimplifyAndExtend(Loop *L, SCEVExpander &Rewriter, LPPassManager &LPM);
134
135   bool CanLoopBeDeleted(Loop *L, SmallVector<RewritePhi, 8> &RewritePhiSet);
136   void RewriteLoopExitValues(Loop *L, SCEVExpander &Rewriter);
137
138   Value *LinearFunctionTestReplace(Loop *L, const SCEV *BackedgeTakenCount,
139                                    PHINode *IndVar, SCEVExpander &Rewriter);
140
141   void SinkUnusedInvariants(Loop *L);
142
143   Value *ExpandSCEVIfNeeded(SCEVExpander &Rewriter, const SCEV *S, Loop *L,
144                             Instruction *InsertPt, Type *Ty);
145 };
146 }
147
148 char IndVarSimplify::ID = 0;
149 INITIALIZE_PASS_BEGIN(IndVarSimplify, "indvars",
150                 "Induction Variable Simplification", false, false)
151 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
152 INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass)
153 INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass)
154 INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
155 INITIALIZE_PASS_DEPENDENCY(LCSSA)
156 INITIALIZE_PASS_END(IndVarSimplify, "indvars",
157                 "Induction Variable Simplification", false, false)
158
159 Pass *llvm::createIndVarSimplifyPass() {
160   return new IndVarSimplify();
161 }
162
163 /// Return true if the SCEV expansion generated by the rewriter can replace the
164 /// original value. SCEV guarantees that it produces the same value, but the way
165 /// it is produced may be illegal IR.  Ideally, this function will only be
166 /// called for verification.
167 bool IndVarSimplify::isValidRewrite(Value *FromVal, Value *ToVal) {
168   // If an SCEV expression subsumed multiple pointers, its expansion could
169   // reassociate the GEP changing the base pointer. This is illegal because the
170   // final address produced by a GEP chain must be inbounds relative to its
171   // underlying object. Otherwise basic alias analysis, among other things,
172   // could fail in a dangerous way. Ultimately, SCEV will be improved to avoid
173   // producing an expression involving multiple pointers. Until then, we must
174   // bail out here.
175   //
176   // Retrieve the pointer operand of the GEP. Don't use GetUnderlyingObject
177   // because it understands lcssa phis while SCEV does not.
178   Value *FromPtr = FromVal;
179   Value *ToPtr = ToVal;
180   if (GEPOperator *GEP = dyn_cast<GEPOperator>(FromVal)) {
181     FromPtr = GEP->getPointerOperand();
182   }
183   if (GEPOperator *GEP = dyn_cast<GEPOperator>(ToVal)) {
184     ToPtr = GEP->getPointerOperand();
185   }
186   if (FromPtr != FromVal || ToPtr != ToVal) {
187     // Quickly check the common case
188     if (FromPtr == ToPtr)
189       return true;
190
191     // SCEV may have rewritten an expression that produces the GEP's pointer
192     // operand. That's ok as long as the pointer operand has the same base
193     // pointer. Unlike GetUnderlyingObject(), getPointerBase() will find the
194     // base of a recurrence. This handles the case in which SCEV expansion
195     // converts a pointer type recurrence into a nonrecurrent pointer base
196     // indexed by an integer recurrence.
197
198     // If the GEP base pointer is a vector of pointers, abort.
199     if (!FromPtr->getType()->isPointerTy() || !ToPtr->getType()->isPointerTy())
200       return false;
201
202     const SCEV *FromBase = SE->getPointerBase(SE->getSCEV(FromPtr));
203     const SCEV *ToBase = SE->getPointerBase(SE->getSCEV(ToPtr));
204     if (FromBase == ToBase)
205       return true;
206
207     DEBUG(dbgs() << "INDVARS: GEP rewrite bail out "
208           << *FromBase << " != " << *ToBase << "\n");
209
210     return false;
211   }
212   return true;
213 }
214
215 /// Determine the insertion point for this user. By default, insert immediately
216 /// before the user. SCEVExpander or LICM will hoist loop invariants out of the
217 /// loop. For PHI nodes, there may be multiple uses, so compute the nearest
218 /// common dominator for the incoming blocks.
219 static Instruction *getInsertPointForUses(Instruction *User, Value *Def,
220                                           DominatorTree *DT) {
221   PHINode *PHI = dyn_cast<PHINode>(User);
222   if (!PHI)
223     return User;
224
225   Instruction *InsertPt = nullptr;
226   for (unsigned i = 0, e = PHI->getNumIncomingValues(); i != e; ++i) {
227     if (PHI->getIncomingValue(i) != Def)
228       continue;
229
230     BasicBlock *InsertBB = PHI->getIncomingBlock(i);
231     if (!InsertPt) {
232       InsertPt = InsertBB->getTerminator();
233       continue;
234     }
235     InsertBB = DT->findNearestCommonDominator(InsertPt->getParent(), InsertBB);
236     InsertPt = InsertBB->getTerminator();
237   }
238   assert(InsertPt && "Missing phi operand");
239   assert((!isa<Instruction>(Def) ||
240           DT->dominates(cast<Instruction>(Def), InsertPt)) &&
241          "def does not dominate all uses");
242   return InsertPt;
243 }
244
245 //===----------------------------------------------------------------------===//
246 // RewriteNonIntegerIVs and helpers. Prefer integer IVs.
247 //===----------------------------------------------------------------------===//
248
249 /// Convert APF to an integer, if possible.
250 static bool ConvertToSInt(const APFloat &APF, int64_t &IntVal) {
251   bool isExact = false;
252   // See if we can convert this to an int64_t
253   uint64_t UIntVal;
254   if (APF.convertToInteger(&UIntVal, 64, true, APFloat::rmTowardZero,
255                            &isExact) != APFloat::opOK || !isExact)
256     return false;
257   IntVal = UIntVal;
258   return true;
259 }
260
261 /// If the loop has floating induction variable then insert corresponding
262 /// integer induction variable if possible.
263 /// For example,
264 /// for(double i = 0; i < 10000; ++i)
265 ///   bar(i)
266 /// is converted into
267 /// for(int i = 0; i < 10000; ++i)
268 ///   bar((double)i);
269 ///
270 void IndVarSimplify::HandleFloatingPointIV(Loop *L, PHINode *PN) {
271   unsigned IncomingEdge = L->contains(PN->getIncomingBlock(0));
272   unsigned BackEdge     = IncomingEdge^1;
273
274   // Check incoming value.
275   ConstantFP *InitValueVal =
276     dyn_cast<ConstantFP>(PN->getIncomingValue(IncomingEdge));
277
278   int64_t InitValue;
279   if (!InitValueVal || !ConvertToSInt(InitValueVal->getValueAPF(), InitValue))
280     return;
281
282   // Check IV increment. Reject this PN if increment operation is not
283   // an add or increment value can not be represented by an integer.
284   BinaryOperator *Incr =
285     dyn_cast<BinaryOperator>(PN->getIncomingValue(BackEdge));
286   if (Incr == nullptr || Incr->getOpcode() != Instruction::FAdd) return;
287
288   // If this is not an add of the PHI with a constantfp, or if the constant fp
289   // is not an integer, bail out.
290   ConstantFP *IncValueVal = dyn_cast<ConstantFP>(Incr->getOperand(1));
291   int64_t IncValue;
292   if (IncValueVal == nullptr || Incr->getOperand(0) != PN ||
293       !ConvertToSInt(IncValueVal->getValueAPF(), IncValue))
294     return;
295
296   // Check Incr uses. One user is PN and the other user is an exit condition
297   // used by the conditional terminator.
298   Value::user_iterator IncrUse = Incr->user_begin();
299   Instruction *U1 = cast<Instruction>(*IncrUse++);
300   if (IncrUse == Incr->user_end()) return;
301   Instruction *U2 = cast<Instruction>(*IncrUse++);
302   if (IncrUse != Incr->user_end()) return;
303
304   // Find exit condition, which is an fcmp.  If it doesn't exist, or if it isn't
305   // only used by a branch, we can't transform it.
306   FCmpInst *Compare = dyn_cast<FCmpInst>(U1);
307   if (!Compare)
308     Compare = dyn_cast<FCmpInst>(U2);
309   if (!Compare || !Compare->hasOneUse() ||
310       !isa<BranchInst>(Compare->user_back()))
311     return;
312
313   BranchInst *TheBr = cast<BranchInst>(Compare->user_back());
314
315   // We need to verify that the branch actually controls the iteration count
316   // of the loop.  If not, the new IV can overflow and no one will notice.
317   // The branch block must be in the loop and one of the successors must be out
318   // of the loop.
319   assert(TheBr->isConditional() && "Can't use fcmp if not conditional");
320   if (!L->contains(TheBr->getParent()) ||
321       (L->contains(TheBr->getSuccessor(0)) &&
322        L->contains(TheBr->getSuccessor(1))))
323     return;
324
325
326   // If it isn't a comparison with an integer-as-fp (the exit value), we can't
327   // transform it.
328   ConstantFP *ExitValueVal = dyn_cast<ConstantFP>(Compare->getOperand(1));
329   int64_t ExitValue;
330   if (ExitValueVal == nullptr ||
331       !ConvertToSInt(ExitValueVal->getValueAPF(), ExitValue))
332     return;
333
334   // Find new predicate for integer comparison.
335   CmpInst::Predicate NewPred = CmpInst::BAD_ICMP_PREDICATE;
336   switch (Compare->getPredicate()) {
337   default: return;  // Unknown comparison.
338   case CmpInst::FCMP_OEQ:
339   case CmpInst::FCMP_UEQ: NewPred = CmpInst::ICMP_EQ; break;
340   case CmpInst::FCMP_ONE:
341   case CmpInst::FCMP_UNE: NewPred = CmpInst::ICMP_NE; break;
342   case CmpInst::FCMP_OGT:
343   case CmpInst::FCMP_UGT: NewPred = CmpInst::ICMP_SGT; break;
344   case CmpInst::FCMP_OGE:
345   case CmpInst::FCMP_UGE: NewPred = CmpInst::ICMP_SGE; break;
346   case CmpInst::FCMP_OLT:
347   case CmpInst::FCMP_ULT: NewPred = CmpInst::ICMP_SLT; break;
348   case CmpInst::FCMP_OLE:
349   case CmpInst::FCMP_ULE: NewPred = CmpInst::ICMP_SLE; break;
350   }
351
352   // We convert the floating point induction variable to a signed i32 value if
353   // we can.  This is only safe if the comparison will not overflow in a way
354   // that won't be trapped by the integer equivalent operations.  Check for this
355   // now.
356   // TODO: We could use i64 if it is native and the range requires it.
357
358   // The start/stride/exit values must all fit in signed i32.
359   if (!isInt<32>(InitValue) || !isInt<32>(IncValue) || !isInt<32>(ExitValue))
360     return;
361
362   // If not actually striding (add x, 0.0), avoid touching the code.
363   if (IncValue == 0)
364     return;
365
366   // Positive and negative strides have different safety conditions.
367   if (IncValue > 0) {
368     // If we have a positive stride, we require the init to be less than the
369     // exit value.
370     if (InitValue >= ExitValue)
371       return;
372
373     uint32_t Range = uint32_t(ExitValue-InitValue);
374     // Check for infinite loop, either:
375     // while (i <= Exit) or until (i > Exit)
376     if (NewPred == CmpInst::ICMP_SLE || NewPred == CmpInst::ICMP_SGT) {
377       if (++Range == 0) return;  // Range overflows.
378     }
379
380     unsigned Leftover = Range % uint32_t(IncValue);
381
382     // If this is an equality comparison, we require that the strided value
383     // exactly land on the exit value, otherwise the IV condition will wrap
384     // around and do things the fp IV wouldn't.
385     if ((NewPred == CmpInst::ICMP_EQ || NewPred == CmpInst::ICMP_NE) &&
386         Leftover != 0)
387       return;
388
389     // If the stride would wrap around the i32 before exiting, we can't
390     // transform the IV.
391     if (Leftover != 0 && int32_t(ExitValue+IncValue) < ExitValue)
392       return;
393
394   } else {
395     // If we have a negative stride, we require the init to be greater than the
396     // exit value.
397     if (InitValue <= ExitValue)
398       return;
399
400     uint32_t Range = uint32_t(InitValue-ExitValue);
401     // Check for infinite loop, either:
402     // while (i >= Exit) or until (i < Exit)
403     if (NewPred == CmpInst::ICMP_SGE || NewPred == CmpInst::ICMP_SLT) {
404       if (++Range == 0) return;  // Range overflows.
405     }
406
407     unsigned Leftover = Range % uint32_t(-IncValue);
408
409     // If this is an equality comparison, we require that the strided value
410     // exactly land on the exit value, otherwise the IV condition will wrap
411     // around and do things the fp IV wouldn't.
412     if ((NewPred == CmpInst::ICMP_EQ || NewPred == CmpInst::ICMP_NE) &&
413         Leftover != 0)
414       return;
415
416     // If the stride would wrap around the i32 before exiting, we can't
417     // transform the IV.
418     if (Leftover != 0 && int32_t(ExitValue+IncValue) > ExitValue)
419       return;
420   }
421
422   IntegerType *Int32Ty = Type::getInt32Ty(PN->getContext());
423
424   // Insert new integer induction variable.
425   PHINode *NewPHI = PHINode::Create(Int32Ty, 2, PN->getName()+".int", PN);
426   NewPHI->addIncoming(ConstantInt::get(Int32Ty, InitValue),
427                       PN->getIncomingBlock(IncomingEdge));
428
429   Value *NewAdd =
430     BinaryOperator::CreateAdd(NewPHI, ConstantInt::get(Int32Ty, IncValue),
431                               Incr->getName()+".int", Incr);
432   NewPHI->addIncoming(NewAdd, PN->getIncomingBlock(BackEdge));
433
434   ICmpInst *NewCompare = new ICmpInst(TheBr, NewPred, NewAdd,
435                                       ConstantInt::get(Int32Ty, ExitValue),
436                                       Compare->getName());
437
438   // In the following deletions, PN may become dead and may be deleted.
439   // Use a WeakVH to observe whether this happens.
440   WeakVH WeakPH = PN;
441
442   // Delete the old floating point exit comparison.  The branch starts using the
443   // new comparison.
444   NewCompare->takeName(Compare);
445   Compare->replaceAllUsesWith(NewCompare);
446   RecursivelyDeleteTriviallyDeadInstructions(Compare, TLI);
447
448   // Delete the old floating point increment.
449   Incr->replaceAllUsesWith(UndefValue::get(Incr->getType()));
450   RecursivelyDeleteTriviallyDeadInstructions(Incr, TLI);
451
452   // If the FP induction variable still has uses, this is because something else
453   // in the loop uses its value.  In order to canonicalize the induction
454   // variable, we chose to eliminate the IV and rewrite it in terms of an
455   // int->fp cast.
456   //
457   // We give preference to sitofp over uitofp because it is faster on most
458   // platforms.
459   if (WeakPH) {
460     Value *Conv = new SIToFPInst(NewPHI, PN->getType(), "indvar.conv",
461                                  PN->getParent()->getFirstInsertionPt());
462     PN->replaceAllUsesWith(Conv);
463     RecursivelyDeleteTriviallyDeadInstructions(PN, TLI);
464   }
465   Changed = true;
466 }
467
468 void IndVarSimplify::RewriteNonIntegerIVs(Loop *L) {
469   // First step.  Check to see if there are any floating-point recurrences.
470   // If there are, change them into integer recurrences, permitting analysis by
471   // the SCEV routines.
472   //
473   BasicBlock *Header = L->getHeader();
474
475   SmallVector<WeakVH, 8> PHIs;
476   for (BasicBlock::iterator I = Header->begin();
477        PHINode *PN = dyn_cast<PHINode>(I); ++I)
478     PHIs.push_back(PN);
479
480   for (unsigned i = 0, e = PHIs.size(); i != e; ++i)
481     if (PHINode *PN = dyn_cast_or_null<PHINode>(&*PHIs[i]))
482       HandleFloatingPointIV(L, PN);
483
484   // If the loop previously had floating-point IV, ScalarEvolution
485   // may not have been able to compute a trip count. Now that we've done some
486   // re-writing, the trip count may be computable.
487   if (Changed)
488     SE->forgetLoop(L);
489 }
490
491 namespace {
492 // Collect information about PHI nodes which can be transformed in
493 // RewriteLoopExitValues.
494 struct RewritePhi {
495   PHINode *PN;
496   unsigned Ith;  // Ith incoming value.
497   Value *Val;    // Exit value after expansion.
498   bool HighCost; // High Cost when expansion.
499   bool SafePhi;  // LCSSASafePhiForRAUW.
500
501   RewritePhi(PHINode *P, unsigned I, Value *V, bool H, bool S)
502       : PN(P), Ith(I), Val(V), HighCost(H), SafePhi(S) {}
503 };
504 }
505
506 Value *IndVarSimplify::ExpandSCEVIfNeeded(SCEVExpander &Rewriter, const SCEV *S,
507                                           Loop *L, Instruction *InsertPt,
508                                           Type *ResultTy) {
509   // Before expanding S into an expensive LLVM expression, see if we can use an
510   // already existing value as the expansion for S.
511   if (Value *ExistingValue = Rewriter.findExistingExpansion(S, InsertPt, L))
512     if (ExistingValue->getType() == ResultTy)
513       return ExistingValue;
514
515   // We didn't find anything, fall back to using SCEVExpander.
516   return Rewriter.expandCodeFor(S, ResultTy, InsertPt);
517 }
518
519 //===----------------------------------------------------------------------===//
520 // RewriteLoopExitValues - Optimize IV users outside the loop.
521 // As a side effect, reduces the amount of IV processing within the loop.
522 //===----------------------------------------------------------------------===//
523
524 /// Check to see if this loop has a computable loop-invariant execution count.
525 /// If so, this means that we can compute the final value of any expressions
526 /// that are recurrent in the loop, and substitute the exit values from the loop
527 /// into any instructions outside of the loop that use the final values of the
528 /// current expressions.
529 ///
530 /// This is mostly redundant with the regular IndVarSimplify activities that
531 /// happen later, except that it's more powerful in some cases, because it's
532 /// able to brute-force evaluate arbitrary instructions as long as they have
533 /// constant operands at the beginning of the loop.
534 void IndVarSimplify::RewriteLoopExitValues(Loop *L, SCEVExpander &Rewriter) {
535   // Verify the input to the pass in already in LCSSA form.
536   assert(L->isLCSSAForm(*DT));
537
538   SmallVector<BasicBlock*, 8> ExitBlocks;
539   L->getUniqueExitBlocks(ExitBlocks);
540
541   SmallVector<RewritePhi, 8> RewritePhiSet;
542   // Find all values that are computed inside the loop, but used outside of it.
543   // Because of LCSSA, these values will only occur in LCSSA PHI Nodes.  Scan
544   // the exit blocks of the loop to find them.
545   for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
546     BasicBlock *ExitBB = ExitBlocks[i];
547
548     // If there are no PHI nodes in this exit block, then no values defined
549     // inside the loop are used on this path, skip it.
550     PHINode *PN = dyn_cast<PHINode>(ExitBB->begin());
551     if (!PN) continue;
552
553     unsigned NumPreds = PN->getNumIncomingValues();
554
555     // We would like to be able to RAUW single-incoming value PHI nodes. We
556     // have to be certain this is safe even when this is an LCSSA PHI node.
557     // While the computed exit value is no longer varying in *this* loop, the
558     // exit block may be an exit block for an outer containing loop as well,
559     // the exit value may be varying in the outer loop, and thus it may still
560     // require an LCSSA PHI node. The safe case is when this is
561     // single-predecessor PHI node (LCSSA) and the exit block containing it is
562     // part of the enclosing loop, or this is the outer most loop of the nest.
563     // In either case the exit value could (at most) be varying in the same
564     // loop body as the phi node itself. Thus if it is in turn used outside of
565     // an enclosing loop it will only be via a separate LCSSA node.
566     bool LCSSASafePhiForRAUW =
567         NumPreds == 1 &&
568         (!L->getParentLoop() || L->getParentLoop() == LI->getLoopFor(ExitBB));
569
570     // Iterate over all of the PHI nodes.
571     BasicBlock::iterator BBI = ExitBB->begin();
572     while ((PN = dyn_cast<PHINode>(BBI++))) {
573       if (PN->use_empty())
574         continue; // dead use, don't replace it
575
576       // SCEV only supports integer expressions for now.
577       if (!PN->getType()->isIntegerTy() && !PN->getType()->isPointerTy())
578         continue;
579
580       // It's necessary to tell ScalarEvolution about this explicitly so that
581       // it can walk the def-use list and forget all SCEVs, as it may not be
582       // watching the PHI itself. Once the new exit value is in place, there
583       // may not be a def-use connection between the loop and every instruction
584       // which got a SCEVAddRecExpr for that loop.
585       SE->forgetValue(PN);
586
587       // Iterate over all of the values in all the PHI nodes.
588       for (unsigned i = 0; i != NumPreds; ++i) {
589         // If the value being merged in is not integer or is not defined
590         // in the loop, skip it.
591         Value *InVal = PN->getIncomingValue(i);
592         if (!isa<Instruction>(InVal))
593           continue;
594
595         // If this pred is for a subloop, not L itself, skip it.
596         if (LI->getLoopFor(PN->getIncomingBlock(i)) != L)
597           continue; // The Block is in a subloop, skip it.
598
599         // Check that InVal is defined in the loop.
600         Instruction *Inst = cast<Instruction>(InVal);
601         if (!L->contains(Inst))
602           continue;
603
604         // Okay, this instruction has a user outside of the current loop
605         // and varies predictably *inside* the loop.  Evaluate the value it
606         // contains when the loop exits, if possible.
607         const SCEV *ExitValue = SE->getSCEVAtScope(Inst, L->getParentLoop());
608         if (!SE->isLoopInvariant(ExitValue, L) ||
609             !isSafeToExpand(ExitValue, *SE))
610           continue;
611
612         // Computing the value outside of the loop brings no benefit if :
613         //  - it is definitely used inside the loop in a way which can not be
614         //    optimized away.
615         //  - no use outside of the loop can take advantage of hoisting the
616         //    computation out of the loop
617         if (ExitValue->getSCEVType()>=scMulExpr) {
618           unsigned NumHardInternalUses = 0;
619           unsigned NumSoftExternalUses = 0;
620           unsigned NumUses = 0;
621           for (auto IB = Inst->user_begin(), IE = Inst->user_end();
622                IB != IE && NumUses <= 6; ++IB) {
623             Instruction *UseInstr = cast<Instruction>(*IB);
624             unsigned Opc = UseInstr->getOpcode();
625             NumUses++;
626             if (L->contains(UseInstr)) {
627               if (Opc == Instruction::Call || Opc == Instruction::Ret)
628                 NumHardInternalUses++;
629             } else {
630               if (Opc == Instruction::PHI) {
631                 // Do not count the Phi as a use. LCSSA may have inserted
632                 // plenty of trivial ones.
633                 NumUses--;
634                 for (auto PB = UseInstr->user_begin(),
635                           PE = UseInstr->user_end();
636                      PB != PE && NumUses <= 6; ++PB, ++NumUses) {
637                   unsigned PhiOpc = cast<Instruction>(*PB)->getOpcode();
638                   if (PhiOpc != Instruction::Call && PhiOpc != Instruction::Ret)
639                     NumSoftExternalUses++;
640                 }
641                 continue;
642               }
643               if (Opc != Instruction::Call && Opc != Instruction::Ret)
644                 NumSoftExternalUses++;
645             }
646           }
647           if (NumUses <= 6 && NumHardInternalUses && !NumSoftExternalUses)
648             continue;
649         }
650
651         bool HighCost = Rewriter.isHighCostExpansion(ExitValue, L, Inst);
652         Value *ExitVal =
653             ExpandSCEVIfNeeded(Rewriter, ExitValue, L, Inst, PN->getType());
654
655         DEBUG(dbgs() << "INDVARS: RLEV: AfterLoopVal = " << *ExitVal << '\n'
656                      << "  LoopVal = " << *Inst << "\n");
657
658         if (!isValidRewrite(Inst, ExitVal)) {
659           DeadInsts.push_back(ExitVal);
660           continue;
661         }
662
663         // Collect all the candidate PHINodes to be rewritten.
664         RewritePhiSet.push_back(
665             RewritePhi(PN, i, ExitVal, HighCost, LCSSASafePhiForRAUW));
666       }
667     }
668   }
669
670   bool LoopCanBeDel = CanLoopBeDeleted(L, RewritePhiSet);
671
672   // Transformation.
673   for (const RewritePhi &Phi : RewritePhiSet) {
674     PHINode *PN = Phi.PN;
675     Value *ExitVal = Phi.Val;
676
677     // Only do the rewrite when the ExitValue can be expanded cheaply.
678     // If LoopCanBeDel is true, rewrite exit value aggressively.
679     if (ReplaceExitValue == OnlyCheapRepl && !LoopCanBeDel && Phi.HighCost) {
680       DeadInsts.push_back(ExitVal);
681       continue;
682     }
683
684     Changed = true;
685     ++NumReplaced;
686     Instruction *Inst = cast<Instruction>(PN->getIncomingValue(Phi.Ith));
687     PN->setIncomingValue(Phi.Ith, ExitVal);
688
689     // If this instruction is dead now, delete it. Don't do it now to avoid
690     // invalidating iterators.
691     if (isInstructionTriviallyDead(Inst, TLI))
692       DeadInsts.push_back(Inst);
693
694     // If we determined that this PHI is safe to replace even if an LCSSA
695     // PHI, do so.
696     if (Phi.SafePhi) {
697       PN->replaceAllUsesWith(ExitVal);
698       PN->eraseFromParent();
699     }
700   }
701
702   // The insertion point instruction may have been deleted; clear it out
703   // so that the rewriter doesn't trip over it later.
704   Rewriter.clearInsertPoint();
705 }
706
707 /// Check whether it is possible to delete the loop after rewriting exit
708 /// value. If it is possible, ignore ReplaceExitValue and do rewriting
709 /// aggressively.
710 bool IndVarSimplify::CanLoopBeDeleted(
711     Loop *L, SmallVector<RewritePhi, 8> &RewritePhiSet) {
712
713   BasicBlock *Preheader = L->getLoopPreheader();
714   // If there is no preheader, the loop will not be deleted.
715   if (!Preheader)
716     return false;
717
718   // In LoopDeletion pass Loop can be deleted when ExitingBlocks.size() > 1.
719   // We obviate multiple ExitingBlocks case for simplicity.
720   // TODO: If we see testcase with multiple ExitingBlocks can be deleted
721   // after exit value rewriting, we can enhance the logic here.
722   SmallVector<BasicBlock *, 4> ExitingBlocks;
723   L->getExitingBlocks(ExitingBlocks);
724   SmallVector<BasicBlock *, 8> ExitBlocks;
725   L->getUniqueExitBlocks(ExitBlocks);
726   if (ExitBlocks.size() > 1 || ExitingBlocks.size() > 1)
727     return false;
728
729   BasicBlock *ExitBlock = ExitBlocks[0];
730   BasicBlock::iterator BI = ExitBlock->begin();
731   while (PHINode *P = dyn_cast<PHINode>(BI)) {
732     Value *Incoming = P->getIncomingValueForBlock(ExitingBlocks[0]);
733
734     // If the Incoming value of P is found in RewritePhiSet, we know it
735     // could be rewritten to use a loop invariant value in transformation
736     // phase later. Skip it in the loop invariant check below.
737     bool found = false;
738     for (const RewritePhi &Phi : RewritePhiSet) {
739       unsigned i = Phi.Ith;
740       if (Phi.PN == P && (Phi.PN)->getIncomingValue(i) == Incoming) {
741         found = true;
742         break;
743       }
744     }
745
746     Instruction *I;
747     if (!found && (I = dyn_cast<Instruction>(Incoming)))
748       if (!L->hasLoopInvariantOperands(I))
749         return false;
750
751     ++BI;
752   }
753
754   for (Loop::block_iterator LI = L->block_begin(), LE = L->block_end();
755        LI != LE; ++LI) {
756     for (BasicBlock::iterator BI = (*LI)->begin(), BE = (*LI)->end(); BI != BE;
757          ++BI) {
758       if (BI->mayHaveSideEffects())
759         return false;
760     }
761   }
762
763   return true;
764 }
765
766 //===----------------------------------------------------------------------===//
767 //  IV Widening - Extend the width of an IV to cover its widest uses.
768 //===----------------------------------------------------------------------===//
769
770 namespace {
771 // Collect information about induction variables that are used by sign/zero
772 // extend operations. This information is recorded by CollectExtend and provides
773 // the input to WidenIV.
774 struct WideIVInfo {
775   PHINode *NarrowIV = nullptr;
776   Type *WidestNativeType = nullptr; // Widest integer type created [sz]ext
777   bool IsSigned = false;            // Was a sext user seen before a zext?
778 };
779 }
780
781 /// Update information about the induction variable that is extended by this
782 /// sign or zero extend operation. This is used to determine the final width of
783 /// the IV before actually widening it.
784 static void visitIVCast(CastInst *Cast, WideIVInfo &WI, ScalarEvolution *SE,
785                         const TargetTransformInfo *TTI) {
786   bool IsSigned = Cast->getOpcode() == Instruction::SExt;
787   if (!IsSigned && Cast->getOpcode() != Instruction::ZExt)
788     return;
789
790   Type *Ty = Cast->getType();
791   uint64_t Width = SE->getTypeSizeInBits(Ty);
792   if (!Cast->getModule()->getDataLayout().isLegalInteger(Width))
793     return;
794
795   // Cast is either an sext or zext up to this point.
796   // We should not widen an indvar if arithmetics on the wider indvar are more
797   // expensive than those on the narrower indvar. We check only the cost of ADD
798   // because at least an ADD is required to increment the induction variable. We
799   // could compute more comprehensively the cost of all instructions on the
800   // induction variable when necessary.
801   if (TTI &&
802       TTI->getArithmeticInstrCost(Instruction::Add, Ty) >
803           TTI->getArithmeticInstrCost(Instruction::Add,
804                                       Cast->getOperand(0)->getType())) {
805     return;
806   }
807
808   if (!WI.WidestNativeType) {
809     WI.WidestNativeType = SE->getEffectiveSCEVType(Ty);
810     WI.IsSigned = IsSigned;
811     return;
812   }
813
814   // We extend the IV to satisfy the sign of its first user, arbitrarily.
815   if (WI.IsSigned != IsSigned)
816     return;
817
818   if (Width > SE->getTypeSizeInBits(WI.WidestNativeType))
819     WI.WidestNativeType = SE->getEffectiveSCEVType(Ty);
820 }
821
822 namespace {
823
824 /// Record a link in the Narrow IV def-use chain along with the WideIV that
825 /// computes the same value as the Narrow IV def.  This avoids caching Use*
826 /// pointers.
827 struct NarrowIVDefUse {
828   Instruction *NarrowDef = nullptr;
829   Instruction *NarrowUse = nullptr;
830   Instruction *WideDef = nullptr;
831
832   // True if the narrow def is never negative.  Tracking this information lets
833   // us use a sign extension instead of a zero extension or vice versa, when
834   // profitable and legal.
835   bool NeverNegative = false;
836
837   NarrowIVDefUse(Instruction *ND, Instruction *NU, Instruction *WD,
838                  bool NeverNegative)
839       : NarrowDef(ND), NarrowUse(NU), WideDef(WD),
840         NeverNegative(NeverNegative) {}
841 };
842
843 /// The goal of this transform is to remove sign and zero extends without
844 /// creating any new induction variables. To do this, it creates a new phi of
845 /// the wider type and redirects all users, either removing extends or inserting
846 /// truncs whenever we stop propagating the type.
847 ///
848 class WidenIV {
849   // Parameters
850   PHINode *OrigPhi;
851   Type *WideType;
852   bool IsSigned;
853
854   // Context
855   LoopInfo        *LI;
856   Loop            *L;
857   ScalarEvolution *SE;
858   DominatorTree   *DT;
859
860   // Result
861   PHINode *WidePhi;
862   Instruction *WideInc;
863   const SCEV *WideIncExpr;
864   SmallVectorImpl<WeakVH> &DeadInsts;
865
866   SmallPtrSet<Instruction*,16> Widened;
867   SmallVector<NarrowIVDefUse, 8> NarrowIVUsers;
868
869 public:
870   WidenIV(const WideIVInfo &WI, LoopInfo *LInfo,
871           ScalarEvolution *SEv, DominatorTree *DTree,
872           SmallVectorImpl<WeakVH> &DI) :
873     OrigPhi(WI.NarrowIV),
874     WideType(WI.WidestNativeType),
875     IsSigned(WI.IsSigned),
876     LI(LInfo),
877     L(LI->getLoopFor(OrigPhi->getParent())),
878     SE(SEv),
879     DT(DTree),
880     WidePhi(nullptr),
881     WideInc(nullptr),
882     WideIncExpr(nullptr),
883     DeadInsts(DI) {
884     assert(L->getHeader() == OrigPhi->getParent() && "Phi must be an IV");
885   }
886
887   PHINode *CreateWideIV(SCEVExpander &Rewriter);
888
889 protected:
890   Value *getExtend(Value *NarrowOper, Type *WideType, bool IsSigned,
891                    Instruction *Use);
892
893   Instruction *CloneIVUser(NarrowIVDefUse DU);
894
895   const SCEVAddRecExpr *GetWideRecurrence(Instruction *NarrowUse);
896
897   const SCEVAddRecExpr* GetExtendedOperandRecurrence(NarrowIVDefUse DU);
898
899   const SCEV *GetSCEVByOpCode(const SCEV *LHS, const SCEV *RHS,
900                               unsigned OpCode) const;
901
902   Instruction *WidenIVUse(NarrowIVDefUse DU, SCEVExpander &Rewriter);
903
904   bool WidenLoopCompare(NarrowIVDefUse DU);
905
906   void pushNarrowIVUsers(Instruction *NarrowDef, Instruction *WideDef);
907 };
908 } // anonymous namespace
909
910 /// Perform a quick domtree based check for loop invariance assuming that V is
911 /// used within the loop. LoopInfo::isLoopInvariant() seems gratuitous for this
912 /// purpose.
913 static bool isLoopInvariant(Value *V, const Loop *L, const DominatorTree *DT) {
914   Instruction *Inst = dyn_cast<Instruction>(V);
915   if (!Inst)
916     return true;
917
918   return DT->properlyDominates(Inst->getParent(), L->getHeader());
919 }
920
921 Value *WidenIV::getExtend(Value *NarrowOper, Type *WideType, bool IsSigned,
922                           Instruction *Use) {
923   // Set the debug location and conservative insertion point.
924   IRBuilder<> Builder(Use);
925   // Hoist the insertion point into loop preheaders as far as possible.
926   for (const Loop *L = LI->getLoopFor(Use->getParent());
927        L && L->getLoopPreheader() && isLoopInvariant(NarrowOper, L, DT);
928        L = L->getParentLoop())
929     Builder.SetInsertPoint(L->getLoopPreheader()->getTerminator());
930
931   return IsSigned ? Builder.CreateSExt(NarrowOper, WideType) :
932                     Builder.CreateZExt(NarrowOper, WideType);
933 }
934
935 /// Instantiate a wide operation to replace a narrow operation. This only needs
936 /// to handle operations that can evaluation to SCEVAddRec. It can safely return
937 /// 0 for any operation we decide not to clone.
938 Instruction *WidenIV::CloneIVUser(NarrowIVDefUse DU) {
939   unsigned Opcode = DU.NarrowUse->getOpcode();
940   switch (Opcode) {
941   default:
942     return nullptr;
943   case Instruction::Add:
944   case Instruction::Mul:
945   case Instruction::UDiv:
946   case Instruction::Sub:
947   case Instruction::And:
948   case Instruction::Or:
949   case Instruction::Xor:
950   case Instruction::Shl:
951   case Instruction::LShr:
952   case Instruction::AShr:
953     DEBUG(dbgs() << "Cloning IVUser: " << *DU.NarrowUse << "\n");
954
955     // Replace NarrowDef operands with WideDef. Otherwise, we don't know
956     // anything about the narrow operand yet so must insert a [sz]ext. It is
957     // probably loop invariant and will be folded or hoisted. If it actually
958     // comes from a widened IV, it should be removed during a future call to
959     // WidenIVUse.
960     Value *LHS = (DU.NarrowUse->getOperand(0) == DU.NarrowDef) ? DU.WideDef :
961       getExtend(DU.NarrowUse->getOperand(0), WideType, IsSigned, DU.NarrowUse);
962     Value *RHS = (DU.NarrowUse->getOperand(1) == DU.NarrowDef) ? DU.WideDef :
963       getExtend(DU.NarrowUse->getOperand(1), WideType, IsSigned, DU.NarrowUse);
964
965     BinaryOperator *NarrowBO = cast<BinaryOperator>(DU.NarrowUse);
966     BinaryOperator *WideBO = BinaryOperator::Create(NarrowBO->getOpcode(),
967                                                     LHS, RHS,
968                                                     NarrowBO->getName());
969     IRBuilder<> Builder(DU.NarrowUse);
970     Builder.Insert(WideBO);
971     if (const OverflowingBinaryOperator *OBO =
972         dyn_cast<OverflowingBinaryOperator>(NarrowBO)) {
973       if (OBO->hasNoUnsignedWrap()) WideBO->setHasNoUnsignedWrap();
974       if (OBO->hasNoSignedWrap()) WideBO->setHasNoSignedWrap();
975     }
976     return WideBO;
977   }
978 }
979
980 const SCEV *WidenIV::GetSCEVByOpCode(const SCEV *LHS, const SCEV *RHS,
981                                      unsigned OpCode) const {
982   if (OpCode == Instruction::Add)
983     return SE->getAddExpr(LHS, RHS);
984   if (OpCode == Instruction::Sub)
985     return SE->getMinusSCEV(LHS, RHS);
986   if (OpCode == Instruction::Mul)
987     return SE->getMulExpr(LHS, RHS);
988
989   llvm_unreachable("Unsupported opcode.");
990 }
991
992 /// No-wrap operations can transfer sign extension of their result to their
993 /// operands. Generate the SCEV value for the widened operation without
994 /// actually modifying the IR yet. If the expression after extending the
995 /// operands is an AddRec for this loop, return it.
996 const SCEVAddRecExpr* WidenIV::GetExtendedOperandRecurrence(NarrowIVDefUse DU) {
997
998   // Handle the common case of add<nsw/nuw>
999   const unsigned OpCode = DU.NarrowUse->getOpcode();
1000   // Only Add/Sub/Mul instructions supported yet.
1001   if (OpCode != Instruction::Add && OpCode != Instruction::Sub &&
1002       OpCode != Instruction::Mul)
1003     return nullptr;
1004
1005   // One operand (NarrowDef) has already been extended to WideDef. Now determine
1006   // if extending the other will lead to a recurrence.
1007   const unsigned ExtendOperIdx =
1008       DU.NarrowUse->getOperand(0) == DU.NarrowDef ? 1 : 0;
1009   assert(DU.NarrowUse->getOperand(1-ExtendOperIdx) == DU.NarrowDef && "bad DU");
1010
1011   const SCEV *ExtendOperExpr = nullptr;
1012   const OverflowingBinaryOperator *OBO =
1013     cast<OverflowingBinaryOperator>(DU.NarrowUse);
1014   if (IsSigned && OBO->hasNoSignedWrap())
1015     ExtendOperExpr = SE->getSignExtendExpr(
1016       SE->getSCEV(DU.NarrowUse->getOperand(ExtendOperIdx)), WideType);
1017   else if(!IsSigned && OBO->hasNoUnsignedWrap())
1018     ExtendOperExpr = SE->getZeroExtendExpr(
1019       SE->getSCEV(DU.NarrowUse->getOperand(ExtendOperIdx)), WideType);
1020   else
1021     return nullptr;
1022
1023   // When creating this SCEV expr, don't apply the current operations NSW or NUW
1024   // flags. This instruction may be guarded by control flow that the no-wrap
1025   // behavior depends on. Non-control-equivalent instructions can be mapped to
1026   // the same SCEV expression, and it would be incorrect to transfer NSW/NUW
1027   // semantics to those operations.
1028   const SCEV *lhs = SE->getSCEV(DU.WideDef);
1029   const SCEV *rhs = ExtendOperExpr;
1030
1031   // Let's swap operands to the initial order for the case of non-commutative
1032   // operations, like SUB. See PR21014.
1033   if (ExtendOperIdx == 0)
1034     std::swap(lhs, rhs);
1035   const SCEVAddRecExpr *AddRec =
1036       dyn_cast<SCEVAddRecExpr>(GetSCEVByOpCode(lhs, rhs, OpCode));
1037
1038   if (!AddRec || AddRec->getLoop() != L)
1039     return nullptr;
1040   return AddRec;
1041 }
1042
1043 /// Is this instruction potentially interesting for further simplification after
1044 /// widening it's type? In other words, can the extend be safely hoisted out of
1045 /// the loop with SCEV reducing the value to a recurrence on the same loop. If
1046 /// so, return the sign or zero extended recurrence. Otherwise return NULL.
1047 const SCEVAddRecExpr *WidenIV::GetWideRecurrence(Instruction *NarrowUse) {
1048   if (!SE->isSCEVable(NarrowUse->getType()))
1049     return nullptr;
1050
1051   const SCEV *NarrowExpr = SE->getSCEV(NarrowUse);
1052   if (SE->getTypeSizeInBits(NarrowExpr->getType())
1053       >= SE->getTypeSizeInBits(WideType)) {
1054     // NarrowUse implicitly widens its operand. e.g. a gep with a narrow
1055     // index. So don't follow this use.
1056     return nullptr;
1057   }
1058
1059   const SCEV *WideExpr = IsSigned ?
1060     SE->getSignExtendExpr(NarrowExpr, WideType) :
1061     SE->getZeroExtendExpr(NarrowExpr, WideType);
1062   const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(WideExpr);
1063   if (!AddRec || AddRec->getLoop() != L)
1064     return nullptr;
1065   return AddRec;
1066 }
1067
1068 /// This IV user cannot be widen. Replace this use of the original narrow IV
1069 /// with a truncation of the new wide IV to isolate and eliminate the narrow IV.
1070 static void truncateIVUse(NarrowIVDefUse DU, DominatorTree *DT) {
1071   DEBUG(dbgs() << "INDVARS: Truncate IV " << *DU.WideDef
1072         << " for user " << *DU.NarrowUse << "\n");
1073   IRBuilder<> Builder(getInsertPointForUses(DU.NarrowUse, DU.NarrowDef, DT));
1074   Value *Trunc = Builder.CreateTrunc(DU.WideDef, DU.NarrowDef->getType());
1075   DU.NarrowUse->replaceUsesOfWith(DU.NarrowDef, Trunc);
1076 }
1077
1078 /// If the narrow use is a compare instruction, then widen the compare
1079 //  (and possibly the other operand).  The extend operation is hoisted into the
1080 // loop preheader as far as possible.
1081 bool WidenIV::WidenLoopCompare(NarrowIVDefUse DU) {
1082   ICmpInst *Cmp = dyn_cast<ICmpInst>(DU.NarrowUse);
1083   if (!Cmp)
1084     return false;
1085
1086   // We can legally widen the comparison in the following two cases:
1087   //
1088   //  - The signedness of the IV extension and comparison match
1089   //
1090   //  - The narrow IV is always positive (and thus its sign extension is equal
1091   //    to its zero extension).  For instance, let's say we're zero extending
1092   //    %narrow for the following use
1093   //
1094   //      icmp slt i32 %narrow, %val   ... (A)
1095   //
1096   //    and %narrow is always positive.  Then
1097   //
1098   //      (A) == icmp slt i32 sext(%narrow), sext(%val)
1099   //          == icmp slt i32 zext(%narrow), sext(%val)
1100
1101   if (!(DU.NeverNegative || IsSigned == Cmp->isSigned()))
1102     return false;
1103
1104   Value *Op = Cmp->getOperand(Cmp->getOperand(0) == DU.NarrowDef ? 1 : 0);
1105   unsigned CastWidth = SE->getTypeSizeInBits(Op->getType());
1106   unsigned IVWidth = SE->getTypeSizeInBits(WideType);
1107   assert (CastWidth <= IVWidth && "Unexpected width while widening compare.");
1108
1109   // Widen the compare instruction.
1110   IRBuilder<> Builder(getInsertPointForUses(DU.NarrowUse, DU.NarrowDef, DT));
1111   DU.NarrowUse->replaceUsesOfWith(DU.NarrowDef, DU.WideDef);
1112
1113   // Widen the other operand of the compare, if necessary.
1114   if (CastWidth < IVWidth) {
1115     Value *ExtOp = getExtend(Op, WideType, Cmp->isSigned(), Cmp);
1116     DU.NarrowUse->replaceUsesOfWith(Op, ExtOp);
1117   }
1118   return true;
1119 }
1120
1121 /// Determine whether an individual user of the narrow IV can be widened. If so,
1122 /// return the wide clone of the user.
1123 Instruction *WidenIV::WidenIVUse(NarrowIVDefUse DU, SCEVExpander &Rewriter) {
1124
1125   // Stop traversing the def-use chain at inner-loop phis or post-loop phis.
1126   if (PHINode *UsePhi = dyn_cast<PHINode>(DU.NarrowUse)) {
1127     if (LI->getLoopFor(UsePhi->getParent()) != L) {
1128       // For LCSSA phis, sink the truncate outside the loop.
1129       // After SimplifyCFG most loop exit targets have a single predecessor.
1130       // Otherwise fall back to a truncate within the loop.
1131       if (UsePhi->getNumOperands() != 1)
1132         truncateIVUse(DU, DT);
1133       else {
1134         PHINode *WidePhi =
1135           PHINode::Create(DU.WideDef->getType(), 1, UsePhi->getName() + ".wide",
1136                           UsePhi);
1137         WidePhi->addIncoming(DU.WideDef, UsePhi->getIncomingBlock(0));
1138         IRBuilder<> Builder(WidePhi->getParent()->getFirstInsertionPt());
1139         Value *Trunc = Builder.CreateTrunc(WidePhi, DU.NarrowDef->getType());
1140         UsePhi->replaceAllUsesWith(Trunc);
1141         DeadInsts.emplace_back(UsePhi);
1142         DEBUG(dbgs() << "INDVARS: Widen lcssa phi " << *UsePhi
1143               << " to " << *WidePhi << "\n");
1144       }
1145       return nullptr;
1146     }
1147   }
1148   // Our raison d'etre! Eliminate sign and zero extension.
1149   if (IsSigned ? isa<SExtInst>(DU.NarrowUse) : isa<ZExtInst>(DU.NarrowUse)) {
1150     Value *NewDef = DU.WideDef;
1151     if (DU.NarrowUse->getType() != WideType) {
1152       unsigned CastWidth = SE->getTypeSizeInBits(DU.NarrowUse->getType());
1153       unsigned IVWidth = SE->getTypeSizeInBits(WideType);
1154       if (CastWidth < IVWidth) {
1155         // The cast isn't as wide as the IV, so insert a Trunc.
1156         IRBuilder<> Builder(DU.NarrowUse);
1157         NewDef = Builder.CreateTrunc(DU.WideDef, DU.NarrowUse->getType());
1158       }
1159       else {
1160         // A wider extend was hidden behind a narrower one. This may induce
1161         // another round of IV widening in which the intermediate IV becomes
1162         // dead. It should be very rare.
1163         DEBUG(dbgs() << "INDVARS: New IV " << *WidePhi
1164               << " not wide enough to subsume " << *DU.NarrowUse << "\n");
1165         DU.NarrowUse->replaceUsesOfWith(DU.NarrowDef, DU.WideDef);
1166         NewDef = DU.NarrowUse;
1167       }
1168     }
1169     if (NewDef != DU.NarrowUse) {
1170       DEBUG(dbgs() << "INDVARS: eliminating " << *DU.NarrowUse
1171             << " replaced by " << *DU.WideDef << "\n");
1172       ++NumElimExt;
1173       DU.NarrowUse->replaceAllUsesWith(NewDef);
1174       DeadInsts.emplace_back(DU.NarrowUse);
1175     }
1176     // Now that the extend is gone, we want to expose it's uses for potential
1177     // further simplification. We don't need to directly inform SimplifyIVUsers
1178     // of the new users, because their parent IV will be processed later as a
1179     // new loop phi. If we preserved IVUsers analysis, we would also want to
1180     // push the uses of WideDef here.
1181
1182     // No further widening is needed. The deceased [sz]ext had done it for us.
1183     return nullptr;
1184   }
1185
1186   // Does this user itself evaluate to a recurrence after widening?
1187   const SCEVAddRecExpr *WideAddRec = GetWideRecurrence(DU.NarrowUse);
1188   if (!WideAddRec)
1189     WideAddRec = GetExtendedOperandRecurrence(DU);
1190
1191   if (!WideAddRec) {
1192     // If use is a loop condition, try to promote the condition instead of
1193     // truncating the IV first.
1194     if (WidenLoopCompare(DU))
1195       return nullptr;
1196
1197     // This user does not evaluate to a recurence after widening, so don't
1198     // follow it. Instead insert a Trunc to kill off the original use,
1199     // eventually isolating the original narrow IV so it can be removed.
1200     truncateIVUse(DU, DT);
1201     return nullptr;
1202   }
1203   // Assume block terminators cannot evaluate to a recurrence. We can't to
1204   // insert a Trunc after a terminator if there happens to be a critical edge.
1205   assert(DU.NarrowUse != DU.NarrowUse->getParent()->getTerminator() &&
1206          "SCEV is not expected to evaluate a block terminator");
1207
1208   // Reuse the IV increment that SCEVExpander created as long as it dominates
1209   // NarrowUse.
1210   Instruction *WideUse = nullptr;
1211   if (WideAddRec == WideIncExpr
1212       && Rewriter.hoistIVInc(WideInc, DU.NarrowUse))
1213     WideUse = WideInc;
1214   else {
1215     WideUse = CloneIVUser(DU);
1216     if (!WideUse)
1217       return nullptr;
1218   }
1219   // Evaluation of WideAddRec ensured that the narrow expression could be
1220   // extended outside the loop without overflow. This suggests that the wide use
1221   // evaluates to the same expression as the extended narrow use, but doesn't
1222   // absolutely guarantee it. Hence the following failsafe check. In rare cases
1223   // where it fails, we simply throw away the newly created wide use.
1224   if (WideAddRec != SE->getSCEV(WideUse)) {
1225     DEBUG(dbgs() << "Wide use expression mismatch: " << *WideUse
1226           << ": " << *SE->getSCEV(WideUse) << " != " << *WideAddRec << "\n");
1227     DeadInsts.emplace_back(WideUse);
1228     return nullptr;
1229   }
1230
1231   // Returning WideUse pushes it on the worklist.
1232   return WideUse;
1233 }
1234
1235 /// Add eligible users of NarrowDef to NarrowIVUsers.
1236 ///
1237 void WidenIV::pushNarrowIVUsers(Instruction *NarrowDef, Instruction *WideDef) {
1238   const SCEV *NarrowSCEV = SE->getSCEV(NarrowDef);
1239   bool NeverNegative =
1240       SE->isKnownPredicate(ICmpInst::ICMP_SGE, NarrowSCEV,
1241                            SE->getConstant(NarrowSCEV->getType(), 0));
1242   for (User *U : NarrowDef->users()) {
1243     Instruction *NarrowUser = cast<Instruction>(U);
1244
1245     // Handle data flow merges and bizarre phi cycles.
1246     if (!Widened.insert(NarrowUser).second)
1247       continue;
1248
1249     NarrowIVUsers.push_back(
1250         NarrowIVDefUse(NarrowDef, NarrowUser, WideDef, NeverNegative));
1251   }
1252 }
1253
1254 /// Process a single induction variable. First use the SCEVExpander to create a
1255 /// wide induction variable that evaluates to the same recurrence as the
1256 /// original narrow IV. Then use a worklist to forward traverse the narrow IV's
1257 /// def-use chain. After WidenIVUse has processed all interesting IV users, the
1258 /// narrow IV will be isolated for removal by DeleteDeadPHIs.
1259 ///
1260 /// It would be simpler to delete uses as they are processed, but we must avoid
1261 /// invalidating SCEV expressions.
1262 ///
1263 PHINode *WidenIV::CreateWideIV(SCEVExpander &Rewriter) {
1264   // Is this phi an induction variable?
1265   const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(SE->getSCEV(OrigPhi));
1266   if (!AddRec)
1267     return nullptr;
1268
1269   // Widen the induction variable expression.
1270   const SCEV *WideIVExpr = IsSigned ?
1271     SE->getSignExtendExpr(AddRec, WideType) :
1272     SE->getZeroExtendExpr(AddRec, WideType);
1273
1274   assert(SE->getEffectiveSCEVType(WideIVExpr->getType()) == WideType &&
1275          "Expect the new IV expression to preserve its type");
1276
1277   // Can the IV be extended outside the loop without overflow?
1278   AddRec = dyn_cast<SCEVAddRecExpr>(WideIVExpr);
1279   if (!AddRec || AddRec->getLoop() != L)
1280     return nullptr;
1281
1282   // An AddRec must have loop-invariant operands. Since this AddRec is
1283   // materialized by a loop header phi, the expression cannot have any post-loop
1284   // operands, so they must dominate the loop header.
1285   assert(SE->properlyDominates(AddRec->getStart(), L->getHeader()) &&
1286          SE->properlyDominates(AddRec->getStepRecurrence(*SE), L->getHeader())
1287          && "Loop header phi recurrence inputs do not dominate the loop");
1288
1289   // The rewriter provides a value for the desired IV expression. This may
1290   // either find an existing phi or materialize a new one. Either way, we
1291   // expect a well-formed cyclic phi-with-increments. i.e. any operand not part
1292   // of the phi-SCC dominates the loop entry.
1293   Instruction *InsertPt = L->getHeader()->begin();
1294   WidePhi = cast<PHINode>(Rewriter.expandCodeFor(AddRec, WideType, InsertPt));
1295
1296   // Remembering the WideIV increment generated by SCEVExpander allows
1297   // WidenIVUse to reuse it when widening the narrow IV's increment. We don't
1298   // employ a general reuse mechanism because the call above is the only call to
1299   // SCEVExpander. Henceforth, we produce 1-to-1 narrow to wide uses.
1300   if (BasicBlock *LatchBlock = L->getLoopLatch()) {
1301     WideInc =
1302       cast<Instruction>(WidePhi->getIncomingValueForBlock(LatchBlock));
1303     WideIncExpr = SE->getSCEV(WideInc);
1304   }
1305
1306   DEBUG(dbgs() << "Wide IV: " << *WidePhi << "\n");
1307   ++NumWidened;
1308
1309   // Traverse the def-use chain using a worklist starting at the original IV.
1310   assert(Widened.empty() && NarrowIVUsers.empty() && "expect initial state" );
1311
1312   Widened.insert(OrigPhi);
1313   pushNarrowIVUsers(OrigPhi, WidePhi);
1314
1315   while (!NarrowIVUsers.empty()) {
1316     NarrowIVDefUse DU = NarrowIVUsers.pop_back_val();
1317
1318     // Process a def-use edge. This may replace the use, so don't hold a
1319     // use_iterator across it.
1320     Instruction *WideUse = WidenIVUse(DU, Rewriter);
1321
1322     // Follow all def-use edges from the previous narrow use.
1323     if (WideUse)
1324       pushNarrowIVUsers(DU.NarrowUse, WideUse);
1325
1326     // WidenIVUse may have removed the def-use edge.
1327     if (DU.NarrowDef->use_empty())
1328       DeadInsts.emplace_back(DU.NarrowDef);
1329   }
1330   return WidePhi;
1331 }
1332
1333 //===----------------------------------------------------------------------===//
1334 //  Live IV Reduction - Minimize IVs live across the loop.
1335 //===----------------------------------------------------------------------===//
1336
1337
1338 //===----------------------------------------------------------------------===//
1339 //  Simplification of IV users based on SCEV evaluation.
1340 //===----------------------------------------------------------------------===//
1341
1342 namespace {
1343 class IndVarSimplifyVisitor : public IVVisitor {
1344   ScalarEvolution *SE;
1345   const TargetTransformInfo *TTI;
1346   PHINode *IVPhi;
1347
1348 public:
1349   WideIVInfo WI;
1350
1351   IndVarSimplifyVisitor(PHINode *IV, ScalarEvolution *SCEV,
1352                         const TargetTransformInfo *TTI,
1353                         const DominatorTree *DTree)
1354     : SE(SCEV), TTI(TTI), IVPhi(IV) {
1355     DT = DTree;
1356     WI.NarrowIV = IVPhi;
1357     if (ReduceLiveIVs)
1358       setSplitOverflowIntrinsics();
1359   }
1360
1361   // Implement the interface used by simplifyUsersOfIV.
1362   void visitCast(CastInst *Cast) override { visitIVCast(Cast, WI, SE, TTI); }
1363 };
1364 }
1365
1366 /// Iteratively perform simplification on a worklist of IV users. Each
1367 /// successive simplification may push more users which may themselves be
1368 /// candidates for simplification.
1369 ///
1370 /// Sign/Zero extend elimination is interleaved with IV simplification.
1371 ///
1372 void IndVarSimplify::SimplifyAndExtend(Loop *L,
1373                                        SCEVExpander &Rewriter,
1374                                        LPPassManager &LPM) {
1375   SmallVector<WideIVInfo, 8> WideIVs;
1376
1377   SmallVector<PHINode*, 8> LoopPhis;
1378   for (BasicBlock::iterator I = L->getHeader()->begin(); isa<PHINode>(I); ++I) {
1379     LoopPhis.push_back(cast<PHINode>(I));
1380   }
1381   // Each round of simplification iterates through the SimplifyIVUsers worklist
1382   // for all current phis, then determines whether any IVs can be
1383   // widened. Widening adds new phis to LoopPhis, inducing another round of
1384   // simplification on the wide IVs.
1385   while (!LoopPhis.empty()) {
1386     // Evaluate as many IV expressions as possible before widening any IVs. This
1387     // forces SCEV to set no-wrap flags before evaluating sign/zero
1388     // extension. The first time SCEV attempts to normalize sign/zero extension,
1389     // the result becomes final. So for the most predictable results, we delay
1390     // evaluation of sign/zero extend evaluation until needed, and avoid running
1391     // other SCEV based analysis prior to SimplifyAndExtend.
1392     do {
1393       PHINode *CurrIV = LoopPhis.pop_back_val();
1394
1395       // Information about sign/zero extensions of CurrIV.
1396       IndVarSimplifyVisitor Visitor(CurrIV, SE, TTI, DT);
1397
1398       Changed |= simplifyUsersOfIV(CurrIV, SE, &LPM, DeadInsts, &Visitor);
1399
1400       if (Visitor.WI.WidestNativeType) {
1401         WideIVs.push_back(Visitor.WI);
1402       }
1403     } while(!LoopPhis.empty());
1404
1405     for (; !WideIVs.empty(); WideIVs.pop_back()) {
1406       WidenIV Widener(WideIVs.back(), LI, SE, DT, DeadInsts);
1407       if (PHINode *WidePhi = Widener.CreateWideIV(Rewriter)) {
1408         Changed = true;
1409         LoopPhis.push_back(WidePhi);
1410       }
1411     }
1412   }
1413 }
1414
1415 //===----------------------------------------------------------------------===//
1416 //  LinearFunctionTestReplace and its kin. Rewrite the loop exit condition.
1417 //===----------------------------------------------------------------------===//
1418
1419 /// Return true if this loop's backedge taken count expression can be safely and
1420 /// cheaply expanded into an instruction sequence that can be used by
1421 /// LinearFunctionTestReplace.
1422 ///
1423 /// TODO: This fails for pointer-type loop counters with greater than one byte
1424 /// strides, consequently preventing LFTR from running. For the purpose of LFTR
1425 /// we could skip this check in the case that the LFTR loop counter (chosen by
1426 /// FindLoopCounter) is also pointer type. Instead, we could directly convert
1427 /// the loop test to an inequality test by checking the target data's alignment
1428 /// of element types (given that the initial pointer value originates from or is
1429 /// used by ABI constrained operation, as opposed to inttoptr/ptrtoint).
1430 /// However, we don't yet have a strong motivation for converting loop tests
1431 /// into inequality tests.
1432 static bool canExpandBackedgeTakenCount(Loop *L, ScalarEvolution *SE,
1433                                         SCEVExpander &Rewriter) {
1434   const SCEV *BackedgeTakenCount = SE->getBackedgeTakenCount(L);
1435   if (isa<SCEVCouldNotCompute>(BackedgeTakenCount) ||
1436       BackedgeTakenCount->isZero())
1437     return false;
1438
1439   if (!L->getExitingBlock())
1440     return false;
1441
1442   // Can't rewrite non-branch yet.
1443   if (!isa<BranchInst>(L->getExitingBlock()->getTerminator()))
1444     return false;
1445
1446   if (Rewriter.isHighCostExpansion(BackedgeTakenCount, L))
1447     return false;
1448
1449   return true;
1450 }
1451
1452 /// Return the loop header phi IFF IncV adds a loop invariant value to the phi.
1453 static PHINode *getLoopPhiForCounter(Value *IncV, Loop *L, DominatorTree *DT) {
1454   Instruction *IncI = dyn_cast<Instruction>(IncV);
1455   if (!IncI)
1456     return nullptr;
1457
1458   switch (IncI->getOpcode()) {
1459   case Instruction::Add:
1460   case Instruction::Sub:
1461     break;
1462   case Instruction::GetElementPtr:
1463     // An IV counter must preserve its type.
1464     if (IncI->getNumOperands() == 2)
1465       break;
1466   default:
1467     return nullptr;
1468   }
1469
1470   PHINode *Phi = dyn_cast<PHINode>(IncI->getOperand(0));
1471   if (Phi && Phi->getParent() == L->getHeader()) {
1472     if (isLoopInvariant(IncI->getOperand(1), L, DT))
1473       return Phi;
1474     return nullptr;
1475   }
1476   if (IncI->getOpcode() == Instruction::GetElementPtr)
1477     return nullptr;
1478
1479   // Allow add/sub to be commuted.
1480   Phi = dyn_cast<PHINode>(IncI->getOperand(1));
1481   if (Phi && Phi->getParent() == L->getHeader()) {
1482     if (isLoopInvariant(IncI->getOperand(0), L, DT))
1483       return Phi;
1484   }
1485   return nullptr;
1486 }
1487
1488 /// Return the compare guarding the loop latch, or NULL for unrecognized tests.
1489 static ICmpInst *getLoopTest(Loop *L) {
1490   assert(L->getExitingBlock() && "expected loop exit");
1491
1492   BasicBlock *LatchBlock = L->getLoopLatch();
1493   // Don't bother with LFTR if the loop is not properly simplified.
1494   if (!LatchBlock)
1495     return nullptr;
1496
1497   BranchInst *BI = dyn_cast<BranchInst>(L->getExitingBlock()->getTerminator());
1498   assert(BI && "expected exit branch");
1499
1500   return dyn_cast<ICmpInst>(BI->getCondition());
1501 }
1502
1503 /// LinearFunctionTestReplace policy. Return true unless we can show that the
1504 /// current exit test is already sufficiently canonical.
1505 static bool needsLFTR(Loop *L, DominatorTree *DT) {
1506   // Do LFTR to simplify the exit condition to an ICMP.
1507   ICmpInst *Cond = getLoopTest(L);
1508   if (!Cond)
1509     return true;
1510
1511   // Do LFTR to simplify the exit ICMP to EQ/NE
1512   ICmpInst::Predicate Pred = Cond->getPredicate();
1513   if (Pred != ICmpInst::ICMP_NE && Pred != ICmpInst::ICMP_EQ)
1514     return true;
1515
1516   // Look for a loop invariant RHS
1517   Value *LHS = Cond->getOperand(0);
1518   Value *RHS = Cond->getOperand(1);
1519   if (!isLoopInvariant(RHS, L, DT)) {
1520     if (!isLoopInvariant(LHS, L, DT))
1521       return true;
1522     std::swap(LHS, RHS);
1523   }
1524   // Look for a simple IV counter LHS
1525   PHINode *Phi = dyn_cast<PHINode>(LHS);
1526   if (!Phi)
1527     Phi = getLoopPhiForCounter(LHS, L, DT);
1528
1529   if (!Phi)
1530     return true;
1531
1532   // Do LFTR if PHI node is defined in the loop, but is *not* a counter.
1533   int Idx = Phi->getBasicBlockIndex(L->getLoopLatch());
1534   if (Idx < 0)
1535     return true;
1536
1537   // Do LFTR if the exit condition's IV is *not* a simple counter.
1538   Value *IncV = Phi->getIncomingValue(Idx);
1539   return Phi != getLoopPhiForCounter(IncV, L, DT);
1540 }
1541
1542 /// Recursive helper for hasConcreteDef(). Unfortunately, this currently boils
1543 /// down to checking that all operands are constant and listing instructions
1544 /// that may hide undef.
1545 static bool hasConcreteDefImpl(Value *V, SmallPtrSetImpl<Value*> &Visited,
1546                                unsigned Depth) {
1547   if (isa<Constant>(V))
1548     return !isa<UndefValue>(V);
1549
1550   if (Depth >= 6)
1551     return false;
1552
1553   // Conservatively handle non-constant non-instructions. For example, Arguments
1554   // may be undef.
1555   Instruction *I = dyn_cast<Instruction>(V);
1556   if (!I)
1557     return false;
1558
1559   // Load and return values may be undef.
1560   if(I->mayReadFromMemory() || isa<CallInst>(I) || isa<InvokeInst>(I))
1561     return false;
1562
1563   // Optimistically handle other instructions.
1564   for (User::op_iterator OI = I->op_begin(), E = I->op_end(); OI != E; ++OI) {
1565     if (!Visited.insert(*OI).second)
1566       continue;
1567     if (!hasConcreteDefImpl(*OI, Visited, Depth+1))
1568       return false;
1569   }
1570   return true;
1571 }
1572
1573 /// Return true if the given value is concrete. We must prove that undef can
1574 /// never reach it.
1575 ///
1576 /// TODO: If we decide that this is a good approach to checking for undef, we
1577 /// may factor it into a common location.
1578 static bool hasConcreteDef(Value *V) {
1579   SmallPtrSet<Value*, 8> Visited;
1580   Visited.insert(V);
1581   return hasConcreteDefImpl(V, Visited, 0);
1582 }
1583
1584 /// Return true if this IV has any uses other than the (soon to be rewritten)
1585 /// loop exit test.
1586 static bool AlmostDeadIV(PHINode *Phi, BasicBlock *LatchBlock, Value *Cond) {
1587   int LatchIdx = Phi->getBasicBlockIndex(LatchBlock);
1588   Value *IncV = Phi->getIncomingValue(LatchIdx);
1589
1590   for (User *U : Phi->users())
1591     if (U != Cond && U != IncV) return false;
1592
1593   for (User *U : IncV->users())
1594     if (U != Cond && U != Phi) return false;
1595   return true;
1596 }
1597
1598 /// Find an affine IV in canonical form.
1599 ///
1600 /// BECount may be an i8* pointer type. The pointer difference is already
1601 /// valid count without scaling the address stride, so it remains a pointer
1602 /// expression as far as SCEV is concerned.
1603 ///
1604 /// Currently only valid for LFTR. See the comments on hasConcreteDef below.
1605 ///
1606 /// FIXME: Accept -1 stride and set IVLimit = IVInit - BECount
1607 ///
1608 /// FIXME: Accept non-unit stride as long as SCEV can reduce BECount * Stride.
1609 /// This is difficult in general for SCEV because of potential overflow. But we
1610 /// could at least handle constant BECounts.
1611 static PHINode *FindLoopCounter(Loop *L, const SCEV *BECount,
1612                                 ScalarEvolution *SE, DominatorTree *DT) {
1613   uint64_t BCWidth = SE->getTypeSizeInBits(BECount->getType());
1614
1615   Value *Cond =
1616     cast<BranchInst>(L->getExitingBlock()->getTerminator())->getCondition();
1617
1618   // Loop over all of the PHI nodes, looking for a simple counter.
1619   PHINode *BestPhi = nullptr;
1620   const SCEV *BestInit = nullptr;
1621   BasicBlock *LatchBlock = L->getLoopLatch();
1622   assert(LatchBlock && "needsLFTR should guarantee a loop latch");
1623
1624   for (BasicBlock::iterator I = L->getHeader()->begin(); isa<PHINode>(I); ++I) {
1625     PHINode *Phi = cast<PHINode>(I);
1626     if (!SE->isSCEVable(Phi->getType()))
1627       continue;
1628
1629     // Avoid comparing an integer IV against a pointer Limit.
1630     if (BECount->getType()->isPointerTy() && !Phi->getType()->isPointerTy())
1631       continue;
1632
1633     const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(SE->getSCEV(Phi));
1634     if (!AR || AR->getLoop() != L || !AR->isAffine())
1635       continue;
1636
1637     // AR may be a pointer type, while BECount is an integer type.
1638     // AR may be wider than BECount. With eq/ne tests overflow is immaterial.
1639     // AR may not be a narrower type, or we may never exit.
1640     uint64_t PhiWidth = SE->getTypeSizeInBits(AR->getType());
1641     if (PhiWidth < BCWidth ||
1642         !L->getHeader()->getModule()->getDataLayout().isLegalInteger(PhiWidth))
1643       continue;
1644
1645     const SCEV *Step = dyn_cast<SCEVConstant>(AR->getStepRecurrence(*SE));
1646     if (!Step || !Step->isOne())
1647       continue;
1648
1649     int LatchIdx = Phi->getBasicBlockIndex(LatchBlock);
1650     Value *IncV = Phi->getIncomingValue(LatchIdx);
1651     if (getLoopPhiForCounter(IncV, L, DT) != Phi)
1652       continue;
1653
1654     // Avoid reusing a potentially undef value to compute other values that may
1655     // have originally had a concrete definition.
1656     if (!hasConcreteDef(Phi)) {
1657       // We explicitly allow unknown phis as long as they are already used by
1658       // the loop test. In this case we assume that performing LFTR could not
1659       // increase the number of undef users.
1660       if (ICmpInst *Cond = getLoopTest(L)) {
1661         if (Phi != getLoopPhiForCounter(Cond->getOperand(0), L, DT)
1662             && Phi != getLoopPhiForCounter(Cond->getOperand(1), L, DT)) {
1663           continue;
1664         }
1665       }
1666     }
1667     const SCEV *Init = AR->getStart();
1668
1669     if (BestPhi && !AlmostDeadIV(BestPhi, LatchBlock, Cond)) {
1670       // Don't force a live loop counter if another IV can be used.
1671       if (AlmostDeadIV(Phi, LatchBlock, Cond))
1672         continue;
1673
1674       // Prefer to count-from-zero. This is a more "canonical" counter form. It
1675       // also prefers integer to pointer IVs.
1676       if (BestInit->isZero() != Init->isZero()) {
1677         if (BestInit->isZero())
1678           continue;
1679       }
1680       // If two IVs both count from zero or both count from nonzero then the
1681       // narrower is likely a dead phi that has been widened. Use the wider phi
1682       // to allow the other to be eliminated.
1683       else if (PhiWidth <= SE->getTypeSizeInBits(BestPhi->getType()))
1684         continue;
1685     }
1686     BestPhi = Phi;
1687     BestInit = Init;
1688   }
1689   return BestPhi;
1690 }
1691
1692 /// Help LinearFunctionTestReplace by generating a value that holds the RHS of
1693 /// the new loop test.
1694 static Value *genLoopLimit(PHINode *IndVar, const SCEV *IVCount, Loop *L,
1695                            SCEVExpander &Rewriter, ScalarEvolution *SE) {
1696   const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(SE->getSCEV(IndVar));
1697   assert(AR && AR->getLoop() == L && AR->isAffine() && "bad loop counter");
1698   const SCEV *IVInit = AR->getStart();
1699
1700   // IVInit may be a pointer while IVCount is an integer when FindLoopCounter
1701   // finds a valid pointer IV. Sign extend BECount in order to materialize a
1702   // GEP. Avoid running SCEVExpander on a new pointer value, instead reusing
1703   // the existing GEPs whenever possible.
1704   if (IndVar->getType()->isPointerTy()
1705       && !IVCount->getType()->isPointerTy()) {
1706
1707     // IVOffset will be the new GEP offset that is interpreted by GEP as a
1708     // signed value. IVCount on the other hand represents the loop trip count,
1709     // which is an unsigned value. FindLoopCounter only allows induction
1710     // variables that have a positive unit stride of one. This means we don't
1711     // have to handle the case of negative offsets (yet) and just need to zero
1712     // extend IVCount.
1713     Type *OfsTy = SE->getEffectiveSCEVType(IVInit->getType());
1714     const SCEV *IVOffset = SE->getTruncateOrZeroExtend(IVCount, OfsTy);
1715
1716     // Expand the code for the iteration count.
1717     assert(SE->isLoopInvariant(IVOffset, L) &&
1718            "Computed iteration count is not loop invariant!");
1719     BranchInst *BI = cast<BranchInst>(L->getExitingBlock()->getTerminator());
1720     Value *GEPOffset = Rewriter.expandCodeFor(IVOffset, OfsTy, BI);
1721
1722     Value *GEPBase = IndVar->getIncomingValueForBlock(L->getLoopPreheader());
1723     assert(AR->getStart() == SE->getSCEV(GEPBase) && "bad loop counter");
1724     // We could handle pointer IVs other than i8*, but we need to compensate for
1725     // gep index scaling. See canExpandBackedgeTakenCount comments.
1726     assert(SE->getSizeOfExpr(IntegerType::getInt64Ty(IndVar->getContext()),
1727              cast<PointerType>(GEPBase->getType())->getElementType())->isOne()
1728            && "unit stride pointer IV must be i8*");
1729
1730     IRBuilder<> Builder(L->getLoopPreheader()->getTerminator());
1731     return Builder.CreateGEP(nullptr, GEPBase, GEPOffset, "lftr.limit");
1732   }
1733   else {
1734     // In any other case, convert both IVInit and IVCount to integers before
1735     // comparing. This may result in SCEV expension of pointers, but in practice
1736     // SCEV will fold the pointer arithmetic away as such:
1737     // BECount = (IVEnd - IVInit - 1) => IVLimit = IVInit (postinc).
1738     //
1739     // Valid Cases: (1) both integers is most common; (2) both may be pointers
1740     // for simple memset-style loops.
1741     //
1742     // IVInit integer and IVCount pointer would only occur if a canonical IV
1743     // were generated on top of case #2, which is not expected.
1744
1745     const SCEV *IVLimit = nullptr;
1746     // For unit stride, IVCount = Start + BECount with 2's complement overflow.
1747     // For non-zero Start, compute IVCount here.
1748     if (AR->getStart()->isZero())
1749       IVLimit = IVCount;
1750     else {
1751       assert(AR->getStepRecurrence(*SE)->isOne() && "only handles unit stride");
1752       const SCEV *IVInit = AR->getStart();
1753
1754       // For integer IVs, truncate the IV before computing IVInit + BECount.
1755       if (SE->getTypeSizeInBits(IVInit->getType())
1756           > SE->getTypeSizeInBits(IVCount->getType()))
1757         IVInit = SE->getTruncateExpr(IVInit, IVCount->getType());
1758
1759       IVLimit = SE->getAddExpr(IVInit, IVCount);
1760     }
1761     // Expand the code for the iteration count.
1762     BranchInst *BI = cast<BranchInst>(L->getExitingBlock()->getTerminator());
1763     IRBuilder<> Builder(BI);
1764     assert(SE->isLoopInvariant(IVLimit, L) &&
1765            "Computed iteration count is not loop invariant!");
1766     // Ensure that we generate the same type as IndVar, or a smaller integer
1767     // type. In the presence of null pointer values, we have an integer type
1768     // SCEV expression (IVInit) for a pointer type IV value (IndVar).
1769     Type *LimitTy = IVCount->getType()->isPointerTy() ?
1770       IndVar->getType() : IVCount->getType();
1771     return Rewriter.expandCodeFor(IVLimit, LimitTy, BI);
1772   }
1773 }
1774
1775 /// This method rewrites the exit condition of the loop to be a canonical !=
1776 /// comparison against the incremented loop induction variable.  This pass is
1777 /// able to rewrite the exit tests of any loop where the SCEV analysis can
1778 /// determine a loop-invariant trip count of the loop, which is actually a much
1779 /// broader range than just linear tests.
1780 Value *IndVarSimplify::
1781 LinearFunctionTestReplace(Loop *L,
1782                           const SCEV *BackedgeTakenCount,
1783                           PHINode *IndVar,
1784                           SCEVExpander &Rewriter) {
1785   assert(canExpandBackedgeTakenCount(L, SE, Rewriter) && "precondition");
1786
1787   // Initialize CmpIndVar and IVCount to their preincremented values.
1788   Value *CmpIndVar = IndVar;
1789   const SCEV *IVCount = BackedgeTakenCount;
1790
1791   // If the exiting block is the same as the backedge block, we prefer to
1792   // compare against the post-incremented value, otherwise we must compare
1793   // against the preincremented value.
1794   if (L->getExitingBlock() == L->getLoopLatch()) {
1795     // Add one to the "backedge-taken" count to get the trip count.
1796     // This addition may overflow, which is valid as long as the comparison is
1797     // truncated to BackedgeTakenCount->getType().
1798     IVCount = SE->getAddExpr(BackedgeTakenCount,
1799                              SE->getOne(BackedgeTakenCount->getType()));
1800     // The BackedgeTaken expression contains the number of times that the
1801     // backedge branches to the loop header.  This is one less than the
1802     // number of times the loop executes, so use the incremented indvar.
1803     CmpIndVar = IndVar->getIncomingValueForBlock(L->getExitingBlock());
1804   }
1805
1806   Value *ExitCnt = genLoopLimit(IndVar, IVCount, L, Rewriter, SE);
1807   assert(ExitCnt->getType()->isPointerTy() == IndVar->getType()->isPointerTy()
1808          && "genLoopLimit missed a cast");
1809
1810   // Insert a new icmp_ne or icmp_eq instruction before the branch.
1811   BranchInst *BI = cast<BranchInst>(L->getExitingBlock()->getTerminator());
1812   ICmpInst::Predicate P;
1813   if (L->contains(BI->getSuccessor(0)))
1814     P = ICmpInst::ICMP_NE;
1815   else
1816     P = ICmpInst::ICMP_EQ;
1817
1818   DEBUG(dbgs() << "INDVARS: Rewriting loop exit condition to:\n"
1819                << "      LHS:" << *CmpIndVar << '\n'
1820                << "       op:\t"
1821                << (P == ICmpInst::ICMP_NE ? "!=" : "==") << "\n"
1822                << "      RHS:\t" << *ExitCnt << "\n"
1823                << "  IVCount:\t" << *IVCount << "\n");
1824
1825   IRBuilder<> Builder(BI);
1826
1827   // LFTR can ignore IV overflow and truncate to the width of
1828   // BECount. This avoids materializing the add(zext(add)) expression.
1829   unsigned CmpIndVarSize = SE->getTypeSizeInBits(CmpIndVar->getType());
1830   unsigned ExitCntSize = SE->getTypeSizeInBits(ExitCnt->getType());
1831   if (CmpIndVarSize > ExitCntSize) {
1832     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(SE->getSCEV(IndVar));
1833     const SCEV *ARStart = AR->getStart();
1834     const SCEV *ARStep = AR->getStepRecurrence(*SE);
1835     // For constant IVCount, avoid truncation.
1836     if (isa<SCEVConstant>(ARStart) && isa<SCEVConstant>(IVCount)) {
1837       const APInt &Start = cast<SCEVConstant>(ARStart)->getValue()->getValue();
1838       APInt Count = cast<SCEVConstant>(IVCount)->getValue()->getValue();
1839       // Note that the post-inc value of BackedgeTakenCount may have overflowed
1840       // above such that IVCount is now zero.
1841       if (IVCount != BackedgeTakenCount && Count == 0) {
1842         Count = APInt::getMaxValue(Count.getBitWidth()).zext(CmpIndVarSize);
1843         ++Count;
1844       }
1845       else
1846         Count = Count.zext(CmpIndVarSize);
1847       APInt NewLimit;
1848       if (cast<SCEVConstant>(ARStep)->getValue()->isNegative())
1849         NewLimit = Start - Count;
1850       else
1851         NewLimit = Start + Count;
1852       ExitCnt = ConstantInt::get(CmpIndVar->getType(), NewLimit);
1853
1854       DEBUG(dbgs() << "  Widen RHS:\t" << *ExitCnt << "\n");
1855     } else {
1856       CmpIndVar = Builder.CreateTrunc(CmpIndVar, ExitCnt->getType(),
1857                                       "lftr.wideiv");
1858     }
1859   }
1860   Value *Cond = Builder.CreateICmp(P, CmpIndVar, ExitCnt, "exitcond");
1861   Value *OrigCond = BI->getCondition();
1862   // It's tempting to use replaceAllUsesWith here to fully replace the old
1863   // comparison, but that's not immediately safe, since users of the old
1864   // comparison may not be dominated by the new comparison. Instead, just
1865   // update the branch to use the new comparison; in the common case this
1866   // will make old comparison dead.
1867   BI->setCondition(Cond);
1868   DeadInsts.push_back(OrigCond);
1869
1870   ++NumLFTR;
1871   Changed = true;
1872   return Cond;
1873 }
1874
1875 //===----------------------------------------------------------------------===//
1876 //  SinkUnusedInvariants. A late subpass to cleanup loop preheaders.
1877 //===----------------------------------------------------------------------===//
1878
1879 /// If there's a single exit block, sink any loop-invariant values that
1880 /// were defined in the preheader but not used inside the loop into the
1881 /// exit block to reduce register pressure in the loop.
1882 void IndVarSimplify::SinkUnusedInvariants(Loop *L) {
1883   BasicBlock *ExitBlock = L->getExitBlock();
1884   if (!ExitBlock) return;
1885
1886   BasicBlock *Preheader = L->getLoopPreheader();
1887   if (!Preheader) return;
1888
1889   Instruction *InsertPt = ExitBlock->getFirstInsertionPt();
1890   BasicBlock::iterator I = Preheader->getTerminator();
1891   while (I != Preheader->begin()) {
1892     --I;
1893     // New instructions were inserted at the end of the preheader.
1894     if (isa<PHINode>(I))
1895       break;
1896
1897     // Don't move instructions which might have side effects, since the side
1898     // effects need to complete before instructions inside the loop.  Also don't
1899     // move instructions which might read memory, since the loop may modify
1900     // memory. Note that it's okay if the instruction might have undefined
1901     // behavior: LoopSimplify guarantees that the preheader dominates the exit
1902     // block.
1903     if (I->mayHaveSideEffects() || I->mayReadFromMemory())
1904       continue;
1905
1906     // Skip debug info intrinsics.
1907     if (isa<DbgInfoIntrinsic>(I))
1908       continue;
1909
1910     // Skip eh pad instructions.
1911     if (I->isEHPad())
1912       continue;
1913
1914     // Don't sink alloca: we never want to sink static alloca's out of the
1915     // entry block, and correctly sinking dynamic alloca's requires
1916     // checks for stacksave/stackrestore intrinsics.
1917     // FIXME: Refactor this check somehow?
1918     if (isa<AllocaInst>(I))
1919       continue;
1920
1921     // Determine if there is a use in or before the loop (direct or
1922     // otherwise).
1923     bool UsedInLoop = false;
1924     for (Use &U : I->uses()) {
1925       Instruction *User = cast<Instruction>(U.getUser());
1926       BasicBlock *UseBB = User->getParent();
1927       if (PHINode *P = dyn_cast<PHINode>(User)) {
1928         unsigned i =
1929           PHINode::getIncomingValueNumForOperand(U.getOperandNo());
1930         UseBB = P->getIncomingBlock(i);
1931       }
1932       if (UseBB == Preheader || L->contains(UseBB)) {
1933         UsedInLoop = true;
1934         break;
1935       }
1936     }
1937
1938     // If there is, the def must remain in the preheader.
1939     if (UsedInLoop)
1940       continue;
1941
1942     // Otherwise, sink it to the exit block.
1943     Instruction *ToMove = I;
1944     bool Done = false;
1945
1946     if (I != Preheader->begin()) {
1947       // Skip debug info intrinsics.
1948       do {
1949         --I;
1950       } while (isa<DbgInfoIntrinsic>(I) && I != Preheader->begin());
1951
1952       if (isa<DbgInfoIntrinsic>(I) && I == Preheader->begin())
1953         Done = true;
1954     } else {
1955       Done = true;
1956     }
1957
1958     ToMove->moveBefore(InsertPt);
1959     if (Done) break;
1960     InsertPt = ToMove;
1961   }
1962 }
1963
1964 //===----------------------------------------------------------------------===//
1965 //  IndVarSimplify driver. Manage several subpasses of IV simplification.
1966 //===----------------------------------------------------------------------===//
1967
1968 bool IndVarSimplify::runOnLoop(Loop *L, LPPassManager &LPM) {
1969   if (skipOptnoneFunction(L))
1970     return false;
1971
1972   // If LoopSimplify form is not available, stay out of trouble. Some notes:
1973   //  - LSR currently only supports LoopSimplify-form loops. Indvars'
1974   //    canonicalization can be a pessimization without LSR to "clean up"
1975   //    afterwards.
1976   //  - We depend on having a preheader; in particular,
1977   //    Loop::getCanonicalInductionVariable only supports loops with preheaders,
1978   //    and we're in trouble if we can't find the induction variable even when
1979   //    we've manually inserted one.
1980   if (!L->isLoopSimplifyForm())
1981     return false;
1982
1983   LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
1984   SE = &getAnalysis<ScalarEvolutionWrapperPass>().getSE();
1985   DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
1986   auto *TLIP = getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>();
1987   TLI = TLIP ? &TLIP->getTLI() : nullptr;
1988   auto *TTIP = getAnalysisIfAvailable<TargetTransformInfoWrapperPass>();
1989   TTI = TTIP ? &TTIP->getTTI(*L->getHeader()->getParent()) : nullptr;
1990   const DataLayout &DL = L->getHeader()->getModule()->getDataLayout();
1991
1992   DeadInsts.clear();
1993   Changed = false;
1994
1995   // If there are any floating-point recurrences, attempt to
1996   // transform them to use integer recurrences.
1997   RewriteNonIntegerIVs(L);
1998
1999   const SCEV *BackedgeTakenCount = SE->getBackedgeTakenCount(L);
2000
2001   // Create a rewriter object which we'll use to transform the code with.
2002   SCEVExpander Rewriter(*SE, DL, "indvars");
2003 #ifndef NDEBUG
2004   Rewriter.setDebugType(DEBUG_TYPE);
2005 #endif
2006
2007   // Eliminate redundant IV users.
2008   //
2009   // Simplification works best when run before other consumers of SCEV. We
2010   // attempt to avoid evaluating SCEVs for sign/zero extend operations until
2011   // other expressions involving loop IVs have been evaluated. This helps SCEV
2012   // set no-wrap flags before normalizing sign/zero extension.
2013   Rewriter.disableCanonicalMode();
2014   SimplifyAndExtend(L, Rewriter, LPM);
2015
2016   // Check to see if this loop has a computable loop-invariant execution count.
2017   // If so, this means that we can compute the final value of any expressions
2018   // that are recurrent in the loop, and substitute the exit values from the
2019   // loop into any instructions outside of the loop that use the final values of
2020   // the current expressions.
2021   //
2022   if (ReplaceExitValue != NeverRepl &&
2023       !isa<SCEVCouldNotCompute>(BackedgeTakenCount))
2024     RewriteLoopExitValues(L, Rewriter);
2025
2026   // Eliminate redundant IV cycles.
2027   NumElimIV += Rewriter.replaceCongruentIVs(L, DT, DeadInsts);
2028
2029   // If we have a trip count expression, rewrite the loop's exit condition
2030   // using it.  We can currently only handle loops with a single exit.
2031   if (canExpandBackedgeTakenCount(L, SE, Rewriter) && needsLFTR(L, DT)) {
2032     PHINode *IndVar = FindLoopCounter(L, BackedgeTakenCount, SE, DT);
2033     if (IndVar) {
2034       // Check preconditions for proper SCEVExpander operation. SCEV does not
2035       // express SCEVExpander's dependencies, such as LoopSimplify. Instead any
2036       // pass that uses the SCEVExpander must do it. This does not work well for
2037       // loop passes because SCEVExpander makes assumptions about all loops,
2038       // while LoopPassManager only forces the current loop to be simplified.
2039       //
2040       // FIXME: SCEV expansion has no way to bail out, so the caller must
2041       // explicitly check any assumptions made by SCEV. Brittle.
2042       const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(BackedgeTakenCount);
2043       if (!AR || AR->getLoop()->getLoopPreheader())
2044         (void)LinearFunctionTestReplace(L, BackedgeTakenCount, IndVar,
2045                                         Rewriter);
2046     }
2047   }
2048   // Clear the rewriter cache, because values that are in the rewriter's cache
2049   // can be deleted in the loop below, causing the AssertingVH in the cache to
2050   // trigger.
2051   Rewriter.clear();
2052
2053   // Now that we're done iterating through lists, clean up any instructions
2054   // which are now dead.
2055   while (!DeadInsts.empty())
2056     if (Instruction *Inst =
2057             dyn_cast_or_null<Instruction>(DeadInsts.pop_back_val()))
2058       RecursivelyDeleteTriviallyDeadInstructions(Inst, TLI);
2059
2060   // The Rewriter may not be used from this point on.
2061
2062   // Loop-invariant instructions in the preheader that aren't used in the
2063   // loop may be sunk below the loop to reduce register pressure.
2064   SinkUnusedInvariants(L);
2065
2066   // Clean up dead instructions.
2067   Changed |= DeleteDeadPHIs(L->getHeader(), TLI);
2068   // Check a post-condition.
2069   assert(L->isLCSSAForm(*DT) &&
2070          "Indvars did not leave the loop in lcssa form!");
2071
2072   // Verify that LFTR, and any other change have not interfered with SCEV's
2073   // ability to compute trip count.
2074 #ifndef NDEBUG
2075   if (VerifyIndvars && !isa<SCEVCouldNotCompute>(BackedgeTakenCount)) {
2076     SE->forgetLoop(L);
2077     const SCEV *NewBECount = SE->getBackedgeTakenCount(L);
2078     if (SE->getTypeSizeInBits(BackedgeTakenCount->getType()) <
2079         SE->getTypeSizeInBits(NewBECount->getType()))
2080       NewBECount = SE->getTruncateOrNoop(NewBECount,
2081                                          BackedgeTakenCount->getType());
2082     else
2083       BackedgeTakenCount = SE->getTruncateOrNoop(BackedgeTakenCount,
2084                                                  NewBECount->getType());
2085     assert(BackedgeTakenCount == NewBECount && "indvars must preserve SCEV");
2086   }
2087 #endif
2088
2089   return Changed;
2090 }