lib/Analysis/ScalarEvolutionExpander.cpp

   1 //===- ScalarEvolutionExpander.cpp - Scalar Evolution Analysis --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains the implementation of the scalar evolution expander,
  11 // which is used to generate the code corresponding to a given scalar evolution
  12 // expression.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "llvm/Analysis/ScalarEvolutionExpander.h"
  17 #include "llvm/ADT/SmallSet.h"
  18 #include "llvm/ADT/STLExtras.h"
  19 #include "llvm/Analysis/LoopInfo.h"
  20 #include "llvm/Analysis/TargetTransformInfo.h"
  21 #include "llvm/IR/DataLayout.h"
  22 #include "llvm/IR/IntrinsicInst.h"
  23 #include "llvm/IR/LLVMContext.h"
  24 #include "llvm/Support/Debug.h"
  25
  26 using namespace llvm;
  27
  28 /// ReuseOrCreateCast - Arrange for there to be a cast of V to Ty at IP,
  29 /// reusing an existing cast if a suitable one exists, moving an existing
  30 /// cast if a suitable one exists but isn't in the right place, or
  31 /// creating a new one.
  32 Value *SCEVExpander::ReuseOrCreateCast(Value *V, Type *Ty,
  33                                        Instruction::CastOps Op,
  34                                        BasicBlock::iterator IP) {
  35   // This function must be called with the builder having a valid insertion
  36   // point. It doesn't need to be the actual IP where the uses of the returned
  37   // cast will be added, but it must dominate such IP.
  38   // We use this precondition to produce a cast that will dominate all its
  39   // uses. In particular, this is crucial for the case where the builder's
  40   // insertion point *is* the point where we were asked to put the cast.
  41   // Since we don't know the builder's insertion point is actually
  42   // where the uses will be added (only that it dominates it), we are
  43   // not allowed to move it.
  44   BasicBlock::iterator BIP = Builder.GetInsertPoint();
  45
  46   Instruction *Ret = NULL;
  47
  48   // Check to see if there is already a cast!
  49   for (Value::use_iterator UI = V->use_begin(), E = V->use_end();
  50        UI != E; ++UI) {
  51     User *U = *UI;
  52     if (U->getType() == Ty)
  53       if (CastInst *CI = dyn_cast<CastInst>(U))
  54         if (CI->getOpcode() == Op) {
  55           // If the cast isn't where we want it, create a new cast at IP.
  56           // Likewise, do not reuse a cast at BIP because it must dominate
  57           // instructions that might be inserted before BIP.
  58           if (BasicBlock::iterator(CI) != IP || BIP == IP) {
  59             // Create a new cast, and leave the old cast in place in case
  60             // it is being used as an insert point. Clear its operand
  61             // so that it doesn't hold anything live.
  62             Ret = CastInst::Create(Op, V, Ty, "", IP);
  63             Ret->takeName(CI);
  64             CI->replaceAllUsesWith(Ret);
  65             CI->setOperand(0, UndefValue::get(V->getType()));
  66             break;
  67           }
  68           Ret = CI;
  69           break;
  70         }
  71   }
  72
  73   // Create a new cast.
  74   if (!Ret)
  75     Ret = CastInst::Create(Op, V, Ty, V->getName(), IP);
  76
  77   // We assert at the end of the function since IP might point to an
  78   // instruction with different dominance properties than a cast
  79   // (an invoke for example) and not dominate BIP (but the cast does).
  80   assert(SE.DT->dominates(Ret, BIP));
  81
  82   rememberInstruction(Ret);
  83   return Ret;
  84 }
  85
  86 /// InsertNoopCastOfTo - Insert a cast of V to the specified type,
  87 /// which must be possible with a noop cast, doing what we can to share
  88 /// the casts.
  89 Value *SCEVExpander::InsertNoopCastOfTo(Value *V, Type *Ty) {
  90   Instruction::CastOps Op = CastInst::getCastOpcode(V, false, Ty, false);
  91   assert((Op == Instruction::BitCast ||
  92           Op == Instruction::PtrToInt ||
  93           Op == Instruction::IntToPtr) &&
  94          "InsertNoopCastOfTo cannot perform non-noop casts!");
  95   assert(SE.getTypeSizeInBits(V->getType()) == SE.getTypeSizeInBits(Ty) &&
  96          "InsertNoopCastOfTo cannot change sizes!");
  97
  98   // Short-circuit unnecessary bitcasts.
  99   if (Op == Instruction::BitCast) {
 100     if (V->getType() == Ty)
 101       return V;
 102     if (CastInst *CI = dyn_cast<CastInst>(V)) {
 103       if (CI->getOperand(0)->getType() == Ty)
 104         return CI->getOperand(0);
 105     }
 106   }
 107   // Short-circuit unnecessary inttoptr<->ptrtoint casts.
 108   if ((Op == Instruction::PtrToInt || Op == Instruction::IntToPtr) &&
 109       SE.getTypeSizeInBits(Ty) == SE.getTypeSizeInBits(V->getType())) {
 110     if (CastInst *CI = dyn_cast<CastInst>(V))
 111       if ((CI->getOpcode() == Instruction::PtrToInt ||
 112            CI->getOpcode() == Instruction::IntToPtr) &&
 113           SE.getTypeSizeInBits(CI->getType()) ==
 114           SE.getTypeSizeInBits(CI->getOperand(0)->getType()))
 115         return CI->getOperand(0);
 116     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
 117       if ((CE->getOpcode() == Instruction::PtrToInt ||
 118            CE->getOpcode() == Instruction::IntToPtr) &&
 119           SE.getTypeSizeInBits(CE->getType()) ==
 120           SE.getTypeSizeInBits(CE->getOperand(0)->getType()))
 121         return CE->getOperand(0);
 122   }
 123
 124   // Fold a cast of a constant.
 125   if (Constant *C = dyn_cast<Constant>(V))
 126     return ConstantExpr::getCast(Op, C, Ty);
 127
 128   // Cast the argument at the beginning of the entry block, after
 129   // any bitcasts of other arguments.
 130   if (Argument *A = dyn_cast<Argument>(V)) {
 131     BasicBlock::iterator IP = A->getParent()->getEntryBlock().begin();
 132     while ((isa<BitCastInst>(IP) &&
 133             isa<Argument>(cast<BitCastInst>(IP)->getOperand(0)) &&
 134             cast<BitCastInst>(IP)->getOperand(0) != A) ||
 135            isa<DbgInfoIntrinsic>(IP) ||
 136            isa<LandingPadInst>(IP))
 137       ++IP;
 138     return ReuseOrCreateCast(A, Ty, Op, IP);
 139   }
 140
 141   // Cast the instruction immediately after the instruction.
 142   Instruction *I = cast<Instruction>(V);
 143   BasicBlock::iterator IP = I; ++IP;
 144   if (InvokeInst *II = dyn_cast<InvokeInst>(I))
 145     IP = II->getNormalDest()->begin();
 146   while (isa<PHINode>(IP) || isa<LandingPadInst>(IP))
 147     ++IP;
 148   return ReuseOrCreateCast(I, Ty, Op, IP);
 149 }
 150
 151 /// InsertBinop - Insert the specified binary operator, doing a small amount
 152 /// of work to avoid inserting an obviously redundant operation.
 153 Value *SCEVExpander::InsertBinop(Instruction::BinaryOps Opcode,
 154                                  Value *LHS, Value *RHS) {
 155   // Fold a binop with constant operands.
 156   if (Constant *CLHS = dyn_cast<Constant>(LHS))
 157     if (Constant *CRHS = dyn_cast<Constant>(RHS))
 158       return ConstantExpr::get(Opcode, CLHS, CRHS);
 159
 160   // Do a quick scan to see if we have this binop nearby.  If so, reuse it.
 161   unsigned ScanLimit = 6;
 162   BasicBlock::iterator BlockBegin = Builder.GetInsertBlock()->begin();
 163   // Scanning starts from the last instruction before the insertion point.
 164   BasicBlock::iterator IP = Builder.GetInsertPoint();
 165   if (IP != BlockBegin) {
 166     --IP;
 167     for (; ScanLimit; --IP, --ScanLimit) {
 168       // Don't count dbg.value against the ScanLimit, to avoid perturbing the
 169       // generated code.
 170       if (isa<DbgInfoIntrinsic>(IP))
 171         ScanLimit++;
 172       if (IP->getOpcode() == (unsigned)Opcode && IP->getOperand(0) == LHS &&
 173           IP->getOperand(1) == RHS)
 174         return IP;
 175       if (IP == BlockBegin) break;
 176     }
 177   }
 178
 179   // Save the original insertion point so we can restore it when we're done.
 180   BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
 181   BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
 182
 183   // Move the insertion point out of as many loops as we can.
 184   while (const Loop *L = SE.LI->getLoopFor(Builder.GetInsertBlock())) {
 185     if (!L->isLoopInvariant(LHS) || !L->isLoopInvariant(RHS)) break;
 186     BasicBlock *Preheader = L->getLoopPreheader();
 187     if (!Preheader) break;
 188
 189     // Ok, move up a level.
 190     Builder.SetInsertPoint(Preheader, Preheader->getTerminator());
 191   }
 192
 193   // If we haven't found this binop, insert it.
 194   Instruction *BO = cast<Instruction>(Builder.CreateBinOp(Opcode, LHS, RHS));
 195   BO->setDebugLoc(SaveInsertPt->getDebugLoc());
 196   rememberInstruction(BO);
 197
 198   // Restore the original insert point.
 199   if (SaveInsertBB)
 200     restoreInsertPoint(SaveInsertBB, SaveInsertPt);
 201
 202   return BO;
 203 }
 204
 205 /// FactorOutConstant - Test if S is divisible by Factor, using signed
 206 /// division. If so, update S with Factor divided out and return true.
 207 /// S need not be evenly divisible if a reasonable remainder can be
 208 /// computed.
 209 /// TODO: When ScalarEvolution gets a SCEVSDivExpr, this can be made
 210 /// unnecessary; in its place, just signed-divide Ops[i] by the scale and
 211 /// check to see if the divide was folded.
 212 static bool FactorOutConstant(const SCEV *&S,
 213                               const SCEV *&Remainder,
 214                               const SCEV *Factor,
 215                               ScalarEvolution &SE,
 216                               const DataLayout *TD) {
 217   // Everything is divisible by one.
 218   if (Factor->isOne())
 219     return true;
 220
 221   // x/x == 1.
 222   if (S == Factor) {
 223     S = SE.getConstant(S->getType(), 1);
 224     return true;
 225   }
 226
 227   // For a Constant, check for a multiple of the given factor.
 228   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S)) {
 229     // 0/x == 0.
 230     if (C->isZero())
 231       return true;
 232     // Check for divisibility.
 233     if (const SCEVConstant *FC = dyn_cast<SCEVConstant>(Factor)) {
 234       ConstantInt *CI =
 235         ConstantInt::get(SE.getContext(),
 236                          C->getValue()->getValue().sdiv(
 237                                                    FC->getValue()->getValue()));
 238       // If the quotient is zero and the remainder is non-zero, reject
 239       // the value at this scale. It will be considered for subsequent
 240       // smaller scales.
 241       if (!CI->isZero()) {
 242         const SCEV *Div = SE.getConstant(CI);
 243         S = Div;
 244         Remainder =
 245           SE.getAddExpr(Remainder,
 246                         SE.getConstant(C->getValue()->getValue().srem(
 247                                                   FC->getValue()->getValue())));
 248         return true;
 249       }
 250     }
 251   }
 252
 253   // In a Mul, check if there is a constant operand which is a multiple
 254   // of the given factor.
 255   if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(S)) {
 256     if (TD) {
 257       // With DataLayout, the size is known. Check if there is a constant
 258       // operand which is a multiple of the given factor. If so, we can
 259       // factor it.
 260       const SCEVConstant *FC = cast<SCEVConstant>(Factor);
 261       if (const SCEVConstant *C = dyn_cast<SCEVConstant>(M->getOperand(0)))
 262         if (!C->getValue()->getValue().srem(FC->getValue()->getValue())) {
 263           SmallVector<const SCEV *, 4> NewMulOps(M->op_begin(), M->op_end());
 264           NewMulOps[0] =
 265             SE.getConstant(C->getValue()->getValue().sdiv(
 266                                                    FC->getValue()->getValue()));
 267           S = SE.getMulExpr(NewMulOps);
 268           return true;
 269         }
 270     } else {
 271       // Without DataLayout, check if Factor can be factored out of any of the
 272       // Mul's operands. If so, we can just remove it.
 273       for (unsigned i = 0, e = M->getNumOperands(); i != e; ++i) {
 274         const SCEV *SOp = M->getOperand(i);
 275         const SCEV *Remainder = SE.getConstant(SOp->getType(), 0);
 276         if (FactorOutConstant(SOp, Remainder, Factor, SE, TD) &&
 277             Remainder->isZero()) {
 278           SmallVector<const SCEV *, 4> NewMulOps(M->op_begin(), M->op_end());
 279           NewMulOps[i] = SOp;
 280           S = SE.getMulExpr(NewMulOps);
 281           return true;
 282         }
 283       }
 284     }
 285   }
 286
 287   // In an AddRec, check if both start and step are divisible.
 288   if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(S)) {
 289     const SCEV *Step = A->getStepRecurrence(SE);
 290     const SCEV *StepRem = SE.getConstant(Step->getType(), 0);
 291     if (!FactorOutConstant(Step, StepRem, Factor, SE, TD))
 292       return false;
 293     if (!StepRem->isZero())
 294       return false;
 295     const SCEV *Start = A->getStart();
 296     if (!FactorOutConstant(Start, Remainder, Factor, SE, TD))
 297       return false;
 298     S = SE.getAddRecExpr(Start, Step, A->getLoop(),
 299                          A->getNoWrapFlags(SCEV::FlagNW));
 300     return true;
 301   }
 302
 303   return false;
 304 }
 305
 306 /// SimplifyAddOperands - Sort and simplify a list of add operands. NumAddRecs
 307 /// is the number of SCEVAddRecExprs present, which are kept at the end of
 308 /// the list.
 309 ///
 310 static void SimplifyAddOperands(SmallVectorImpl<const SCEV *> &Ops,
 311                                 Type *Ty,
 312                                 ScalarEvolution &SE) {
 313   unsigned NumAddRecs = 0;
 314   for (unsigned i = Ops.size(); i > 0 && isa<SCEVAddRecExpr>(Ops[i-1]); --i)
 315     ++NumAddRecs;
 316   // Group Ops into non-addrecs and addrecs.
 317   SmallVector<const SCEV *, 8> NoAddRecs(Ops.begin(), Ops.end() - NumAddRecs);
 318   SmallVector<const SCEV *, 8> AddRecs(Ops.end() - NumAddRecs, Ops.end());
 319   // Let ScalarEvolution sort and simplify the non-addrecs list.
 320   const SCEV *Sum = NoAddRecs.empty() ?
 321                     SE.getConstant(Ty, 0) :
 322                     SE.getAddExpr(NoAddRecs);
 323   // If it returned an add, use the operands. Otherwise it simplified
 324   // the sum into a single value, so just use that.
 325   Ops.clear();
 326   if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Sum))
 327     Ops.append(Add->op_begin(), Add->op_end());
 328   else if (!Sum->isZero())
 329     Ops.push_back(Sum);
 330   // Then append the addrecs.
 331   Ops.append(AddRecs.begin(), AddRecs.end());
 332 }
 333
 334 /// SplitAddRecs - Flatten a list of add operands, moving addrec start values
 335 /// out to the top level. For example, convert {a + b,+,c} to a, b, {0,+,d}.
 336 /// This helps expose more opportunities for folding parts of the expressions
 337 /// into GEP indices.
 338 ///
 339 static void SplitAddRecs(SmallVectorImpl<const SCEV *> &Ops,
 340                          Type *Ty,
 341                          ScalarEvolution &SE) {
 342   // Find the addrecs.
 343   SmallVector<const SCEV *, 8> AddRecs;
 344   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
 345     while (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(Ops[i])) {
 346       const SCEV *Start = A->getStart();
 347       if (Start->isZero()) break;
 348       const SCEV *Zero = SE.getConstant(Ty, 0);
 349       AddRecs.push_back(SE.getAddRecExpr(Zero,
 350                                          A->getStepRecurrence(SE),
 351                                          A->getLoop(),
 352                                          A->getNoWrapFlags(SCEV::FlagNW)));
 353       if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Start)) {
 354         Ops[i] = Zero;
 355         Ops.append(Add->op_begin(), Add->op_end());
 356         e += Add->getNumOperands();
 357       } else {
 358         Ops[i] = Start;
 359       }
 360     }
 361   if (!AddRecs.empty()) {
 362     // Add the addrecs onto the end of the list.
 363     Ops.append(AddRecs.begin(), AddRecs.end());
 364     // Resort the operand list, moving any constants to the front.
 365     SimplifyAddOperands(Ops, Ty, SE);
 366   }
 367 }
 368
 369 /// expandAddToGEP - Expand an addition expression with a pointer type into
 370 /// a GEP instead of using ptrtoint+arithmetic+inttoptr. This helps
 371 /// BasicAliasAnalysis and other passes analyze the result. See the rules
 372 /// for getelementptr vs. inttoptr in
 373 /// http://llvm.org/docs/LangRef.html#pointeraliasing
 374 /// for details.
 375 ///
 376 /// Design note: The correctness of using getelementptr here depends on
 377 /// ScalarEvolution not recognizing inttoptr and ptrtoint operators, as
 378 /// they may introduce pointer arithmetic which may not be safely converted
 379 /// into getelementptr.
 380 ///
 381 /// Design note: It might seem desirable for this function to be more
 382 /// loop-aware. If some of the indices are loop-invariant while others
 383 /// aren't, it might seem desirable to emit multiple GEPs, keeping the
 384 /// loop-invariant portions of the overall computation outside the loop.
 385 /// However, there are a few reasons this is not done here. Hoisting simple
 386 /// arithmetic is a low-level optimization that often isn't very
 387 /// important until late in the optimization process. In fact, passes
 388 /// like InstructionCombining will combine GEPs, even if it means
 389 /// pushing loop-invariant computation down into loops, so even if the
 390 /// GEPs were split here, the work would quickly be undone. The
 391 /// LoopStrengthReduction pass, which is usually run quite late (and
 392 /// after the last InstructionCombining pass), takes care of hoisting
 393 /// loop-invariant portions of expressions, after considering what
 394 /// can be folded using target addressing modes.
 395 ///
 396 Value *SCEVExpander::expandAddToGEP(const SCEV *const *op_begin,
 397                                     const SCEV *const *op_end,
 398                                     PointerType *PTy,
 399                                     Type *Ty,
 400                                     Value *V) {
 401   Type *ElTy = PTy->getElementType();
 402   SmallVector<Value *, 4> GepIndices;
 403   SmallVector<const SCEV *, 8> Ops(op_begin, op_end);
 404   bool AnyNonZeroIndices = false;
 405
 406   // Split AddRecs up into parts as either of the parts may be usable
 407   // without the other.
 408   SplitAddRecs(Ops, Ty, SE);
 409
 410   Type *IntPtrTy = SE.TD
 411                  ? SE.TD->getIntPtrType(PTy)
 412                  : Type::getInt64Ty(PTy->getContext());
 413
 414   // Descend down the pointer's type and attempt to convert the other
 415   // operands into GEP indices, at each level. The first index in a GEP
 416   // indexes into the array implied by the pointer operand; the rest of
 417   // the indices index into the element or field type selected by the
 418   // preceding index.
 419   for (;;) {
 420     // If the scale size is not 0, attempt to factor out a scale for
 421     // array indexing.
 422     SmallVector<const SCEV *, 8> ScaledOps;
 423     if (ElTy->isSized()) {
 424       const SCEV *ElSize = SE.getSizeOfExpr(IntPtrTy, ElTy);
 425       if (!ElSize->isZero()) {
 426         SmallVector<const SCEV *, 8> NewOps;
 427         for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
 428           const SCEV *Op = Ops[i];
 429           const SCEV *Remainder = SE.getConstant(Ty, 0);
 430           if (FactorOutConstant(Op, Remainder, ElSize, SE, SE.TD)) {
 431             // Op now has ElSize factored out.
 432             ScaledOps.push_back(Op);
 433             if (!Remainder->isZero())
 434               NewOps.push_back(Remainder);
 435             AnyNonZeroIndices = true;
 436           } else {
 437             // The operand was not divisible, so add it to the list of operands
 438             // we'll scan next iteration.
 439             NewOps.push_back(Ops[i]);
 440           }
 441         }
 442         // If we made any changes, update Ops.
 443         if (!ScaledOps.empty()) {
 444           Ops = NewOps;
 445           SimplifyAddOperands(Ops, Ty, SE);
 446         }
 447       }
 448     }
 449
 450     // Record the scaled array index for this level of the type. If
 451     // we didn't find any operands that could be factored, tentatively
 452     // assume that element zero was selected (since the zero offset
 453     // would obviously be folded away).
 454     Value *Scaled = ScaledOps.empty() ?
 455                     Constant::getNullValue(Ty) :
 456                     expandCodeFor(SE.getAddExpr(ScaledOps), Ty);
 457     GepIndices.push_back(Scaled);
 458
 459     // Collect struct field index operands.
 460     while (StructType *STy = dyn_cast<StructType>(ElTy)) {
 461       bool FoundFieldNo = false;
 462       // An empty struct has no fields.
 463       if (STy->getNumElements() == 0) break;
 464       if (SE.TD) {
 465         // With DataLayout, field offsets are known. See if a constant offset
 466         // falls within any of the struct fields.
 467         if (Ops.empty()) break;
 468         if (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[0]))
 469           if (SE.getTypeSizeInBits(C->getType()) <= 64) {
 470             const StructLayout &SL = *SE.TD->getStructLayout(STy);
 471             uint64_t FullOffset = C->getValue()->getZExtValue();
 472             if (FullOffset < SL.getSizeInBytes()) {
 473               unsigned ElIdx = SL.getElementContainingOffset(FullOffset);
 474               GepIndices.push_back(
 475                   ConstantInt::get(Type::getInt32Ty(Ty->getContext()), ElIdx));
 476               ElTy = STy->getTypeAtIndex(ElIdx);
 477               Ops[0] =
 478                 SE.getConstant(Ty, FullOffset - SL.getElementOffset(ElIdx));
 479               AnyNonZeroIndices = true;
 480               FoundFieldNo = true;
 481             }
 482           }
 483       } else {
 484         // Without DataLayout, just check for an offsetof expression of the
 485         // appropriate struct type.
 486         for (unsigned i = 0, e = Ops.size(); i != e; ++i)
 487           if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(Ops[i])) {
 488             Type *CTy;
 489             Constant *FieldNo;
 490             if (U->isOffsetOf(CTy, FieldNo) && CTy == STy) {
 491               GepIndices.push_back(FieldNo);
 492               ElTy =
 493                 STy->getTypeAtIndex(cast<ConstantInt>(FieldNo)->getZExtValue());
 494               Ops[i] = SE.getConstant(Ty, 0);
 495               AnyNonZeroIndices = true;
 496               FoundFieldNo = true;
 497               break;
 498             }
 499           }
 500       }
 501       // If no struct field offsets were found, tentatively assume that
 502       // field zero was selected (since the zero offset would obviously
 503       // be folded away).
 504       if (!FoundFieldNo) {
 505         ElTy = STy->getTypeAtIndex(0u);
 506         GepIndices.push_back(
 507           Constant::getNullValue(Type::getInt32Ty(Ty->getContext())));
 508       }
 509     }
 510
 511     if (ArrayType *ATy = dyn_cast<ArrayType>(ElTy))
 512       ElTy = ATy->getElementType();
 513     else
 514       break;
 515   }
 516
 517   // If none of the operands were convertible to proper GEP indices, cast
 518   // the base to i8* and do an ugly getelementptr with that. It's still
 519   // better than ptrtoint+arithmetic+inttoptr at least.
 520   if (!AnyNonZeroIndices) {
 521     // Cast the base to i8*.
 522     V = InsertNoopCastOfTo(V,
 523        Type::getInt8PtrTy(Ty->getContext(), PTy->getAddressSpace()));
 524
 525     assert(!isa<Instruction>(V) ||
 526            SE.DT->dominates(cast<Instruction>(V), Builder.GetInsertPoint()));
 527
 528     // Expand the operands for a plain byte offset.
 529     Value *Idx = expandCodeFor(SE.getAddExpr(Ops), Ty);
 530
 531     // Fold a GEP with constant operands.
 532     if (Constant *CLHS = dyn_cast<Constant>(V))
 533       if (Constant *CRHS = dyn_cast<Constant>(Idx))
 534         return ConstantExpr::getGetElementPtr(CLHS, CRHS);
 535
 536     // Do a quick scan to see if we have this GEP nearby.  If so, reuse it.
 537     unsigned ScanLimit = 6;
 538     BasicBlock::iterator BlockBegin = Builder.GetInsertBlock()->begin();
 539     // Scanning starts from the last instruction before the insertion point.
 540     BasicBlock::iterator IP = Builder.GetInsertPoint();
 541     if (IP != BlockBegin) {
 542       --IP;
 543       for (; ScanLimit; --IP, --ScanLimit) {
 544         // Don't count dbg.value against the ScanLimit, to avoid perturbing the
 545         // generated code.
 546         if (isa<DbgInfoIntrinsic>(IP))
 547           ScanLimit++;
 548         if (IP->getOpcode() == Instruction::GetElementPtr &&
 549             IP->getOperand(0) == V && IP->getOperand(1) == Idx)
 550           return IP;
 551         if (IP == BlockBegin) break;
 552       }
 553     }
 554
 555     // Save the original insertion point so we can restore it when we're done.
 556     BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
 557     BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
 558
 559     // Move the insertion point out of as many loops as we can.
 560     while (const Loop *L = SE.LI->getLoopFor(Builder.GetInsertBlock())) {
 561       if (!L->isLoopInvariant(V) || !L->isLoopInvariant(Idx)) break;
 562       BasicBlock *Preheader = L->getLoopPreheader();
 563       if (!Preheader) break;
 564
 565       // Ok, move up a level.
 566       Builder.SetInsertPoint(Preheader, Preheader->getTerminator());
 567     }
 568
 569     // Emit a GEP.
 570     Value *GEP = Builder.CreateGEP(V, Idx, "uglygep");
 571     rememberInstruction(GEP);
 572
 573     // Restore the original insert point.
 574     if (SaveInsertBB)
 575       restoreInsertPoint(SaveInsertBB, SaveInsertPt);
 576
 577     return GEP;
 578   }
 579
 580   // Save the original insertion point so we can restore it when we're done.
 581   BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
 582   BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
 583
 584   // Move the insertion point out of as many loops as we can.
 585   while (const Loop *L = SE.LI->getLoopFor(Builder.GetInsertBlock())) {
 586     if (!L->isLoopInvariant(V)) break;
 587
 588     bool AnyIndexNotLoopInvariant = false;
 589     for (SmallVectorImpl<Value *>::const_iterator I = GepIndices.begin(),
 590          E = GepIndices.end(); I != E; ++I)
 591       if (!L->isLoopInvariant(*I)) {
 592         AnyIndexNotLoopInvariant = true;
 593         break;
 594       }
 595     if (AnyIndexNotLoopInvariant)
 596       break;
 597
 598     BasicBlock *Preheader = L->getLoopPreheader();
 599     if (!Preheader) break;
 600
 601     // Ok, move up a level.
 602     Builder.SetInsertPoint(Preheader, Preheader->getTerminator());
 603   }
 604
 605   // Insert a pretty getelementptr. Note that this GEP is not marked inbounds,
 606   // because ScalarEvolution may have changed the address arithmetic to
 607   // compute a value which is beyond the end of the allocated object.
 608   Value *Casted = V;
 609   if (V->getType() != PTy)
 610     Casted = InsertNoopCastOfTo(Casted, PTy);
 611   Value *GEP = Builder.CreateGEP(Casted,
 612                                  GepIndices,
 613                                  "scevgep");
 614   Ops.push_back(SE.getUnknown(GEP));
 615   rememberInstruction(GEP);
 616
 617   // Restore the original insert point.
 618   if (SaveInsertBB)
 619     restoreInsertPoint(SaveInsertBB, SaveInsertPt);
 620
 621   return expand(SE.getAddExpr(Ops));
 622 }
 623
 624 /// PickMostRelevantLoop - Given two loops pick the one that's most relevant for
 625 /// SCEV expansion. If they are nested, this is the most nested. If they are
 626 /// neighboring, pick the later.
 627 static const Loop *PickMostRelevantLoop(const Loop *A, const Loop *B,
 628                                         DominatorTree &DT) {
 629   if (!A) return B;
 630   if (!B) return A;
 631   if (A->contains(B)) return B;
 632   if (B->contains(A)) return A;
 633   if (DT.dominates(A->getHeader(), B->getHeader())) return B;
 634   if (DT.dominates(B->getHeader(), A->getHeader())) return A;
 635   return A; // Arbitrarily break the tie.
 636 }
 637
 638 /// getRelevantLoop - Get the most relevant loop associated with the given
 639 /// expression, according to PickMostRelevantLoop.
 640 const Loop *SCEVExpander::getRelevantLoop(const SCEV *S) {
 641   // Test whether we've already computed the most relevant loop for this SCEV.
 642   std::pair<DenseMap<const SCEV *, const Loop *>::iterator, bool> Pair =
 643     RelevantLoops.insert(std::make_pair(S, static_cast<const Loop *>(0)));
 644   if (!Pair.second)
 645     return Pair.first->second;
 646
 647   if (isa<SCEVConstant>(S))
 648     // A constant has no relevant loops.
 649     return 0;
 650   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
 651     if (const Instruction *I = dyn_cast<Instruction>(U->getValue()))
 652       return Pair.first->second = SE.LI->getLoopFor(I->getParent());
 653     // A non-instruction has no relevant loops.
 654     return 0;
 655   }
 656   if (const SCEVNAryExpr *N = dyn_cast<SCEVNAryExpr>(S)) {
 657     const Loop *L = 0;
 658     if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S))
 659       L = AR->getLoop();
 660     for (SCEVNAryExpr::op_iterator I = N->op_begin(), E = N->op_end();
 661          I != E; ++I)
 662       L = PickMostRelevantLoop(L, getRelevantLoop(*I), *SE.DT);
 663     return RelevantLoops[N] = L;
 664   }
 665   if (const SCEVCastExpr *C = dyn_cast<SCEVCastExpr>(S)) {
 666     const Loop *Result = getRelevantLoop(C->getOperand());
 667     return RelevantLoops[C] = Result;
 668   }
 669   if (const SCEVUDivExpr *D = dyn_cast<SCEVUDivExpr>(S)) {
 670     const Loop *Result =
 671       PickMostRelevantLoop(getRelevantLoop(D->getLHS()),
 672                            getRelevantLoop(D->getRHS()),
 673                            *SE.DT);
 674     return RelevantLoops[D] = Result;
 675   }
 676   llvm_unreachable("Unexpected SCEV type!");
 677 }
 678
 679 namespace {
 680
 681 /// LoopCompare - Compare loops by PickMostRelevantLoop.
 682 class LoopCompare {
 683   DominatorTree &DT;
 684 public:
 685   explicit LoopCompare(DominatorTree &dt) : DT(dt) {}
 686
 687   bool operator()(std::pair<const Loop *, const SCEV *> LHS,
 688                   std::pair<const Loop *, const SCEV *> RHS) const {
 689     // Keep pointer operands sorted at the end.
 690     if (LHS.second->getType()->isPointerTy() !=
 691         RHS.second->getType()->isPointerTy())
 692       return LHS.second->getType()->isPointerTy();
 693
 694     // Compare loops with PickMostRelevantLoop.
 695     if (LHS.first != RHS.first)
 696       return PickMostRelevantLoop(LHS.first, RHS.first, DT) != LHS.first;
 697
 698     // If one operand is a non-constant negative and the other is not,
 699     // put the non-constant negative on the right so that a sub can
 700     // be used instead of a negate and add.
 701     if (LHS.second->isNonConstantNegative()) {
 702       if (!RHS.second->isNonConstantNegative())
 703         return false;
 704     } else if (RHS.second->isNonConstantNegative())
 705       return true;
 706
 707     // Otherwise they are equivalent according to this comparison.
 708     return false;
 709   }
 710 };
 711
 712 }
 713
 714 Value *SCEVExpander::visitAddExpr(const SCEVAddExpr *S) {
 715   Type *Ty = SE.getEffectiveSCEVType(S->getType());
 716
 717   // Collect all the add operands in a loop, along with their associated loops.
 718   // Iterate in reverse so that constants are emitted last, all else equal, and
 719   // so that pointer operands are inserted first, which the code below relies on
 720   // to form more involved GEPs.
 721   SmallVector<std::pair<const Loop *, const SCEV *>, 8> OpsAndLoops;
 722   for (std::reverse_iterator<SCEVAddExpr::op_iterator> I(S->op_end()),
 723        E(S->op_begin()); I != E; ++I)
 724     OpsAndLoops.push_back(std::make_pair(getRelevantLoop(*I), *I));
 725
 726   // Sort by loop. Use a stable sort so that constants follow non-constants and
 727   // pointer operands precede non-pointer operands.
 728   std::stable_sort(OpsAndLoops.begin(), OpsAndLoops.end(), LoopCompare(*SE.DT));
 729
 730   // Emit instructions to add all the operands. Hoist as much as possible
 731   // out of loops, and form meaningful getelementptrs where possible.
 732   Value *Sum = 0;
 733   for (SmallVectorImpl<std::pair<const Loop *, const SCEV *> >::iterator
 734        I = OpsAndLoops.begin(), E = OpsAndLoops.end(); I != E; ) {
 735     const Loop *CurLoop = I->first;
 736     const SCEV *Op = I->second;
 737     if (!Sum) {
 738       // This is the first operand. Just expand it.
 739       Sum = expand(Op);
 740       ++I;
 741     } else if (PointerType *PTy = dyn_cast<PointerType>(Sum->getType())) {
 742       // The running sum expression is a pointer. Try to form a getelementptr
 743       // at this level with that as the base.
 744       SmallVector<const SCEV *, 4> NewOps;
 745       for (; I != E && I->first == CurLoop; ++I) {
 746         // If the operand is SCEVUnknown and not instructions, peek through
 747         // it, to enable more of it to be folded into the GEP.
 748         const SCEV *X = I->second;
 749         if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(X))
 750           if (!isa<Instruction>(U->getValue()))
 751             X = SE.getSCEV(U->getValue());
 752         NewOps.push_back(X);
 753       }
 754       Sum = expandAddToGEP(NewOps.begin(), NewOps.end(), PTy, Ty, Sum);
 755     } else if (PointerType *PTy = dyn_cast<PointerType>(Op->getType())) {
 756       // The running sum is an integer, and there's a pointer at this level.
 757       // Try to form a getelementptr. If the running sum is instructions,
 758       // use a SCEVUnknown to avoid re-analyzing them.
 759       SmallVector<const SCEV *, 4> NewOps;
 760       NewOps.push_back(isa<Instruction>(Sum) ? SE.getUnknown(Sum) :
 761                                                SE.getSCEV(Sum));
 762       for (++I; I != E && I->first == CurLoop; ++I)
 763         NewOps.push_back(I->second);
 764       Sum = expandAddToGEP(NewOps.begin(), NewOps.end(), PTy, Ty, expand(Op));
 765     } else if (Op->isNonConstantNegative()) {
 766       // Instead of doing a negate and add, just do a subtract.
 767       Value *W = expandCodeFor(SE.getNegativeSCEV(Op), Ty);
 768       Sum = InsertNoopCastOfTo(Sum, Ty);
 769       Sum = InsertBinop(Instruction::Sub, Sum, W);
 770       ++I;
 771     } else {
 772       // A simple add.
 773       Value *W = expandCodeFor(Op, Ty);
 774       Sum = InsertNoopCastOfTo(Sum, Ty);
 775       // Canonicalize a constant to the RHS.
 776       if (isa<Constant>(Sum)) std::swap(Sum, W);
 777       Sum = InsertBinop(Instruction::Add, Sum, W);
 778       ++I;
 779     }
 780   }
 781
 782   return Sum;
 783 }
 784
 785 Value *SCEVExpander::visitMulExpr(const SCEVMulExpr *S) {
 786   Type *Ty = SE.getEffectiveSCEVType(S->getType());
 787
 788   // Collect all the mul operands in a loop, along with their associated loops.
 789   // Iterate in reverse so that constants are emitted last, all else equal.
 790   SmallVector<std::pair<const Loop *, const SCEV *>, 8> OpsAndLoops;
 791   for (std::reverse_iterator<SCEVMulExpr::op_iterator> I(S->op_end()),
 792        E(S->op_begin()); I != E; ++I)
 793     OpsAndLoops.push_back(std::make_pair(getRelevantLoop(*I), *I));
 794
 795   // Sort by loop. Use a stable sort so that constants follow non-constants.
 796   std::stable_sort(OpsAndLoops.begin(), OpsAndLoops.end(), LoopCompare(*SE.DT));
 797
 798   // Emit instructions to mul all the operands. Hoist as much as possible
 799   // out of loops.
 800   Value *Prod = 0;
 801   for (SmallVectorImpl<std::pair<const Loop *, const SCEV *> >::iterator
 802        I = OpsAndLoops.begin(), E = OpsAndLoops.end(); I != E; ) {
 803     const SCEV *Op = I->second;
 804     if (!Prod) {
 805       // This is the first operand. Just expand it.
 806       Prod = expand(Op);
 807       ++I;
 808     } else if (Op->isAllOnesValue()) {
 809       // Instead of doing a multiply by negative one, just do a negate.
 810       Prod = InsertNoopCastOfTo(Prod, Ty);
 811       Prod = InsertBinop(Instruction::Sub, Constant::getNullValue(Ty), Prod);
 812       ++I;
 813     } else {
 814       // A simple mul.
 815       Value *W = expandCodeFor(Op, Ty);
 816       Prod = InsertNoopCastOfTo(Prod, Ty);
 817       // Canonicalize a constant to the RHS.
 818       if (isa<Constant>(Prod)) std::swap(Prod, W);
 819       Prod = InsertBinop(Instruction::Mul, Prod, W);
 820       ++I;
 821     }
 822   }
 823
 824   return Prod;
 825 }
 826
 827 Value *SCEVExpander::visitUDivExpr(const SCEVUDivExpr *S) {
 828   Type *Ty = SE.getEffectiveSCEVType(S->getType());
 829
 830   Value *LHS = expandCodeFor(S->getLHS(), Ty);
 831   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(S->getRHS())) {
 832     const APInt &RHS = SC->getValue()->getValue();
 833     if (RHS.isPowerOf2())
 834       return InsertBinop(Instruction::LShr, LHS,
 835                          ConstantInt::get(Ty, RHS.logBase2()));
 836   }
 837
 838   Value *RHS = expandCodeFor(S->getRHS(), Ty);
 839   return InsertBinop(Instruction::UDiv, LHS, RHS);
 840 }
 841
 842 /// Move parts of Base into Rest to leave Base with the minimal
 843 /// expression that provides a pointer operand suitable for a
 844 /// GEP expansion.
 845 static void ExposePointerBase(const SCEV *&Base, const SCEV *&Rest,
 846                               ScalarEvolution &SE) {
 847   while (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(Base)) {
 848     Base = A->getStart();
 849     Rest = SE.getAddExpr(Rest,
 850                          SE.getAddRecExpr(SE.getConstant(A->getType(), 0),
 851                                           A->getStepRecurrence(SE),
 852                                           A->getLoop(),
 853                                           A->getNoWrapFlags(SCEV::FlagNW)));
 854   }
 855   if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(Base)) {
 856     Base = A->getOperand(A->getNumOperands()-1);
 857     SmallVector<const SCEV *, 8> NewAddOps(A->op_begin(), A->op_end());
 858     NewAddOps.back() = Rest;
 859     Rest = SE.getAddExpr(NewAddOps);
 860     ExposePointerBase(Base, Rest, SE);
 861   }
 862 }
 863
 864 /// Determine if this is a well-behaved chain of instructions leading back to
 865 /// the PHI. If so, it may be reused by expanded expressions.
 866 bool SCEVExpander::isNormalAddRecExprPHI(PHINode *PN, Instruction *IncV,
 867                                          const Loop *L) {
 868   if (IncV->getNumOperands() == 0 || isa<PHINode>(IncV) ||
 869       (isa<CastInst>(IncV) && !isa<BitCastInst>(IncV)))
 870     return false;
 871   // If any of the operands don't dominate the insert position, bail.
 872   // Addrec operands are always loop-invariant, so this can only happen
 873   // if there are instructions which haven't been hoisted.
 874   if (L == IVIncInsertLoop) {
 875     for (User::op_iterator OI = IncV->op_begin()+1,
 876            OE = IncV->op_end(); OI != OE; ++OI)
 877       if (Instruction *OInst = dyn_cast<Instruction>(OI))
 878         if (!SE.DT->dominates(OInst, IVIncInsertPos))
 879           return false;
 880   }
 881   // Advance to the next instruction.
 882   IncV = dyn_cast<Instruction>(IncV->getOperand(0));
 883   if (!IncV)
 884     return false;
 885
 886   if (IncV->mayHaveSideEffects())
 887     return false;
 888
 889   if (IncV != PN)
 890     return true;
 891
 892   return isNormalAddRecExprPHI(PN, IncV, L);
 893 }
 894
 895 /// getIVIncOperand returns an induction variable increment's induction
 896 /// variable operand.
 897 ///
 898 /// If allowScale is set, any type of GEP is allowed as long as the nonIV
 899 /// operands dominate InsertPos.
 900 ///
 901 /// If allowScale is not set, ensure that a GEP increment conforms to one of the
 902 /// simple patterns generated by getAddRecExprPHILiterally and
 903 /// expandAddtoGEP. If the pattern isn't recognized, return NULL.
 904 Instruction *SCEVExpander::getIVIncOperand(Instruction *IncV,
 905                                            Instruction *InsertPos,
 906                                            bool allowScale) {
 907   if (IncV == InsertPos)
 908     return NULL;
 909
 910   switch (IncV->getOpcode()) {
 911   default:
 912     return NULL;
 913   // Check for a simple Add/Sub or GEP of a loop invariant step.
 914   case Instruction::Add:
 915   case Instruction::Sub: {
 916     Instruction *OInst = dyn_cast<Instruction>(IncV->getOperand(1));
 917     if (!OInst || SE.DT->dominates(OInst, InsertPos))
 918       return dyn_cast<Instruction>(IncV->getOperand(0));
 919     return NULL;
 920   }
 921   case Instruction::BitCast:
 922     return dyn_cast<Instruction>(IncV->getOperand(0));
 923   case Instruction::GetElementPtr:
 924     for (Instruction::op_iterator I = IncV->op_begin()+1, E = IncV->op_end();
 925          I != E; ++I) {
 926       if (isa<Constant>(*I))
 927         continue;
 928       if (Instruction *OInst = dyn_cast<Instruction>(*I)) {
 929         if (!SE.DT->dominates(OInst, InsertPos))
 930           return NULL;
 931       }
 932       if (allowScale) {
 933         // allow any kind of GEP as long as it can be hoisted.
 934         continue;
 935       }
 936       // This must be a pointer addition of constants (pretty), which is already
 937       // handled, or some number of address-size elements (ugly). Ugly geps
 938       // have 2 operands. i1* is used by the expander to represent an
 939       // address-size element.
 940       if (IncV->getNumOperands() != 2)
 941         return NULL;
 942       unsigned AS = cast<PointerType>(IncV->getType())->getAddressSpace();
 943       if (IncV->getType() != Type::getInt1PtrTy(SE.getContext(), AS)
 944           && IncV->getType() != Type::getInt8PtrTy(SE.getContext(), AS))
 945         return NULL;
 946       break;
 947     }
 948     return dyn_cast<Instruction>(IncV->getOperand(0));
 949   }
 950 }
 951
 952 /// hoistStep - Attempt to hoist a simple IV increment above InsertPos to make
 953 /// it available to other uses in this loop. Recursively hoist any operands,
 954 /// until we reach a value that dominates InsertPos.
 955 bool SCEVExpander::hoistIVInc(Instruction *IncV, Instruction *InsertPos) {
 956   if (SE.DT->dominates(IncV, InsertPos))
 957       return true;
 958
 959   // InsertPos must itself dominate IncV so that IncV's new position satisfies
 960   // its existing users.
 961   if (isa<PHINode>(InsertPos)
 962       || !SE.DT->dominates(InsertPos->getParent(), IncV->getParent()))
 963     return false;
 964
 965   // Check that the chain of IV operands leading back to Phi can be hoisted.
 966   SmallVector<Instruction*, 4> IVIncs;
 967   for(;;) {
 968     Instruction *Oper = getIVIncOperand(IncV, InsertPos, /*allowScale*/true);
 969     if (!Oper)
 970       return false;
 971     // IncV is safe to hoist.
 972     IVIncs.push_back(IncV);
 973     IncV = Oper;
 974     if (SE.DT->dominates(IncV, InsertPos))
 975       break;
 976   }
 977   for (SmallVectorImpl<Instruction*>::reverse_iterator I = IVIncs.rbegin(),
 978          E = IVIncs.rend(); I != E; ++I) {
 979     (*I)->moveBefore(InsertPos);
 980   }
 981   return true;
 982 }
 983
 984 /// Determine if this cyclic phi is in a form that would have been generated by
 985 /// LSR. We don't care if the phi was actually expanded in this pass, as long
 986 /// as it is in a low-cost form, for example, no implied multiplication. This
 987 /// should match any patterns generated by getAddRecExprPHILiterally and
 988 /// expandAddtoGEP.
 989 bool SCEVExpander::isExpandedAddRecExprPHI(PHINode *PN, Instruction *IncV,
 990                                            const Loop *L) {
 991   for(Instruction *IVOper = IncV;
 992       (IVOper = getIVIncOperand(IVOper, L->getLoopPreheader()->getTerminator(),
 993                                 /*allowScale=*/false));) {
 994     if (IVOper == PN)
 995       return true;
 996   }
 997   return false;
 998 }
 999
1000 /// expandIVInc - Expand an IV increment at Builder's current InsertPos.
1001 /// Typically this is the LatchBlock terminator or IVIncInsertPos, but we may
1002 /// need to materialize IV increments elsewhere to handle difficult situations.
1003 Value *SCEVExpander::expandIVInc(PHINode *PN, Value *StepV, const Loop *L,
1004                                  Type *ExpandTy, Type *IntTy,
1005                                  bool useSubtract) {
1006   Value *IncV;
1007   // If the PHI is a pointer, use a GEP, otherwise use an add or sub.
1008   if (ExpandTy->isPointerTy()) {
1009     PointerType *GEPPtrTy = cast<PointerType>(ExpandTy);
1010     // If the step isn't constant, don't use an implicitly scaled GEP, because
1011     // that would require a multiply inside the loop.
1012     if (!isa<ConstantInt>(StepV))
1013       GEPPtrTy = PointerType::get(Type::getInt1Ty(SE.getContext()),
1014                                   GEPPtrTy->getAddressSpace());
1015     const SCEV *const StepArray[1] = { SE.getSCEV(StepV) };
1016     IncV = expandAddToGEP(StepArray, StepArray+1, GEPPtrTy, IntTy, PN);
1017     if (IncV->getType() != PN->getType()) {
1018       IncV = Builder.CreateBitCast(IncV, PN->getType());
1019       rememberInstruction(IncV);
1020     }
1021   } else {
1022     IncV = useSubtract ?
1023       Builder.CreateSub(PN, StepV, Twine(IVName) + ".iv.next") :
1024       Builder.CreateAdd(PN, StepV, Twine(IVName) + ".iv.next");
1025     rememberInstruction(IncV);
1026   }
1027   return IncV;
1028 }
1029
1030 /// getAddRecExprPHILiterally - Helper for expandAddRecExprLiterally. Expand
1031 /// the base addrec, which is the addrec without any non-loop-dominating
1032 /// values, and return the PHI.
1033 PHINode *
1034 SCEVExpander::getAddRecExprPHILiterally(const SCEVAddRecExpr *Normalized,
1035                                         const Loop *L,
1036                                         Type *ExpandTy,
1037                                         Type *IntTy) {
1038   assert((!IVIncInsertLoop||IVIncInsertPos) && "Uninitialized insert position");
1039
1040   // Reuse a previously-inserted PHI, if present.
1041   BasicBlock *LatchBlock = L->getLoopLatch();
1042   if (LatchBlock) {
1043     for (BasicBlock::iterator I = L->getHeader()->begin();
1044          PHINode *PN = dyn_cast<PHINode>(I); ++I) {
1045       if (!SE.isSCEVable(PN->getType()) ||
1046           (SE.getEffectiveSCEVType(PN->getType()) !=
1047            SE.getEffectiveSCEVType(Normalized->getType())) ||
1048           SE.getSCEV(PN) != Normalized)
1049         continue;
1050
1051       Instruction *IncV =
1052         cast<Instruction>(PN->getIncomingValueForBlock(LatchBlock));
1053
1054       if (LSRMode) {
1055         if (!isExpandedAddRecExprPHI(PN, IncV, L))
1056           continue;
1057         if (L == IVIncInsertLoop && !hoistIVInc(IncV, IVIncInsertPos))
1058           continue;
1059       }
1060       else {
1061         if (!isNormalAddRecExprPHI(PN, IncV, L))
1062           continue;
1063         if (L == IVIncInsertLoop)
1064           do {
1065             if (SE.DT->dominates(IncV, IVIncInsertPos))
1066               break;
1067             // Make sure the increment is where we want it. But don't move it
1068             // down past a potential existing post-inc user.
1069             IncV->moveBefore(IVIncInsertPos);
1070             IVIncInsertPos = IncV;
1071             IncV = cast<Instruction>(IncV->getOperand(0));
1072           } while (IncV != PN);
1073       }
1074       // Ok, the add recurrence looks usable.
1075       // Remember this PHI, even in post-inc mode.
1076       InsertedValues.insert(PN);
1077       // Remember the increment.
1078       rememberInstruction(IncV);
1079       return PN;
1080     }
1081   }
1082
1083   // Save the original insertion point so we can restore it when we're done.
1084   BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
1085   BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
1086
1087   // Another AddRec may need to be recursively expanded below. For example, if
1088   // this AddRec is quadratic, the StepV may itself be an AddRec in this
1089   // loop. Remove this loop from the PostIncLoops set before expanding such
1090   // AddRecs. Otherwise, we cannot find a valid position for the step
1091   // (i.e. StepV can never dominate its loop header).  Ideally, we could do
1092   // SavedIncLoops.swap(PostIncLoops), but we generally have a single element,
1093   // so it's not worth implementing SmallPtrSet::swap.
1094   PostIncLoopSet SavedPostIncLoops = PostIncLoops;
1095   PostIncLoops.clear();
1096
1097   // Expand code for the start value.
1098   Value *StartV = expandCodeFor(Normalized->getStart(), ExpandTy,
1099                                 L->getHeader()->begin());
1100
1101   // StartV must be hoisted into L's preheader to dominate the new phi.
1102   assert(!isa<Instruction>(StartV) ||
1103          SE.DT->properlyDominates(cast<Instruction>(StartV)->getParent(),
1104                                   L->getHeader()));
1105
1106   // Expand code for the step value. Do this before creating the PHI so that PHI
1107   // reuse code doesn't see an incomplete PHI.
1108   const SCEV *Step = Normalized->getStepRecurrence(SE);
1109   // If the stride is negative, insert a sub instead of an add for the increment
1110   // (unless it's a constant, because subtracts of constants are canonicalized
1111   // to adds).
1112   bool useSubtract = !ExpandTy->isPointerTy() && Step->isNonConstantNegative();
1113   if (useSubtract)
1114     Step = SE.getNegativeSCEV(Step);
1115   // Expand the step somewhere that dominates the loop header.
1116   Value *StepV = expandCodeFor(Step, IntTy, L->getHeader()->begin());
1117
1118   // Create the PHI.
1119   BasicBlock *Header = L->getHeader();
1120   Builder.SetInsertPoint(Header, Header->begin());
1121   pred_iterator HPB = pred_begin(Header), HPE = pred_end(Header);
1122   PHINode *PN = Builder.CreatePHI(ExpandTy, std::distance(HPB, HPE),
1123                                   Twine(IVName) + ".iv");
1124   rememberInstruction(PN);
1125
1126   // Create the step instructions and populate the PHI.
1127   for (pred_iterator HPI = HPB; HPI != HPE; ++HPI) {
1128     BasicBlock *Pred = *HPI;
1129
1130     // Add a start value.
1131     if (!L->contains(Pred)) {
1132       PN->addIncoming(StartV, Pred);
1133       continue;
1134     }
1135
1136     // Create a step value and add it to the PHI.
1137     // If IVIncInsertLoop is non-null and equal to the addrec's loop, insert the
1138     // instructions at IVIncInsertPos.
1139     Instruction *InsertPos = L == IVIncInsertLoop ?
1140       IVIncInsertPos : Pred->getTerminator();
1141     Builder.SetInsertPoint(InsertPos);
1142     Value *IncV = expandIVInc(PN, StepV, L, ExpandTy, IntTy, useSubtract);
1143     if (isa<OverflowingBinaryOperator>(IncV)) {
1144       if (Normalized->getNoWrapFlags(SCEV::FlagNUW))
1145         cast<BinaryOperator>(IncV)->setHasNoUnsignedWrap();
1146       if (Normalized->getNoWrapFlags(SCEV::FlagNSW))
1147         cast<BinaryOperator>(IncV)->setHasNoSignedWrap();
1148     }
1149     PN->addIncoming(IncV, Pred);
1150   }
1151
1152   // Restore the original insert point.
1153   if (SaveInsertBB)
1154     restoreInsertPoint(SaveInsertBB, SaveInsertPt);
1155
1156   // After expanding subexpressions, restore the PostIncLoops set so the caller
1157   // can ensure that IVIncrement dominates the current uses.
1158   PostIncLoops = SavedPostIncLoops;
1159
1160   // Remember this PHI, even in post-inc mode.
1161   InsertedValues.insert(PN);
1162
1163   return PN;
1164 }
1165
1166 Value *SCEVExpander::expandAddRecExprLiterally(const SCEVAddRecExpr *S) {
1167   Type *STy = S->getType();
1168   Type *IntTy = SE.getEffectiveSCEVType(STy);
1169   const Loop *L = S->getLoop();
1170
1171   // Determine a normalized form of this expression, which is the expression
1172   // before any post-inc adjustment is made.
1173   const SCEVAddRecExpr *Normalized = S;
1174   if (PostIncLoops.count(L)) {
1175     PostIncLoopSet Loops;
1176     Loops.insert(L);
1177     Normalized =
1178       cast<SCEVAddRecExpr>(TransformForPostIncUse(Normalize, S, 0, 0,
1179                                                   Loops, SE, *SE.DT));
1180   }
1181
1182   // Strip off any non-loop-dominating component from the addrec start.
1183   const SCEV *Start = Normalized->getStart();
1184   const SCEV *PostLoopOffset = 0;
1185   if (!SE.properlyDominates(Start, L->getHeader())) {
1186     PostLoopOffset = Start;
1187     Start = SE.getConstant(Normalized->getType(), 0);
1188     Normalized = cast<SCEVAddRecExpr>(
1189       SE.getAddRecExpr(Start, Normalized->getStepRecurrence(SE),
1190                        Normalized->getLoop(),
1191                        Normalized->getNoWrapFlags(SCEV::FlagNW)));
1192   }
1193
1194   // Strip off any non-loop-dominating component from the addrec step.
1195   const SCEV *Step = Normalized->getStepRecurrence(SE);
1196   const SCEV *PostLoopScale = 0;
1197   if (!SE.dominates(Step, L->getHeader())) {
1198     PostLoopScale = Step;
1199     Step = SE.getConstant(Normalized->getType(), 1);
1200     Normalized =
1201       cast<SCEVAddRecExpr>(SE.getAddRecExpr(
1202                              Start, Step, Normalized->getLoop(),
1203                              Normalized->getNoWrapFlags(SCEV::FlagNW)));
1204   }
1205
1206   // Expand the core addrec. If we need post-loop scaling, force it to
1207   // expand to an integer type to avoid the need for additional casting.
1208   Type *ExpandTy = PostLoopScale ? IntTy : STy;
1209   PHINode *PN = getAddRecExprPHILiterally(Normalized, L, ExpandTy, IntTy);
1210
1211   // Accommodate post-inc mode, if necessary.
1212   Value *Result;
1213   if (!PostIncLoops.count(L))
1214     Result = PN;
1215   else {
1216     // In PostInc mode, use the post-incremented value.
1217     BasicBlock *LatchBlock = L->getLoopLatch();
1218     assert(LatchBlock && "PostInc mode requires a unique loop latch!");
1219     Result = PN->getIncomingValueForBlock(LatchBlock);
1220
1221     // For an expansion to use the postinc form, the client must call
1222     // expandCodeFor with an InsertPoint that is either outside the PostIncLoop
1223     // or dominated by IVIncInsertPos.
1224     if (isa<Instruction>(Result)
1225         && !SE.DT->dominates(cast<Instruction>(Result),
1226                              Builder.GetInsertPoint())) {
1227       // The induction variable's postinc expansion does not dominate this use.
1228       // IVUsers tries to prevent this case, so it is rare. However, it can
1229       // happen when an IVUser outside the loop is not dominated by the latch
1230       // block. Adjusting IVIncInsertPos before expansion begins cannot handle
1231       // all cases. Consider a phi outide whose operand is replaced during
1232       // expansion with the value of the postinc user. Without fundamentally
1233       // changing the way postinc users are tracked, the only remedy is
1234       // inserting an extra IV increment. StepV might fold into PostLoopOffset,
1235       // but hopefully expandCodeFor handles that.
1236       bool useSubtract =
1237         !ExpandTy->isPointerTy() && Step->isNonConstantNegative();
1238       if (useSubtract)
1239         Step = SE.getNegativeSCEV(Step);
1240       // Expand the step somewhere that dominates the loop header.
1241       BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
1242       BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
1243       Value *StepV = expandCodeFor(Step, IntTy, L->getHeader()->begin());
1244       // Restore the insertion point to the place where the caller has
1245       // determined dominates all uses.
1246       restoreInsertPoint(SaveInsertBB, SaveInsertPt);
1247       Result = expandIVInc(PN, StepV, L, ExpandTy, IntTy, useSubtract);
1248     }
1249   }
1250
1251   // Re-apply any non-loop-dominating scale.
1252   if (PostLoopScale) {
1253     Result = InsertNoopCastOfTo(Result, IntTy);
1254     Result = Builder.CreateMul(Result,
1255                                expandCodeFor(PostLoopScale, IntTy));
1256     rememberInstruction(Result);
1257   }
1258
1259   // Re-apply any non-loop-dominating offset.
1260   if (PostLoopOffset) {
1261     if (PointerType *PTy = dyn_cast<PointerType>(ExpandTy)) {
1262       const SCEV *const OffsetArray[1] = { PostLoopOffset };
1263       Result = expandAddToGEP(OffsetArray, OffsetArray+1, PTy, IntTy, Result);
1264     } else {
1265       Result = InsertNoopCastOfTo(Result, IntTy);
1266       Result = Builder.CreateAdd(Result,
1267                                  expandCodeFor(PostLoopOffset, IntTy));
1268       rememberInstruction(Result);
1269     }
1270   }
1271
1272   return Result;
1273 }
1274
1275 Value *SCEVExpander::visitAddRecExpr(const SCEVAddRecExpr *S) {
1276   if (!CanonicalMode) return expandAddRecExprLiterally(S);
1277
1278   Type *Ty = SE.getEffectiveSCEVType(S->getType());
1279   const Loop *L = S->getLoop();
1280
1281   // First check for an existing canonical IV in a suitable type.
1282   PHINode *CanonicalIV = 0;
1283   if (PHINode *PN = L->getCanonicalInductionVariable())
1284     if (SE.getTypeSizeInBits(PN->getType()) >= SE.getTypeSizeInBits(Ty))
1285       CanonicalIV = PN;
1286
1287   // Rewrite an AddRec in terms of the canonical induction variable, if
1288   // its type is more narrow.
1289   if (CanonicalIV &&
1290       SE.getTypeSizeInBits(CanonicalIV->getType()) >
1291       SE.getTypeSizeInBits(Ty)) {
1292     SmallVector<const SCEV *, 4> NewOps(S->getNumOperands());
1293     for (unsigned i = 0, e = S->getNumOperands(); i != e; ++i)
1294       NewOps[i] = SE.getAnyExtendExpr(S->op_begin()[i], CanonicalIV->getType());
1295     Value *V = expand(SE.getAddRecExpr(NewOps, S->getLoop(),
1296                                        S->getNoWrapFlags(SCEV::FlagNW)));
1297     BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
1298     BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
1299     BasicBlock::iterator NewInsertPt =
1300       llvm::next(BasicBlock::iterator(cast<Instruction>(V)));
1301     while (isa<PHINode>(NewInsertPt) || isa<DbgInfoIntrinsic>(NewInsertPt) ||
1302            isa<LandingPadInst>(NewInsertPt))
1303       ++NewInsertPt;
1304     V = expandCodeFor(SE.getTruncateExpr(SE.getUnknown(V), Ty), 0,
1305                       NewInsertPt);
1306     restoreInsertPoint(SaveInsertBB, SaveInsertPt);
1307     return V;
1308   }
1309
1310   // {X,+,F} --> X + {0,+,F}
1311   if (!S->getStart()->isZero()) {
1312     SmallVector<const SCEV *, 4> NewOps(S->op_begin(), S->op_end());
1313     NewOps[0] = SE.getConstant(Ty, 0);
1314     const SCEV *Rest = SE.getAddRecExpr(NewOps, L,
1315                                         S->getNoWrapFlags(SCEV::FlagNW));
1316
1317     // Turn things like ptrtoint+arithmetic+inttoptr into GEP. See the
1318     // comments on expandAddToGEP for details.
1319     const SCEV *Base = S->getStart();
1320     const SCEV *RestArray[1] = { Rest };
1321     // Dig into the expression to find the pointer base for a GEP.
1322     ExposePointerBase(Base, RestArray[0], SE);
1323     // If we found a pointer, expand the AddRec with a GEP.
1324     if (PointerType *PTy = dyn_cast<PointerType>(Base->getType())) {
1325       // Make sure the Base isn't something exotic, such as a multiplied
1326       // or divided pointer value. In those cases, the result type isn't
1327       // actually a pointer type.
1328       if (!isa<SCEVMulExpr>(Base) && !isa<SCEVUDivExpr>(Base)) {
1329         Value *StartV = expand(Base);
1330         assert(StartV->getType() == PTy && "Pointer type mismatch for GEP!");
1331         return expandAddToGEP(RestArray, RestArray+1, PTy, Ty, StartV);
1332       }
1333     }
1334
1335     // Just do a normal add. Pre-expand the operands to suppress folding.
1336     return expand(SE.getAddExpr(SE.getUnknown(expand(S->getStart())),
1337                                 SE.getUnknown(expand(Rest))));
1338   }
1339
1340   // If we don't yet have a canonical IV, create one.
1341   if (!CanonicalIV) {
1342     // Create and insert the PHI node for the induction variable in the
1343     // specified loop.
1344     BasicBlock *Header = L->getHeader();
1345     pred_iterator HPB = pred_begin(Header), HPE = pred_end(Header);
1346     CanonicalIV = PHINode::Create(Ty, std::distance(HPB, HPE), "indvar",
1347                                   Header->begin());
1348     rememberInstruction(CanonicalIV);
1349
1350     SmallSet<BasicBlock *, 4> PredSeen;
1351     Constant *One = ConstantInt::get(Ty, 1);
1352     for (pred_iterator HPI = HPB; HPI != HPE; ++HPI) {
1353       BasicBlock *HP = *HPI;
1354       if (!PredSeen.insert(HP))
1355         continue;
1356
1357       if (L->contains(HP)) {
1358         // Insert a unit add instruction right before the terminator
1359         // corresponding to the back-edge.
1360         Instruction *Add = BinaryOperator::CreateAdd(CanonicalIV, One,
1361                                                      "indvar.next",
1362                                                      HP->getTerminator());
1363         Add->setDebugLoc(HP->getTerminator()->getDebugLoc());
1364         rememberInstruction(Add);
1365         CanonicalIV->addIncoming(Add, HP);
1366       } else {
1367         CanonicalIV->addIncoming(Constant::getNullValue(Ty), HP);
1368       }
1369     }
1370   }
1371
1372   // {0,+,1} --> Insert a canonical induction variable into the loop!
1373   if (S->isAffine() && S->getOperand(1)->isOne()) {
1374     assert(Ty == SE.getEffectiveSCEVType(CanonicalIV->getType()) &&
1375            "IVs with types different from the canonical IV should "
1376            "already have been handled!");
1377     return CanonicalIV;
1378   }
1379
1380   // {0,+,F} --> {0,+,1} * F
1381
1382   // If this is a simple linear addrec, emit it now as a special case.
1383   if (S->isAffine())    // {0,+,F} --> i*F
1384     return
1385       expand(SE.getTruncateOrNoop(
1386         SE.getMulExpr(SE.getUnknown(CanonicalIV),
1387                       SE.getNoopOrAnyExtend(S->getOperand(1),
1388                                             CanonicalIV->getType())),
1389         Ty));
1390
1391   // If this is a chain of recurrences, turn it into a closed form, using the
1392   // folders, then expandCodeFor the closed form.  This allows the folders to
1393   // simplify the expression without having to build a bunch of special code
1394   // into this folder.
1395   const SCEV *IH = SE.getUnknown(CanonicalIV);   // Get I as a "symbolic" SCEV.
1396
1397   // Promote S up to the canonical IV type, if the cast is foldable.
1398   const SCEV *NewS = S;
1399   const SCEV *Ext = SE.getNoopOrAnyExtend(S, CanonicalIV->getType());
1400   if (isa<SCEVAddRecExpr>(Ext))
1401     NewS = Ext;
1402
1403   const SCEV *V = cast<SCEVAddRecExpr>(NewS)->evaluateAtIteration(IH, SE);
1404   //cerr << "Evaluated: " << *this << "\n     to: " << *V << "\n";
1405
1406   // Truncate the result down to the original type, if needed.
1407   const SCEV *T = SE.getTruncateOrNoop(V, Ty);
1408   return expand(T);
1409 }
1410
1411 Value *SCEVExpander::visitTruncateExpr(const SCEVTruncateExpr *S) {
1412   Type *Ty = SE.getEffectiveSCEVType(S->getType());
1413   Value *V = expandCodeFor(S->getOperand(),
1414                            SE.getEffectiveSCEVType(S->getOperand()->getType()));
1415   Value *I = Builder.CreateTrunc(V, Ty);
1416   rememberInstruction(I);
1417   return I;
1418 }
1419
1420 Value *SCEVExpander::visitZeroExtendExpr(const SCEVZeroExtendExpr *S) {
1421   Type *Ty = SE.getEffectiveSCEVType(S->getType());
1422   Value *V = expandCodeFor(S->getOperand(),
1423                            SE.getEffectiveSCEVType(S->getOperand()->getType()));
1424   Value *I = Builder.CreateZExt(V, Ty);
1425   rememberInstruction(I);
1426   return I;
1427 }
1428
1429 Value *SCEVExpander::visitSignExtendExpr(const SCEVSignExtendExpr *S) {
1430   Type *Ty = SE.getEffectiveSCEVType(S->getType());
1431   Value *V = expandCodeFor(S->getOperand(),
1432                            SE.getEffectiveSCEVType(S->getOperand()->getType()));
1433   Value *I = Builder.CreateSExt(V, Ty);
1434   rememberInstruction(I);
1435   return I;
1436 }
1437
1438 Value *SCEVExpander::visitSMaxExpr(const SCEVSMaxExpr *S) {
1439   Value *LHS = expand(S->getOperand(S->getNumOperands()-1));
1440   Type *Ty = LHS->getType();
1441   for (int i = S->getNumOperands()-2; i >= 0; --i) {
1442     // In the case of mixed integer and pointer types, do the
1443     // rest of the comparisons as integer.
1444     if (S->getOperand(i)->getType() != Ty) {
1445       Ty = SE.getEffectiveSCEVType(Ty);
1446       LHS = InsertNoopCastOfTo(LHS, Ty);
1447     }
1448     Value *RHS = expandCodeFor(S->getOperand(i), Ty);
1449     Value *ICmp = Builder.CreateICmpSGT(LHS, RHS);
1450     rememberInstruction(ICmp);
1451     Value *Sel = Builder.CreateSelect(ICmp, LHS, RHS, "smax");
1452     rememberInstruction(Sel);
1453     LHS = Sel;
1454   }
1455   // In the case of mixed integer and pointer types, cast the
1456   // final result back to the pointer type.
1457   if (LHS->getType() != S->getType())
1458     LHS = InsertNoopCastOfTo(LHS, S->getType());
1459   return LHS;
1460 }
1461
1462 Value *SCEVExpander::visitUMaxExpr(const SCEVUMaxExpr *S) {
1463   Value *LHS = expand(S->getOperand(S->getNumOperands()-1));
1464   Type *Ty = LHS->getType();
1465   for (int i = S->getNumOperands()-2; i >= 0; --i) {
1466     // In the case of mixed integer and pointer types, do the
1467     // rest of the comparisons as integer.
1468     if (S->getOperand(i)->getType() != Ty) {
1469       Ty = SE.getEffectiveSCEVType(Ty);
1470       LHS = InsertNoopCastOfTo(LHS, Ty);
1471     }
1472     Value *RHS = expandCodeFor(S->getOperand(i), Ty);
1473     Value *ICmp = Builder.CreateICmpUGT(LHS, RHS);
1474     rememberInstruction(ICmp);
1475     Value *Sel = Builder.CreateSelect(ICmp, LHS, RHS, "umax");
1476     rememberInstruction(Sel);
1477     LHS = Sel;
1478   }
1479   // In the case of mixed integer and pointer types, cast the
1480   // final result back to the pointer type.
1481   if (LHS->getType() != S->getType())
1482     LHS = InsertNoopCastOfTo(LHS, S->getType());
1483   return LHS;
1484 }
1485
1486 Value *SCEVExpander::expandCodeFor(const SCEV *SH, Type *Ty,
1487                                    Instruction *IP) {
1488   Builder.SetInsertPoint(IP->getParent(), IP);
1489   return expandCodeFor(SH, Ty);
1490 }
1491
1492 Value *SCEVExpander::expandCodeFor(const SCEV *SH, Type *Ty) {
1493   // Expand the code for this SCEV.
1494   Value *V = expand(SH);
1495   if (Ty) {
1496     assert(SE.getTypeSizeInBits(Ty) == SE.getTypeSizeInBits(SH->getType()) &&
1497            "non-trivial casts should be done with the SCEVs directly!");
1498     V = InsertNoopCastOfTo(V, Ty);
1499   }
1500   return V;
1501 }
1502
1503 Value *SCEVExpander::expand(const SCEV *S) {
1504   // Compute an insertion point for this SCEV object. Hoist the instructions
1505   // as far out in the loop nest as possible.
1506   Instruction *InsertPt = Builder.GetInsertPoint();
1507   for (Loop *L = SE.LI->getLoopFor(Builder.GetInsertBlock()); ;
1508        L = L->getParentLoop())
1509     if (SE.isLoopInvariant(S, L)) {
1510       if (!L) break;
1511       if (BasicBlock *Preheader = L->getLoopPreheader())
1512         InsertPt = Preheader->getTerminator();
1513       else {
1514         // LSR sets the insertion point for AddRec start/step values to the
1515         // block start to simplify value reuse, even though it's an invalid
1516         // position. SCEVExpander must correct for this in all cases.
1517         InsertPt = L->getHeader()->getFirstInsertionPt();
1518       }
1519     } else {
1520       // If the SCEV is computable at this level, insert it into the header
1521       // after the PHIs (and after any other instructions that we've inserted
1522       // there) so that it is guaranteed to dominate any user inside the loop.
1523       if (L && SE.hasComputableLoopEvolution(S, L) && !PostIncLoops.count(L))
1524         InsertPt = L->getHeader()->getFirstInsertionPt();
1525       while (InsertPt != Builder.GetInsertPoint()
1526              && (isInsertedInstruction(InsertPt)
1527                  || isa<DbgInfoIntrinsic>(InsertPt))) {
1528         InsertPt = llvm::next(BasicBlock::iterator(InsertPt));
1529       }
1530       break;
1531     }
1532
1533   // Check to see if we already expanded this here.
1534   std::map<std::pair<const SCEV *, Instruction *>, TrackingVH<Value> >::iterator
1535     I = InsertedExpressions.find(std::make_pair(S, InsertPt));
1536   if (I != InsertedExpressions.end())
1537     return I->second;
1538
1539   BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
1540   BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
1541   Builder.SetInsertPoint(InsertPt->getParent(), InsertPt);
1542
1543   // Expand the expression into instructions.
1544   Value *V = visit(S);
1545
1546   // Remember the expanded value for this SCEV at this location.
1547   //
1548   // This is independent of PostIncLoops. The mapped value simply materializes
1549   // the expression at this insertion point. If the mapped value happened to be
1550   // a postinc expansion, it could be reused by a non postinc user, but only if
1551   // its insertion point was already at the head of the loop.
1552   InsertedExpressions[std::make_pair(S, InsertPt)] = V;
1553
1554   restoreInsertPoint(SaveInsertBB, SaveInsertPt);
1555   return V;
1556 }
1557
1558 void SCEVExpander::rememberInstruction(Value *I) {
1559   if (!PostIncLoops.empty())
1560     InsertedPostIncValues.insert(I);
1561   else
1562     InsertedValues.insert(I);
1563 }
1564
1565 void SCEVExpander::restoreInsertPoint(BasicBlock *BB, BasicBlock::iterator I) {
1566   Builder.SetInsertPoint(BB, I);
1567 }
1568
1569 /// getOrInsertCanonicalInductionVariable - This method returns the
1570 /// canonical induction variable of the specified type for the specified
1571 /// loop (inserting one if there is none).  A canonical induction variable
1572 /// starts at zero and steps by one on each iteration.
1573 PHINode *
1574 SCEVExpander::getOrInsertCanonicalInductionVariable(const Loop *L,
1575                                                     Type *Ty) {
1576   assert(Ty->isIntegerTy() && "Can only insert integer induction variables!");
1577
1578   // Build a SCEV for {0,+,1}<L>.
1579   // Conservatively use FlagAnyWrap for now.
1580   const SCEV *H = SE.getAddRecExpr(SE.getConstant(Ty, 0),
1581                                    SE.getConstant(Ty, 1), L, SCEV::FlagAnyWrap);
1582
1583   // Emit code for it.
1584   BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
1585   BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
1586   PHINode *V = cast<PHINode>(expandCodeFor(H, 0, L->getHeader()->begin()));
1587   if (SaveInsertBB)
1588     restoreInsertPoint(SaveInsertBB, SaveInsertPt);
1589
1590   return V;
1591 }
1592
1593 /// Sort values by integer width for replaceCongruentIVs.
1594 static bool width_descending(Value *lhs, Value *rhs) {
1595   // Put pointers at the back and make sure pointer < pointer = false.
1596   if (!lhs->getType()->isIntegerTy() || !rhs->getType()->isIntegerTy())
1597     return rhs->getType()->isIntegerTy() && !lhs->getType()->isIntegerTy();
1598   return rhs->getType()->getPrimitiveSizeInBits()
1599     < lhs->getType()->getPrimitiveSizeInBits();
1600 }
1601
1602 /// replaceCongruentIVs - Check for congruent phis in this loop header and
1603 /// replace them with their most canonical representative. Return the number of
1604 /// phis eliminated.
1605 ///
1606 /// This does not depend on any SCEVExpander state but should be used in
1607 /// the same context that SCEVExpander is used.
1608 unsigned SCEVExpander::replaceCongruentIVs(Loop *L, const DominatorTree *DT,
1609                                            SmallVectorImpl<WeakVH> &DeadInsts,
1610                                            const TargetTransformInfo *TTI) {
1611   // Find integer phis in order of increasing width.
1612   SmallVector<PHINode*, 8> Phis;
1613   for (BasicBlock::iterator I = L->getHeader()->begin();
1614        PHINode *Phi = dyn_cast<PHINode>(I); ++I) {
1615     Phis.push_back(Phi);
1616   }
1617   if (TTI)
1618     std::sort(Phis.begin(), Phis.end(), width_descending);
1619
1620   unsigned NumElim = 0;
1621   DenseMap<const SCEV *, PHINode *> ExprToIVMap;
1622   // Process phis from wide to narrow. Mapping wide phis to the their truncation
1623   // so narrow phis can reuse them.
1624   for (SmallVectorImpl<PHINode*>::const_iterator PIter = Phis.begin(),
1625          PEnd = Phis.end(); PIter != PEnd; ++PIter) {
1626     PHINode *Phi = *PIter;
1627
1628     // Fold constant phis. They may be congruent to other constant phis and
1629     // would confuse the logic below that expects proper IVs.
1630     if (Value *V = Phi->hasConstantValue()) {
1631       Phi->replaceAllUsesWith(V);
1632       DeadInsts.push_back(Phi);
1633       ++NumElim;
1634       DEBUG_WITH_TYPE(DebugType, dbgs()
1635                       << "INDVARS: Eliminated constant iv: " << *Phi << '\n');
1636       continue;
1637     }
1638
1639     if (!SE.isSCEVable(Phi->getType()))
1640       continue;
1641
1642     PHINode *&OrigPhiRef = ExprToIVMap[SE.getSCEV(Phi)];
1643     if (!OrigPhiRef) {
1644       OrigPhiRef = Phi;
1645       if (Phi->getType()->isIntegerTy() && TTI
1646           && TTI->isTruncateFree(Phi->getType(), Phis.back()->getType())) {
1647         // This phi can be freely truncated to the narrowest phi type. Map the
1648         // truncated expression to it so it will be reused for narrow types.
1649         const SCEV *TruncExpr =
1650           SE.getTruncateExpr(SE.getSCEV(Phi), Phis.back()->getType());
1651         ExprToIVMap[TruncExpr] = Phi;
1652       }
1653       continue;
1654     }
1655
1656     // Replacing a pointer phi with an integer phi or vice-versa doesn't make
1657     // sense.
1658     if (OrigPhiRef->getType()->isPointerTy() != Phi->getType()->isPointerTy())
1659       continue;
1660
1661     if (BasicBlock *LatchBlock = L->getLoopLatch()) {
1662       Instruction *OrigInc =
1663         cast<Instruction>(OrigPhiRef->getIncomingValueForBlock(LatchBlock));
1664       Instruction *IsomorphicInc =
1665         cast<Instruction>(Phi->getIncomingValueForBlock(LatchBlock));
1666
1667       // If this phi has the same width but is more canonical, replace the
1668       // original with it. As part of the "more canonical" determination,
1669       // respect a prior decision to use an IV chain.
1670       if (OrigPhiRef->getType() == Phi->getType()
1671           && !(ChainedPhis.count(Phi)
1672                || isExpandedAddRecExprPHI(OrigPhiRef, OrigInc, L))
1673           && (ChainedPhis.count(Phi)
1674               || isExpandedAddRecExprPHI(Phi, IsomorphicInc, L))) {
1675         std::swap(OrigPhiRef, Phi);
1676         std::swap(OrigInc, IsomorphicInc);
1677       }
1678       // Replacing the congruent phi is sufficient because acyclic redundancy
1679       // elimination, CSE/GVN, should handle the rest. However, once SCEV proves
1680       // that a phi is congruent, it's often the head of an IV user cycle that
1681       // is isomorphic with the original phi. It's worth eagerly cleaning up the
1682       // common case of a single IV increment so that DeleteDeadPHIs can remove
1683       // cycles that had postinc uses.
1684       const SCEV *TruncExpr = SE.getTruncateOrNoop(SE.getSCEV(OrigInc),
1685                                                    IsomorphicInc->getType());
1686       if (OrigInc != IsomorphicInc
1687           && TruncExpr == SE.getSCEV(IsomorphicInc)
1688           && ((isa<PHINode>(OrigInc) && isa<PHINode>(IsomorphicInc))
1689               || hoistIVInc(OrigInc, IsomorphicInc))) {
1690         DEBUG_WITH_TYPE(DebugType, dbgs()
1691                         << "INDVARS: Eliminated congruent iv.inc: "
1692                         << *IsomorphicInc << '\n');
1693         Value *NewInc = OrigInc;
1694         if (OrigInc->getType() != IsomorphicInc->getType()) {
1695           Instruction *IP = isa<PHINode>(OrigInc)
1696             ? (Instruction*)L->getHeader()->getFirstInsertionPt()
1697             : OrigInc->getNextNode();
1698           IRBuilder<> Builder(IP);
1699           Builder.SetCurrentDebugLocation(IsomorphicInc->getDebugLoc());
1700           NewInc = Builder.
1701             CreateTruncOrBitCast(OrigInc, IsomorphicInc->getType(), IVName);
1702         }
1703         IsomorphicInc->replaceAllUsesWith(NewInc);
1704         DeadInsts.push_back(IsomorphicInc);
1705       }
1706     }
1707     DEBUG_WITH_TYPE(DebugType, dbgs()
1708                     << "INDVARS: Eliminated congruent iv: " << *Phi << '\n');
1709     ++NumElim;
1710     Value *NewIV = OrigPhiRef;
1711     if (OrigPhiRef->getType() != Phi->getType()) {
1712       IRBuilder<> Builder(L->getHeader()->getFirstInsertionPt());
1713       Builder.SetCurrentDebugLocation(Phi->getDebugLoc());
1714       NewIV = Builder.CreateTruncOrBitCast(OrigPhiRef, Phi->getType(), IVName);
1715     }
1716     Phi->replaceAllUsesWith(NewIV);
1717     DeadInsts.push_back(Phi);
1718   }
1719   return NumElim;
1720 }
1721
1722 namespace {
1723 // Search for a SCEV subexpression that is not safe to expand.  Any expression
1724 // that may expand to a !isSafeToSpeculativelyExecute value is unsafe, namely
1725 // UDiv expressions. We don't know if the UDiv is derived from an IR divide
1726 // instruction, but the important thing is that we prove the denominator is
1727 // nonzero before expansion.
1728 //
1729 // IVUsers already checks that IV-derived expressions are safe. So this check is
1730 // only needed when the expression includes some subexpression that is not IV
1731 // derived.
1732 //
1733 // Currently, we only allow division by a nonzero constant here. If this is
1734 // inadequate, we could easily allow division by SCEVUnknown by using
1735 // ValueTracking to check isKnownNonZero().
1736 struct SCEVFindUnsafe {
1737   bool IsUnsafe;
1738
1739   SCEVFindUnsafe(): IsUnsafe(false) {}
1740
1741   bool follow(const SCEV *S) {
1742     const SCEVUDivExpr *D = dyn_cast<SCEVUDivExpr>(S);
1743     if (!D)
1744       return true;
1745     const SCEVConstant *SC = dyn_cast<SCEVConstant>(D->getRHS());
1746     if (SC && !SC->getValue()->isZero())
1747       return true;
1748     IsUnsafe = true;
1749     return false;
1750   }
1751   bool isDone() const { return IsUnsafe; }
1752 };
1753 }
1754
1755 namespace llvm {
1756 bool isSafeToExpand(const SCEV *S) {
1757   SCEVFindUnsafe Search;
1758   visitAll(S, Search);
1759   return !Search.IsUnsafe;
1760 }
1761 }