Back out Owen's 6/9 changes. They broke MultiSource/Benchmarks/Prolangs-C/bison ...
[oota-llvm.git] / lib / Analysis / LoopInfo.cpp
1 //===- LoopInfo.cpp - Natural Loop Calculator -----------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines the LoopInfo class that is used to identify natural loops
11 // and determine the loop depth of various nodes of the CFG.  Note that the
12 // loops identified may actually be several natural loops that share the same
13 // header node... not just a single natural loop.
14 //
15 //===----------------------------------------------------------------------===//
16
17 #include "llvm/Analysis/LoopInfo.h"
18 #include "llvm/Constants.h"
19 #include "llvm/Instructions.h"
20 #include "llvm/Analysis/Dominators.h"
21 #include "llvm/Assembly/Writer.h"
22 #include "llvm/Support/CFG.h"
23 #include "llvm/ADT/DepthFirstIterator.h"
24 #include <algorithm>
25 #include <iostream>
26 using namespace llvm;
27
28 static RegisterAnalysis<LoopInfo>
29 X("loops", "Natural Loop Construction", true);
30
31 //===----------------------------------------------------------------------===//
32 // Loop implementation
33 //
34 bool Loop::contains(const BasicBlock *BB) const {
35   return std::find(Blocks.begin(), Blocks.end(), BB) != Blocks.end();
36 }
37
38 bool Loop::isLoopExit(const BasicBlock *BB) const {
39   for (succ_const_iterator SI = succ_begin(BB), SE = succ_end(BB);
40        SI != SE; ++SI) {
41     if (!contains(*SI))
42       return true;
43   }
44   return false;
45 }
46
47 /// getNumBackEdges - Calculate the number of back edges to the loop header.
48 ///
49 unsigned Loop::getNumBackEdges() const {
50   unsigned NumBackEdges = 0;
51   BasicBlock *H = getHeader();
52
53   for (pred_iterator I = pred_begin(H), E = pred_end(H); I != E; ++I)
54     if (contains(*I))
55       ++NumBackEdges;
56
57   return NumBackEdges;
58 }
59
60 /// isLoopInvariant - Return true if the specified value is loop invariant
61 ///
62 bool Loop::isLoopInvariant(Value *V) const {
63   if (Instruction *I = dyn_cast<Instruction>(V))
64     return !contains(I->getParent());
65   return true;  // All non-instructions are loop invariant
66 }
67
68 void Loop::print(std::ostream &OS, unsigned Depth) const {
69   OS << std::string(Depth*2, ' ') << "Loop Containing: ";
70
71   for (unsigned i = 0; i < getBlocks().size(); ++i) {
72     if (i) OS << ",";
73     WriteAsOperand(OS, getBlocks()[i], false);
74   }
75   OS << "\n";
76
77   for (iterator I = begin(), E = end(); I != E; ++I)
78     (*I)->print(OS, Depth+2);
79 }
80
81 void Loop::dump() const {
82   print(std::cerr);
83 }
84
85
86 //===----------------------------------------------------------------------===//
87 // LoopInfo implementation
88 //
89 bool LoopInfo::runOnFunction(Function &) {
90   releaseMemory();
91   Calculate(getAnalysis<ETForest>());    // Update
92   return false;
93 }
94
95 void LoopInfo::releaseMemory() {
96   for (std::vector<Loop*>::iterator I = TopLevelLoops.begin(),
97          E = TopLevelLoops.end(); I != E; ++I)
98     delete *I;   // Delete all of the loops...
99
100   BBMap.clear();                             // Reset internal state of analysis
101   TopLevelLoops.clear();
102 }
103
104
105 void LoopInfo::Calculate(ETForest &EF) {
106   BasicBlock *RootNode = EF.getRoot();
107
108   for (df_iterator<BasicBlock*> NI = df_begin(RootNode),
109          NE = df_end(RootNode); NI != NE; ++NI)
110     if (Loop *L = ConsiderForLoop(*NI, EF))
111       TopLevelLoops.push_back(L);
112 }
113
114 void LoopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
115   AU.setPreservesAll();
116   AU.addRequired<ETForest>();
117 }
118
119 void LoopInfo::print(std::ostream &OS, const Module* ) const {
120   for (unsigned i = 0; i < TopLevelLoops.size(); ++i)
121     TopLevelLoops[i]->print(OS);
122 #if 0
123   for (std::map<BasicBlock*, Loop*>::const_iterator I = BBMap.begin(),
124          E = BBMap.end(); I != E; ++I)
125     OS << "BB '" << I->first->getName() << "' level = "
126        << I->second->getLoopDepth() << "\n";
127 #endif
128 }
129
130 static bool isNotAlreadyContainedIn(Loop *SubLoop, Loop *ParentLoop) {
131   if (SubLoop == 0) return true;
132   if (SubLoop == ParentLoop) return false;
133   return isNotAlreadyContainedIn(SubLoop->getParentLoop(), ParentLoop);
134 }
135
136 Loop *LoopInfo::ConsiderForLoop(BasicBlock *BB, ETForest &EF) {
137   if (BBMap.find(BB) != BBMap.end()) return 0;   // Haven't processed this node?
138
139   std::vector<BasicBlock *> TodoStack;
140
141   // Scan the predecessors of BB, checking to see if BB dominates any of
142   // them.  This identifies backedges which target this node...
143   for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I)
144     if (EF.dominates(BB, *I))   // If BB dominates it's predecessor...
145       TodoStack.push_back(*I);
146
147   if (TodoStack.empty()) return 0;  // No backedges to this block...
148
149   // Create a new loop to represent this basic block...
150   Loop *L = new Loop(BB);
151   BBMap[BB] = L;
152
153   BasicBlock *EntryBlock = &BB->getParent()->getEntryBlock();
154
155   while (!TodoStack.empty()) {  // Process all the nodes in the loop
156     BasicBlock *X = TodoStack.back();
157     TodoStack.pop_back();
158
159     if (!L->contains(X) &&         // As of yet unprocessed??
160         EF.dominates(EntryBlock, X)) {   // X is reachable from entry block?
161       // Check to see if this block already belongs to a loop.  If this occurs
162       // then we have a case where a loop that is supposed to be a child of the
163       // current loop was processed before the current loop.  When this occurs,
164       // this child loop gets added to a part of the current loop, making it a
165       // sibling to the current loop.  We have to reparent this loop.
166       if (Loop *SubLoop = const_cast<Loop*>(getLoopFor(X)))
167         if (SubLoop->getHeader() == X && isNotAlreadyContainedIn(SubLoop, L)) {
168           // Remove the subloop from it's current parent...
169           assert(SubLoop->ParentLoop && SubLoop->ParentLoop != L);
170           Loop *SLP = SubLoop->ParentLoop;  // SubLoopParent
171           std::vector<Loop*>::iterator I =
172             std::find(SLP->SubLoops.begin(), SLP->SubLoops.end(), SubLoop);
173           assert(I != SLP->SubLoops.end() && "SubLoop not a child of parent?");
174           SLP->SubLoops.erase(I);   // Remove from parent...
175
176           // Add the subloop to THIS loop...
177           SubLoop->ParentLoop = L;
178           L->SubLoops.push_back(SubLoop);
179         }
180
181       // Normal case, add the block to our loop...
182       L->Blocks.push_back(X);
183
184       // Add all of the predecessors of X to the end of the work stack...
185       TodoStack.insert(TodoStack.end(), pred_begin(X), pred_end(X));
186     }
187   }
188
189   // If there are any loops nested within this loop, create them now!
190   for (std::vector<BasicBlock*>::iterator I = L->Blocks.begin(),
191          E = L->Blocks.end(); I != E; ++I)
192     if (Loop *NewLoop = ConsiderForLoop(*I, EF)) {
193       L->SubLoops.push_back(NewLoop);
194       NewLoop->ParentLoop = L;
195     }
196
197   // Add the basic blocks that comprise this loop to the BBMap so that this
198   // loop can be found for them.
199   //
200   for (std::vector<BasicBlock*>::iterator I = L->Blocks.begin(),
201          E = L->Blocks.end(); I != E; ++I) {
202     std::map<BasicBlock*, Loop*>::iterator BBMI = BBMap.lower_bound(*I);
203     if (BBMI == BBMap.end() || BBMI->first != *I)  // Not in map yet...
204       BBMap.insert(BBMI, std::make_pair(*I, L));   // Must be at this level
205   }
206
207   // Now that we have a list of all of the child loops of this loop, check to
208   // see if any of them should actually be nested inside of each other.  We can
209   // accidentally pull loops our of their parents, so we must make sure to
210   // organize the loop nests correctly now.
211   {
212     std::map<BasicBlock*, Loop*> ContainingLoops;
213     for (unsigned i = 0; i != L->SubLoops.size(); ++i) {
214       Loop *Child = L->SubLoops[i];
215       assert(Child->getParentLoop() == L && "Not proper child loop?");
216
217       if (Loop *ContainingLoop = ContainingLoops[Child->getHeader()]) {
218         // If there is already a loop which contains this loop, move this loop
219         // into the containing loop.
220         MoveSiblingLoopInto(Child, ContainingLoop);
221         --i;  // The loop got removed from the SubLoops list.
222       } else {
223         // This is currently considered to be a top-level loop.  Check to see if
224         // any of the contained blocks are loop headers for subloops we have
225         // already processed.
226         for (unsigned b = 0, e = Child->Blocks.size(); b != e; ++b) {
227           Loop *&BlockLoop = ContainingLoops[Child->Blocks[b]];
228           if (BlockLoop == 0) {   // Child block not processed yet...
229             BlockLoop = Child;
230           } else if (BlockLoop != Child) {
231             Loop *SubLoop = BlockLoop;
232             // Reparent all of the blocks which used to belong to BlockLoops
233             for (unsigned j = 0, e = SubLoop->Blocks.size(); j != e; ++j)
234               ContainingLoops[SubLoop->Blocks[j]] = Child;
235
236             // There is already a loop which contains this block, that means
237             // that we should reparent the loop which the block is currently
238             // considered to belong to to be a child of this loop.
239             MoveSiblingLoopInto(SubLoop, Child);
240             --i;  // We just shrunk the SubLoops list.
241           }
242         }
243       }
244     }
245   }
246
247   return L;
248 }
249
250 /// MoveSiblingLoopInto - This method moves the NewChild loop to live inside of
251 /// the NewParent Loop, instead of being a sibling of it.
252 void LoopInfo::MoveSiblingLoopInto(Loop *NewChild, Loop *NewParent) {
253   Loop *OldParent = NewChild->getParentLoop();
254   assert(OldParent && OldParent == NewParent->getParentLoop() &&
255          NewChild != NewParent && "Not sibling loops!");
256
257   // Remove NewChild from being a child of OldParent
258   std::vector<Loop*>::iterator I =
259     std::find(OldParent->SubLoops.begin(), OldParent->SubLoops.end(), NewChild);
260   assert(I != OldParent->SubLoops.end() && "Parent fields incorrect??");
261   OldParent->SubLoops.erase(I);   // Remove from parent's subloops list
262   NewChild->ParentLoop = 0;
263
264   InsertLoopInto(NewChild, NewParent);
265 }
266
267 /// InsertLoopInto - This inserts loop L into the specified parent loop.  If the
268 /// parent loop contains a loop which should contain L, the loop gets inserted
269 /// into L instead.
270 void LoopInfo::InsertLoopInto(Loop *L, Loop *Parent) {
271   BasicBlock *LHeader = L->getHeader();
272   assert(Parent->contains(LHeader) && "This loop should not be inserted here!");
273
274   // Check to see if it belongs in a child loop...
275   for (unsigned i = 0, e = Parent->SubLoops.size(); i != e; ++i)
276     if (Parent->SubLoops[i]->contains(LHeader)) {
277       InsertLoopInto(L, Parent->SubLoops[i]);
278       return;
279     }
280
281   // If not, insert it here!
282   Parent->SubLoops.push_back(L);
283   L->ParentLoop = Parent;
284 }
285
286 /// changeLoopFor - Change the top-level loop that contains BB to the
287 /// specified loop.  This should be used by transformations that restructure
288 /// the loop hierarchy tree.
289 void LoopInfo::changeLoopFor(BasicBlock *BB, Loop *L) {
290   Loop *&OldLoop = BBMap[BB];
291   assert(OldLoop && "Block not in a loop yet!");
292   OldLoop = L;
293 }
294
295 /// changeTopLevelLoop - Replace the specified loop in the top-level loops
296 /// list with the indicated loop.
297 void LoopInfo::changeTopLevelLoop(Loop *OldLoop, Loop *NewLoop) {
298   std::vector<Loop*>::iterator I = std::find(TopLevelLoops.begin(),
299                                              TopLevelLoops.end(), OldLoop);
300   assert(I != TopLevelLoops.end() && "Old loop not at top level!");
301   *I = NewLoop;
302   assert(NewLoop->ParentLoop == 0 && OldLoop->ParentLoop == 0 &&
303          "Loops already embedded into a subloop!");
304 }
305
306 /// removeLoop - This removes the specified top-level loop from this loop info
307 /// object.  The loop is not deleted, as it will presumably be inserted into
308 /// another loop.
309 Loop *LoopInfo::removeLoop(iterator I) {
310   assert(I != end() && "Cannot remove end iterator!");
311   Loop *L = *I;
312   assert(L->getParentLoop() == 0 && "Not a top-level loop!");
313   TopLevelLoops.erase(TopLevelLoops.begin() + (I-begin()));
314   return L;
315 }
316
317 /// removeBlock - This method completely removes BB from all data structures,
318 /// including all of the Loop objects it is nested in and our mapping from
319 /// BasicBlocks to loops.
320 void LoopInfo::removeBlock(BasicBlock *BB) {
321   std::map<BasicBlock *, Loop*>::iterator I = BBMap.find(BB);
322   if (I != BBMap.end()) {
323     for (Loop *L = I->second; L; L = L->getParentLoop())
324       L->removeBlockFromLoop(BB);
325
326     BBMap.erase(I);
327   }
328 }
329
330
331 //===----------------------------------------------------------------------===//
332 // APIs for simple analysis of the loop.
333 //
334
335 /// getExitBlocks - Return all of the successor blocks of this loop.  These
336 /// are the blocks _outside of the current loop_ which are branched to.
337 ///
338 void Loop::getExitBlocks(std::vector<BasicBlock*> &ExitBlocks) const {
339   for (std::vector<BasicBlock*>::const_iterator BI = Blocks.begin(),
340          BE = Blocks.end(); BI != BE; ++BI)
341     for (succ_iterator I = succ_begin(*BI), E = succ_end(*BI); I != E; ++I)
342       if (!contains(*I))               // Not in current loop?
343         ExitBlocks.push_back(*I);          // It must be an exit block...
344 }
345
346
347 /// getLoopPreheader - If there is a preheader for this loop, return it.  A
348 /// loop has a preheader if there is only one edge to the header of the loop
349 /// from outside of the loop.  If this is the case, the block branching to the
350 /// header of the loop is the preheader node.
351 ///
352 /// This method returns null if there is no preheader for the loop.
353 ///
354 BasicBlock *Loop::getLoopPreheader() const {
355   // Keep track of nodes outside the loop branching to the header...
356   BasicBlock *Out = 0;
357
358   // Loop over the predecessors of the header node...
359   BasicBlock *Header = getHeader();
360   for (pred_iterator PI = pred_begin(Header), PE = pred_end(Header);
361        PI != PE; ++PI)
362     if (!contains(*PI)) {     // If the block is not in the loop...
363       if (Out && Out != *PI)
364         return 0;             // Multiple predecessors outside the loop
365       Out = *PI;
366     }
367
368   // Make sure there is only one exit out of the preheader.
369   assert(Out && "Header of loop has no predecessors from outside loop?");
370   succ_iterator SI = succ_begin(Out);
371   ++SI;
372   if (SI != succ_end(Out))
373     return 0;  // Multiple exits from the block, must not be a preheader.
374
375   // If there is exactly one preheader, return it.  If there was zero, then Out
376   // is still null.
377   return Out;
378 }
379
380 /// getLoopLatch - If there is a latch block for this loop, return it.  A
381 /// latch block is the canonical backedge for a loop.  A loop header in normal
382 /// form has two edges into it: one from a preheader and one from a latch
383 /// block.
384 BasicBlock *Loop::getLoopLatch() const {
385   BasicBlock *Header = getHeader();
386   pred_iterator PI = pred_begin(Header), PE = pred_end(Header);
387   if (PI == PE) return 0;  // no preds?
388   
389   BasicBlock *Latch = 0;
390   if (contains(*PI))
391     Latch = *PI;
392   ++PI;
393   if (PI == PE) return 0;  // only one pred?
394   
395   if (contains(*PI)) {
396     if (Latch) return 0;  // multiple backedges
397     Latch = *PI;
398   }
399   ++PI;
400   if (PI != PE) return 0;  // more than two preds
401   
402   return Latch;  
403 }
404
405 /// getCanonicalInductionVariable - Check to see if the loop has a canonical
406 /// induction variable: an integer recurrence that starts at 0 and increments by
407 /// one each time through the loop.  If so, return the phi node that corresponds
408 /// to it.
409 ///
410 PHINode *Loop::getCanonicalInductionVariable() const {
411   BasicBlock *H = getHeader();
412
413   BasicBlock *Incoming = 0, *Backedge = 0;
414   pred_iterator PI = pred_begin(H);
415   assert(PI != pred_end(H) && "Loop must have at least one backedge!");
416   Backedge = *PI++;
417   if (PI == pred_end(H)) return 0;  // dead loop
418   Incoming = *PI++;
419   if (PI != pred_end(H)) return 0;  // multiple backedges?
420
421   if (contains(Incoming)) {
422     if (contains(Backedge))
423       return 0;
424     std::swap(Incoming, Backedge);
425   } else if (!contains(Backedge))
426     return 0;
427
428   // Loop over all of the PHI nodes, looking for a canonical indvar.
429   for (BasicBlock::iterator I = H->begin(); isa<PHINode>(I); ++I) {
430     PHINode *PN = cast<PHINode>(I);
431     if (Instruction *Inc =
432         dyn_cast<Instruction>(PN->getIncomingValueForBlock(Backedge)))
433       if (Inc->getOpcode() == Instruction::Add && Inc->getOperand(0) == PN)
434         if (ConstantInt *CI = dyn_cast<ConstantInt>(Inc->getOperand(1)))
435           if (CI->equalsInt(1))
436             return PN;
437   }
438   return 0;
439 }
440
441 /// getCanonicalInductionVariableIncrement - Return the LLVM value that holds
442 /// the canonical induction variable value for the "next" iteration of the loop.
443 /// This always succeeds if getCanonicalInductionVariable succeeds.
444 ///
445 Instruction *Loop::getCanonicalInductionVariableIncrement() const {
446   if (PHINode *PN = getCanonicalInductionVariable()) {
447     bool P1InLoop = contains(PN->getIncomingBlock(1));
448     return cast<Instruction>(PN->getIncomingValue(P1InLoop));
449   }
450   return 0;
451 }
452
453 /// getTripCount - Return a loop-invariant LLVM value indicating the number of
454 /// times the loop will be executed.  Note that this means that the backedge of
455 /// the loop executes N-1 times.  If the trip-count cannot be determined, this
456 /// returns null.
457 ///
458 Value *Loop::getTripCount() const {
459   // Canonical loops will end with a 'setne I, V', where I is the incremented
460   // canonical induction variable and V is the trip count of the loop.
461   Instruction *Inc = getCanonicalInductionVariableIncrement();
462   if (Inc == 0) return 0;
463   PHINode *IV = cast<PHINode>(Inc->getOperand(0));
464
465   BasicBlock *BackedgeBlock =
466     IV->getIncomingBlock(contains(IV->getIncomingBlock(1)));
467
468   if (BranchInst *BI = dyn_cast<BranchInst>(BackedgeBlock->getTerminator()))
469     if (BI->isConditional())
470       if (SetCondInst *SCI = dyn_cast<SetCondInst>(BI->getCondition()))
471         if (SCI->getOperand(0) == Inc)
472           if (BI->getSuccessor(0) == getHeader()) {
473             if (SCI->getOpcode() == Instruction::SetNE)
474               return SCI->getOperand(1);
475           } else if (SCI->getOpcode() == Instruction::SetEQ) {
476             return SCI->getOperand(1);
477           }
478
479   return 0;
480 }
481
482
483 //===-------------------------------------------------------------------===//
484 // APIs for updating loop information after changing the CFG
485 //
486
487 /// addBasicBlockToLoop - This function is used by other analyses to update loop
488 /// information.  NewBB is set to be a new member of the current loop.  Because
489 /// of this, it is added as a member of all parent loops, and is added to the
490 /// specified LoopInfo object as being in the current basic block.  It is not
491 /// valid to replace the loop header with this method.
492 ///
493 void Loop::addBasicBlockToLoop(BasicBlock *NewBB, LoopInfo &LI) {
494   assert((Blocks.empty() || LI[getHeader()] == this) &&
495          "Incorrect LI specified for this loop!");
496   assert(NewBB && "Cannot add a null basic block to the loop!");
497   assert(LI[NewBB] == 0 && "BasicBlock already in the loop!");
498
499   // Add the loop mapping to the LoopInfo object...
500   LI.BBMap[NewBB] = this;
501
502   // Add the basic block to this loop and all parent loops...
503   Loop *L = this;
504   while (L) {
505     L->Blocks.push_back(NewBB);
506     L = L->getParentLoop();
507   }
508 }
509
510 /// replaceChildLoopWith - This is used when splitting loops up.  It replaces
511 /// the OldChild entry in our children list with NewChild, and updates the
512 /// parent pointers of the two loops as appropriate.
513 void Loop::replaceChildLoopWith(Loop *OldChild, Loop *NewChild) {
514   assert(OldChild->ParentLoop == this && "This loop is already broken!");
515   assert(NewChild->ParentLoop == 0 && "NewChild already has a parent!");
516   std::vector<Loop*>::iterator I = std::find(SubLoops.begin(), SubLoops.end(),
517                                              OldChild);
518   assert(I != SubLoops.end() && "OldChild not in loop!");
519   *I = NewChild;
520   OldChild->ParentLoop = 0;
521   NewChild->ParentLoop = this;
522 }
523
524 /// addChildLoop - Add the specified loop to be a child of this loop.
525 ///
526 void Loop::addChildLoop(Loop *NewChild) {
527   assert(NewChild->ParentLoop == 0 && "NewChild already has a parent!");
528   NewChild->ParentLoop = this;
529   SubLoops.push_back(NewChild);
530 }
531
532 template<typename T>
533 static void RemoveFromVector(std::vector<T*> &V, T *N) {
534   typename std::vector<T*>::iterator I = std::find(V.begin(), V.end(), N);
535   assert(I != V.end() && "N is not in this list!");
536   V.erase(I);
537 }
538
539 /// removeChildLoop - This removes the specified child from being a subloop of
540 /// this loop.  The loop is not deleted, as it will presumably be inserted
541 /// into another loop.
542 Loop *Loop::removeChildLoop(iterator I) {
543   assert(I != SubLoops.end() && "Cannot remove end iterator!");
544   Loop *Child = *I;
545   assert(Child->ParentLoop == this && "Child is not a child of this loop!");
546   SubLoops.erase(SubLoops.begin()+(I-begin()));
547   Child->ParentLoop = 0;
548   return Child;
549 }
550
551
552 /// removeBlockFromLoop - This removes the specified basic block from the
553 /// current loop, updating the Blocks and ExitBlocks lists as appropriate.  This
554 /// does not update the mapping in the LoopInfo class.
555 void Loop::removeBlockFromLoop(BasicBlock *BB) {
556   RemoveFromVector(Blocks, BB);
557 }
558
559 // Ensure this file gets linked when LoopInfo.h is used.
560 DEFINING_FILE_FOR(LoopInfo)