1 //===- IndVarSimplify.cpp - Induction Variable Elimination ----------------===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
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.
14 // This transformation makes 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.
22 // If the trip count of a loop is computable, this pass also makes the following
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.
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).
38 //===----------------------------------------------------------------------===//
40 #define DEBUG_TYPE "indvars"
41 #include "llvm/Transforms/Scalar.h"
42 #include "llvm/BasicBlock.h"
43 #include "llvm/Constants.h"
44 #include "llvm/Instructions.h"
45 #include "llvm/Type.h"
46 #include "llvm/Analysis/ScalarEvolutionExpander.h"
47 #include "llvm/Analysis/LoopInfo.h"
48 #include "llvm/Analysis/LoopPass.h"
49 #include "llvm/Support/CFG.h"
50 #include "llvm/Support/Compiler.h"
51 #include "llvm/Support/Debug.h"
52 #include "llvm/Support/GetElementPtrTypeIterator.h"
53 #include "llvm/Transforms/Utils/Local.h"
54 #include "llvm/Support/CommandLine.h"
55 #include "llvm/ADT/SmallVector.h"
56 #include "llvm/ADT/Statistic.h"
59 STATISTIC(NumRemoved , "Number of aux indvars removed");
60 STATISTIC(NumPointer , "Number of pointer indvars promoted");
61 STATISTIC(NumInserted, "Number of canonical indvars added");
62 STATISTIC(NumReplaced, "Number of exit values replaced");
63 STATISTIC(NumLFTR , "Number of loop exit tests replaced");
66 class VISIBILITY_HIDDEN IndVarSimplify : public LoopPass {
72 static const int ID; // Pass identifcation, replacement for typeid
73 IndVarSimplify() : LoopPass((intptr_t)&ID) {}
75 bool runOnLoop(Loop *L, LPPassManager &LPM);
76 bool doInitialization(Loop *L, LPPassManager &LPM);
77 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
78 AU.addRequiredID(LCSSAID);
79 AU.addRequiredID(LoopSimplifyID);
80 AU.addRequired<ScalarEvolution>();
81 AU.addRequired<LoopInfo>();
82 AU.addPreservedID(LoopSimplifyID);
83 AU.addPreservedID(LCSSAID);
89 void EliminatePointerRecurrence(PHINode *PN, BasicBlock *Preheader,
90 std::set<Instruction*> &DeadInsts);
91 Instruction *LinearFunctionTestReplace(Loop *L, SCEV *IterationCount,
93 void RewriteLoopExitValues(Loop *L);
95 void DeleteTriviallyDeadInstructions(std::set<Instruction*> &Insts);
98 const int IndVarSimplify::ID = 0;
99 RegisterPass<IndVarSimplify> X("indvars", "Canonicalize Induction Variables");
102 LoopPass *llvm::createIndVarSimplifyPass() {
103 return new IndVarSimplify();
106 /// DeleteTriviallyDeadInstructions - If any of the instructions is the
107 /// specified set are trivially dead, delete them and see if this makes any of
108 /// their operands subsequently dead.
109 void IndVarSimplify::
110 DeleteTriviallyDeadInstructions(std::set<Instruction*> &Insts) {
111 while (!Insts.empty()) {
112 Instruction *I = *Insts.begin();
113 Insts.erase(Insts.begin());
114 if (isInstructionTriviallyDead(I)) {
115 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
116 if (Instruction *U = dyn_cast<Instruction>(I->getOperand(i)))
118 SE->deleteInstructionFromRecords(I);
119 DOUT << "INDVARS: Deleting: " << *I;
120 I->eraseFromParent();
127 /// EliminatePointerRecurrence - Check to see if this is a trivial GEP pointer
128 /// recurrence. If so, change it into an integer recurrence, permitting
129 /// analysis by the SCEV routines.
130 void IndVarSimplify::EliminatePointerRecurrence(PHINode *PN,
131 BasicBlock *Preheader,
132 std::set<Instruction*> &DeadInsts) {
133 assert(PN->getNumIncomingValues() == 2 && "Noncanonicalized loop!");
134 unsigned PreheaderIdx = PN->getBasicBlockIndex(Preheader);
135 unsigned BackedgeIdx = PreheaderIdx^1;
136 if (GetElementPtrInst *GEPI =
137 dyn_cast<GetElementPtrInst>(PN->getIncomingValue(BackedgeIdx)))
138 if (GEPI->getOperand(0) == PN) {
139 assert(GEPI->getNumOperands() == 2 && "GEP types must match!");
140 DOUT << "INDVARS: Eliminating pointer recurrence: " << *GEPI;
142 // Okay, we found a pointer recurrence. Transform this pointer
143 // recurrence into an integer recurrence. Compute the value that gets
144 // added to the pointer at every iteration.
145 Value *AddedVal = GEPI->getOperand(1);
147 // Insert a new integer PHI node into the top of the block.
148 PHINode *NewPhi = new PHINode(AddedVal->getType(),
149 PN->getName()+".rec", PN);
150 NewPhi->addIncoming(Constant::getNullValue(NewPhi->getType()), Preheader);
152 // Create the new add instruction.
153 Value *NewAdd = BinaryOperator::createAdd(NewPhi, AddedVal,
154 GEPI->getName()+".rec", GEPI);
155 NewPhi->addIncoming(NewAdd, PN->getIncomingBlock(BackedgeIdx));
157 // Update the existing GEP to use the recurrence.
158 GEPI->setOperand(0, PN->getIncomingValue(PreheaderIdx));
160 // Update the GEP to use the new recurrence we just inserted.
161 GEPI->setOperand(1, NewAdd);
163 // If the incoming value is a constant expr GEP, try peeling out the array
164 // 0 index if possible to make things simpler.
165 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GEPI->getOperand(0)))
166 if (CE->getOpcode() == Instruction::GetElementPtr) {
167 unsigned NumOps = CE->getNumOperands();
168 assert(NumOps > 1 && "CE folding didn't work!");
169 if (CE->getOperand(NumOps-1)->isNullValue()) {
170 // Check to make sure the last index really is an array index.
171 gep_type_iterator GTI = gep_type_begin(CE);
172 for (unsigned i = 1, e = CE->getNumOperands()-1;
175 if (isa<SequentialType>(*GTI)) {
176 // Pull the last index out of the constant expr GEP.
177 SmallVector<Value*, 8> CEIdxs(CE->op_begin()+1, CE->op_end()-1);
178 Constant *NCE = ConstantExpr::getGetElementPtr(CE->getOperand(0),
181 GetElementPtrInst *NGEPI = new GetElementPtrInst(
182 NCE, Constant::getNullValue(Type::Int32Ty), NewAdd,
183 GEPI->getName(), GEPI);
184 GEPI->replaceAllUsesWith(NGEPI);
185 GEPI->eraseFromParent();
192 // Finally, if there are any other users of the PHI node, we must
193 // insert a new GEP instruction that uses the pre-incremented version
194 // of the induction amount.
195 if (!PN->use_empty()) {
196 BasicBlock::iterator InsertPos = PN; ++InsertPos;
197 while (isa<PHINode>(InsertPos)) ++InsertPos;
199 new GetElementPtrInst(PN->getIncomingValue(PreheaderIdx),
200 NewPhi, "", InsertPos);
201 PreInc->takeName(PN);
202 PN->replaceAllUsesWith(PreInc);
205 // Delete the old PHI for sure, and the GEP if its otherwise unused.
206 DeadInsts.insert(PN);
213 /// LinearFunctionTestReplace - This method rewrites the exit condition of the
214 /// loop to be a canonical != comparison against the incremented loop induction
215 /// variable. This pass is able to rewrite the exit tests of any loop where the
216 /// SCEV analysis can determine a loop-invariant trip count of the loop, which
217 /// is actually a much broader range than just linear tests.
219 /// This method returns a "potentially dead" instruction whose computation chain
220 /// should be deleted when convenient.
221 Instruction *IndVarSimplify::LinearFunctionTestReplace(Loop *L,
222 SCEV *IterationCount,
224 // Find the exit block for the loop. We can currently only handle loops with
226 std::vector<BasicBlock*> ExitBlocks;
227 L->getExitBlocks(ExitBlocks);
228 if (ExitBlocks.size() != 1) return 0;
229 BasicBlock *ExitBlock = ExitBlocks[0];
231 // Make sure there is only one predecessor block in the loop.
232 BasicBlock *ExitingBlock = 0;
233 for (pred_iterator PI = pred_begin(ExitBlock), PE = pred_end(ExitBlock);
235 if (L->contains(*PI)) {
236 if (ExitingBlock == 0)
239 return 0; // Multiple exits from loop to this block.
241 assert(ExitingBlock && "Loop info is broken");
243 if (!isa<BranchInst>(ExitingBlock->getTerminator()))
244 return 0; // Can't rewrite non-branch yet
245 BranchInst *BI = cast<BranchInst>(ExitingBlock->getTerminator());
246 assert(BI->isConditional() && "Must be conditional to be part of loop!");
248 Instruction *PotentiallyDeadInst = dyn_cast<Instruction>(BI->getCondition());
250 // If the exiting block is not the same as the backedge block, we must compare
251 // against the preincremented value, otherwise we prefer to compare against
252 // the post-incremented value.
253 BasicBlock *Header = L->getHeader();
254 pred_iterator HPI = pred_begin(Header);
255 assert(HPI != pred_end(Header) && "Loop with zero preds???");
256 if (!L->contains(*HPI)) ++HPI;
257 assert(HPI != pred_end(Header) && L->contains(*HPI) &&
258 "No backedge in loop?");
260 SCEVHandle TripCount = IterationCount;
262 if (*HPI == ExitingBlock) {
263 // The IterationCount expression contains the number of times that the
264 // backedge actually branches to the loop header. This is one less than the
265 // number of times the loop executes, so add one to it.
266 Constant *OneC = ConstantInt::get(IterationCount->getType(), 1);
267 TripCount = SCEVAddExpr::get(IterationCount, SCEVUnknown::get(OneC));
268 IndVar = L->getCanonicalInductionVariableIncrement();
270 // We have to use the preincremented value...
271 IndVar = L->getCanonicalInductionVariable();
274 DOUT << "INDVARS: LFTR: TripCount = " << *TripCount
275 << " IndVar = " << *IndVar << "\n";
277 // Expand the code for the iteration count into the preheader of the loop.
278 BasicBlock *Preheader = L->getLoopPreheader();
279 Value *ExitCnt = RW.expandCodeFor(TripCount, Preheader->getTerminator(),
282 // Insert a new icmp_ne or icmp_eq instruction before the branch.
283 ICmpInst::Predicate Opcode;
284 if (L->contains(BI->getSuccessor(0)))
285 Opcode = ICmpInst::ICMP_NE;
287 Opcode = ICmpInst::ICMP_EQ;
289 Value *Cond = new ICmpInst(Opcode, IndVar, ExitCnt, "exitcond", BI);
290 BI->setCondition(Cond);
293 return PotentiallyDeadInst;
297 /// RewriteLoopExitValues - Check to see if this loop has a computable
298 /// loop-invariant execution count. If so, this means that we can compute the
299 /// final value of any expressions that are recurrent in the loop, and
300 /// substitute the exit values from the loop into any instructions outside of
301 /// the loop that use the final values of the current expressions.
302 void IndVarSimplify::RewriteLoopExitValues(Loop *L) {
303 BasicBlock *Preheader = L->getLoopPreheader();
305 // Scan all of the instructions in the loop, looking at those that have
306 // extra-loop users and which are recurrences.
307 SCEVExpander Rewriter(*SE, *LI);
309 // We insert the code into the preheader of the loop if the loop contains
310 // multiple exit blocks, or in the exit block if there is exactly one.
311 BasicBlock *BlockToInsertInto;
312 std::vector<BasicBlock*> ExitBlocks;
313 L->getUniqueExitBlocks(ExitBlocks);
314 if (ExitBlocks.size() == 1)
315 BlockToInsertInto = ExitBlocks[0];
317 BlockToInsertInto = Preheader;
318 BasicBlock::iterator InsertPt = BlockToInsertInto->begin();
319 while (isa<PHINode>(InsertPt)) ++InsertPt;
321 bool HasConstantItCount = isa<SCEVConstant>(SE->getIterationCount(L));
323 std::set<Instruction*> InstructionsToDelete;
324 std::map<Instruction*, Value*> ExitValues;
326 // Find all values that are computed inside the loop, but used outside of it.
327 // Because of LCSSA, these values will only occur in LCSSA PHI Nodes. Scan
328 // the exit blocks of the loop to find them.
329 for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
330 BasicBlock *ExitBB = ExitBlocks[i];
332 // If there are no PHI nodes in this exit block, then no values defined
333 // inside the loop are used on this path, skip it.
334 PHINode *PN = dyn_cast<PHINode>(ExitBB->begin());
337 unsigned NumPreds = PN->getNumIncomingValues();
339 // Iterate over all of the PHI nodes.
340 BasicBlock::iterator BBI = ExitBB->begin();
341 while ((PN = dyn_cast<PHINode>(BBI++))) {
343 // Iterate over all of the values in all the PHI nodes.
344 for (unsigned i = 0; i != NumPreds; ++i) {
345 // If the value being merged in is not integer or is not defined
346 // in the loop, skip it.
347 Value *InVal = PN->getIncomingValue(i);
348 if (!isa<Instruction>(InVal) ||
349 // SCEV only supports integer expressions for now.
350 !isa<IntegerType>(InVal->getType()))
353 // If this pred is for a subloop, not L itself, skip it.
354 if (LI->getLoopFor(PN->getIncomingBlock(i)) != L)
355 continue; // The Block is in a subloop, skip it.
357 // Check that InVal is defined in the loop.
358 Instruction *Inst = cast<Instruction>(InVal);
359 if (!L->contains(Inst->getParent()))
362 // We require that this value either have a computable evolution or that
363 // the loop have a constant iteration count. In the case where the loop
364 // has a constant iteration count, we can sometimes force evaluation of
365 // the exit value through brute force.
366 SCEVHandle SH = SE->getSCEV(Inst);
367 if (!SH->hasComputableLoopEvolution(L) && !HasConstantItCount)
368 continue; // Cannot get exit evolution for the loop value.
370 // Okay, this instruction has a user outside of the current loop
371 // and varies predictably *inside* the loop. Evaluate the value it
372 // contains when the loop exits, if possible.
373 SCEVHandle ExitValue = SE->getSCEVAtScope(Inst, L->getParentLoop());
374 if (isa<SCEVCouldNotCompute>(ExitValue) ||
375 !ExitValue->isLoopInvariant(L))
381 // See if we already computed the exit value for the instruction, if so,
383 Value *&ExitVal = ExitValues[Inst];
385 ExitVal = Rewriter.expandCodeFor(ExitValue, InsertPt,Inst->getType());
387 DOUT << "INDVARS: RLEV: AfterLoopVal = " << *ExitVal
388 << " LoopVal = " << *Inst << "\n";
390 PN->setIncomingValue(i, ExitVal);
392 // If this instruction is dead now, schedule it to be removed.
393 if (Inst->use_empty())
394 InstructionsToDelete.insert(Inst);
396 // See if this is a single-entry LCSSA PHI node. If so, we can (and
398 // the PHI entirely. This is safe, because the NewVal won't be variant
399 // in the loop, so we don't need an LCSSA phi node anymore.
401 PN->replaceAllUsesWith(ExitVal);
402 PN->eraseFromParent();
409 DeleteTriviallyDeadInstructions(InstructionsToDelete);
412 bool IndVarSimplify::doInitialization(Loop *L, LPPassManager &LPM) {
415 // First step. Check to see if there are any trivial GEP pointer recurrences.
416 // If there are, change them into integer recurrences, permitting analysis by
417 // the SCEV routines.
419 BasicBlock *Header = L->getHeader();
420 BasicBlock *Preheader = L->getLoopPreheader();
421 SE = &LPM.getAnalysis<ScalarEvolution>();
423 std::set<Instruction*> DeadInsts;
424 for (BasicBlock::iterator I = Header->begin(); isa<PHINode>(I); ++I) {
425 PHINode *PN = cast<PHINode>(I);
426 if (isa<PointerType>(PN->getType()))
427 EliminatePointerRecurrence(PN, Preheader, DeadInsts);
430 if (!DeadInsts.empty())
431 DeleteTriviallyDeadInstructions(DeadInsts);
436 bool IndVarSimplify::runOnLoop(Loop *L, LPPassManager &LPM) {
439 LI = &getAnalysis<LoopInfo>();
440 SE = &getAnalysis<ScalarEvolution>();
443 BasicBlock *Header = L->getHeader();
444 std::set<Instruction*> DeadInsts;
446 // Verify the input to the pass in already in LCSSA form.
447 assert(L->isLCSSAForm());
449 // Check to see if this loop has a computable loop-invariant execution count.
450 // If so, this means that we can compute the final value of any expressions
451 // that are recurrent in the loop, and substitute the exit values from the
452 // loop into any instructions outside of the loop that use the final values of
453 // the current expressions.
455 SCEVHandle IterationCount = SE->getIterationCount(L);
456 if (!isa<SCEVCouldNotCompute>(IterationCount))
457 RewriteLoopExitValues(L);
459 // Next, analyze all of the induction variables in the loop, canonicalizing
460 // auxillary induction variables.
461 std::vector<std::pair<PHINode*, SCEVHandle> > IndVars;
463 for (BasicBlock::iterator I = Header->begin(); isa<PHINode>(I); ++I) {
464 PHINode *PN = cast<PHINode>(I);
465 if (PN->getType()->isInteger()) { // FIXME: when we have fast-math, enable!
466 SCEVHandle SCEV = SE->getSCEV(PN);
467 if (SCEV->hasComputableLoopEvolution(L))
468 // FIXME: It is an extremely bad idea to indvar substitute anything more
469 // complex than affine induction variables. Doing so will put expensive
470 // polynomial evaluations inside of the loop, and the str reduction pass
471 // currently can only reduce affine polynomials. For now just disable
472 // indvar subst on anything more complex than an affine addrec.
473 if (SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(SCEV))
475 IndVars.push_back(std::make_pair(PN, SCEV));
479 // If there are no induction variables in the loop, there is nothing more to
481 if (IndVars.empty()) {
482 // Actually, if we know how many times the loop iterates, lets insert a
483 // canonical induction variable to help subsequent passes.
484 if (!isa<SCEVCouldNotCompute>(IterationCount)) {
485 SCEVExpander Rewriter(*SE, *LI);
486 Rewriter.getOrInsertCanonicalInductionVariable(L,
487 IterationCount->getType());
488 if (Instruction *I = LinearFunctionTestReplace(L, IterationCount,
490 std::set<Instruction*> InstructionsToDelete;
491 InstructionsToDelete.insert(I);
492 DeleteTriviallyDeadInstructions(InstructionsToDelete);
498 // Compute the type of the largest recurrence expression.
500 const Type *LargestType = IndVars[0].first->getType();
501 bool DifferingSizes = false;
502 for (unsigned i = 1, e = IndVars.size(); i != e; ++i) {
503 const Type *Ty = IndVars[i].first->getType();
505 Ty->getPrimitiveSizeInBits() != LargestType->getPrimitiveSizeInBits();
506 if (Ty->getPrimitiveSizeInBits() > LargestType->getPrimitiveSizeInBits())
510 // Create a rewriter object which we'll use to transform the code with.
511 SCEVExpander Rewriter(*SE, *LI);
513 // Now that we know the largest of of the induction variables in this loop,
514 // insert a canonical induction variable of the largest size.
515 Value *IndVar = Rewriter.getOrInsertCanonicalInductionVariable(L,LargestType);
518 DOUT << "INDVARS: New CanIV: " << *IndVar;
520 if (!isa<SCEVCouldNotCompute>(IterationCount))
521 if (Instruction *DI = LinearFunctionTestReplace(L, IterationCount,Rewriter))
522 DeadInsts.insert(DI);
524 // Now that we have a canonical induction variable, we can rewrite any
525 // recurrences in terms of the induction variable. Start with the auxillary
526 // induction variables, and recursively rewrite any of their uses.
527 BasicBlock::iterator InsertPt = Header->begin();
528 while (isa<PHINode>(InsertPt)) ++InsertPt;
530 // If there were induction variables of other sizes, cast the primary
531 // induction variable to the right size for them, avoiding the need for the
532 // code evaluation methods to insert induction variables of different sizes.
533 if (DifferingSizes) {
534 SmallVector<unsigned,4> InsertedSizes;
535 InsertedSizes.push_back(LargestType->getPrimitiveSizeInBits());
536 for (unsigned i = 0, e = IndVars.size(); i != e; ++i) {
537 unsigned ithSize = IndVars[i].first->getType()->getPrimitiveSizeInBits();
538 if (std::find(InsertedSizes.begin(), InsertedSizes.end(), ithSize)
539 == InsertedSizes.end()) {
540 PHINode *PN = IndVars[i].first;
541 InsertedSizes.push_back(ithSize);
542 Instruction *New = new TruncInst(IndVar, PN->getType(), "indvar",
544 Rewriter.addInsertedValue(New, SE->getSCEV(New));
545 DOUT << "INDVARS: Made trunc IV for " << *PN
546 << " NewVal = " << *New << "\n";
551 // Rewrite all induction variables in terms of the canonical induction
553 std::map<unsigned, Value*> InsertedSizes;
554 while (!IndVars.empty()) {
555 PHINode *PN = IndVars.back().first;
556 Value *NewVal = Rewriter.expandCodeFor(IndVars.back().second, InsertPt,
558 DOUT << "INDVARS: Rewrote IV '" << *IndVars.back().second << "' " << *PN
559 << " into = " << *NewVal << "\n";
560 NewVal->takeName(PN);
562 // Replace the old PHI Node with the inserted computation.
563 PN->replaceAllUsesWith(NewVal);
564 DeadInsts.insert(PN);
571 // Now replace all derived expressions in the loop body with simpler
573 for (unsigned i = 0, e = L->getBlocks().size(); i != e; ++i)
574 if (LI->getLoopFor(L->getBlocks()[i]) == L) { // Not in a subloop...
575 BasicBlock *BB = L->getBlocks()[i];
576 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
577 if (I->getType()->isInteger() && // Is an integer instruction
579 !Rewriter.isInsertedInstruction(I)) {
580 SCEVHandle SH = SE->getSCEV(I);
581 Value *V = Rewriter.expandCodeFor(SH, I, I->getType());
583 if (isa<Instruction>(V))
585 I->replaceAllUsesWith(V);
594 DeleteTriviallyDeadInstructions(DeadInsts);
596 assert(L->isLCSSAForm());