blob: 3368f2acd717b0067b23459987ec1815ca9343a6 [file] [log] [blame]
Chris Lattner6148c022001-12-03 17:28:42 +00001//===- IndVarSimplify.cpp - Induction Variable Elimination ----------------===//
Misha Brukmanfd939082005-04-21 23:48:37 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanfd939082005-04-21 23:48:37 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner6148c022001-12-03 17:28:42 +00009//
Chris Lattner40bf8b42004-04-02 20:24:31 +000010// 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//
Reid Spencer47a53ac2006-08-18 09:01:07 +000014// This transformation makes the following changes to each loop with an
Chris Lattner40bf8b42004-04-02 20:24:31 +000015// 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).
Chris Lattner6148c022001-12-03 17:28:42 +000037//
38//===----------------------------------------------------------------------===//
39
Chris Lattner0e5f4992006-12-19 21:40:18 +000040#define DEBUG_TYPE "indvars"
Chris Lattner022103b2002-05-07 20:03:00 +000041#include "llvm/Transforms/Scalar.h"
Chris Lattner40bf8b42004-04-02 20:24:31 +000042#include "llvm/BasicBlock.h"
Chris Lattner59fdaee2004-04-15 15:21:43 +000043#include "llvm/Constants.h"
Chris Lattner18b3c972003-12-22 05:02:01 +000044#include "llvm/Instructions.h"
Chris Lattner40bf8b42004-04-02 20:24:31 +000045#include "llvm/Type.h"
Nate Begeman36f891b2005-07-30 00:12:19 +000046#include "llvm/Analysis/ScalarEvolutionExpander.h"
John Criswell47df12d2003-12-18 17:19:19 +000047#include "llvm/Analysis/LoopInfo.h"
Devang Patel5ee99972007-03-07 06:39:01 +000048#include "llvm/Analysis/LoopPass.h"
Chris Lattner455889a2002-02-12 22:39:50 +000049#include "llvm/Support/CFG.h"
Reid Spencer9133fe22007-02-05 23:32:05 +000050#include "llvm/Support/Compiler.h"
Chris Lattneree4f13a2007-01-07 01:14:12 +000051#include "llvm/Support/Debug.h"
Chris Lattnera4b9c782004-10-11 23:06:50 +000052#include "llvm/Support/GetElementPtrTypeIterator.h"
John Criswell47df12d2003-12-18 17:19:19 +000053#include "llvm/Transforms/Utils/Local.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000054#include "llvm/Support/CommandLine.h"
Reid Spencera54b7cb2007-01-12 07:05:14 +000055#include "llvm/ADT/SmallVector.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000056#include "llvm/ADT/Statistic.h"
John Criswell47df12d2003-12-18 17:19:19 +000057using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000058
Chris Lattner0e5f4992006-12-19 21:40:18 +000059STATISTIC(NumRemoved , "Number of aux indvars removed");
60STATISTIC(NumPointer , "Number of pointer indvars promoted");
61STATISTIC(NumInserted, "Number of canonical indvars added");
62STATISTIC(NumReplaced, "Number of exit values replaced");
63STATISTIC(NumLFTR , "Number of loop exit tests replaced");
Chris Lattner3324e712003-12-22 03:58:44 +000064
Chris Lattner0e5f4992006-12-19 21:40:18 +000065namespace {
Devang Patel5ee99972007-03-07 06:39:01 +000066 class VISIBILITY_HIDDEN IndVarSimplify : public LoopPass {
Chris Lattner40bf8b42004-04-02 20:24:31 +000067 LoopInfo *LI;
68 ScalarEvolution *SE;
Chris Lattner15cad752003-12-23 07:47:09 +000069 bool Changed;
Chris Lattner3324e712003-12-22 03:58:44 +000070 public:
Devang Patel794fd752007-05-01 21:15:47 +000071
Nick Lewyckyecd94c82007-05-06 13:37:16 +000072 static char ID; // Pass identification, replacement for typeid
Devang Patel794fd752007-05-01 21:15:47 +000073 IndVarSimplify() : LoopPass((intptr_t)&ID) {}
74
Devang Patel5ee99972007-03-07 06:39:01 +000075 bool runOnLoop(Loop *L, LPPassManager &LPM);
76 bool doInitialization(Loop *L, LPPassManager &LPM);
77 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Devang Patelbc533cd2007-09-10 18:08:23 +000078 AU.addRequired<ScalarEvolution>();
Devang Patel5ee99972007-03-07 06:39:01 +000079 AU.addRequiredID(LCSSAID);
80 AU.addRequiredID(LoopSimplifyID);
Devang Patel5ee99972007-03-07 06:39:01 +000081 AU.addRequired<LoopInfo>();
82 AU.addPreservedID(LoopSimplifyID);
83 AU.addPreservedID(LCSSAID);
84 AU.setPreservesCFG();
85 }
Chris Lattner15cad752003-12-23 07:47:09 +000086
Chris Lattner40bf8b42004-04-02 20:24:31 +000087 private:
Devang Patel5ee99972007-03-07 06:39:01 +000088
Chris Lattner40bf8b42004-04-02 20:24:31 +000089 void EliminatePointerRecurrence(PHINode *PN, BasicBlock *Preheader,
90 std::set<Instruction*> &DeadInsts);
Chris Lattner9ba46c12006-09-21 05:12:20 +000091 Instruction *LinearFunctionTestReplace(Loop *L, SCEV *IterationCount,
92 SCEVExpander &RW);
Chris Lattner40bf8b42004-04-02 20:24:31 +000093 void RewriteLoopExitValues(Loop *L);
94
95 void DeleteTriviallyDeadInstructions(std::set<Instruction*> &Insts);
Chris Lattner3324e712003-12-22 03:58:44 +000096 };
Chris Lattner5e761402002-09-10 05:24:05 +000097}
Chris Lattner394437f2001-12-04 04:32:29 +000098
Dan Gohman844731a2008-05-13 00:00:25 +000099char IndVarSimplify::ID = 0;
100static RegisterPass<IndVarSimplify>
101X("indvars", "Canonicalize Induction Variables");
102
Devang Patel5ee99972007-03-07 06:39:01 +0000103LoopPass *llvm::createIndVarSimplifyPass() {
Chris Lattner3324e712003-12-22 03:58:44 +0000104 return new IndVarSimplify();
Chris Lattner394437f2001-12-04 04:32:29 +0000105}
106
Chris Lattner40bf8b42004-04-02 20:24:31 +0000107/// DeleteTriviallyDeadInstructions - If any of the instructions is the
108/// specified set are trivially dead, delete them and see if this makes any of
109/// their operands subsequently dead.
110void IndVarSimplify::
111DeleteTriviallyDeadInstructions(std::set<Instruction*> &Insts) {
112 while (!Insts.empty()) {
113 Instruction *I = *Insts.begin();
114 Insts.erase(Insts.begin());
115 if (isInstructionTriviallyDead(I)) {
116 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
117 if (Instruction *U = dyn_cast<Instruction>(I->getOperand(i)))
118 Insts.insert(U);
Dan Gohman5cec4db2007-06-19 14:28:31 +0000119 SE->deleteValueFromRecords(I);
Chris Lattneree4f13a2007-01-07 01:14:12 +0000120 DOUT << "INDVARS: Deleting: " << *I;
Chris Lattnera4b9c782004-10-11 23:06:50 +0000121 I->eraseFromParent();
Chris Lattner40bf8b42004-04-02 20:24:31 +0000122 Changed = true;
123 }
124 }
125}
126
127
128/// EliminatePointerRecurrence - Check to see if this is a trivial GEP pointer
129/// recurrence. If so, change it into an integer recurrence, permitting
130/// analysis by the SCEV routines.
Misha Brukmanfd939082005-04-21 23:48:37 +0000131void IndVarSimplify::EliminatePointerRecurrence(PHINode *PN,
Chris Lattner40bf8b42004-04-02 20:24:31 +0000132 BasicBlock *Preheader,
133 std::set<Instruction*> &DeadInsts) {
134 assert(PN->getNumIncomingValues() == 2 && "Noncanonicalized loop!");
135 unsigned PreheaderIdx = PN->getBasicBlockIndex(Preheader);
136 unsigned BackedgeIdx = PreheaderIdx^1;
137 if (GetElementPtrInst *GEPI =
Chris Lattnercda9ca52005-08-10 01:12:06 +0000138 dyn_cast<GetElementPtrInst>(PN->getIncomingValue(BackedgeIdx)))
Chris Lattner40bf8b42004-04-02 20:24:31 +0000139 if (GEPI->getOperand(0) == PN) {
Chris Lattnercda9ca52005-08-10 01:12:06 +0000140 assert(GEPI->getNumOperands() == 2 && "GEP types must match!");
Chris Lattneree4f13a2007-01-07 01:14:12 +0000141 DOUT << "INDVARS: Eliminating pointer recurrence: " << *GEPI;
142
Chris Lattner40bf8b42004-04-02 20:24:31 +0000143 // Okay, we found a pointer recurrence. Transform this pointer
144 // recurrence into an integer recurrence. Compute the value that gets
145 // added to the pointer at every iteration.
146 Value *AddedVal = GEPI->getOperand(1);
147
148 // Insert a new integer PHI node into the top of the block.
Gabor Greif051a9502008-04-06 20:25:17 +0000149 PHINode *NewPhi = PHINode::Create(AddedVal->getType(),
150 PN->getName()+".rec", PN);
Chris Lattnerc5c5e6a2004-06-20 05:04:01 +0000151 NewPhi->addIncoming(Constant::getNullValue(NewPhi->getType()), Preheader);
152
Chris Lattner40bf8b42004-04-02 20:24:31 +0000153 // Create the new add instruction.
Gabor Greif7cbd8a32008-05-16 19:29:10 +0000154 Value *NewAdd = BinaryOperator::CreateAdd(NewPhi, AddedVal,
Chris Lattnerc5c5e6a2004-06-20 05:04:01 +0000155 GEPI->getName()+".rec", GEPI);
Chris Lattner40bf8b42004-04-02 20:24:31 +0000156 NewPhi->addIncoming(NewAdd, PN->getIncomingBlock(BackedgeIdx));
Misha Brukmanfd939082005-04-21 23:48:37 +0000157
Chris Lattner40bf8b42004-04-02 20:24:31 +0000158 // Update the existing GEP to use the recurrence.
159 GEPI->setOperand(0, PN->getIncomingValue(PreheaderIdx));
Misha Brukmanfd939082005-04-21 23:48:37 +0000160
Chris Lattner40bf8b42004-04-02 20:24:31 +0000161 // Update the GEP to use the new recurrence we just inserted.
162 GEPI->setOperand(1, NewAdd);
163
Chris Lattnera4b9c782004-10-11 23:06:50 +0000164 // If the incoming value is a constant expr GEP, try peeling out the array
165 // 0 index if possible to make things simpler.
166 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GEPI->getOperand(0)))
167 if (CE->getOpcode() == Instruction::GetElementPtr) {
168 unsigned NumOps = CE->getNumOperands();
169 assert(NumOps > 1 && "CE folding didn't work!");
170 if (CE->getOperand(NumOps-1)->isNullValue()) {
171 // Check to make sure the last index really is an array index.
Chris Lattner17300782005-11-18 18:30:47 +0000172 gep_type_iterator GTI = gep_type_begin(CE);
Chris Lattnerceda6052005-11-17 19:35:42 +0000173 for (unsigned i = 1, e = CE->getNumOperands()-1;
Chris Lattnera4b9c782004-10-11 23:06:50 +0000174 i != e; ++i, ++GTI)
175 /*empty*/;
176 if (isa<SequentialType>(*GTI)) {
177 // Pull the last index out of the constant expr GEP.
Chris Lattner55eb1c42007-01-31 04:40:53 +0000178 SmallVector<Value*, 8> CEIdxs(CE->op_begin()+1, CE->op_end()-1);
Chris Lattnera4b9c782004-10-11 23:06:50 +0000179 Constant *NCE = ConstantExpr::getGetElementPtr(CE->getOperand(0),
Chris Lattner55eb1c42007-01-31 04:40:53 +0000180 &CEIdxs[0],
181 CEIdxs.size());
David Greeneb8f74792007-09-04 15:46:09 +0000182 Value *Idx[2];
183 Idx[0] = Constant::getNullValue(Type::Int32Ty);
184 Idx[1] = NewAdd;
Gabor Greif051a9502008-04-06 20:25:17 +0000185 GetElementPtrInst *NGEPI = GetElementPtrInst::Create(
David Greeneb8f74792007-09-04 15:46:09 +0000186 NCE, Idx, Idx + 2,
Reid Spencercae57542007-03-02 00:28:52 +0000187 GEPI->getName(), GEPI);
Dan Gohman5cec4db2007-06-19 14:28:31 +0000188 SE->deleteValueFromRecords(GEPI);
Chris Lattnera4b9c782004-10-11 23:06:50 +0000189 GEPI->replaceAllUsesWith(NGEPI);
190 GEPI->eraseFromParent();
191 GEPI = NGEPI;
192 }
193 }
194 }
195
196
Chris Lattner40bf8b42004-04-02 20:24:31 +0000197 // Finally, if there are any other users of the PHI node, we must
198 // insert a new GEP instruction that uses the pre-incremented version
199 // of the induction amount.
200 if (!PN->use_empty()) {
201 BasicBlock::iterator InsertPos = PN; ++InsertPos;
202 while (isa<PHINode>(InsertPos)) ++InsertPos;
Chris Lattner40bf8b42004-04-02 20:24:31 +0000203 Value *PreInc =
Gabor Greif051a9502008-04-06 20:25:17 +0000204 GetElementPtrInst::Create(PN->getIncomingValue(PreheaderIdx),
205 NewPhi, "", InsertPos);
Chris Lattner6934a042007-02-11 01:23:03 +0000206 PreInc->takeName(PN);
Chris Lattner40bf8b42004-04-02 20:24:31 +0000207 PN->replaceAllUsesWith(PreInc);
208 }
209
210 // Delete the old PHI for sure, and the GEP if its otherwise unused.
211 DeadInsts.insert(PN);
212
213 ++NumPointer;
214 Changed = true;
215 }
216}
217
218/// LinearFunctionTestReplace - This method rewrites the exit condition of the
Chris Lattner59fdaee2004-04-15 15:21:43 +0000219/// loop to be a canonical != comparison against the incremented loop induction
220/// variable. This pass is able to rewrite the exit tests of any loop where the
221/// SCEV analysis can determine a loop-invariant trip count of the loop, which
222/// is actually a much broader range than just linear tests.
Chris Lattner9ba46c12006-09-21 05:12:20 +0000223///
224/// This method returns a "potentially dead" instruction whose computation chain
225/// should be deleted when convenient.
226Instruction *IndVarSimplify::LinearFunctionTestReplace(Loop *L,
227 SCEV *IterationCount,
228 SCEVExpander &RW) {
Chris Lattner40bf8b42004-04-02 20:24:31 +0000229 // Find the exit block for the loop. We can currently only handle loops with
230 // a single exit.
Devang Patelb7211a22007-08-21 00:31:24 +0000231 SmallVector<BasicBlock*, 8> ExitBlocks;
Chris Lattnerf1ab4b42004-04-18 22:14:10 +0000232 L->getExitBlocks(ExitBlocks);
Chris Lattner9ba46c12006-09-21 05:12:20 +0000233 if (ExitBlocks.size() != 1) return 0;
Chris Lattnerf1ab4b42004-04-18 22:14:10 +0000234 BasicBlock *ExitBlock = ExitBlocks[0];
Chris Lattner40bf8b42004-04-02 20:24:31 +0000235
236 // Make sure there is only one predecessor block in the loop.
237 BasicBlock *ExitingBlock = 0;
238 for (pred_iterator PI = pred_begin(ExitBlock), PE = pred_end(ExitBlock);
239 PI != PE; ++PI)
240 if (L->contains(*PI)) {
241 if (ExitingBlock == 0)
242 ExitingBlock = *PI;
243 else
Chris Lattner9ba46c12006-09-21 05:12:20 +0000244 return 0; // Multiple exits from loop to this block.
Chris Lattner40bf8b42004-04-02 20:24:31 +0000245 }
246 assert(ExitingBlock && "Loop info is broken");
247
248 if (!isa<BranchInst>(ExitingBlock->getTerminator()))
Chris Lattner9ba46c12006-09-21 05:12:20 +0000249 return 0; // Can't rewrite non-branch yet
Chris Lattner40bf8b42004-04-02 20:24:31 +0000250 BranchInst *BI = cast<BranchInst>(ExitingBlock->getTerminator());
251 assert(BI->isConditional() && "Must be conditional to be part of loop!");
252
Chris Lattner9ba46c12006-09-21 05:12:20 +0000253 Instruction *PotentiallyDeadInst = dyn_cast<Instruction>(BI->getCondition());
254
Chris Lattnerd2440572004-04-15 20:26:22 +0000255 // If the exiting block is not the same as the backedge block, we must compare
256 // against the preincremented value, otherwise we prefer to compare against
257 // the post-incremented value.
258 BasicBlock *Header = L->getHeader();
259 pred_iterator HPI = pred_begin(Header);
260 assert(HPI != pred_end(Header) && "Loop with zero preds???");
261 if (!L->contains(*HPI)) ++HPI;
262 assert(HPI != pred_end(Header) && L->contains(*HPI) &&
263 "No backedge in loop?");
Chris Lattner59fdaee2004-04-15 15:21:43 +0000264
Chris Lattnerd2440572004-04-15 20:26:22 +0000265 SCEVHandle TripCount = IterationCount;
266 Value *IndVar;
267 if (*HPI == ExitingBlock) {
268 // The IterationCount expression contains the number of times that the
269 // backedge actually branches to the loop header. This is one less than the
270 // number of times the loop executes, so add one to it.
Dan Gohmane19dd872007-06-15 18:00:55 +0000271 ConstantInt *OneC = ConstantInt::get(IterationCount->getType(), 1);
Dan Gohman246b2562007-10-22 18:31:58 +0000272 TripCount = SE->getAddExpr(IterationCount, SE->getConstant(OneC));
Chris Lattnerd2440572004-04-15 20:26:22 +0000273 IndVar = L->getCanonicalInductionVariableIncrement();
274 } else {
275 // We have to use the preincremented value...
276 IndVar = L->getCanonicalInductionVariable();
277 }
Chris Lattneree4f13a2007-01-07 01:14:12 +0000278
279 DOUT << "INDVARS: LFTR: TripCount = " << *TripCount
280 << " IndVar = " << *IndVar << "\n";
Chris Lattner59fdaee2004-04-15 15:21:43 +0000281
Chris Lattner40bf8b42004-04-02 20:24:31 +0000282 // Expand the code for the iteration count into the preheader of the loop.
283 BasicBlock *Preheader = L->getLoopPreheader();
Dan Gohmand19534a2007-06-15 14:38:12 +0000284 Value *ExitCnt = RW.expandCodeFor(TripCount, Preheader->getTerminator());
Chris Lattner40bf8b42004-04-02 20:24:31 +0000285
Reid Spencere4d87aa2006-12-23 06:05:41 +0000286 // Insert a new icmp_ne or icmp_eq instruction before the branch.
287 ICmpInst::Predicate Opcode;
Chris Lattner40bf8b42004-04-02 20:24:31 +0000288 if (L->contains(BI->getSuccessor(0)))
Reid Spencere4d87aa2006-12-23 06:05:41 +0000289 Opcode = ICmpInst::ICMP_NE;
Chris Lattner40bf8b42004-04-02 20:24:31 +0000290 else
Reid Spencere4d87aa2006-12-23 06:05:41 +0000291 Opcode = ICmpInst::ICMP_EQ;
Chris Lattner40bf8b42004-04-02 20:24:31 +0000292
Reid Spencere4d87aa2006-12-23 06:05:41 +0000293 Value *Cond = new ICmpInst(Opcode, IndVar, ExitCnt, "exitcond", BI);
Chris Lattner40bf8b42004-04-02 20:24:31 +0000294 BI->setCondition(Cond);
295 ++NumLFTR;
296 Changed = true;
Chris Lattner9ba46c12006-09-21 05:12:20 +0000297 return PotentiallyDeadInst;
Chris Lattner40bf8b42004-04-02 20:24:31 +0000298}
299
300
301/// RewriteLoopExitValues - Check to see if this loop has a computable
302/// loop-invariant execution count. If so, this means that we can compute the
303/// final value of any expressions that are recurrent in the loop, and
304/// substitute the exit values from the loop into any instructions outside of
305/// the loop that use the final values of the current expressions.
306void IndVarSimplify::RewriteLoopExitValues(Loop *L) {
307 BasicBlock *Preheader = L->getLoopPreheader();
308
309 // Scan all of the instructions in the loop, looking at those that have
310 // extra-loop users and which are recurrences.
Chris Lattner4a7553e2004-04-23 21:29:48 +0000311 SCEVExpander Rewriter(*SE, *LI);
Chris Lattner40bf8b42004-04-02 20:24:31 +0000312
313 // We insert the code into the preheader of the loop if the loop contains
314 // multiple exit blocks, or in the exit block if there is exactly one.
315 BasicBlock *BlockToInsertInto;
Devang Patelb7211a22007-08-21 00:31:24 +0000316 SmallVector<BasicBlock*, 8> ExitBlocks;
Chris Lattner9f3d7382007-03-04 03:43:23 +0000317 L->getUniqueExitBlocks(ExitBlocks);
Chris Lattnerf1ab4b42004-04-18 22:14:10 +0000318 if (ExitBlocks.size() == 1)
319 BlockToInsertInto = ExitBlocks[0];
Chris Lattner40bf8b42004-04-02 20:24:31 +0000320 else
321 BlockToInsertInto = Preheader;
Dan Gohman02dea8b2008-05-23 21:05:58 +0000322 BasicBlock::iterator InsertPt = BlockToInsertInto->getFirstNonPHI();
Chris Lattner40bf8b42004-04-02 20:24:31 +0000323
Chris Lattner20aa0982004-04-17 18:44:09 +0000324 bool HasConstantItCount = isa<SCEVConstant>(SE->getIterationCount(L));
325
Chris Lattner40bf8b42004-04-02 20:24:31 +0000326 std::set<Instruction*> InstructionsToDelete;
Chris Lattner9f3d7382007-03-04 03:43:23 +0000327 std::map<Instruction*, Value*> ExitValues;
Misha Brukmanfd939082005-04-21 23:48:37 +0000328
Chris Lattner9f3d7382007-03-04 03:43:23 +0000329 // Find all values that are computed inside the loop, but used outside of it.
330 // Because of LCSSA, these values will only occur in LCSSA PHI Nodes. Scan
331 // the exit blocks of the loop to find them.
332 for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
333 BasicBlock *ExitBB = ExitBlocks[i];
334
335 // If there are no PHI nodes in this exit block, then no values defined
336 // inside the loop are used on this path, skip it.
337 PHINode *PN = dyn_cast<PHINode>(ExitBB->begin());
338 if (!PN) continue;
339
340 unsigned NumPreds = PN->getNumIncomingValues();
341
342 // Iterate over all of the PHI nodes.
343 BasicBlock::iterator BBI = ExitBB->begin();
344 while ((PN = dyn_cast<PHINode>(BBI++))) {
Chris Lattnerc9838f22007-03-03 22:48:48 +0000345
Chris Lattner9f3d7382007-03-04 03:43:23 +0000346 // Iterate over all of the values in all the PHI nodes.
347 for (unsigned i = 0; i != NumPreds; ++i) {
348 // If the value being merged in is not integer or is not defined
349 // in the loop, skip it.
350 Value *InVal = PN->getIncomingValue(i);
351 if (!isa<Instruction>(InVal) ||
352 // SCEV only supports integer expressions for now.
353 !isa<IntegerType>(InVal->getType()))
354 continue;
Chris Lattner40bf8b42004-04-02 20:24:31 +0000355
Chris Lattner9f3d7382007-03-04 03:43:23 +0000356 // If this pred is for a subloop, not L itself, skip it.
357 if (LI->getLoopFor(PN->getIncomingBlock(i)) != L)
358 continue; // The Block is in a subloop, skip it.
359
360 // Check that InVal is defined in the loop.
361 Instruction *Inst = cast<Instruction>(InVal);
362 if (!L->contains(Inst->getParent()))
363 continue;
Chris Lattner9caed542007-03-04 01:00:28 +0000364
Chris Lattner9f3d7382007-03-04 03:43:23 +0000365 // We require that this value either have a computable evolution or that
366 // the loop have a constant iteration count. In the case where the loop
367 // has a constant iteration count, we can sometimes force evaluation of
368 // the exit value through brute force.
369 SCEVHandle SH = SE->getSCEV(Inst);
370 if (!SH->hasComputableLoopEvolution(L) && !HasConstantItCount)
371 continue; // Cannot get exit evolution for the loop value.
372
373 // Okay, this instruction has a user outside of the current loop
374 // and varies predictably *inside* the loop. Evaluate the value it
375 // contains when the loop exits, if possible.
376 SCEVHandle ExitValue = SE->getSCEVAtScope(Inst, L->getParentLoop());
377 if (isa<SCEVCouldNotCompute>(ExitValue) ||
378 !ExitValue->isLoopInvariant(L))
379 continue;
Chris Lattner9caed542007-03-04 01:00:28 +0000380
Chris Lattner9f3d7382007-03-04 03:43:23 +0000381 Changed = true;
382 ++NumReplaced;
383
384 // See if we already computed the exit value for the instruction, if so,
385 // just reuse it.
386 Value *&ExitVal = ExitValues[Inst];
387 if (!ExitVal)
Dan Gohmand19534a2007-06-15 14:38:12 +0000388 ExitVal = Rewriter.expandCodeFor(ExitValue, InsertPt);
Chris Lattner9f3d7382007-03-04 03:43:23 +0000389
390 DOUT << "INDVARS: RLEV: AfterLoopVal = " << *ExitVal
391 << " LoopVal = " << *Inst << "\n";
392
393 PN->setIncomingValue(i, ExitVal);
394
395 // If this instruction is dead now, schedule it to be removed.
396 if (Inst->use_empty())
397 InstructionsToDelete.insert(Inst);
398
399 // See if this is a single-entry LCSSA PHI node. If so, we can (and
400 // have to) remove
Chris Lattner9caed542007-03-04 01:00:28 +0000401 // the PHI entirely. This is safe, because the NewVal won't be variant
402 // in the loop, so we don't need an LCSSA phi node anymore.
Chris Lattner9f3d7382007-03-04 03:43:23 +0000403 if (NumPreds == 1) {
Dan Gohman5cec4db2007-06-19 14:28:31 +0000404 SE->deleteValueFromRecords(PN);
Chris Lattner9f3d7382007-03-04 03:43:23 +0000405 PN->replaceAllUsesWith(ExitVal);
406 PN->eraseFromParent();
407 break;
Chris Lattnerc9838f22007-03-03 22:48:48 +0000408 }
409 }
Chris Lattnerc9838f22007-03-03 22:48:48 +0000410 }
411 }
412
Chris Lattner40bf8b42004-04-02 20:24:31 +0000413 DeleteTriviallyDeadInstructions(InstructionsToDelete);
414}
415
Devang Patel5ee99972007-03-07 06:39:01 +0000416bool IndVarSimplify::doInitialization(Loop *L, LPPassManager &LPM) {
Chris Lattner40bf8b42004-04-02 20:24:31 +0000417
Devang Patel5ee99972007-03-07 06:39:01 +0000418 Changed = false;
Chris Lattner40bf8b42004-04-02 20:24:31 +0000419 // First step. Check to see if there are any trivial GEP pointer recurrences.
420 // If there are, change them into integer recurrences, permitting analysis by
421 // the SCEV routines.
422 //
423 BasicBlock *Header = L->getHeader();
424 BasicBlock *Preheader = L->getLoopPreheader();
Devang Patel5ee99972007-03-07 06:39:01 +0000425 SE = &LPM.getAnalysis<ScalarEvolution>();
Misha Brukmanfd939082005-04-21 23:48:37 +0000426
Chris Lattner40bf8b42004-04-02 20:24:31 +0000427 std::set<Instruction*> DeadInsts;
Reid Spencer2da5c3d2004-09-15 17:06:42 +0000428 for (BasicBlock::iterator I = Header->begin(); isa<PHINode>(I); ++I) {
429 PHINode *PN = cast<PHINode>(I);
Chris Lattner40bf8b42004-04-02 20:24:31 +0000430 if (isa<PointerType>(PN->getType()))
431 EliminatePointerRecurrence(PN, Preheader, DeadInsts);
Reid Spencer2da5c3d2004-09-15 17:06:42 +0000432 }
Chris Lattner40bf8b42004-04-02 20:24:31 +0000433
434 if (!DeadInsts.empty())
435 DeleteTriviallyDeadInstructions(DeadInsts);
436
Devang Patel5ee99972007-03-07 06:39:01 +0000437 return Changed;
438}
Chris Lattner40bf8b42004-04-02 20:24:31 +0000439
Devang Patel5ee99972007-03-07 06:39:01 +0000440bool IndVarSimplify::runOnLoop(Loop *L, LPPassManager &LPM) {
Chris Lattner3324e712003-12-22 03:58:44 +0000441
Devang Patel5ee99972007-03-07 06:39:01 +0000442
443 LI = &getAnalysis<LoopInfo>();
444 SE = &getAnalysis<ScalarEvolution>();
445
446 Changed = false;
447 BasicBlock *Header = L->getHeader();
448 std::set<Instruction*> DeadInsts;
449
Chris Lattner9caed542007-03-04 01:00:28 +0000450 // Verify the input to the pass in already in LCSSA form.
451 assert(L->isLCSSAForm());
452
Chris Lattner40bf8b42004-04-02 20:24:31 +0000453 // Check to see if this loop has a computable loop-invariant execution count.
454 // If so, this means that we can compute the final value of any expressions
455 // that are recurrent in the loop, and substitute the exit values from the
456 // loop into any instructions outside of the loop that use the final values of
457 // the current expressions.
Chris Lattner3dec1f22002-05-10 15:38:35 +0000458 //
Chris Lattner40bf8b42004-04-02 20:24:31 +0000459 SCEVHandle IterationCount = SE->getIterationCount(L);
460 if (!isa<SCEVCouldNotCompute>(IterationCount))
461 RewriteLoopExitValues(L);
Chris Lattner6148c022001-12-03 17:28:42 +0000462
Chris Lattner40bf8b42004-04-02 20:24:31 +0000463 // Next, analyze all of the induction variables in the loop, canonicalizing
464 // auxillary induction variables.
465 std::vector<std::pair<PHINode*, SCEVHandle> > IndVars;
466
Reid Spencer2da5c3d2004-09-15 17:06:42 +0000467 for (BasicBlock::iterator I = Header->begin(); isa<PHINode>(I); ++I) {
468 PHINode *PN = cast<PHINode>(I);
Chris Lattner42a75512007-01-15 02:27:26 +0000469 if (PN->getType()->isInteger()) { // FIXME: when we have fast-math, enable!
Chris Lattner40bf8b42004-04-02 20:24:31 +0000470 SCEVHandle SCEV = SE->getSCEV(PN);
471 if (SCEV->hasComputableLoopEvolution(L))
Chris Lattnercda9ca52005-08-10 01:12:06 +0000472 // FIXME: It is an extremely bad idea to indvar substitute anything more
473 // complex than affine induction variables. Doing so will put expensive
474 // polynomial evaluations inside of the loop, and the str reduction pass
475 // currently can only reduce affine polynomials. For now just disable
476 // indvar subst on anything more complex than an affine addrec.
Chris Lattner595ee7e2004-07-26 02:47:12 +0000477 if (SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(SCEV))
Chris Lattnercda9ca52005-08-10 01:12:06 +0000478 if (AR->isAffine())
Chris Lattner595ee7e2004-07-26 02:47:12 +0000479 IndVars.push_back(std::make_pair(PN, SCEV));
Chris Lattner40bf8b42004-04-02 20:24:31 +0000480 }
Reid Spencer2da5c3d2004-09-15 17:06:42 +0000481 }
Chris Lattner40bf8b42004-04-02 20:24:31 +0000482
483 // If there are no induction variables in the loop, there is nothing more to
484 // do.
Chris Lattnerf50af082004-04-17 18:08:33 +0000485 if (IndVars.empty()) {
486 // Actually, if we know how many times the loop iterates, lets insert a
487 // canonical induction variable to help subsequent passes.
488 if (!isa<SCEVCouldNotCompute>(IterationCount)) {
Chris Lattner4a7553e2004-04-23 21:29:48 +0000489 SCEVExpander Rewriter(*SE, *LI);
490 Rewriter.getOrInsertCanonicalInductionVariable(L,
Chris Lattnerf50af082004-04-17 18:08:33 +0000491 IterationCount->getType());
Chris Lattner9ba46c12006-09-21 05:12:20 +0000492 if (Instruction *I = LinearFunctionTestReplace(L, IterationCount,
493 Rewriter)) {
494 std::set<Instruction*> InstructionsToDelete;
495 InstructionsToDelete.insert(I);
496 DeleteTriviallyDeadInstructions(InstructionsToDelete);
497 }
Chris Lattnerf50af082004-04-17 18:08:33 +0000498 }
Devang Patel5ee99972007-03-07 06:39:01 +0000499 return Changed;
Chris Lattnerf50af082004-04-17 18:08:33 +0000500 }
Chris Lattner40bf8b42004-04-02 20:24:31 +0000501
502 // Compute the type of the largest recurrence expression.
Chris Lattner6148c022001-12-03 17:28:42 +0000503 //
Chris Lattner40bf8b42004-04-02 20:24:31 +0000504 const Type *LargestType = IndVars[0].first->getType();
Chris Lattnerfcb81f52004-04-22 14:59:40 +0000505 bool DifferingSizes = false;
Chris Lattner40bf8b42004-04-02 20:24:31 +0000506 for (unsigned i = 1, e = IndVars.size(); i != e; ++i) {
507 const Type *Ty = IndVars[i].first->getType();
Reid Spencerabaa8ca2007-01-08 16:32:00 +0000508 DifferingSizes |=
509 Ty->getPrimitiveSizeInBits() != LargestType->getPrimitiveSizeInBits();
510 if (Ty->getPrimitiveSizeInBits() > LargestType->getPrimitiveSizeInBits())
Chris Lattner40bf8b42004-04-02 20:24:31 +0000511 LargestType = Ty;
Chris Lattner6148c022001-12-03 17:28:42 +0000512 }
513
Chris Lattner40bf8b42004-04-02 20:24:31 +0000514 // Create a rewriter object which we'll use to transform the code with.
Chris Lattner4a7553e2004-04-23 21:29:48 +0000515 SCEVExpander Rewriter(*SE, *LI);
Chris Lattner15cad752003-12-23 07:47:09 +0000516
Chris Lattner40bf8b42004-04-02 20:24:31 +0000517 // Now that we know the largest of of the induction variables in this loop,
518 // insert a canonical induction variable of the largest size.
Chris Lattner4a7553e2004-04-23 21:29:48 +0000519 Value *IndVar = Rewriter.getOrInsertCanonicalInductionVariable(L,LargestType);
Chris Lattner40bf8b42004-04-02 20:24:31 +0000520 ++NumInserted;
521 Changed = true;
Chris Lattneree4f13a2007-01-07 01:14:12 +0000522 DOUT << "INDVARS: New CanIV: " << *IndVar;
Chris Lattner15cad752003-12-23 07:47:09 +0000523
Dan Gohmand19534a2007-06-15 14:38:12 +0000524 if (!isa<SCEVCouldNotCompute>(IterationCount)) {
Wojciech Matyjewicz90087212008-06-13 17:02:03 +0000525 IterationCount = SE->getTruncateOrZeroExtend(IterationCount, LargestType);
Chris Lattner9ba46c12006-09-21 05:12:20 +0000526 if (Instruction *DI = LinearFunctionTestReplace(L, IterationCount,Rewriter))
527 DeadInsts.insert(DI);
Dan Gohmand19534a2007-06-15 14:38:12 +0000528 }
Chris Lattner15cad752003-12-23 07:47:09 +0000529
Chris Lattner40bf8b42004-04-02 20:24:31 +0000530 // Now that we have a canonical induction variable, we can rewrite any
531 // recurrences in terms of the induction variable. Start with the auxillary
532 // induction variables, and recursively rewrite any of their uses.
Dan Gohman02dea8b2008-05-23 21:05:58 +0000533 BasicBlock::iterator InsertPt = Header->getFirstNonPHI();
Chris Lattner6148c022001-12-03 17:28:42 +0000534
Chris Lattner5d461d22004-04-21 22:22:01 +0000535 // If there were induction variables of other sizes, cast the primary
536 // induction variable to the right size for them, avoiding the need for the
537 // code evaluation methods to insert induction variables of different sizes.
Chris Lattnerfcb81f52004-04-22 14:59:40 +0000538 if (DifferingSizes) {
Reid Spencera54b7cb2007-01-12 07:05:14 +0000539 SmallVector<unsigned,4> InsertedSizes;
540 InsertedSizes.push_back(LargestType->getPrimitiveSizeInBits());
541 for (unsigned i = 0, e = IndVars.size(); i != e; ++i) {
542 unsigned ithSize = IndVars[i].first->getType()->getPrimitiveSizeInBits();
Chris Lattneref60b2c2007-01-12 22:51:20 +0000543 if (std::find(InsertedSizes.begin(), InsertedSizes.end(), ithSize)
544 == InsertedSizes.end()) {
Chris Lattnerfcb81f52004-04-22 14:59:40 +0000545 PHINode *PN = IndVars[i].first;
Reid Spencera54b7cb2007-01-12 07:05:14 +0000546 InsertedSizes.push_back(ithSize);
Chris Lattneree4f13a2007-01-07 01:14:12 +0000547 Instruction *New = new TruncInst(IndVar, PN->getType(), "indvar",
548 InsertPt);
Chris Lattnerfcb81f52004-04-22 14:59:40 +0000549 Rewriter.addInsertedValue(New, SE->getSCEV(New));
Chris Lattneree4f13a2007-01-07 01:14:12 +0000550 DOUT << "INDVARS: Made trunc IV for " << *PN
551 << " NewVal = " << *New << "\n";
Chris Lattnerfcb81f52004-04-22 14:59:40 +0000552 }
Reid Spencera54b7cb2007-01-12 07:05:14 +0000553 }
Chris Lattnerfcb81f52004-04-22 14:59:40 +0000554 }
555
Chris Lattneree4f13a2007-01-07 01:14:12 +0000556 // Rewrite all induction variables in terms of the canonical induction
557 // variable.
Chris Lattner5d461d22004-04-21 22:22:01 +0000558 std::map<unsigned, Value*> InsertedSizes;
Chris Lattner40bf8b42004-04-02 20:24:31 +0000559 while (!IndVars.empty()) {
560 PHINode *PN = IndVars.back().first;
Dan Gohmand19534a2007-06-15 14:38:12 +0000561 Value *NewVal = Rewriter.expandCodeFor(IndVars.back().second, InsertPt);
Chris Lattneree4f13a2007-01-07 01:14:12 +0000562 DOUT << "INDVARS: Rewrote IV '" << *IndVars.back().second << "' " << *PN
563 << " into = " << *NewVal << "\n";
Chris Lattner6934a042007-02-11 01:23:03 +0000564 NewVal->takeName(PN);
Chris Lattner5d461d22004-04-21 22:22:01 +0000565
Chris Lattner40bf8b42004-04-02 20:24:31 +0000566 // Replace the old PHI Node with the inserted computation.
Chris Lattnerfcb81f52004-04-22 14:59:40 +0000567 PN->replaceAllUsesWith(NewVal);
Chris Lattner40bf8b42004-04-02 20:24:31 +0000568 DeadInsts.insert(PN);
569 IndVars.pop_back();
570 ++NumRemoved;
Chris Lattner4753bf22001-12-05 19:41:33 +0000571 Changed = true;
Chris Lattner394437f2001-12-04 04:32:29 +0000572 }
573
Chris Lattnerb4782d12004-04-22 15:12:36 +0000574#if 0
Chris Lattner1363e852004-04-21 23:36:08 +0000575 // Now replace all derived expressions in the loop body with simpler
576 // expressions.
Chris Lattner40bf8b42004-04-02 20:24:31 +0000577 for (unsigned i = 0, e = L->getBlocks().size(); i != e; ++i)
578 if (LI->getLoopFor(L->getBlocks()[i]) == L) { // Not in a subloop...
579 BasicBlock *BB = L->getBlocks()[i];
580 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
Chris Lattner42a75512007-01-15 02:27:26 +0000581 if (I->getType()->isInteger() && // Is an integer instruction
Chris Lattner1363e852004-04-21 23:36:08 +0000582 !I->use_empty() &&
Chris Lattner40bf8b42004-04-02 20:24:31 +0000583 !Rewriter.isInsertedInstruction(I)) {
584 SCEVHandle SH = SE->getSCEV(I);
Chris Lattner4a7553e2004-04-23 21:29:48 +0000585 Value *V = Rewriter.expandCodeFor(SH, I, I->getType());
Chris Lattner1363e852004-04-21 23:36:08 +0000586 if (V != I) {
Chris Lattner6934a042007-02-11 01:23:03 +0000587 if (isa<Instruction>(V))
588 V->takeName(I);
Chris Lattner1363e852004-04-21 23:36:08 +0000589 I->replaceAllUsesWith(V);
590 DeadInsts.insert(I);
591 ++NumRemoved;
592 Changed = true;
Misha Brukmanfd939082005-04-21 23:48:37 +0000593 }
Chris Lattner40bf8b42004-04-02 20:24:31 +0000594 }
Chris Lattner394437f2001-12-04 04:32:29 +0000595 }
Chris Lattnerb4782d12004-04-22 15:12:36 +0000596#endif
Chris Lattner1363e852004-04-21 23:36:08 +0000597
Chris Lattner1363e852004-04-21 23:36:08 +0000598 DeleteTriviallyDeadInstructions(DeadInsts);
Owen Andersoneb705912006-08-25 22:12:36 +0000599
Chris Lattner9caed542007-03-04 01:00:28 +0000600 assert(L->isLCSSAForm());
Devang Patel5ee99972007-03-07 06:39:01 +0000601 return Changed;
Chris Lattner6148c022001-12-03 17:28:42 +0000602}