lib/Transforms/Scalar/IndVarSimplify.cpp

   1 //===- IndVarSimplify.cpp - Induction Variable Elimination ----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This transformation analyzes and transforms the induction variables (and
  11 // computations derived from them) into simpler forms suitable for subsequent
  12 // analysis and transformation.
  13 //
  14 // This transformation make the following changes to each loop with an
  15 // identifiable induction variable:
  16 //   1. All loops are transformed to have a SINGLE canonical induction variable
  17 //      which starts at zero and steps by one.
  18 //   2. The canonical induction variable is guaranteed to be the first PHI node
  19 //      in the loop header block.
  20 //   3. Any pointer arithmetic recurrences are raised to use array subscripts.
  21 //
  22 // If the trip count of a loop is computable, this pass also makes the following
  23 // changes:
  24 //   1. The exit condition for the loop is canonicalized to compare the
  25 //      induction value against the exit value.  This turns loops like:
  26 //        'for (i = 7; i*i < 1000; ++i)' into 'for (i = 0; i != 25; ++i)'
  27 //   2. Any use outside of the loop of an expression derived from the indvar
  28 //      is changed to compute the derived value outside of the loop, eliminating
  29 //      the dependence on the exit value of the induction variable.  If the only
  30 //      purpose of the loop is to compute the exit value of some derived
  31 //      expression, this transformation will make the loop dead.
  32 //
  33 // This transformation should be followed by strength reduction after all of the
  34 // desired loop transformations have been performed.  Additionally, on targets
  35 // where it is profitable, the loop could be transformed to count down to zero
  36 // (the "do loop" optimization).
  37 //
  38 //===----------------------------------------------------------------------===//
  39
  40 #include "llvm/Transforms/Scalar.h"
  41 #include "llvm/BasicBlock.h"
  42 #include "llvm/Constants.h"
  43 #include "llvm/Instructions.h"
  44 #include "llvm/Type.h"
  45 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
  46 #include "llvm/Analysis/LoopInfo.h"
  47 #include "llvm/Support/CFG.h"
  48 #include "llvm/Support/GetElementPtrTypeIterator.h"
  49 #include "llvm/Transforms/Utils/Local.h"
  50 #include "llvm/Support/CommandLine.h"
  51 #include "llvm/ADT/Statistic.h"
  52 using namespace llvm;
  53
  54 namespace {
  55   /// SCEVExpander - This class uses information about analyze scalars to
  56   /// rewrite expressions in canonical form.
  57   ///
  58   /// Clients should create an instance of this class when rewriting is needed,
  59   /// and destroying it when finished to allow the release of the associated
  60   /// memory.
  61   struct SCEVExpander : public SCEVVisitor<SCEVExpander, Value*> {
  62     ScalarEvolution &SE;
  63     LoopInfo &LI;
  64     std::map<SCEVHandle, Value*> InsertedExpressions;
  65     std::set<Instruction*> InsertedInstructions;
  66
  67     Instruction *InsertPt;
  68
  69     friend struct SCEVVisitor<SCEVExpander, Value*>;
  70   public:
  71     SCEVExpander(ScalarEvolution &se, LoopInfo &li) : SE(se), LI(li) {}
  72
  73     /// isInsertedInstruction - Return true if the specified instruction was
  74     /// inserted by the code rewriter.  If so, the client should not modify the
  75     /// instruction.
  76     bool isInsertedInstruction(Instruction *I) const {
  77       return InsertedInstructions.count(I);
  78     }
  79
  80     /// getOrInsertCanonicalInductionVariable - This method returns the
  81     /// canonical induction variable of the specified type for the specified
  82     /// loop (inserting one if there is none).  A canonical induction variable
  83     /// starts at zero and steps by one on each iteration.
  84     Value *getOrInsertCanonicalInductionVariable(const Loop *L, const Type *Ty){
  85       assert((Ty->isInteger() || Ty->isFloatingPoint()) &&
  86              "Can only insert integer or floating point induction variables!");
  87       SCEVHandle H = SCEVAddRecExpr::get(SCEVUnknown::getIntegerSCEV(0, Ty),
  88                                          SCEVUnknown::getIntegerSCEV(1, Ty), L);
  89       return expand(H);
  90     }
  91
  92     /// addInsertedValue - Remember the specified instruction as being the
  93     /// canonical form for the specified SCEV.
  94     void addInsertedValue(Instruction *I, SCEV *S) {
  95       InsertedExpressions[S] = (Value*)I;
  96       InsertedInstructions.insert(I);
  97     }
  98
  99     /// expandCodeFor - Insert code to directly compute the specified SCEV
 100     /// expression into the program.  The inserted code is inserted into the
 101     /// specified block.
 102     ///
 103     /// If a particular value sign is required, a type may be specified for the
 104     /// result.
 105     Value *expandCodeFor(SCEVHandle SH, Instruction *IP, const Type *Ty = 0) {
 106       // Expand the code for this SCEV.
 107       this->InsertPt = IP;
 108       return expandInTy(SH, Ty);
 109     }
 110
 111   protected:
 112     Value *expand(SCEV *S) {
 113       // Check to see if we already expanded this.
 114       std::map<SCEVHandle, Value*>::iterator I = InsertedExpressions.find(S);
 115       if (I != InsertedExpressions.end())
 116         return I->second;
 117
 118       Value *V = visit(S);
 119       InsertedExpressions[S] = V;
 120       return V;
 121     }
 122
 123     Value *expandInTy(SCEV *S, const Type *Ty) {
 124       Value *V = expand(S);
 125       if (Ty && V->getType() != Ty) {
 126         // FIXME: keep track of the cast instruction.
 127         if (Constant *C = dyn_cast<Constant>(V))
 128           return ConstantExpr::getCast(C, Ty);
 129         else if (Instruction *I = dyn_cast<Instruction>(V)) {
 130           // Check to see if there is already a cast.  If there is, use it.
 131           for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
 132                UI != E; ++UI) {
 133             if ((*UI)->getType() == Ty)
 134               if (CastInst *CI = dyn_cast<CastInst>(cast<Instruction>(*UI))) {
 135                 BasicBlock::iterator It = I; ++It;
 136                 while (isa<PHINode>(It)) ++It;
 137                 if (It != BasicBlock::iterator(CI)) {
 138                   // Splice the cast immediately after the operand in question.
 139                   BasicBlock::InstListType &InstList =
 140                     I->getParent()->getInstList();
 141                   InstList.splice(It, CI->getParent()->getInstList(), CI);
 142                 }
 143                 return CI;
 144               }
 145           }
 146           BasicBlock::iterator IP = I; ++IP;
 147           if (InvokeInst *II = dyn_cast<InvokeInst>(I))
 148             IP = II->getNormalDest()->begin();
 149           while (isa<PHINode>(IP)) ++IP;
 150           return new CastInst(V, Ty, V->getName(), IP);
 151         } else {
 152           // FIXME: check to see if there is already a cast!
 153           return new CastInst(V, Ty, V->getName(), InsertPt);
 154         }
 155       }
 156       return V;
 157     }
 158
 159     Value *visitConstant(SCEVConstant *S) {
 160       return S->getValue();
 161     }
 162
 163     Value *visitTruncateExpr(SCEVTruncateExpr *S) {
 164       Value *V = expand(S->getOperand());
 165       return new CastInst(V, S->getType(), "tmp.", InsertPt);
 166     }
 167
 168     Value *visitZeroExtendExpr(SCEVZeroExtendExpr *S) {
 169       Value *V = expandInTy(S->getOperand(),S->getType()->getUnsignedVersion());
 170       return new CastInst(V, S->getType(), "tmp.", InsertPt);
 171     }
 172
 173     Value *visitAddExpr(SCEVAddExpr *S) {
 174       const Type *Ty = S->getType();
 175       Value *V = expandInTy(S->getOperand(S->getNumOperands()-1), Ty);
 176
 177       // Emit a bunch of add instructions
 178       for (int i = S->getNumOperands()-2; i >= 0; --i)
 179         V = BinaryOperator::createAdd(V, expandInTy(S->getOperand(i), Ty),
 180                                       "tmp.", InsertPt);
 181       return V;
 182     }
 183
 184     Value *visitMulExpr(SCEVMulExpr *S);
 185
 186     Value *visitUDivExpr(SCEVUDivExpr *S) {
 187       const Type *Ty = S->getType();
 188       Value *LHS = expandInTy(S->getLHS(), Ty);
 189       Value *RHS = expandInTy(S->getRHS(), Ty);
 190       return BinaryOperator::createDiv(LHS, RHS, "tmp.", InsertPt);
 191     }
 192
 193     Value *visitAddRecExpr(SCEVAddRecExpr *S);
 194
 195     Value *visitUnknown(SCEVUnknown *S) {
 196       return S->getValue();
 197     }
 198   };
 199 }
 200
 201 Value *SCEVExpander::visitMulExpr(SCEVMulExpr *S) {
 202   const Type *Ty = S->getType();
 203   int FirstOp = 0;  // Set if we should emit a subtract.
 204   if (SCEVConstant *SC = dyn_cast<SCEVConstant>(S->getOperand(0)))
 205     if (SC->getValue()->isAllOnesValue())
 206       FirstOp = 1;
 207
 208   int i = S->getNumOperands()-2;
 209   Value *V = expandInTy(S->getOperand(i+1), Ty);
 210
 211   // Emit a bunch of multiply instructions
 212   for (; i >= FirstOp; --i)
 213     V = BinaryOperator::createMul(V, expandInTy(S->getOperand(i), Ty),
 214                                   "tmp.", InsertPt);
 215   // -1 * ...  --->  0 - ...
 216   if (FirstOp == 1)
 217     V = BinaryOperator::createNeg(V, "tmp.", InsertPt);
 218   return V;
 219 }
 220
 221 Value *SCEVExpander::visitAddRecExpr(SCEVAddRecExpr *S) {
 222   const Type *Ty = S->getType();
 223   const Loop *L = S->getLoop();
 224   // We cannot yet do fp recurrences, e.g. the xform of {X,+,F} --> X+{0,+,F}
 225   assert(Ty->isIntegral() && "Cannot expand fp recurrences yet!");
 226
 227   // {X,+,F} --> X + {0,+,F}
 228   if (!isa<SCEVConstant>(S->getStart()) ||
 229       !cast<SCEVConstant>(S->getStart())->getValue()->isNullValue()) {
 230     Value *Start = expandInTy(S->getStart(), Ty);
 231     std::vector<SCEVHandle> NewOps(S->op_begin(), S->op_end());
 232     NewOps[0] = SCEVUnknown::getIntegerSCEV(0, Ty);
 233     Value *Rest = expandInTy(SCEVAddRecExpr::get(NewOps, L), Ty);
 234
 235     // FIXME: look for an existing add to use.
 236     return BinaryOperator::createAdd(Rest, Start, "tmp.", InsertPt);
 237   }
 238
 239   // {0,+,1} --> Insert a canonical induction variable into the loop!
 240   if (S->getNumOperands() == 2 &&
 241       S->getOperand(1) == SCEVUnknown::getIntegerSCEV(1, Ty)) {
 242     // Create and insert the PHI node for the induction variable in the
 243     // specified loop.
 244     BasicBlock *Header = L->getHeader();
 245     PHINode *PN = new PHINode(Ty, "indvar", Header->begin());
 246     PN->addIncoming(Constant::getNullValue(Ty), L->getLoopPreheader());
 247
 248     pred_iterator HPI = pred_begin(Header);
 249     assert(HPI != pred_end(Header) && "Loop with zero preds???");
 250     if (!L->contains(*HPI)) ++HPI;
 251     assert(HPI != pred_end(Header) && L->contains(*HPI) &&
 252            "No backedge in loop?");
 253
 254     // Insert a unit add instruction right before the terminator corresponding
 255     // to the back-edge.
 256     Constant *One = Ty->isFloatingPoint() ? (Constant*)ConstantFP::get(Ty, 1.0)
 257                                           : ConstantInt::get(Ty, 1);
 258     Instruction *Add = BinaryOperator::createAdd(PN, One, "indvar.next",
 259                                                  (*HPI)->getTerminator());
 260
 261     pred_iterator PI = pred_begin(Header);
 262     if (*PI == L->getLoopPreheader())
 263       ++PI;
 264     PN->addIncoming(Add, *PI);
 265     return PN;
 266   }
 267
 268   // Get the canonical induction variable I for this loop.
 269   Value *I = getOrInsertCanonicalInductionVariable(L, Ty);
 270
 271   if (S->getNumOperands() == 2) {   // {0,+,F} --> i*F
 272     Value *F = expandInTy(S->getOperand(1), Ty);
 273     return BinaryOperator::createMul(I, F, "tmp.", InsertPt);
 274   }
 275
 276   // If this is a chain of recurrences, turn it into a closed form, using the
 277   // folders, then expandCodeFor the closed form.  This allows the folders to
 278   // simplify the expression without having to build a bunch of special code
 279   // into this folder.
 280   SCEVHandle IH = SCEVUnknown::get(I);   // Get I as a "symbolic" SCEV.
 281
 282   SCEVHandle V = S->evaluateAtIteration(IH);
 283   //std::cerr << "Evaluated: " << *this << "\n     to: " << *V << "\n";
 284
 285   return expandInTy(V, Ty);
 286 }
 287
 288
 289 namespace {
 290   Statistic<> NumRemoved ("indvars", "Number of aux indvars removed");
 291   Statistic<> NumPointer ("indvars", "Number of pointer indvars promoted");
 292   Statistic<> NumInserted("indvars", "Number of canonical indvars added");
 293   Statistic<> NumReplaced("indvars", "Number of exit values replaced");
 294   Statistic<> NumLFTR    ("indvars", "Number of loop exit tests replaced");
 295
 296   class IndVarSimplify : public FunctionPass {
 297     LoopInfo        *LI;
 298     ScalarEvolution *SE;
 299     bool Changed;
 300   public:
 301     virtual bool runOnFunction(Function &) {
 302       LI = &getAnalysis<LoopInfo>();
 303       SE = &getAnalysis<ScalarEvolution>();
 304       Changed = false;
 305
 306       // Induction Variables live in the header nodes of loops
 307       for (LoopInfo::iterator I = LI->begin(), E = LI->end(); I != E; ++I)
 308         runOnLoop(*I);
 309       return Changed;
 310     }
 311
 312     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 313       AU.addRequiredID(LoopSimplifyID);
 314       AU.addRequired<ScalarEvolution>();
 315       AU.addRequired<LoopInfo>();
 316       AU.addPreservedID(LoopSimplifyID);
 317       AU.setPreservesCFG();
 318     }
 319   private:
 320     void runOnLoop(Loop *L);
 321     void EliminatePointerRecurrence(PHINode *PN, BasicBlock *Preheader,
 322                                     std::set<Instruction*> &DeadInsts);
 323     void LinearFunctionTestReplace(Loop *L, SCEV *IterationCount,
 324                                    SCEVExpander &RW);
 325     void RewriteLoopExitValues(Loop *L);
 326
 327     void DeleteTriviallyDeadInstructions(std::set<Instruction*> &Insts);
 328   };
 329   RegisterOpt<IndVarSimplify> X("indvars", "Canonicalize Induction Variables");
 330 }
 331
 332 FunctionPass *llvm::createIndVarSimplifyPass() {
 333   return new IndVarSimplify();
 334 }
 335
 336 /// DeleteTriviallyDeadInstructions - If any of the instructions is the
 337 /// specified set are trivially dead, delete them and see if this makes any of
 338 /// their operands subsequently dead.
 339 void IndVarSimplify::
 340 DeleteTriviallyDeadInstructions(std::set<Instruction*> &Insts) {
 341   while (!Insts.empty()) {
 342     Instruction *I = *Insts.begin();
 343     Insts.erase(Insts.begin());
 344     if (isInstructionTriviallyDead(I)) {
 345       for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
 346         if (Instruction *U = dyn_cast<Instruction>(I->getOperand(i)))
 347           Insts.insert(U);
 348       SE->deleteInstructionFromRecords(I);
 349       I->eraseFromParent();
 350       Changed = true;
 351     }
 352   }
 353 }
 354
 355
 356 /// EliminatePointerRecurrence - Check to see if this is a trivial GEP pointer
 357 /// recurrence.  If so, change it into an integer recurrence, permitting
 358 /// analysis by the SCEV routines.
 359 void IndVarSimplify::EliminatePointerRecurrence(PHINode *PN,
 360                                                 BasicBlock *Preheader,
 361                                             std::set<Instruction*> &DeadInsts) {
 362   assert(PN->getNumIncomingValues() == 2 && "Noncanonicalized loop!");
 363   unsigned PreheaderIdx = PN->getBasicBlockIndex(Preheader);
 364   unsigned BackedgeIdx = PreheaderIdx^1;
 365   if (GetElementPtrInst *GEPI =
 366       dyn_cast<GetElementPtrInst>(PN->getIncomingValue(BackedgeIdx)))
 367     if (GEPI->getOperand(0) == PN) {
 368       assert(GEPI->getNumOperands() == 2 && "GEP types must mismatch!");
 369
 370       // Okay, we found a pointer recurrence.  Transform this pointer
 371       // recurrence into an integer recurrence.  Compute the value that gets
 372       // added to the pointer at every iteration.
 373       Value *AddedVal = GEPI->getOperand(1);
 374
 375       // Insert a new integer PHI node into the top of the block.
 376       PHINode *NewPhi = new PHINode(AddedVal->getType(),
 377                                     PN->getName()+".rec", PN);
 378       NewPhi->addIncoming(Constant::getNullValue(NewPhi->getType()), Preheader);
 379
 380       // Create the new add instruction.
 381       Value *NewAdd = BinaryOperator::createAdd(NewPhi, AddedVal,
 382                                                 GEPI->getName()+".rec", GEPI);
 383       NewPhi->addIncoming(NewAdd, PN->getIncomingBlock(BackedgeIdx));
 384
 385       // Update the existing GEP to use the recurrence.
 386       GEPI->setOperand(0, PN->getIncomingValue(PreheaderIdx));
 387
 388       // Update the GEP to use the new recurrence we just inserted.
 389       GEPI->setOperand(1, NewAdd);
 390
 391       // If the incoming value is a constant expr GEP, try peeling out the array
 392       // 0 index if possible to make things simpler.
 393       if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GEPI->getOperand(0)))
 394         if (CE->getOpcode() == Instruction::GetElementPtr) {
 395           unsigned NumOps = CE->getNumOperands();
 396           assert(NumOps > 1 && "CE folding didn't work!");
 397           if (CE->getOperand(NumOps-1)->isNullValue()) {
 398             // Check to make sure the last index really is an array index.
 399             gep_type_iterator GTI = gep_type_begin(GEPI);
 400             for (unsigned i = 1, e = GEPI->getNumOperands()-1;
 401                  i != e; ++i, ++GTI)
 402               /*empty*/;
 403             if (isa<SequentialType>(*GTI)) {
 404               // Pull the last index out of the constant expr GEP.
 405               std::vector<Value*> CEIdxs(CE->op_begin()+1, CE->op_end()-1);
 406               Constant *NCE = ConstantExpr::getGetElementPtr(CE->getOperand(0),
 407                                                              CEIdxs);
 408               GetElementPtrInst *NGEPI =
 409                 new GetElementPtrInst(NCE, Constant::getNullValue(Type::IntTy),
 410                                       NewAdd, GEPI->getName(), GEPI);
 411               GEPI->replaceAllUsesWith(NGEPI);
 412               GEPI->eraseFromParent();
 413               GEPI = NGEPI;
 414             }
 415           }
 416         }
 417
 418
 419       // Finally, if there are any other users of the PHI node, we must
 420       // insert a new GEP instruction that uses the pre-incremented version
 421       // of the induction amount.
 422       if (!PN->use_empty()) {
 423         BasicBlock::iterator InsertPos = PN; ++InsertPos;
 424         while (isa<PHINode>(InsertPos)) ++InsertPos;
 425         std::string Name = PN->getName(); PN->setName("");
 426         Value *PreInc =
 427           new GetElementPtrInst(PN->getIncomingValue(PreheaderIdx),
 428                                 std::vector<Value*>(1, NewPhi), Name,
 429                                 InsertPos);
 430         PN->replaceAllUsesWith(PreInc);
 431       }
 432
 433       // Delete the old PHI for sure, and the GEP if its otherwise unused.
 434       DeadInsts.insert(PN);
 435
 436       ++NumPointer;
 437       Changed = true;
 438     }
 439 }
 440
 441 /// LinearFunctionTestReplace - This method rewrites the exit condition of the
 442 /// loop to be a canonical != comparison against the incremented loop induction
 443 /// variable.  This pass is able to rewrite the exit tests of any loop where the
 444 /// SCEV analysis can determine a loop-invariant trip count of the loop, which
 445 /// is actually a much broader range than just linear tests.
 446 void IndVarSimplify::LinearFunctionTestReplace(Loop *L, SCEV *IterationCount,
 447                                                SCEVExpander &RW) {
 448   // Find the exit block for the loop.  We can currently only handle loops with
 449   // a single exit.
 450   std::vector<BasicBlock*> ExitBlocks;
 451   L->getExitBlocks(ExitBlocks);
 452   if (ExitBlocks.size() != 1) return;
 453   BasicBlock *ExitBlock = ExitBlocks[0];
 454
 455   // Make sure there is only one predecessor block in the loop.
 456   BasicBlock *ExitingBlock = 0;
 457   for (pred_iterator PI = pred_begin(ExitBlock), PE = pred_end(ExitBlock);
 458        PI != PE; ++PI)
 459     if (L->contains(*PI)) {
 460       if (ExitingBlock == 0)
 461         ExitingBlock = *PI;
 462       else
 463         return;  // Multiple exits from loop to this block.
 464     }
 465   assert(ExitingBlock && "Loop info is broken");
 466
 467   if (!isa<BranchInst>(ExitingBlock->getTerminator()))
 468     return;  // Can't rewrite non-branch yet
 469   BranchInst *BI = cast<BranchInst>(ExitingBlock->getTerminator());
 470   assert(BI->isConditional() && "Must be conditional to be part of loop!");
 471
 472   std::set<Instruction*> InstructionsToDelete;
 473   if (Instruction *Cond = dyn_cast<Instruction>(BI->getCondition()))
 474     InstructionsToDelete.insert(Cond);
 475
 476   // If the exiting block is not the same as the backedge block, we must compare
 477   // against the preincremented value, otherwise we prefer to compare against
 478   // the post-incremented value.
 479   BasicBlock *Header = L->getHeader();
 480   pred_iterator HPI = pred_begin(Header);
 481   assert(HPI != pred_end(Header) && "Loop with zero preds???");
 482   if (!L->contains(*HPI)) ++HPI;
 483   assert(HPI != pred_end(Header) && L->contains(*HPI) &&
 484          "No backedge in loop?");
 485
 486   SCEVHandle TripCount = IterationCount;
 487   Value *IndVar;
 488   if (*HPI == ExitingBlock) {
 489     // The IterationCount expression contains the number of times that the
 490     // backedge actually branches to the loop header.  This is one less than the
 491     // number of times the loop executes, so add one to it.
 492     Constant *OneC = ConstantInt::get(IterationCount->getType(), 1);
 493     TripCount = SCEVAddExpr::get(IterationCount, SCEVUnknown::get(OneC));
 494     IndVar = L->getCanonicalInductionVariableIncrement();
 495   } else {
 496     // We have to use the preincremented value...
 497     IndVar = L->getCanonicalInductionVariable();
 498   }
 499
 500   // Expand the code for the iteration count into the preheader of the loop.
 501   BasicBlock *Preheader = L->getLoopPreheader();
 502   Value *ExitCnt = RW.expandCodeFor(TripCount, Preheader->getTerminator(),
 503                                     IndVar->getType());
 504
 505   // Insert a new setne or seteq instruction before the branch.
 506   Instruction::BinaryOps Opcode;
 507   if (L->contains(BI->getSuccessor(0)))
 508     Opcode = Instruction::SetNE;
 509   else
 510     Opcode = Instruction::SetEQ;
 511
 512   Value *Cond = new SetCondInst(Opcode, IndVar, ExitCnt, "exitcond", BI);
 513   BI->setCondition(Cond);
 514   ++NumLFTR;
 515   Changed = true;
 516
 517   DeleteTriviallyDeadInstructions(InstructionsToDelete);
 518 }
 519
 520
 521 /// RewriteLoopExitValues - Check to see if this loop has a computable
 522 /// loop-invariant execution count.  If so, this means that we can compute the
 523 /// final value of any expressions that are recurrent in the loop, and
 524 /// substitute the exit values from the loop into any instructions outside of
 525 /// the loop that use the final values of the current expressions.
 526 void IndVarSimplify::RewriteLoopExitValues(Loop *L) {
 527   BasicBlock *Preheader = L->getLoopPreheader();
 528
 529   // Scan all of the instructions in the loop, looking at those that have
 530   // extra-loop users and which are recurrences.
 531   SCEVExpander Rewriter(*SE, *LI);
 532
 533   // We insert the code into the preheader of the loop if the loop contains
 534   // multiple exit blocks, or in the exit block if there is exactly one.
 535   BasicBlock *BlockToInsertInto;
 536   std::vector<BasicBlock*> ExitBlocks;
 537   L->getExitBlocks(ExitBlocks);
 538   if (ExitBlocks.size() == 1)
 539     BlockToInsertInto = ExitBlocks[0];
 540   else
 541     BlockToInsertInto = Preheader;
 542   BasicBlock::iterator InsertPt = BlockToInsertInto->begin();
 543   while (isa<PHINode>(InsertPt)) ++InsertPt;
 544
 545   bool HasConstantItCount = isa<SCEVConstant>(SE->getIterationCount(L));
 546
 547   std::set<Instruction*> InstructionsToDelete;
 548
 549   for (unsigned i = 0, e = L->getBlocks().size(); i != e; ++i)
 550     if (LI->getLoopFor(L->getBlocks()[i]) == L) {  // Not in a subloop...
 551       BasicBlock *BB = L->getBlocks()[i];
 552       for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
 553         if (I->getType()->isInteger()) {      // Is an integer instruction
 554           SCEVHandle SH = SE->getSCEV(I);
 555           if (SH->hasComputableLoopEvolution(L) ||    // Varies predictably
 556               HasConstantItCount) {
 557             // Find out if this predictably varying value is actually used
 558             // outside of the loop.  "extra" as opposed to "intra".
 559             std::vector<User*> ExtraLoopUsers;
 560             for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
 561                  UI != E; ++UI)
 562               if (!L->contains(cast<Instruction>(*UI)->getParent()))
 563                 ExtraLoopUsers.push_back(*UI);
 564             if (!ExtraLoopUsers.empty()) {
 565               // Okay, this instruction has a user outside of the current loop
 566               // and varies predictably in this loop.  Evaluate the value it
 567               // contains when the loop exits, and insert code for it.
 568               SCEVHandle ExitValue = SE->getSCEVAtScope(I, L->getParentLoop());
 569               if (!isa<SCEVCouldNotCompute>(ExitValue)) {
 570                 Changed = true;
 571                 ++NumReplaced;
 572                 Value *NewVal = Rewriter.expandCodeFor(ExitValue, InsertPt,
 573                                                        I->getType());
 574
 575                 // Rewrite any users of the computed value outside of the loop
 576                 // with the newly computed value.
 577                 for (unsigned i = 0, e = ExtraLoopUsers.size(); i != e; ++i)
 578                   ExtraLoopUsers[i]->replaceUsesOfWith(I, NewVal);
 579
 580                 // If this instruction is dead now, schedule it to be removed.
 581                 if (I->use_empty())
 582                   InstructionsToDelete.insert(I);
 583               }
 584             }
 585           }
 586         }
 587     }
 588
 589   DeleteTriviallyDeadInstructions(InstructionsToDelete);
 590 }
 591
 592
 593 void IndVarSimplify::runOnLoop(Loop *L) {
 594   // First step.  Check to see if there are any trivial GEP pointer recurrences.
 595   // If there are, change them into integer recurrences, permitting analysis by
 596   // the SCEV routines.
 597   //
 598   BasicBlock *Header    = L->getHeader();
 599   BasicBlock *Preheader = L->getLoopPreheader();
 600
 601   std::set<Instruction*> DeadInsts;
 602   for (BasicBlock::iterator I = Header->begin(); isa<PHINode>(I); ++I) {
 603     PHINode *PN = cast<PHINode>(I);
 604     if (isa<PointerType>(PN->getType()))
 605       EliminatePointerRecurrence(PN, Preheader, DeadInsts);
 606   }
 607
 608   if (!DeadInsts.empty())
 609     DeleteTriviallyDeadInstructions(DeadInsts);
 610
 611
 612   // Next, transform all loops nesting inside of this loop.
 613   for (LoopInfo::iterator I = L->begin(), E = L->end(); I != E; ++I)
 614     runOnLoop(*I);
 615
 616   // Check to see if this loop has a computable loop-invariant execution count.
 617   // If so, this means that we can compute the final value of any expressions
 618   // that are recurrent in the loop, and substitute the exit values from the
 619   // loop into any instructions outside of the loop that use the final values of
 620   // the current expressions.
 621   //
 622   SCEVHandle IterationCount = SE->getIterationCount(L);
 623   if (!isa<SCEVCouldNotCompute>(IterationCount))
 624     RewriteLoopExitValues(L);
 625
 626   // Next, analyze all of the induction variables in the loop, canonicalizing
 627   // auxillary induction variables.
 628   std::vector<std::pair<PHINode*, SCEVHandle> > IndVars;
 629
 630   for (BasicBlock::iterator I = Header->begin(); isa<PHINode>(I); ++I) {
 631     PHINode *PN = cast<PHINode>(I);
 632     if (PN->getType()->isInteger()) {  // FIXME: when we have fast-math, enable!
 633       SCEVHandle SCEV = SE->getSCEV(PN);
 634       if (SCEV->hasComputableLoopEvolution(L))
 635         // FIXME: Without a strength reduction pass, it is an extremely bad idea
 636         // to indvar substitute anything more complex than a linear induction
 637         // variable.  Doing so will put expensive multiply instructions inside
 638         // of the loop.  For now just disable indvar subst on anything more
 639         // complex than a linear addrec.
 640         if (SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(SCEV))
 641           if (AR->getNumOperands() == 2 && isa<SCEVConstant>(AR->getOperand(1)))
 642             IndVars.push_back(std::make_pair(PN, SCEV));
 643     }
 644   }
 645
 646   // If there are no induction variables in the loop, there is nothing more to
 647   // do.
 648   if (IndVars.empty()) {
 649     // Actually, if we know how many times the loop iterates, lets insert a
 650     // canonical induction variable to help subsequent passes.
 651     if (!isa<SCEVCouldNotCompute>(IterationCount)) {
 652       SCEVExpander Rewriter(*SE, *LI);
 653       Rewriter.getOrInsertCanonicalInductionVariable(L,
 654                                                      IterationCount->getType());
 655       LinearFunctionTestReplace(L, IterationCount, Rewriter);
 656     }
 657     return;
 658   }
 659
 660   // Compute the type of the largest recurrence expression.
 661   //
 662   const Type *LargestType = IndVars[0].first->getType();
 663   bool DifferingSizes = false;
 664   for (unsigned i = 1, e = IndVars.size(); i != e; ++i) {
 665     const Type *Ty = IndVars[i].first->getType();
 666     DifferingSizes |= Ty->getPrimitiveSize() != LargestType->getPrimitiveSize();
 667     if (Ty->getPrimitiveSize() > LargestType->getPrimitiveSize())
 668       LargestType = Ty;
 669   }
 670
 671   // Create a rewriter object which we'll use to transform the code with.
 672   SCEVExpander Rewriter(*SE, *LI);
 673
 674   // Now that we know the largest of of the induction variables in this loop,
 675   // insert a canonical induction variable of the largest size.
 676   LargestType = LargestType->getUnsignedVersion();
 677   Value *IndVar = Rewriter.getOrInsertCanonicalInductionVariable(L,LargestType);
 678   ++NumInserted;
 679   Changed = true;
 680
 681   if (!isa<SCEVCouldNotCompute>(IterationCount))
 682     LinearFunctionTestReplace(L, IterationCount, Rewriter);
 683
 684   // Now that we have a canonical induction variable, we can rewrite any
 685   // recurrences in terms of the induction variable.  Start with the auxillary
 686   // induction variables, and recursively rewrite any of their uses.
 687   BasicBlock::iterator InsertPt = Header->begin();
 688   while (isa<PHINode>(InsertPt)) ++InsertPt;
 689
 690   // If there were induction variables of other sizes, cast the primary
 691   // induction variable to the right size for them, avoiding the need for the
 692   // code evaluation methods to insert induction variables of different sizes.
 693   if (DifferingSizes) {
 694     bool InsertedSizes[17] = { false };
 695     InsertedSizes[LargestType->getPrimitiveSize()] = true;
 696     for (unsigned i = 0, e = IndVars.size(); i != e; ++i)
 697       if (!InsertedSizes[IndVars[i].first->getType()->getPrimitiveSize()]) {
 698         PHINode *PN = IndVars[i].first;
 699         InsertedSizes[PN->getType()->getPrimitiveSize()] = true;
 700         Instruction *New = new CastInst(IndVar,
 701                                         PN->getType()->getUnsignedVersion(),
 702                                         "indvar", InsertPt);
 703         Rewriter.addInsertedValue(New, SE->getSCEV(New));
 704       }
 705   }
 706
 707   // If there were induction variables of other sizes, cast the primary
 708   // induction variable to the right size for them, avoiding the need for the
 709   // code evaluation methods to insert induction variables of different sizes.
 710   std::map<unsigned, Value*> InsertedSizes;
 711   while (!IndVars.empty()) {
 712     PHINode *PN = IndVars.back().first;
 713     Value *NewVal = Rewriter.expandCodeFor(IndVars.back().second, InsertPt,
 714                                            PN->getType());
 715     std::string Name = PN->getName();
 716     PN->setName("");
 717     NewVal->setName(Name);
 718
 719     // Replace the old PHI Node with the inserted computation.
 720     PN->replaceAllUsesWith(NewVal);
 721     DeadInsts.insert(PN);
 722     IndVars.pop_back();
 723     ++NumRemoved;
 724     Changed = true;
 725   }
 726
 727 #if 0
 728   // Now replace all derived expressions in the loop body with simpler
 729   // expressions.
 730   for (unsigned i = 0, e = L->getBlocks().size(); i != e; ++i)
 731     if (LI->getLoopFor(L->getBlocks()[i]) == L) {  // Not in a subloop...
 732       BasicBlock *BB = L->getBlocks()[i];
 733       for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
 734         if (I->getType()->isInteger() &&      // Is an integer instruction
 735             !I->use_empty() &&
 736             !Rewriter.isInsertedInstruction(I)) {
 737           SCEVHandle SH = SE->getSCEV(I);
 738           Value *V = Rewriter.expandCodeFor(SH, I, I->getType());
 739           if (V != I) {
 740             if (isa<Instruction>(V)) {
 741               std::string Name = I->getName();
 742               I->setName("");
 743               V->setName(Name);
 744             }
 745             I->replaceAllUsesWith(V);
 746             DeadInsts.insert(I);
 747             ++NumRemoved;
 748             Changed = true;
 749           }
 750         }
 751     }
 752 #endif
 753
 754   DeleteTriviallyDeadInstructions(DeadInsts);
 755 }