1 //===- LoopInfo.cpp - Natural Loop Calculator -------------------------------=//
3 // This file defines the LoopInfo class that is used to identify natural loops
4 // and determine the loop depth of various nodes of the CFG. Note that the
5 // loops identified may actually be several natural loops that share the same
6 // header node... not just a single natural loop.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/Analysis/LoopInfo.h"
11 #include "llvm/Analysis/Dominators.h"
12 #include "llvm/Support/CFG.h"
13 #include "llvm/Assembly/Writer.h"
14 #include "Support/DepthFirstIterator.h"
17 static RegisterAnalysis<LoopInfo>
18 X("loops", "Natural Loop Construction", true);
20 //===----------------------------------------------------------------------===//
21 // Loop implementation
23 bool Loop::contains(const BasicBlock *BB) const {
24 return find(Blocks.begin(), Blocks.end(), BB) != Blocks.end();
27 bool Loop::isLoopExit(const BasicBlock *BB) const {
28 for (succ_const_iterator SI = succ_begin(BB), SE = succ_end(BB);
36 unsigned Loop::getNumBackEdges() const {
37 unsigned NumBackEdges = 0;
38 BasicBlock *H = getHeader();
40 for (std::vector<BasicBlock*>::const_iterator I = Blocks.begin(),
41 E = Blocks.end(); I != E; ++I)
42 for (succ_iterator SI = succ_begin(*I), SE = succ_end(*I);
50 void Loop::print(std::ostream &OS, unsigned Depth) const {
51 OS << std::string(Depth*2, ' ') << "Loop Containing: ";
53 for (unsigned i = 0; i < getBlocks().size(); ++i) {
55 WriteAsOperand(OS, getBlocks()[i], false);
57 if (!ExitBlocks.empty()) {
58 OS << "\tExitBlocks: ";
59 for (unsigned i = 0; i < getExitBlocks().size(); ++i) {
61 WriteAsOperand(OS, getExitBlocks()[i], false);
67 for (unsigned i = 0, e = getSubLoops().size(); i != e; ++i)
68 getSubLoops()[i]->print(OS, Depth+2);
71 void Loop::dump() const {
76 //===----------------------------------------------------------------------===//
77 // LoopInfo implementation
79 void LoopInfo::stub() {}
81 bool LoopInfo::runOnFunction(Function &) {
83 Calculate(getAnalysis<DominatorSet>()); // Update
87 void LoopInfo::releaseMemory() {
88 for (std::vector<Loop*>::iterator I = TopLevelLoops.begin(),
89 E = TopLevelLoops.end(); I != E; ++I)
90 delete *I; // Delete all of the loops...
92 BBMap.clear(); // Reset internal state of analysis
93 TopLevelLoops.clear();
97 void LoopInfo::Calculate(const DominatorSet &DS) {
98 BasicBlock *RootNode = DS.getRoot();
100 for (df_iterator<BasicBlock*> NI = df_begin(RootNode),
101 NE = df_end(RootNode); NI != NE; ++NI)
102 if (Loop *L = ConsiderForLoop(*NI, DS))
103 TopLevelLoops.push_back(L);
105 for (unsigned i = 0; i < TopLevelLoops.size(); ++i)
106 TopLevelLoops[i]->setLoopDepth(1);
109 void LoopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
110 AU.setPreservesAll();
111 AU.addRequired<DominatorSet>();
114 void LoopInfo::print(std::ostream &OS) const {
115 for (unsigned i = 0; i < TopLevelLoops.size(); ++i)
116 TopLevelLoops[i]->print(OS);
118 for (std::map<BasicBlock*, Loop*>::const_iterator I = BBMap.begin(),
119 E = BBMap.end(); I != E; ++I)
120 OS << "BB '" << I->first->getName() << "' level = "
121 << I->second->LoopDepth << "\n";
125 static bool isNotAlreadyContainedIn(Loop *SubLoop, Loop *ParentLoop) {
126 if (SubLoop == 0) return true;
127 if (SubLoop == ParentLoop) return false;
128 return isNotAlreadyContainedIn(SubLoop->getParentLoop(), ParentLoop);
131 Loop *LoopInfo::ConsiderForLoop(BasicBlock *BB, const DominatorSet &DS) {
132 if (BBMap.find(BB) != BBMap.end()) return 0; // Haven't processed this node?
134 std::vector<BasicBlock *> TodoStack;
136 // Scan the predecessors of BB, checking to see if BB dominates any of
137 // them. This identifies backedges which target this node...
138 for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I)
139 if (DS.dominates(BB, *I)) // If BB dominates it's predecessor...
140 TodoStack.push_back(*I);
142 if (TodoStack.empty()) return 0; // No backedges to this block...
144 // Create a new loop to represent this basic block...
145 Loop *L = new Loop(BB);
148 while (!TodoStack.empty()) { // Process all the nodes in the loop
149 BasicBlock *X = TodoStack.back();
150 TodoStack.pop_back();
152 if (!L->contains(X)) { // As of yet unprocessed??
153 // Check to see if this block already belongs to a loop. If this occurs
154 // then we have a case where a loop that is supposed to be a child of the
155 // current loop was processed before the current loop. When this occurs,
156 // this child loop gets added to a part of the current loop, making it a
157 // sibling to the current loop. We have to reparent this loop.
158 if (Loop *SubLoop = const_cast<Loop*>(getLoopFor(X)))
159 if (SubLoop->getHeader() == X && isNotAlreadyContainedIn(SubLoop, L)) {
160 // Remove the subloop from it's current parent...
161 assert(SubLoop->ParentLoop && SubLoop->ParentLoop != L);
162 Loop *SLP = SubLoop->ParentLoop; // SubLoopParent
163 std::vector<Loop*>::iterator I =
164 std::find(SLP->SubLoops.begin(), SLP->SubLoops.end(), SubLoop);
165 assert(I != SLP->SubLoops.end() && "SubLoop not a child of parent?");
166 SLP->SubLoops.erase(I); // Remove from parent...
168 // Add the subloop to THIS loop...
169 SubLoop->ParentLoop = L;
170 L->SubLoops.push_back(SubLoop);
173 // Normal case, add the block to our loop...
174 L->Blocks.push_back(X);
176 // Add all of the predecessors of X to the end of the work stack...
177 TodoStack.insert(TodoStack.end(), pred_begin(X), pred_end(X));
181 // If there are any loops nested within this loop, create them now!
182 for (std::vector<BasicBlock*>::iterator I = L->Blocks.begin(),
183 E = L->Blocks.end(); I != E; ++I)
184 if (Loop *NewLoop = ConsiderForLoop(*I, DS)) {
185 L->SubLoops.push_back(NewLoop);
186 NewLoop->ParentLoop = L;
189 // Add the basic blocks that comprise this loop to the BBMap so that this
190 // loop can be found for them.
192 for (std::vector<BasicBlock*>::iterator I = L->Blocks.begin(),
193 E = L->Blocks.end(); I != E; ++I) {
194 std::map<BasicBlock*, Loop*>::iterator BBMI = BBMap.lower_bound(*I);
195 if (BBMI == BBMap.end() || BBMI->first != *I) // Not in map yet...
196 BBMap.insert(BBMI, std::make_pair(*I, L)); // Must be at this level
199 // Now that we have a list of all of the child loops of this loop, check to
200 // see if any of them should actually be nested inside of each other. We can
201 // accidentally pull loops our of their parents, so we must make sure to
202 // organize the loop nests correctly now.
204 std::map<BasicBlock*, Loop*> ContainingLoops;
205 for (unsigned i = 0; i != L->SubLoops.size(); ++i) {
206 Loop *Child = L->SubLoops[i];
207 assert(Child->getParentLoop() == L && "Not proper child loop?");
209 if (Loop *ContainingLoop = ContainingLoops[Child->getHeader()]) {
210 // If there is already a loop which contains this loop, move this loop
211 // into the containing loop.
212 MoveSiblingLoopInto(Child, ContainingLoop);
213 --i; // The loop got removed from the SubLoops list.
215 // This is currently considered to be a top-level loop. Check to see if
216 // any of the contained blocks are loop headers for subloops we have
217 // already processed.
218 for (unsigned b = 0, e = Child->Blocks.size(); b != e; ++b) {
219 Loop *&BlockLoop = ContainingLoops[Child->Blocks[b]];
220 if (BlockLoop == 0) { // Child block not processed yet...
222 } else if (BlockLoop != Child) {
223 Loop *SubLoop = BlockLoop;
224 // Reparent all of the blocks which used to belong to BlockLoops
225 for (unsigned j = 0, e = SubLoop->Blocks.size(); j != e; ++j)
226 ContainingLoops[SubLoop->Blocks[j]] = Child;
228 // There is already a loop which contains this block, that means
229 // that we should reparent the loop which the block is currently
230 // considered to belong to to be a child of this loop.
231 MoveSiblingLoopInto(SubLoop, Child);
232 --i; // We just shrunk the SubLoops list.
239 // Now that we know all of the blocks that make up this loop, see if there are
240 // any branches to outside of the loop... building the ExitBlocks list.
241 for (std::vector<BasicBlock*>::iterator BI = L->Blocks.begin(),
242 BE = L->Blocks.end(); BI != BE; ++BI)
243 for (succ_iterator I = succ_begin(*BI), E = succ_end(*BI); I != E; ++I)
244 if (!L->contains(*I)) // Not in current loop?
245 L->ExitBlocks.push_back(*I); // It must be an exit block...
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!");
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;
264 InsertLoopInto(NewChild, NewParent);
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
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!");
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]);
281 // If not, insert it here!
282 Parent->SubLoops.push_back(L);
283 L->ParentLoop = Parent;
288 /// getLoopPreheader - If there is a preheader for this loop, return it. A
289 /// loop has a preheader if there is only one edge to the header of the loop
290 /// from outside of the loop. If this is the case, the block branching to the
291 /// header of the loop is the preheader node. The "preheaders" pass can be
292 /// "Required" to ensure that there is always a preheader node for every loop.
294 /// This method returns null if there is no preheader for the loop (either
295 /// because the loop is dead or because multiple blocks branch to the header
296 /// node of this loop).
298 BasicBlock *Loop::getLoopPreheader() const {
299 // Keep track of nodes outside the loop branching to the header...
302 // Loop over the predecessors of the header node...
303 BasicBlock *Header = getHeader();
304 for (pred_iterator PI = pred_begin(Header), PE = pred_end(Header);
306 if (!contains(*PI)) { // If the block is not in the loop...
307 if (Out && Out != *PI)
308 return 0; // Multiple predecessors outside the loop
312 // Make sure there is only one exit out of the preheader...
313 succ_iterator SI = succ_begin(Out);
315 if (SI != succ_end(Out))
316 return 0; // Multiple exits from the block, must not be a preheader.
319 // If there is exactly one preheader, return it. If there was zero, then Out
324 /// addBasicBlockToLoop - This function is used by other analyses to update loop
325 /// information. NewBB is set to be a new member of the current loop. Because
326 /// of this, it is added as a member of all parent loops, and is added to the
327 /// specified LoopInfo object as being in the current basic block. It is not
328 /// valid to replace the loop header with this method.
330 void Loop::addBasicBlockToLoop(BasicBlock *NewBB, LoopInfo &LI) {
331 assert(LI[getHeader()] == this && "Incorrect LI specified for this loop!");
332 assert(NewBB && "Cannot add a null basic block to the loop!");
333 assert(LI[NewBB] == 0 && "BasicBlock already in the loop!");
335 // Add the loop mapping to the LoopInfo object...
336 LI.BBMap[NewBB] = this;
338 // Add the basic block to this loop and all parent loops...
341 L->Blocks.push_back(NewBB);
342 L = L->getParentLoop();
346 /// changeExitBlock - This method is used to update loop information. All
347 /// instances of the specified Old basic block are removed from the exit list
348 /// and replaced with New.
350 void Loop::changeExitBlock(BasicBlock *Old, BasicBlock *New) {
351 assert(Old != New && "Cannot changeExitBlock to the same thing!");
352 assert(Old && New && "Cannot changeExitBlock to or from a null node!");
353 assert(hasExitBlock(Old) && "Old exit block not found!");
354 std::vector<BasicBlock*>::iterator
355 I = std::find(ExitBlocks.begin(), ExitBlocks.end(), Old);
356 while (I != ExitBlocks.end()) {
358 I = std::find(I+1, ExitBlocks.end(), Old);