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/Analysis/LoopInfo.h"
  18 #include "llvm/LLVMContext.h"
  19 #include "llvm/Target/TargetData.h"
  20 #include "llvm/ADT/STLExtras.h"
  21 using namespace llvm;
  22
  23 /// InsertNoopCastOfTo - Insert a cast of V to the specified type,
  24 /// which must be possible with a noop cast, doing what we can to share
  25 /// the casts.
  26 Value *SCEVExpander::InsertNoopCastOfTo(Value *V, const Type *Ty) {
  27   Instruction::CastOps Op = CastInst::getCastOpcode(V, false, Ty, false);
  28   assert((Op == Instruction::BitCast ||
  29           Op == Instruction::PtrToInt ||
  30           Op == Instruction::IntToPtr) &&
  31          "InsertNoopCastOfTo cannot perform non-noop casts!");
  32   assert(SE.getTypeSizeInBits(V->getType()) == SE.getTypeSizeInBits(Ty) &&
  33          "InsertNoopCastOfTo cannot change sizes!");
  34
  35   // Short-circuit unnecessary bitcasts.
  36   if (Op == Instruction::BitCast && V->getType() == Ty)
  37     return V;
  38
  39   // Short-circuit unnecessary inttoptr<->ptrtoint casts.
  40   if ((Op == Instruction::PtrToInt || Op == Instruction::IntToPtr) &&
  41       SE.getTypeSizeInBits(Ty) == SE.getTypeSizeInBits(V->getType())) {
  42     if (CastInst *CI = dyn_cast<CastInst>(V))
  43       if ((CI->getOpcode() == Instruction::PtrToInt ||
  44            CI->getOpcode() == Instruction::IntToPtr) &&
  45           SE.getTypeSizeInBits(CI->getType()) ==
  46           SE.getTypeSizeInBits(CI->getOperand(0)->getType()))
  47         return CI->getOperand(0);
  48     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
  49       if ((CE->getOpcode() == Instruction::PtrToInt ||
  50            CE->getOpcode() == Instruction::IntToPtr) &&
  51           SE.getTypeSizeInBits(CE->getType()) ==
  52           SE.getTypeSizeInBits(CE->getOperand(0)->getType()))
  53         return CE->getOperand(0);
  54   }
  55
  56   // FIXME: keep track of the cast instruction.
  57   if (Constant *C = dyn_cast<Constant>(V))
  58     return ConstantExpr::getCast(Op, C, Ty);
  59
  60   if (Argument *A = dyn_cast<Argument>(V)) {
  61     // Check to see if there is already a cast!
  62     for (Value::use_iterator UI = A->use_begin(), E = A->use_end();
  63          UI != E; ++UI)
  64       if ((*UI)->getType() == Ty)
  65         if (CastInst *CI = dyn_cast<CastInst>(cast<Instruction>(*UI)))
  66           if (CI->getOpcode() == Op) {
  67             // If the cast isn't the first instruction of the function, move it.
  68             if (BasicBlock::iterator(CI) !=
  69                 A->getParent()->getEntryBlock().begin()) {
  70               // Recreate the cast at the beginning of the entry block.
  71               // The old cast is left in place in case it is being used
  72               // as an insert point.
  73               Instruction *NewCI =
  74                 CastInst::Create(Op, V, Ty, "",
  75                                  A->getParent()->getEntryBlock().begin());
  76               NewCI->takeName(CI);
  77               CI->replaceAllUsesWith(NewCI);
  78               return NewCI;
  79             }
  80             return CI;
  81           }
  82
  83     Instruction *I = CastInst::Create(Op, V, Ty, V->getName(),
  84                                       A->getParent()->getEntryBlock().begin());
  85     InsertedValues.insert(I);
  86     return I;
  87   }
  88
  89   Instruction *I = cast<Instruction>(V);
  90
  91   // Check to see if there is already a cast.  If there is, use it.
  92   for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
  93        UI != E; ++UI) {
  94     if ((*UI)->getType() == Ty)
  95       if (CastInst *CI = dyn_cast<CastInst>(cast<Instruction>(*UI)))
  96         if (CI->getOpcode() == Op) {
  97           BasicBlock::iterator It = I; ++It;
  98           if (isa<InvokeInst>(I))
  99             It = cast<InvokeInst>(I)->getNormalDest()->begin();
 100           while (isa<PHINode>(It)) ++It;
 101           if (It != BasicBlock::iterator(CI)) {
 102             // Recreate the cast at the beginning of the entry block.
 103             // The old cast is left in place in case it is being used
 104             // as an insert point.
 105             Instruction *NewCI = CastInst::Create(Op, V, Ty, "", It);
 106             NewCI->takeName(CI);
 107             CI->replaceAllUsesWith(NewCI);
 108             return NewCI;
 109           }
 110           return CI;
 111         }
 112   }
 113   BasicBlock::iterator IP = I; ++IP;
 114   if (InvokeInst *II = dyn_cast<InvokeInst>(I))
 115     IP = II->getNormalDest()->begin();
 116   while (isa<PHINode>(IP)) ++IP;
 117   Instruction *CI = CastInst::Create(Op, V, Ty, V->getName(), IP);
 118   InsertedValues.insert(CI);
 119   return CI;
 120 }
 121
 122 /// InsertBinop - Insert the specified binary operator, doing a small amount
 123 /// of work to avoid inserting an obviously redundant operation.
 124 Value *SCEVExpander::InsertBinop(Instruction::BinaryOps Opcode,
 125                                  Value *LHS, Value *RHS) {
 126   // Fold a binop with constant operands.
 127   if (Constant *CLHS = dyn_cast<Constant>(LHS))
 128     if (Constant *CRHS = dyn_cast<Constant>(RHS))
 129       return ConstantExpr::get(Opcode, CLHS, CRHS);
 130
 131   // Do a quick scan to see if we have this binop nearby.  If so, reuse it.
 132   unsigned ScanLimit = 6;
 133   BasicBlock::iterator BlockBegin = Builder.GetInsertBlock()->begin();
 134   // Scanning starts from the last instruction before the insertion point.
 135   BasicBlock::iterator IP = Builder.GetInsertPoint();
 136   if (IP != BlockBegin) {
 137     --IP;
 138     for (; ScanLimit; --IP, --ScanLimit) {
 139       if (IP->getOpcode() == (unsigned)Opcode && IP->getOperand(0) == LHS &&
 140           IP->getOperand(1) == RHS)
 141         return IP;
 142       if (IP == BlockBegin) break;
 143     }
 144   }
 145
 146   // If we haven't found this binop, insert it.
 147   Value *BO = Builder.CreateBinOp(Opcode, LHS, RHS, "tmp");
 148   InsertedValues.insert(BO);
 149   return BO;
 150 }
 151
 152 /// FactorOutConstant - Test if S is divisible by Factor, using signed
 153 /// division. If so, update S with Factor divided out and return true.
 154 /// S need not be evenly divisble if a reasonable remainder can be
 155 /// computed.
 156 /// TODO: When ScalarEvolution gets a SCEVSDivExpr, this can be made
 157 /// unnecessary; in its place, just signed-divide Ops[i] by the scale and
 158 /// check to see if the divide was folded.
 159 static bool FactorOutConstant(const SCEV *&S,
 160                               const SCEV *&Remainder,
 161                               const APInt &Factor,
 162                               ScalarEvolution &SE) {
 163   // Everything is divisible by one.
 164   if (Factor == 1)
 165     return true;
 166
 167   // For a Constant, check for a multiple of the given factor.
 168   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S)) {
 169     ConstantInt *CI =
 170       ConstantInt::get(SE.getContext(), C->getValue()->getValue().sdiv(Factor));
 171     // If the quotient is zero and the remainder is non-zero, reject
 172     // the value at this scale. It will be considered for subsequent
 173     // smaller scales.
 174     if (C->isZero() || !CI->isZero()) {
 175       const SCEV *Div = SE.getConstant(CI);
 176       S = Div;
 177       Remainder =
 178         SE.getAddExpr(Remainder,
 179                       SE.getConstant(C->getValue()->getValue().srem(Factor)));
 180       return true;
 181     }
 182   }
 183
 184   // In a Mul, check if there is a constant operand which is a multiple
 185   // of the given factor.
 186   if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(S))
 187     if (const SCEVConstant *C = dyn_cast<SCEVConstant>(M->getOperand(0)))
 188       if (!C->getValue()->getValue().srem(Factor)) {
 189         const SmallVectorImpl<const SCEV *> &MOperands = M->getOperands();
 190         SmallVector<const SCEV *, 4> NewMulOps(MOperands.begin(),
 191                                                MOperands.end());
 192         NewMulOps[0] =
 193           SE.getConstant(C->getValue()->getValue().sdiv(Factor));
 194         S = SE.getMulExpr(NewMulOps);
 195         return true;
 196       }
 197
 198   // In an AddRec, check if both start and step are divisible.
 199   if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(S)) {
 200     const SCEV *Step = A->getStepRecurrence(SE);
 201     const SCEV *StepRem = SE.getIntegerSCEV(0, Step->getType());
 202     if (!FactorOutConstant(Step, StepRem, Factor, SE))
 203       return false;
 204     if (!StepRem->isZero())
 205       return false;
 206     const SCEV *Start = A->getStart();
 207     if (!FactorOutConstant(Start, Remainder, Factor, SE))
 208       return false;
 209     S = SE.getAddRecExpr(Start, Step, A->getLoop());
 210     return true;
 211   }
 212
 213   return false;
 214 }
 215
 216 /// expandAddToGEP - Expand a SCEVAddExpr with a pointer type into a GEP
 217 /// instead of using ptrtoint+arithmetic+inttoptr. This helps
 218 /// BasicAliasAnalysis analyze the result.
 219 ///
 220 /// Design note: This depends on ScalarEvolution not recognizing inttoptr
 221 /// and ptrtoint operators, as they may introduce pointer arithmetic
 222 /// which may not be safely converted into getelementptr.
 223 ///
 224 /// Design note: It might seem desirable for this function to be more
 225 /// loop-aware. If some of the indices are loop-invariant while others
 226 /// aren't, it might seem desirable to emit multiple GEPs, keeping the
 227 /// loop-invariant portions of the overall computation outside the loop.
 228 /// However, there are a few reasons this is not done here. Hoisting simple
 229 /// arithmetic is a low-level optimization that often isn't very
 230 /// important until late in the optimization process. In fact, passes
 231 /// like InstructionCombining will combine GEPs, even if it means
 232 /// pushing loop-invariant computation down into loops, so even if the
 233 /// GEPs were split here, the work would quickly be undone. The
 234 /// LoopStrengthReduction pass, which is usually run quite late (and
 235 /// after the last InstructionCombining pass), takes care of hoisting
 236 /// loop-invariant portions of expressions, after considering what
 237 /// can be folded using target addressing modes.
 238 ///
 239 Value *SCEVExpander::expandAddToGEP(const SCEV *const *op_begin,
 240                                     const SCEV *const *op_end,
 241                                     const PointerType *PTy,
 242                                     const Type *Ty,
 243                                     Value *V) {
 244   const Type *ElTy = PTy->getElementType();
 245   SmallVector<Value *, 4> GepIndices;
 246   SmallVector<const SCEV *, 8> Ops(op_begin, op_end);
 247   bool AnyNonZeroIndices = false;
 248
 249   // Decend down the pointer's type and attempt to convert the other
 250   // operands into GEP indices, at each level. The first index in a GEP
 251   // indexes into the array implied by the pointer operand; the rest of
 252   // the indices index into the element or field type selected by the
 253   // preceding index.
 254   for (;;) {
 255     APInt ElSize = APInt(SE.getTypeSizeInBits(Ty),
 256                          ElTy->isSized() ?  SE.TD->getTypeAllocSize(ElTy) : 0);
 257     SmallVector<const SCEV *, 8> NewOps;
 258     SmallVector<const SCEV *, 8> ScaledOps;
 259     for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
 260       // Split AddRecs up into parts as either of the parts may be usable
 261       // without the other.
 262       if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(Ops[i]))
 263         if (!A->getStart()->isZero()) {
 264           const SCEV *Start = A->getStart();
 265           Ops.push_back(SE.getAddRecExpr(SE.getIntegerSCEV(0, A->getType()),
 266                                          A->getStepRecurrence(SE),
 267                                          A->getLoop()));
 268           Ops[i] = Start;
 269           ++e;
 270         }
 271       // If the scale size is not 0, attempt to factor out a scale.
 272       if (ElSize != 0) {
 273         const SCEV *Op = Ops[i];
 274         const SCEV *Remainder = SE.getIntegerSCEV(0, Op->getType());
 275         if (FactorOutConstant(Op, Remainder, ElSize, SE)) {
 276           ScaledOps.push_back(Op); // Op now has ElSize factored out.
 277           NewOps.push_back(Remainder);
 278           continue;
 279         }
 280       }
 281       // If the operand was not divisible, add it to the list of operands
 282       // we'll scan next iteration.
 283       NewOps.push_back(Ops[i]);
 284     }
 285     Ops = NewOps;
 286     AnyNonZeroIndices |= !ScaledOps.empty();
 287     Value *Scaled = ScaledOps.empty() ?
 288                     getContext().getNullValue(Ty) :
 289                     expandCodeFor(SE.getAddExpr(ScaledOps), Ty);
 290     GepIndices.push_back(Scaled);
 291
 292     // Collect struct field index operands.
 293     if (!Ops.empty())
 294       while (const StructType *STy = dyn_cast<StructType>(ElTy)) {
 295         if (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[0]))
 296           if (SE.getTypeSizeInBits(C->getType()) <= 64) {
 297             const StructLayout &SL = *SE.TD->getStructLayout(STy);
 298             uint64_t FullOffset = C->getValue()->getZExtValue();
 299             if (FullOffset < SL.getSizeInBytes()) {
 300               unsigned ElIdx = SL.getElementContainingOffset(FullOffset);
 301               GepIndices.push_back(ConstantInt::get(Type::Int32Ty, ElIdx));
 302               ElTy = STy->getTypeAtIndex(ElIdx);
 303               Ops[0] =
 304                 SE.getConstant(Ty, FullOffset - SL.getElementOffset(ElIdx));
 305               AnyNonZeroIndices = true;
 306               continue;
 307             }
 308           }
 309         break;
 310       }
 311
 312     if (const ArrayType *ATy = dyn_cast<ArrayType>(ElTy)) {
 313       ElTy = ATy->getElementType();
 314       continue;
 315     }
 316     break;
 317   }
 318
 319   // If none of the operands were convertable to proper GEP indices, cast
 320   // the base to i8* and do an ugly getelementptr with that. It's still
 321   // better than ptrtoint+arithmetic+inttoptr at least.
 322   if (!AnyNonZeroIndices) {
 323     V = InsertNoopCastOfTo(V,
 324                            Type::Int8Ty->getPointerTo(PTy->getAddressSpace()));
 325     Value *Idx = expandCodeFor(SE.getAddExpr(Ops), Ty);
 326
 327     // Fold a GEP with constant operands.
 328     if (Constant *CLHS = dyn_cast<Constant>(V))
 329       if (Constant *CRHS = dyn_cast<Constant>(Idx))
 330         return ConstantExpr::getGetElementPtr(CLHS, &CRHS, 1);
 331
 332     // Do a quick scan to see if we have this GEP nearby.  If so, reuse it.
 333     unsigned ScanLimit = 6;
 334     BasicBlock::iterator BlockBegin = Builder.GetInsertBlock()->begin();
 335     // Scanning starts from the last instruction before the insertion point.
 336     BasicBlock::iterator IP = Builder.GetInsertPoint();
 337     if (IP != BlockBegin) {
 338       --IP;
 339       for (; ScanLimit; --IP, --ScanLimit) {
 340         if (IP->getOpcode() == Instruction::GetElementPtr &&
 341             IP->getOperand(0) == V && IP->getOperand(1) == Idx)
 342           return IP;
 343         if (IP == BlockBegin) break;
 344       }
 345     }
 346
 347     Value *GEP = Builder.CreateGEP(V, Idx, "scevgep");
 348     InsertedValues.insert(GEP);
 349     return GEP;
 350   }
 351
 352   // Insert a pretty getelementptr. Note that this GEP is not marked inbounds,
 353   // because ScalarEvolution may have changed the address arithmetic to
 354   // compute a value which is beyond the end of the allocated object.
 355   Value *GEP = Builder.CreateGEP(V,
 356                                  GepIndices.begin(),
 357                                  GepIndices.end(),
 358                                  "scevgep");
 359   Ops.push_back(SE.getUnknown(GEP));
 360   InsertedValues.insert(GEP);
 361   return expand(SE.getAddExpr(Ops));
 362 }
 363
 364 Value *SCEVExpander::visitAddExpr(const SCEVAddExpr *S) {
 365   const Type *Ty = SE.getEffectiveSCEVType(S->getType());
 366   Value *V = expand(S->getOperand(S->getNumOperands()-1));
 367
 368   // Turn things like ptrtoint+arithmetic+inttoptr into GEP. See the
 369   // comments on expandAddToGEP for details.
 370   if (SE.TD)
 371     if (const PointerType *PTy = dyn_cast<PointerType>(V->getType())) {
 372       const SmallVectorImpl<const SCEV *> &Ops = S->getOperands();
 373       return expandAddToGEP(&Ops[0], &Ops[Ops.size() - 1], PTy, Ty, V);
 374     }
 375
 376   V = InsertNoopCastOfTo(V, Ty);
 377
 378   // Emit a bunch of add instructions
 379   for (int i = S->getNumOperands()-2; i >= 0; --i) {
 380     Value *W = expandCodeFor(S->getOperand(i), Ty);
 381     V = InsertBinop(Instruction::Add, V, W);
 382   }
 383   return V;
 384 }
 385
 386 Value *SCEVExpander::visitMulExpr(const SCEVMulExpr *S) {
 387   const Type *Ty = SE.getEffectiveSCEVType(S->getType());
 388   int FirstOp = 0;  // Set if we should emit a subtract.
 389   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(S->getOperand(0)))
 390     if (SC->getValue()->isAllOnesValue())
 391       FirstOp = 1;
 392
 393   int i = S->getNumOperands()-2;
 394   Value *V = expandCodeFor(S->getOperand(i+1), Ty);
 395
 396   // Emit a bunch of multiply instructions
 397   for (; i >= FirstOp; --i) {
 398     Value *W = expandCodeFor(S->getOperand(i), Ty);
 399     V = InsertBinop(Instruction::Mul, V, W);
 400   }
 401
 402   // -1 * ...  --->  0 - ...
 403   if (FirstOp == 1)
 404     V = InsertBinop(Instruction::Sub, getContext().getNullValue(Ty), V);
 405   return V;
 406 }
 407
 408 Value *SCEVExpander::visitUDivExpr(const SCEVUDivExpr *S) {
 409   const Type *Ty = SE.getEffectiveSCEVType(S->getType());
 410
 411   Value *LHS = expandCodeFor(S->getLHS(), Ty);
 412   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(S->getRHS())) {
 413     const APInt &RHS = SC->getValue()->getValue();
 414     if (RHS.isPowerOf2())
 415       return InsertBinop(Instruction::LShr, LHS,
 416                          ConstantInt::get(Ty, RHS.logBase2()));
 417   }
 418
 419   Value *RHS = expandCodeFor(S->getRHS(), Ty);
 420   return InsertBinop(Instruction::UDiv, LHS, RHS);
 421 }
 422
 423 /// Move parts of Base into Rest to leave Base with the minimal
 424 /// expression that provides a pointer operand suitable for a
 425 /// GEP expansion.
 426 static void ExposePointerBase(const SCEV *&Base, const SCEV *&Rest,
 427                               ScalarEvolution &SE) {
 428   while (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(Base)) {
 429     Base = A->getStart();
 430     Rest = SE.getAddExpr(Rest,
 431                          SE.getAddRecExpr(SE.getIntegerSCEV(0, A->getType()),
 432                                           A->getStepRecurrence(SE),
 433                                           A->getLoop()));
 434   }
 435   if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(Base)) {
 436     Base = A->getOperand(A->getNumOperands()-1);
 437     SmallVector<const SCEV *, 8> NewAddOps(A->op_begin(), A->op_end());
 438     NewAddOps.back() = Rest;
 439     Rest = SE.getAddExpr(NewAddOps);
 440     ExposePointerBase(Base, Rest, SE);
 441   }
 442 }
 443
 444 Value *SCEVExpander::visitAddRecExpr(const SCEVAddRecExpr *S) {
 445   const Type *Ty = SE.getEffectiveSCEVType(S->getType());
 446   const Loop *L = S->getLoop();
 447
 448   // First check for an existing canonical IV in a suitable type.
 449   PHINode *CanonicalIV = 0;
 450   if (PHINode *PN = L->getCanonicalInductionVariable())
 451     if (SE.isSCEVable(PN->getType()) &&
 452         isa<IntegerType>(SE.getEffectiveSCEVType(PN->getType())) &&
 453         SE.getTypeSizeInBits(PN->getType()) >= SE.getTypeSizeInBits(Ty))
 454       CanonicalIV = PN;
 455
 456   // Rewrite an AddRec in terms of the canonical induction variable, if
 457   // its type is more narrow.
 458   if (CanonicalIV &&
 459       SE.getTypeSizeInBits(CanonicalIV->getType()) >
 460       SE.getTypeSizeInBits(Ty)) {
 461     const SCEV *Start = SE.getAnyExtendExpr(S->getStart(),
 462                                             CanonicalIV->getType());
 463     const SCEV *Step = SE.getAnyExtendExpr(S->getStepRecurrence(SE),
 464                                            CanonicalIV->getType());
 465     Value *V = expand(SE.getAddRecExpr(Start, Step, S->getLoop()));
 466     BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
 467     BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
 468     BasicBlock::iterator NewInsertPt =
 469       next(BasicBlock::iterator(cast<Instruction>(V)));
 470     while (isa<PHINode>(NewInsertPt)) ++NewInsertPt;
 471     V = expandCodeFor(SE.getTruncateExpr(SE.getUnknown(V), Ty), 0,
 472                       NewInsertPt);
 473     Builder.SetInsertPoint(SaveInsertBB, SaveInsertPt);
 474     return V;
 475   }
 476
 477   // {X,+,F} --> X + {0,+,F}
 478   if (!S->getStart()->isZero()) {
 479     const SmallVectorImpl<const SCEV *> &SOperands = S->getOperands();
 480     SmallVector<const SCEV *, 4> NewOps(SOperands.begin(), SOperands.end());
 481     NewOps[0] = SE.getIntegerSCEV(0, Ty);
 482     const SCEV *Rest = SE.getAddRecExpr(NewOps, L);
 483
 484     // Turn things like ptrtoint+arithmetic+inttoptr into GEP. See the
 485     // comments on expandAddToGEP for details.
 486     if (SE.TD) {
 487       const SCEV *Base = S->getStart();
 488       const SCEV *RestArray[1] = { Rest };
 489       // Dig into the expression to find the pointer base for a GEP.
 490       ExposePointerBase(Base, RestArray[0], SE);
 491       // If we found a pointer, expand the AddRec with a GEP.
 492       if (const PointerType *PTy = dyn_cast<PointerType>(Base->getType())) {
 493         // Make sure the Base isn't something exotic, such as a multiplied
 494         // or divided pointer value. In those cases, the result type isn't
 495         // actually a pointer type.
 496         if (!isa<SCEVMulExpr>(Base) && !isa<SCEVUDivExpr>(Base)) {
 497           Value *StartV = expand(Base);
 498           assert(StartV->getType() == PTy && "Pointer type mismatch for GEP!");
 499           return expandAddToGEP(RestArray, RestArray+1, PTy, Ty, StartV);
 500         }
 501       }
 502     }
 503
 504     // Just do a normal add. Pre-expand the operands to suppress folding.
 505     return expand(SE.getAddExpr(SE.getUnknown(expand(S->getStart())),
 506                                 SE.getUnknown(expand(Rest))));
 507   }
 508
 509   // {0,+,1} --> Insert a canonical induction variable into the loop!
 510   if (S->isAffine() &&
 511       S->getOperand(1) == SE.getIntegerSCEV(1, Ty)) {
 512     // If there's a canonical IV, just use it.
 513     if (CanonicalIV) {
 514       assert(Ty == SE.getEffectiveSCEVType(CanonicalIV->getType()) &&
 515              "IVs with types different from the canonical IV should "
 516              "already have been handled!");
 517       return CanonicalIV;
 518     }
 519
 520     // Create and insert the PHI node for the induction variable in the
 521     // specified loop.
 522     BasicBlock *Header = L->getHeader();
 523     BasicBlock *Preheader = L->getLoopPreheader();
 524     PHINode *PN = PHINode::Create(Ty, "indvar", Header->begin());
 525     InsertedValues.insert(PN);
 526     PN->addIncoming(getContext().getNullValue(Ty), Preheader);
 527
 528     pred_iterator HPI = pred_begin(Header);
 529     assert(HPI != pred_end(Header) && "Loop with zero preds???");
 530     if (!L->contains(*HPI)) ++HPI;
 531     assert(HPI != pred_end(Header) && L->contains(*HPI) &&
 532            "No backedge in loop?");
 533
 534     // Insert a unit add instruction right before the terminator corresponding
 535     // to the back-edge.
 536     Constant *One = ConstantInt::get(Ty, 1);
 537     Instruction *Add = BinaryOperator::CreateAdd(PN, One, "indvar.next",
 538                                                  (*HPI)->getTerminator());
 539     InsertedValues.insert(Add);
 540
 541     pred_iterator PI = pred_begin(Header);
 542     if (*PI == Preheader)
 543       ++PI;
 544     PN->addIncoming(Add, *PI);
 545     return PN;
 546   }
 547
 548   // {0,+,F} --> {0,+,1} * F
 549   // Get the canonical induction variable I for this loop.
 550   Value *I = CanonicalIV ?
 551              CanonicalIV :
 552              getOrInsertCanonicalInductionVariable(L, Ty);
 553
 554   // If this is a simple linear addrec, emit it now as a special case.
 555   if (S->isAffine())    // {0,+,F} --> i*F
 556     return
 557       expand(SE.getTruncateOrNoop(
 558         SE.getMulExpr(SE.getUnknown(I),
 559                       SE.getNoopOrAnyExtend(S->getOperand(1),
 560                                             I->getType())),
 561         Ty));
 562
 563   // If this is a chain of recurrences, turn it into a closed form, using the
 564   // folders, then expandCodeFor the closed form.  This allows the folders to
 565   // simplify the expression without having to build a bunch of special code
 566   // into this folder.
 567   const SCEV *IH = SE.getUnknown(I);   // Get I as a "symbolic" SCEV.
 568
 569   // Promote S up to the canonical IV type, if the cast is foldable.
 570   const SCEV *NewS = S;
 571   const SCEV *Ext = SE.getNoopOrAnyExtend(S, I->getType());
 572   if (isa<SCEVAddRecExpr>(Ext))
 573     NewS = Ext;
 574
 575   const SCEV *V = cast<SCEVAddRecExpr>(NewS)->evaluateAtIteration(IH, SE);
 576   //cerr << "Evaluated: " << *this << "\n     to: " << *V << "\n";
 577
 578   // Truncate the result down to the original type, if needed.
 579   const SCEV *T = SE.getTruncateOrNoop(V, Ty);
 580   return expand(T);
 581 }
 582
 583 Value *SCEVExpander::visitTruncateExpr(const SCEVTruncateExpr *S) {
 584   const Type *Ty = SE.getEffectiveSCEVType(S->getType());
 585   Value *V = expandCodeFor(S->getOperand(),
 586                            SE.getEffectiveSCEVType(S->getOperand()->getType()));
 587   Value *I = Builder.CreateTrunc(V, Ty, "tmp");
 588   InsertedValues.insert(I);
 589   return I;
 590 }
 591
 592 Value *SCEVExpander::visitZeroExtendExpr(const SCEVZeroExtendExpr *S) {
 593   const Type *Ty = SE.getEffectiveSCEVType(S->getType());
 594   Value *V = expandCodeFor(S->getOperand(),
 595                            SE.getEffectiveSCEVType(S->getOperand()->getType()));
 596   Value *I = Builder.CreateZExt(V, Ty, "tmp");
 597   InsertedValues.insert(I);
 598   return I;
 599 }
 600
 601 Value *SCEVExpander::visitSignExtendExpr(const SCEVSignExtendExpr *S) {
 602   const Type *Ty = SE.getEffectiveSCEVType(S->getType());
 603   Value *V = expandCodeFor(S->getOperand(),
 604                            SE.getEffectiveSCEVType(S->getOperand()->getType()));
 605   Value *I = Builder.CreateSExt(V, Ty, "tmp");
 606   InsertedValues.insert(I);
 607   return I;
 608 }
 609
 610 Value *SCEVExpander::visitSMaxExpr(const SCEVSMaxExpr *S) {
 611   Value *LHS = expand(S->getOperand(S->getNumOperands()-1));
 612   const Type *Ty = LHS->getType();
 613   for (int i = S->getNumOperands()-2; i >= 0; --i) {
 614     // In the case of mixed integer and pointer types, do the
 615     // rest of the comparisons as integer.
 616     if (S->getOperand(i)->getType() != Ty) {
 617       Ty = SE.getEffectiveSCEVType(Ty);
 618       LHS = InsertNoopCastOfTo(LHS, Ty);
 619     }
 620     Value *RHS = expandCodeFor(S->getOperand(i), Ty);
 621     Value *ICmp = Builder.CreateICmpSGT(LHS, RHS, "tmp");
 622     InsertedValues.insert(ICmp);
 623     Value *Sel = Builder.CreateSelect(ICmp, LHS, RHS, "smax");
 624     InsertedValues.insert(Sel);
 625     LHS = Sel;
 626   }
 627   // In the case of mixed integer and pointer types, cast the
 628   // final result back to the pointer type.
 629   if (LHS->getType() != S->getType())
 630     LHS = InsertNoopCastOfTo(LHS, S->getType());
 631   return LHS;
 632 }
 633
 634 Value *SCEVExpander::visitUMaxExpr(const SCEVUMaxExpr *S) {
 635   Value *LHS = expand(S->getOperand(S->getNumOperands()-1));
 636   const Type *Ty = LHS->getType();
 637   for (int i = S->getNumOperands()-2; i >= 0; --i) {
 638     // In the case of mixed integer and pointer types, do the
 639     // rest of the comparisons as integer.
 640     if (S->getOperand(i)->getType() != Ty) {
 641       Ty = SE.getEffectiveSCEVType(Ty);
 642       LHS = InsertNoopCastOfTo(LHS, Ty);
 643     }
 644     Value *RHS = expandCodeFor(S->getOperand(i), Ty);
 645     Value *ICmp = Builder.CreateICmpUGT(LHS, RHS, "tmp");
 646     InsertedValues.insert(ICmp);
 647     Value *Sel = Builder.CreateSelect(ICmp, LHS, RHS, "umax");
 648     InsertedValues.insert(Sel);
 649     LHS = Sel;
 650   }
 651   // In the case of mixed integer and pointer types, cast the
 652   // final result back to the pointer type.
 653   if (LHS->getType() != S->getType())
 654     LHS = InsertNoopCastOfTo(LHS, S->getType());
 655   return LHS;
 656 }
 657
 658 Value *SCEVExpander::expandCodeFor(const SCEV *SH, const Type *Ty) {
 659   // Expand the code for this SCEV.
 660   Value *V = expand(SH);
 661   if (Ty) {
 662     assert(SE.getTypeSizeInBits(Ty) == SE.getTypeSizeInBits(SH->getType()) &&
 663            "non-trivial casts should be done with the SCEVs directly!");
 664     V = InsertNoopCastOfTo(V, Ty);
 665   }
 666   return V;
 667 }
 668
 669 Value *SCEVExpander::expand(const SCEV *S) {
 670   // Compute an insertion point for this SCEV object. Hoist the instructions
 671   // as far out in the loop nest as possible.
 672   Instruction *InsertPt = Builder.GetInsertPoint();
 673   for (Loop *L = SE.LI->getLoopFor(Builder.GetInsertBlock()); ;
 674        L = L->getParentLoop())
 675     if (S->isLoopInvariant(L)) {
 676       if (!L) break;
 677       if (BasicBlock *Preheader = L->getLoopPreheader())
 678         InsertPt = Preheader->getTerminator();
 679     } else {
 680       // If the SCEV is computable at this level, insert it into the header
 681       // after the PHIs (and after any other instructions that we've inserted
 682       // there) so that it is guaranteed to dominate any user inside the loop.
 683       if (L && S->hasComputableLoopEvolution(L))
 684         InsertPt = L->getHeader()->getFirstNonPHI();
 685       while (isInsertedInstruction(InsertPt))
 686         InsertPt = next(BasicBlock::iterator(InsertPt));
 687       break;
 688     }
 689
 690   // Check to see if we already expanded this here.
 691   std::map<std::pair<const SCEV *, Instruction *>,
 692            AssertingVH<Value> >::iterator I =
 693     InsertedExpressions.find(std::make_pair(S, InsertPt));
 694   if (I != InsertedExpressions.end())
 695     return I->second;
 696
 697   BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
 698   BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
 699   Builder.SetInsertPoint(InsertPt->getParent(), InsertPt);
 700
 701   // Expand the expression into instructions.
 702   Value *V = visit(S);
 703
 704   // Remember the expanded value for this SCEV at this location.
 705   InsertedExpressions[std::make_pair(S, InsertPt)] = V;
 706
 707   Builder.SetInsertPoint(SaveInsertBB, SaveInsertPt);
 708   return V;
 709 }
 710
 711 /// getOrInsertCanonicalInductionVariable - This method returns the
 712 /// canonical induction variable of the specified type for the specified
 713 /// loop (inserting one if there is none).  A canonical induction variable
 714 /// starts at zero and steps by one on each iteration.
 715 Value *
 716 SCEVExpander::getOrInsertCanonicalInductionVariable(const Loop *L,
 717                                                     const Type *Ty) {
 718   assert(Ty->isInteger() && "Can only insert integer induction variables!");
 719   const SCEV *H = SE.getAddRecExpr(SE.getIntegerSCEV(0, Ty),
 720                                    SE.getIntegerSCEV(1, Ty), L);
 721   BasicBlock *SaveInsertBB = Builder.GetInsertBlock();
 722   BasicBlock::iterator SaveInsertPt = Builder.GetInsertPoint();
 723   Value *V = expandCodeFor(H, 0, L->getHeader()->begin());
 724   if (SaveInsertBB)
 725     Builder.SetInsertPoint(SaveInsertBB, SaveInsertPt);
 726   return V;
 727 }