blob: 0643e75ab34beacd87d94dbefd13f909d441beff [file] [log] [blame]
Chris Lattner476e6df2001-12-03 17:28:42 +00001//===- IndVarSimplify.cpp - Induction Variable Elimination ----------------===//
Misha Brukmanb1c93172005-04-21 23:48:37 +00002//
John Criswell482202a2003-10-20 19:43:21 +00003// 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.
Misha Brukmanb1c93172005-04-21 23:48:37 +00007//
John Criswell482202a2003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner476e6df2001-12-03 17:28:42 +00009//
Chris Lattnere61b67d2004-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 Spencer5495fe82006-08-18 09:01:07 +000014// This transformation makes the following changes to each loop with an
Chris Lattnere61b67d2004-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 Lattner476e6df2001-12-03 17:28:42 +000037//
38//===----------------------------------------------------------------------===//
39
Chris Lattner79a42ac2006-12-19 21:40:18 +000040#define DEBUG_TYPE "indvars"
Chris Lattnerb4cfa7f2002-05-07 20:03:00 +000041#include "llvm/Transforms/Scalar.h"
Chris Lattnere61b67d2004-04-02 20:24:31 +000042#include "llvm/BasicBlock.h"
Chris Lattner0cec5cb2004-04-15 15:21:43 +000043#include "llvm/Constants.h"
Chris Lattner6449dce2003-12-22 05:02:01 +000044#include "llvm/Instructions.h"
Chris Lattnere61b67d2004-04-02 20:24:31 +000045#include "llvm/Type.h"
Nate Begeman2bca4d92005-07-30 00:12:19 +000046#include "llvm/Analysis/ScalarEvolutionExpander.h"
John Criswellb22e9b42003-12-18 17:19:19 +000047#include "llvm/Analysis/LoopInfo.h"
Chris Lattner83d485b2002-02-12 22:39:50 +000048#include "llvm/Support/CFG.h"
Chris Lattner08165592007-01-07 01:14:12 +000049#include "llvm/Support/Debug.h"
Chris Lattner9776f722004-10-11 23:06:50 +000050#include "llvm/Support/GetElementPtrTypeIterator.h"
John Criswellb22e9b42003-12-18 17:19:19 +000051#include "llvm/Transforms/Utils/Local.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000052#include "llvm/Support/CommandLine.h"
Reid Spencer7a9c62b2007-01-12 07:05:14 +000053#include "llvm/ADT/SmallVector.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000054#include "llvm/ADT/Statistic.h"
John Criswellb22e9b42003-12-18 17:19:19 +000055using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000056
Chris Lattner79a42ac2006-12-19 21:40:18 +000057STATISTIC(NumRemoved , "Number of aux indvars removed");
58STATISTIC(NumPointer , "Number of pointer indvars promoted");
59STATISTIC(NumInserted, "Number of canonical indvars added");
60STATISTIC(NumReplaced, "Number of exit values replaced");
61STATISTIC(NumLFTR , "Number of loop exit tests replaced");
Chris Lattnerd3678bc2003-12-22 03:58:44 +000062
Chris Lattner79a42ac2006-12-19 21:40:18 +000063namespace {
Chris Lattnerd3678bc2003-12-22 03:58:44 +000064 class IndVarSimplify : public FunctionPass {
Chris Lattnere61b67d2004-04-02 20:24:31 +000065 LoopInfo *LI;
66 ScalarEvolution *SE;
Chris Lattner7e755e42003-12-23 07:47:09 +000067 bool Changed;
Chris Lattnerd3678bc2003-12-22 03:58:44 +000068 public:
69 virtual bool runOnFunction(Function &) {
Chris Lattnere61b67d2004-04-02 20:24:31 +000070 LI = &getAnalysis<LoopInfo>();
71 SE = &getAnalysis<ScalarEvolution>();
Chris Lattner7e755e42003-12-23 07:47:09 +000072 Changed = false;
73
Chris Lattnerd3678bc2003-12-22 03:58:44 +000074 // Induction Variables live in the header nodes of loops
Chris Lattnere61b67d2004-04-02 20:24:31 +000075 for (LoopInfo::iterator I = LI->begin(), E = LI->end(); I != E; ++I)
Chris Lattner59d2d7f2004-01-08 00:09:44 +000076 runOnLoop(*I);
Chris Lattnerd3678bc2003-12-22 03:58:44 +000077 return Changed;
78 }
79
Chris Lattnerd3678bc2003-12-22 03:58:44 +000080 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Chris Lattnerd3678bc2003-12-22 03:58:44 +000081 AU.addRequiredID(LoopSimplifyID);
Chris Lattnere61b67d2004-04-02 20:24:31 +000082 AU.addRequired<ScalarEvolution>();
83 AU.addRequired<LoopInfo>();
Chris Lattnerd3678bc2003-12-22 03:58:44 +000084 AU.addPreservedID(LoopSimplifyID);
Owen Anderson8cca95c2006-08-25 17:41:25 +000085 AU.addPreservedID(LCSSAID);
Chris Lattnerd3678bc2003-12-22 03:58:44 +000086 AU.setPreservesCFG();
87 }
Chris Lattnere61b67d2004-04-02 20:24:31 +000088 private:
89 void runOnLoop(Loop *L);
90 void EliminatePointerRecurrence(PHINode *PN, BasicBlock *Preheader,
91 std::set<Instruction*> &DeadInsts);
Chris Lattner51c95cd2006-09-21 05:12:20 +000092 Instruction *LinearFunctionTestReplace(Loop *L, SCEV *IterationCount,
93 SCEVExpander &RW);
Chris Lattnere61b67d2004-04-02 20:24:31 +000094 void RewriteLoopExitValues(Loop *L);
95
96 void DeleteTriviallyDeadInstructions(std::set<Instruction*> &Insts);
Chris Lattnerd3678bc2003-12-22 03:58:44 +000097 };
Chris Lattnerc2d3d312006-08-27 22:42:52 +000098 RegisterPass<IndVarSimplify> X("indvars", "Canonicalize Induction Variables");
Chris Lattner4184bcc2002-09-10 05:24:05 +000099}
Chris Lattner91daaab2001-12-04 04:32:29 +0000100
Chris Lattner3e860842004-09-20 04:43:15 +0000101FunctionPass *llvm::createIndVarSimplifyPass() {
Chris Lattnerd3678bc2003-12-22 03:58:44 +0000102 return new IndVarSimplify();
Chris Lattner91daaab2001-12-04 04:32:29 +0000103}
104
Chris Lattnere61b67d2004-04-02 20:24:31 +0000105/// DeleteTriviallyDeadInstructions - If any of the instructions is the
106/// specified set are trivially dead, delete them and see if this makes any of
107/// their operands subsequently dead.
108void IndVarSimplify::
109DeleteTriviallyDeadInstructions(std::set<Instruction*> &Insts) {
110 while (!Insts.empty()) {
111 Instruction *I = *Insts.begin();
112 Insts.erase(Insts.begin());
113 if (isInstructionTriviallyDead(I)) {
114 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
115 if (Instruction *U = dyn_cast<Instruction>(I->getOperand(i)))
116 Insts.insert(U);
117 SE->deleteInstructionFromRecords(I);
Chris Lattner08165592007-01-07 01:14:12 +0000118 DOUT << "INDVARS: Deleting: " << *I;
Chris Lattner9776f722004-10-11 23:06:50 +0000119 I->eraseFromParent();
Chris Lattnere61b67d2004-04-02 20:24:31 +0000120 Changed = true;
121 }
122 }
123}
124
125
126/// EliminatePointerRecurrence - Check to see if this is a trivial GEP pointer
127/// recurrence. If so, change it into an integer recurrence, permitting
128/// analysis by the SCEV routines.
Misha Brukmanb1c93172005-04-21 23:48:37 +0000129void IndVarSimplify::EliminatePointerRecurrence(PHINode *PN,
Chris Lattnere61b67d2004-04-02 20:24:31 +0000130 BasicBlock *Preheader,
131 std::set<Instruction*> &DeadInsts) {
132 assert(PN->getNumIncomingValues() == 2 && "Noncanonicalized loop!");
133 unsigned PreheaderIdx = PN->getBasicBlockIndex(Preheader);
134 unsigned BackedgeIdx = PreheaderIdx^1;
135 if (GetElementPtrInst *GEPI =
Chris Lattner677d8572005-08-10 01:12:06 +0000136 dyn_cast<GetElementPtrInst>(PN->getIncomingValue(BackedgeIdx)))
Chris Lattnere61b67d2004-04-02 20:24:31 +0000137 if (GEPI->getOperand(0) == PN) {
Chris Lattner677d8572005-08-10 01:12:06 +0000138 assert(GEPI->getNumOperands() == 2 && "GEP types must match!");
Chris Lattner08165592007-01-07 01:14:12 +0000139 DOUT << "INDVARS: Eliminating pointer recurrence: " << *GEPI;
140
Chris Lattnere61b67d2004-04-02 20:24:31 +0000141 // Okay, we found a pointer recurrence. Transform this pointer
142 // recurrence into an integer recurrence. Compute the value that gets
143 // added to the pointer at every iteration.
144 Value *AddedVal = GEPI->getOperand(1);
145
146 // Insert a new integer PHI node into the top of the block.
147 PHINode *NewPhi = new PHINode(AddedVal->getType(),
148 PN->getName()+".rec", PN);
Chris Lattnerc9e06332004-06-20 05:04:01 +0000149 NewPhi->addIncoming(Constant::getNullValue(NewPhi->getType()), Preheader);
150
Chris Lattnere61b67d2004-04-02 20:24:31 +0000151 // Create the new add instruction.
Chris Lattnerc9e06332004-06-20 05:04:01 +0000152 Value *NewAdd = BinaryOperator::createAdd(NewPhi, AddedVal,
153 GEPI->getName()+".rec", GEPI);
Chris Lattnere61b67d2004-04-02 20:24:31 +0000154 NewPhi->addIncoming(NewAdd, PN->getIncomingBlock(BackedgeIdx));
Misha Brukmanb1c93172005-04-21 23:48:37 +0000155
Chris Lattnere61b67d2004-04-02 20:24:31 +0000156 // Update the existing GEP to use the recurrence.
157 GEPI->setOperand(0, PN->getIncomingValue(PreheaderIdx));
Misha Brukmanb1c93172005-04-21 23:48:37 +0000158
Chris Lattnere61b67d2004-04-02 20:24:31 +0000159 // Update the GEP to use the new recurrence we just inserted.
160 GEPI->setOperand(1, NewAdd);
161
Chris Lattner9776f722004-10-11 23:06:50 +0000162 // If the incoming value is a constant expr GEP, try peeling out the array
163 // 0 index if possible to make things simpler.
164 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GEPI->getOperand(0)))
165 if (CE->getOpcode() == Instruction::GetElementPtr) {
166 unsigned NumOps = CE->getNumOperands();
167 assert(NumOps > 1 && "CE folding didn't work!");
168 if (CE->getOperand(NumOps-1)->isNullValue()) {
169 // Check to make sure the last index really is an array index.
Chris Lattner9c37f232005-11-18 18:30:47 +0000170 gep_type_iterator GTI = gep_type_begin(CE);
Chris Lattnerbca0be82005-11-17 19:35:42 +0000171 for (unsigned i = 1, e = CE->getNumOperands()-1;
Chris Lattner9776f722004-10-11 23:06:50 +0000172 i != e; ++i, ++GTI)
173 /*empty*/;
174 if (isa<SequentialType>(*GTI)) {
175 // Pull the last index out of the constant expr GEP.
176 std::vector<Value*> CEIdxs(CE->op_begin()+1, CE->op_end()-1);
177 Constant *NCE = ConstantExpr::getGetElementPtr(CE->getOperand(0),
178 CEIdxs);
179 GetElementPtrInst *NGEPI =
Reid Spencerc635f472006-12-31 05:48:39 +0000180 new GetElementPtrInst(NCE, Constant::getNullValue(Type::Int32Ty),
Chris Lattner9776f722004-10-11 23:06:50 +0000181 NewAdd, GEPI->getName(), GEPI);
182 GEPI->replaceAllUsesWith(NGEPI);
183 GEPI->eraseFromParent();
184 GEPI = NGEPI;
185 }
186 }
187 }
188
189
Chris Lattnere61b67d2004-04-02 20:24:31 +0000190 // Finally, if there are any other users of the PHI node, we must
191 // insert a new GEP instruction that uses the pre-incremented version
192 // of the induction amount.
193 if (!PN->use_empty()) {
194 BasicBlock::iterator InsertPos = PN; ++InsertPos;
195 while (isa<PHINode>(InsertPos)) ++InsertPos;
196 std::string Name = PN->getName(); PN->setName("");
197 Value *PreInc =
198 new GetElementPtrInst(PN->getIncomingValue(PreheaderIdx),
199 std::vector<Value*>(1, NewPhi), Name,
200 InsertPos);
201 PN->replaceAllUsesWith(PreInc);
202 }
203
204 // Delete the old PHI for sure, and the GEP if its otherwise unused.
205 DeadInsts.insert(PN);
206
207 ++NumPointer;
208 Changed = true;
209 }
210}
211
212/// LinearFunctionTestReplace - This method rewrites the exit condition of the
Chris Lattner0cec5cb2004-04-15 15:21:43 +0000213/// loop to be a canonical != comparison against the incremented loop induction
214/// variable. This pass is able to rewrite the exit tests of any loop where the
215/// SCEV analysis can determine a loop-invariant trip count of the loop, which
216/// is actually a much broader range than just linear tests.
Chris Lattner51c95cd2006-09-21 05:12:20 +0000217///
218/// This method returns a "potentially dead" instruction whose computation chain
219/// should be deleted when convenient.
220Instruction *IndVarSimplify::LinearFunctionTestReplace(Loop *L,
221 SCEV *IterationCount,
222 SCEVExpander &RW) {
Chris Lattnere61b67d2004-04-02 20:24:31 +0000223 // Find the exit block for the loop. We can currently only handle loops with
224 // a single exit.
Chris Lattnerd72c3eb2004-04-18 22:14:10 +0000225 std::vector<BasicBlock*> ExitBlocks;
226 L->getExitBlocks(ExitBlocks);
Chris Lattner51c95cd2006-09-21 05:12:20 +0000227 if (ExitBlocks.size() != 1) return 0;
Chris Lattnerd72c3eb2004-04-18 22:14:10 +0000228 BasicBlock *ExitBlock = ExitBlocks[0];
Chris Lattnere61b67d2004-04-02 20:24:31 +0000229
230 // Make sure there is only one predecessor block in the loop.
231 BasicBlock *ExitingBlock = 0;
232 for (pred_iterator PI = pred_begin(ExitBlock), PE = pred_end(ExitBlock);
233 PI != PE; ++PI)
234 if (L->contains(*PI)) {
235 if (ExitingBlock == 0)
236 ExitingBlock = *PI;
237 else
Chris Lattner51c95cd2006-09-21 05:12:20 +0000238 return 0; // Multiple exits from loop to this block.
Chris Lattnere61b67d2004-04-02 20:24:31 +0000239 }
240 assert(ExitingBlock && "Loop info is broken");
241
242 if (!isa<BranchInst>(ExitingBlock->getTerminator()))
Chris Lattner51c95cd2006-09-21 05:12:20 +0000243 return 0; // Can't rewrite non-branch yet
Chris Lattnere61b67d2004-04-02 20:24:31 +0000244 BranchInst *BI = cast<BranchInst>(ExitingBlock->getTerminator());
245 assert(BI->isConditional() && "Must be conditional to be part of loop!");
246
Chris Lattner51c95cd2006-09-21 05:12:20 +0000247 Instruction *PotentiallyDeadInst = dyn_cast<Instruction>(BI->getCondition());
248
Chris Lattnerd7a559e2004-04-15 20:26:22 +0000249 // If the exiting block is not the same as the backedge block, we must compare
250 // against the preincremented value, otherwise we prefer to compare against
251 // the post-incremented value.
252 BasicBlock *Header = L->getHeader();
253 pred_iterator HPI = pred_begin(Header);
254 assert(HPI != pred_end(Header) && "Loop with zero preds???");
255 if (!L->contains(*HPI)) ++HPI;
256 assert(HPI != pred_end(Header) && L->contains(*HPI) &&
257 "No backedge in loop?");
Chris Lattner0cec5cb2004-04-15 15:21:43 +0000258
Chris Lattnerd7a559e2004-04-15 20:26:22 +0000259 SCEVHandle TripCount = IterationCount;
260 Value *IndVar;
261 if (*HPI == ExitingBlock) {
262 // The IterationCount expression contains the number of times that the
263 // backedge actually branches to the loop header. This is one less than the
264 // number of times the loop executes, so add one to it.
265 Constant *OneC = ConstantInt::get(IterationCount->getType(), 1);
266 TripCount = SCEVAddExpr::get(IterationCount, SCEVUnknown::get(OneC));
267 IndVar = L->getCanonicalInductionVariableIncrement();
268 } else {
269 // We have to use the preincremented value...
270 IndVar = L->getCanonicalInductionVariable();
271 }
Chris Lattner08165592007-01-07 01:14:12 +0000272
273 DOUT << "INDVARS: LFTR: TripCount = " << *TripCount
274 << " IndVar = " << *IndVar << "\n";
Chris Lattner0cec5cb2004-04-15 15:21:43 +0000275
Chris Lattnere61b67d2004-04-02 20:24:31 +0000276 // Expand the code for the iteration count into the preheader of the loop.
277 BasicBlock *Preheader = L->getLoopPreheader();
Chris Lattner83cd87e2004-04-23 21:29:48 +0000278 Value *ExitCnt = RW.expandCodeFor(TripCount, Preheader->getTerminator(),
Chris Lattnere61b67d2004-04-02 20:24:31 +0000279 IndVar->getType());
280
Reid Spencer266e42b2006-12-23 06:05:41 +0000281 // Insert a new icmp_ne or icmp_eq instruction before the branch.
282 ICmpInst::Predicate Opcode;
Chris Lattnere61b67d2004-04-02 20:24:31 +0000283 if (L->contains(BI->getSuccessor(0)))
Reid Spencer266e42b2006-12-23 06:05:41 +0000284 Opcode = ICmpInst::ICMP_NE;
Chris Lattnere61b67d2004-04-02 20:24:31 +0000285 else
Reid Spencer266e42b2006-12-23 06:05:41 +0000286 Opcode = ICmpInst::ICMP_EQ;
Chris Lattnere61b67d2004-04-02 20:24:31 +0000287
Reid Spencer266e42b2006-12-23 06:05:41 +0000288 Value *Cond = new ICmpInst(Opcode, IndVar, ExitCnt, "exitcond", BI);
Chris Lattnere61b67d2004-04-02 20:24:31 +0000289 BI->setCondition(Cond);
290 ++NumLFTR;
291 Changed = true;
Chris Lattner51c95cd2006-09-21 05:12:20 +0000292 return PotentiallyDeadInst;
Chris Lattnere61b67d2004-04-02 20:24:31 +0000293}
294
295
296/// RewriteLoopExitValues - Check to see if this loop has a computable
297/// loop-invariant execution count. If so, this means that we can compute the
298/// final value of any expressions that are recurrent in the loop, and
299/// substitute the exit values from the loop into any instructions outside of
300/// the loop that use the final values of the current expressions.
301void IndVarSimplify::RewriteLoopExitValues(Loop *L) {
302 BasicBlock *Preheader = L->getLoopPreheader();
303
304 // Scan all of the instructions in the loop, looking at those that have
305 // extra-loop users and which are recurrences.
Chris Lattner83cd87e2004-04-23 21:29:48 +0000306 SCEVExpander Rewriter(*SE, *LI);
Chris Lattnere61b67d2004-04-02 20:24:31 +0000307
308 // We insert the code into the preheader of the loop if the loop contains
309 // multiple exit blocks, or in the exit block if there is exactly one.
310 BasicBlock *BlockToInsertInto;
Chris Lattnerd72c3eb2004-04-18 22:14:10 +0000311 std::vector<BasicBlock*> ExitBlocks;
312 L->getExitBlocks(ExitBlocks);
313 if (ExitBlocks.size() == 1)
314 BlockToInsertInto = ExitBlocks[0];
Chris Lattnere61b67d2004-04-02 20:24:31 +0000315 else
316 BlockToInsertInto = Preheader;
317 BasicBlock::iterator InsertPt = BlockToInsertInto->begin();
318 while (isa<PHINode>(InsertPt)) ++InsertPt;
319
Chris Lattnera8140802004-04-17 18:44:09 +0000320 bool HasConstantItCount = isa<SCEVConstant>(SE->getIterationCount(L));
321
Chris Lattnere61b67d2004-04-02 20:24:31 +0000322 std::set<Instruction*> InstructionsToDelete;
Misha Brukmanb1c93172005-04-21 23:48:37 +0000323
Chris Lattnere61b67d2004-04-02 20:24:31 +0000324 for (unsigned i = 0, e = L->getBlocks().size(); i != e; ++i)
325 if (LI->getLoopFor(L->getBlocks()[i]) == L) { // Not in a subloop...
326 BasicBlock *BB = L->getBlocks()[i];
Chris Lattnerdf815392005-06-15 21:29:31 +0000327 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E;) {
Chris Lattnere61b67d2004-04-02 20:24:31 +0000328 if (I->getType()->isInteger()) { // Is an integer instruction
329 SCEVHandle SH = SE->getSCEV(I);
Chris Lattnera8140802004-04-17 18:44:09 +0000330 if (SH->hasComputableLoopEvolution(L) || // Varies predictably
331 HasConstantItCount) {
Chris Lattnere61b67d2004-04-02 20:24:31 +0000332 // Find out if this predictably varying value is actually used
333 // outside of the loop. "extra" as opposed to "intra".
Chris Lattner053fb932006-06-17 01:02:31 +0000334 std::vector<Instruction*> ExtraLoopUsers;
Chris Lattnere61b67d2004-04-02 20:24:31 +0000335 for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
Chris Lattner053fb932006-06-17 01:02:31 +0000336 UI != E; ++UI) {
337 Instruction *User = cast<Instruction>(*UI);
Chris Lattner9b6c02e2006-07-13 19:05:20 +0000338 if (!L->contains(User->getParent())) {
339 // If this is a PHI node in the exit block and we're inserting,
340 // into the exit block, it must have a single entry. In this
341 // case, we can't insert the code after the PHI and have the PHI
342 // still use it. Instead, don't insert the the PHI.
343 if (PHINode *PN = dyn_cast<PHINode>(User)) {
344 // FIXME: This is a case where LCSSA pessimizes code, this
345 // should be fixed better.
346 if (PN->getNumOperands() == 2 &&
347 PN->getParent() == BlockToInsertInto)
348 continue;
349 }
Chris Lattner053fb932006-06-17 01:02:31 +0000350 ExtraLoopUsers.push_back(User);
Chris Lattner9b6c02e2006-07-13 19:05:20 +0000351 }
Chris Lattner053fb932006-06-17 01:02:31 +0000352 }
353
Chris Lattnere61b67d2004-04-02 20:24:31 +0000354 if (!ExtraLoopUsers.empty()) {
355 // Okay, this instruction has a user outside of the current loop
356 // and varies predictably in this loop. Evaluate the value it
357 // contains when the loop exits, and insert code for it.
Chris Lattnera8140802004-04-17 18:44:09 +0000358 SCEVHandle ExitValue = SE->getSCEVAtScope(I, L->getParentLoop());
Chris Lattnere61b67d2004-04-02 20:24:31 +0000359 if (!isa<SCEVCouldNotCompute>(ExitValue)) {
360 Changed = true;
361 ++NumReplaced;
Chris Lattnerdf815392005-06-15 21:29:31 +0000362 // Remember the next instruction. The rewriter can move code
363 // around in some cases.
364 BasicBlock::iterator NextI = I; ++NextI;
365
Chris Lattner83cd87e2004-04-23 21:29:48 +0000366 Value *NewVal = Rewriter.expandCodeFor(ExitValue, InsertPt,
Chris Lattnere61b67d2004-04-02 20:24:31 +0000367 I->getType());
368
Chris Lattner08165592007-01-07 01:14:12 +0000369 DOUT << "INDVARS: RLEV: AfterLoopVal = " << *NewVal
370 << " LoopVal = " << *I << "\n";
371
Chris Lattnere61b67d2004-04-02 20:24:31 +0000372 // Rewrite any users of the computed value outside of the loop
373 // with the newly computed value.
Owen Andersonbea70ee2006-07-14 18:49:15 +0000374 for (unsigned i = 0, e = ExtraLoopUsers.size(); i != e; ++i) {
375 PHINode* PN = dyn_cast<PHINode>(ExtraLoopUsers[i]);
376 if (PN && PN->getNumOperands() == 2 &&
377 !L->contains(PN->getParent())) {
378 // We're dealing with an LCSSA Phi. Handle it specially.
379 Instruction* LCSSAInsertPt = BlockToInsertInto->begin();
380
381 Instruction* NewInstr = dyn_cast<Instruction>(NewVal);
382 if (NewInstr && !isa<PHINode>(NewInstr) &&
383 !L->contains(NewInstr->getParent()))
384 for (unsigned j = 0; j < NewInstr->getNumOperands(); ++j){
385 Instruction* PredI =
386 dyn_cast<Instruction>(NewInstr->getOperand(j));
387 if (PredI && L->contains(PredI->getParent())) {
388 PHINode* NewLCSSA = new PHINode(PredI->getType(),
389 PredI->getName() + ".lcssa",
390 LCSSAInsertPt);
391 NewLCSSA->addIncoming(PredI,
392 BlockToInsertInto->getSinglePredecessor());
393
394 NewInstr->replaceUsesOfWith(PredI, NewLCSSA);
395 }
396 }
397
398 PN->replaceAllUsesWith(NewVal);
399 PN->eraseFromParent();
400 } else {
401 ExtraLoopUsers[i]->replaceUsesOfWith(I, NewVal);
402 }
403 }
Chris Lattnere61b67d2004-04-02 20:24:31 +0000404
405 // If this instruction is dead now, schedule it to be removed.
406 if (I->use_empty())
407 InstructionsToDelete.insert(I);
Chris Lattnerdf815392005-06-15 21:29:31 +0000408 I = NextI;
409 continue; // Skip the ++I
Chris Lattnere61b67d2004-04-02 20:24:31 +0000410 }
411 }
412 }
413 }
Chris Lattnerdf815392005-06-15 21:29:31 +0000414
415 // Next instruction. Continue instruction skips this.
416 ++I;
417 }
Chris Lattnere61b67d2004-04-02 20:24:31 +0000418 }
419
420 DeleteTriviallyDeadInstructions(InstructionsToDelete);
421}
422
423
424void IndVarSimplify::runOnLoop(Loop *L) {
425 // First step. Check to see if there are any trivial GEP pointer recurrences.
426 // If there are, change them into integer recurrences, permitting analysis by
427 // the SCEV routines.
428 //
429 BasicBlock *Header = L->getHeader();
430 BasicBlock *Preheader = L->getLoopPreheader();
Misha Brukmanb1c93172005-04-21 23:48:37 +0000431
Chris Lattnere61b67d2004-04-02 20:24:31 +0000432 std::set<Instruction*> DeadInsts;
Reid Spencer66149462004-09-15 17:06:42 +0000433 for (BasicBlock::iterator I = Header->begin(); isa<PHINode>(I); ++I) {
434 PHINode *PN = cast<PHINode>(I);
Chris Lattnere61b67d2004-04-02 20:24:31 +0000435 if (isa<PointerType>(PN->getType()))
436 EliminatePointerRecurrence(PN, Preheader, DeadInsts);
Reid Spencer66149462004-09-15 17:06:42 +0000437 }
Chris Lattnere61b67d2004-04-02 20:24:31 +0000438
439 if (!DeadInsts.empty())
440 DeleteTriviallyDeadInstructions(DeadInsts);
441
442
443 // Next, transform all loops nesting inside of this loop.
444 for (LoopInfo::iterator I = L->begin(), E = L->end(); I != E; ++I)
Chris Lattner59d2d7f2004-01-08 00:09:44 +0000445 runOnLoop(*I);
Chris Lattnerd3678bc2003-12-22 03:58:44 +0000446
Chris Lattnere61b67d2004-04-02 20:24:31 +0000447 // Check to see if this loop has a computable loop-invariant execution count.
448 // If so, this means that we can compute the final value of any expressions
449 // that are recurrent in the loop, and substitute the exit values from the
450 // loop into any instructions outside of the loop that use the final values of
451 // the current expressions.
Chris Lattner0b18c1d2002-05-10 15:38:35 +0000452 //
Chris Lattnere61b67d2004-04-02 20:24:31 +0000453 SCEVHandle IterationCount = SE->getIterationCount(L);
454 if (!isa<SCEVCouldNotCompute>(IterationCount))
455 RewriteLoopExitValues(L);
Chris Lattner476e6df2001-12-03 17:28:42 +0000456
Chris Lattnere61b67d2004-04-02 20:24:31 +0000457 // Next, analyze all of the induction variables in the loop, canonicalizing
458 // auxillary induction variables.
459 std::vector<std::pair<PHINode*, SCEVHandle> > IndVars;
460
Reid Spencer66149462004-09-15 17:06:42 +0000461 for (BasicBlock::iterator I = Header->begin(); isa<PHINode>(I); ++I) {
462 PHINode *PN = cast<PHINode>(I);
Chris Lattnere61b67d2004-04-02 20:24:31 +0000463 if (PN->getType()->isInteger()) { // FIXME: when we have fast-math, enable!
464 SCEVHandle SCEV = SE->getSCEV(PN);
465 if (SCEV->hasComputableLoopEvolution(L))
Chris Lattner677d8572005-08-10 01:12:06 +0000466 // FIXME: It is an extremely bad idea to indvar substitute anything more
467 // complex than affine induction variables. Doing so will put expensive
468 // polynomial evaluations inside of the loop, and the str reduction pass
469 // currently can only reduce affine polynomials. For now just disable
470 // indvar subst on anything more complex than an affine addrec.
Chris Lattnere5ad26d2004-07-26 02:47:12 +0000471 if (SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(SCEV))
Chris Lattner677d8572005-08-10 01:12:06 +0000472 if (AR->isAffine())
Chris Lattnere5ad26d2004-07-26 02:47:12 +0000473 IndVars.push_back(std::make_pair(PN, SCEV));
Chris Lattnere61b67d2004-04-02 20:24:31 +0000474 }
Reid Spencer66149462004-09-15 17:06:42 +0000475 }
Chris Lattnere61b67d2004-04-02 20:24:31 +0000476
477 // If there are no induction variables in the loop, there is nothing more to
478 // do.
Chris Lattner885a6eb2004-04-17 18:08:33 +0000479 if (IndVars.empty()) {
480 // Actually, if we know how many times the loop iterates, lets insert a
481 // canonical induction variable to help subsequent passes.
482 if (!isa<SCEVCouldNotCompute>(IterationCount)) {
Chris Lattner83cd87e2004-04-23 21:29:48 +0000483 SCEVExpander Rewriter(*SE, *LI);
484 Rewriter.getOrInsertCanonicalInductionVariable(L,
Chris Lattner885a6eb2004-04-17 18:08:33 +0000485 IterationCount->getType());
Chris Lattner51c95cd2006-09-21 05:12:20 +0000486 if (Instruction *I = LinearFunctionTestReplace(L, IterationCount,
487 Rewriter)) {
488 std::set<Instruction*> InstructionsToDelete;
489 InstructionsToDelete.insert(I);
490 DeleteTriviallyDeadInstructions(InstructionsToDelete);
491 }
Chris Lattner885a6eb2004-04-17 18:08:33 +0000492 }
493 return;
494 }
Chris Lattnere61b67d2004-04-02 20:24:31 +0000495
496 // Compute the type of the largest recurrence expression.
Chris Lattner476e6df2001-12-03 17:28:42 +0000497 //
Chris Lattnere61b67d2004-04-02 20:24:31 +0000498 const Type *LargestType = IndVars[0].first->getType();
Chris Lattnerc1a682d2004-04-22 14:59:40 +0000499 bool DifferingSizes = false;
Chris Lattnere61b67d2004-04-02 20:24:31 +0000500 for (unsigned i = 1, e = IndVars.size(); i != e; ++i) {
501 const Type *Ty = IndVars[i].first->getType();
Reid Spencer8f166b02007-01-08 16:32:00 +0000502 DifferingSizes |=
503 Ty->getPrimitiveSizeInBits() != LargestType->getPrimitiveSizeInBits();
504 if (Ty->getPrimitiveSizeInBits() > LargestType->getPrimitiveSizeInBits())
Chris Lattnere61b67d2004-04-02 20:24:31 +0000505 LargestType = Ty;
Chris Lattner476e6df2001-12-03 17:28:42 +0000506 }
507
Chris Lattnere61b67d2004-04-02 20:24:31 +0000508 // Create a rewriter object which we'll use to transform the code with.
Chris Lattner83cd87e2004-04-23 21:29:48 +0000509 SCEVExpander Rewriter(*SE, *LI);
Chris Lattner7e755e42003-12-23 07:47:09 +0000510
Chris Lattnere61b67d2004-04-02 20:24:31 +0000511 // Now that we know the largest of of the induction variables in this loop,
512 // insert a canonical induction variable of the largest size.
Chris Lattner83cd87e2004-04-23 21:29:48 +0000513 Value *IndVar = Rewriter.getOrInsertCanonicalInductionVariable(L,LargestType);
Chris Lattnere61b67d2004-04-02 20:24:31 +0000514 ++NumInserted;
515 Changed = true;
Chris Lattner08165592007-01-07 01:14:12 +0000516 DOUT << "INDVARS: New CanIV: " << *IndVar;
Chris Lattner7e755e42003-12-23 07:47:09 +0000517
Chris Lattnere61b67d2004-04-02 20:24:31 +0000518 if (!isa<SCEVCouldNotCompute>(IterationCount))
Chris Lattner51c95cd2006-09-21 05:12:20 +0000519 if (Instruction *DI = LinearFunctionTestReplace(L, IterationCount,Rewriter))
520 DeadInsts.insert(DI);
Chris Lattner7e755e42003-12-23 07:47:09 +0000521
Chris Lattnere61b67d2004-04-02 20:24:31 +0000522 // Now that we have a canonical induction variable, we can rewrite any
523 // recurrences in terms of the induction variable. Start with the auxillary
524 // induction variables, and recursively rewrite any of their uses.
525 BasicBlock::iterator InsertPt = Header->begin();
526 while (isa<PHINode>(InsertPt)) ++InsertPt;
Chris Lattner476e6df2001-12-03 17:28:42 +0000527
Chris Lattnerdc7cc352004-04-21 22:22:01 +0000528 // If there were induction variables of other sizes, cast the primary
529 // induction variable to the right size for them, avoiding the need for the
530 // code evaluation methods to insert induction variables of different sizes.
Chris Lattnerc1a682d2004-04-22 14:59:40 +0000531 if (DifferingSizes) {
Reid Spencer7a9c62b2007-01-12 07:05:14 +0000532 SmallVector<unsigned,4> InsertedSizes;
533 InsertedSizes.push_back(LargestType->getPrimitiveSizeInBits());
534 for (unsigned i = 0, e = IndVars.size(); i != e; ++i) {
535 unsigned ithSize = IndVars[i].first->getType()->getPrimitiveSizeInBits();
536 bool alreadyInsertedSize = false;
537 for (SmallVector<unsigned,4>::iterator I = InsertedSizes.begin(),
538 E = InsertedSizes.end(); I != E; ++I)
539 if (*I == ithSize) {
540 alreadyInsertedSize = true;
541 break;
542 }
543 if (!alreadyInsertedSize) {
Chris Lattnerc1a682d2004-04-22 14:59:40 +0000544 PHINode *PN = IndVars[i].first;
Reid Spencer7a9c62b2007-01-12 07:05:14 +0000545 InsertedSizes.push_back(ithSize);
Chris Lattner08165592007-01-07 01:14:12 +0000546 Instruction *New = new TruncInst(IndVar, PN->getType(), "indvar",
547 InsertPt);
Chris Lattnerc1a682d2004-04-22 14:59:40 +0000548 Rewriter.addInsertedValue(New, SE->getSCEV(New));
Chris Lattner08165592007-01-07 01:14:12 +0000549 DOUT << "INDVARS: Made trunc IV for " << *PN
550 << " NewVal = " << *New << "\n";
Chris Lattnerc1a682d2004-04-22 14:59:40 +0000551 }
Reid Spencer7a9c62b2007-01-12 07:05:14 +0000552 }
Chris Lattnerc1a682d2004-04-22 14:59:40 +0000553 }
554
Chris Lattner08165592007-01-07 01:14:12 +0000555 // Rewrite all induction variables in terms of the canonical induction
556 // variable.
Chris Lattnerdc7cc352004-04-21 22:22:01 +0000557 std::map<unsigned, Value*> InsertedSizes;
Chris Lattnere61b67d2004-04-02 20:24:31 +0000558 while (!IndVars.empty()) {
559 PHINode *PN = IndVars.back().first;
Chris Lattner83cd87e2004-04-23 21:29:48 +0000560 Value *NewVal = Rewriter.expandCodeFor(IndVars.back().second, InsertPt,
Chris Lattnerc1a682d2004-04-22 14:59:40 +0000561 PN->getType());
Chris Lattner08165592007-01-07 01:14:12 +0000562 DOUT << "INDVARS: Rewrote IV '" << *IndVars.back().second << "' " << *PN
563 << " into = " << *NewVal << "\n";
Chris Lattnerc1a682d2004-04-22 14:59:40 +0000564 std::string Name = PN->getName();
565 PN->setName("");
566 NewVal->setName(Name);
Chris Lattnerdc7cc352004-04-21 22:22:01 +0000567
Chris Lattnere61b67d2004-04-02 20:24:31 +0000568 // Replace the old PHI Node with the inserted computation.
Chris Lattnerc1a682d2004-04-22 14:59:40 +0000569 PN->replaceAllUsesWith(NewVal);
Chris Lattnere61b67d2004-04-02 20:24:31 +0000570 DeadInsts.insert(PN);
571 IndVars.pop_back();
572 ++NumRemoved;
Chris Lattner67439402001-12-05 19:41:33 +0000573 Changed = true;
Chris Lattner91daaab2001-12-04 04:32:29 +0000574 }
575
Chris Lattnerc27302c2004-04-22 15:12:36 +0000576#if 0
Chris Lattneraf532f22004-04-21 23:36:08 +0000577 // Now replace all derived expressions in the loop body with simpler
578 // expressions.
Chris Lattnere61b67d2004-04-02 20:24:31 +0000579 for (unsigned i = 0, e = L->getBlocks().size(); i != e; ++i)
580 if (LI->getLoopFor(L->getBlocks()[i]) == L) { // Not in a subloop...
581 BasicBlock *BB = L->getBlocks()[i];
582 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
583 if (I->getType()->isInteger() && // Is an integer instruction
Chris Lattneraf532f22004-04-21 23:36:08 +0000584 !I->use_empty() &&
Chris Lattnere61b67d2004-04-02 20:24:31 +0000585 !Rewriter.isInsertedInstruction(I)) {
586 SCEVHandle SH = SE->getSCEV(I);
Chris Lattner83cd87e2004-04-23 21:29:48 +0000587 Value *V = Rewriter.expandCodeFor(SH, I, I->getType());
Chris Lattneraf532f22004-04-21 23:36:08 +0000588 if (V != I) {
589 if (isa<Instruction>(V)) {
590 std::string Name = I->getName();
591 I->setName("");
592 V->setName(Name);
593 }
594 I->replaceAllUsesWith(V);
595 DeadInsts.insert(I);
596 ++NumRemoved;
597 Changed = true;
Misha Brukmanb1c93172005-04-21 23:48:37 +0000598 }
Chris Lattnere61b67d2004-04-02 20:24:31 +0000599 }
Chris Lattner91daaab2001-12-04 04:32:29 +0000600 }
Chris Lattnerc27302c2004-04-22 15:12:36 +0000601#endif
Chris Lattneraf532f22004-04-21 23:36:08 +0000602
Chris Lattneraf532f22004-04-21 23:36:08 +0000603 DeleteTriviallyDeadInstructions(DeadInsts);
Owen Anderson8e4b0292006-08-25 22:12:36 +0000604
605 if (mustPreserveAnalysisID(LCSSAID)) assert(L->isLCSSAForm());
Chris Lattner476e6df2001-12-03 17:28:42 +0000606}