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