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