LoopInfo.h revision f25c19c6b57aec5670e87dc57840c6ac12252099
1//===- llvm/Analysis/LoopInfo.h - Natural Loop Calculator -------*- C++ -*-===// 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 natural 12// loops may actually be several loops that share the same header node. 13// 14// This analysis calculates the nesting structure of loops in a function. For 15// each natural loop identified, this analysis identifies natural loops 16// contained entirely within the loop and the basic blocks the make up the loop. 17// 18// It can calculate on the fly various bits of information, for example: 19// 20// * whether there is a preheader for the loop 21// * the number of back edges to the header 22// * whether or not a particular block branches out of the loop 23// * the successor blocks of the loop 24// * the loop depth 25// * the trip count 26// * etc... 27// 28//===----------------------------------------------------------------------===// 29 30#ifndef LLVM_ANALYSIS_LOOP_INFO_H 31#define LLVM_ANALYSIS_LOOP_INFO_H 32 33#include "llvm/Pass.h" 34#include "llvm/ADT/GraphTraits.h" 35 36namespace llvm { 37 38struct ETForest; 39class LoopInfo; 40class PHINode; 41class Instruction; 42 43//===----------------------------------------------------------------------===// 44/// Loop class - Instances of this class are used to represent loops that are 45/// detected in the flow graph 46/// 47class Loop { 48 Loop *ParentLoop; 49 std::vector<Loop*> SubLoops; // Loops contained entirely within this one 50 std::vector<BasicBlock*> Blocks; // First entry is the header node 51 52 Loop(const Loop &); // DO NOT IMPLEMENT 53 const Loop &operator=(const Loop &); // DO NOT IMPLEMENT 54public: 55 /// Loop ctor - This creates an empty loop. 56 Loop() : ParentLoop(0) {} 57 ~Loop() { 58 for (unsigned i = 0, e = SubLoops.size(); i != e; ++i) 59 delete SubLoops[i]; 60 } 61 62 unsigned getLoopDepth() const { 63 unsigned D = 0; 64 for (const Loop *CurLoop = this; CurLoop; CurLoop = CurLoop->ParentLoop) 65 ++D; 66 return D; 67 } 68 BasicBlock *getHeader() const { return Blocks.front(); } 69 Loop *getParentLoop() const { return ParentLoop; } 70 71 /// contains - Return true of the specified basic block is in this loop 72 /// 73 bool contains(const BasicBlock *BB) const; 74 75 /// iterator/begin/end - Return the loops contained entirely within this loop. 76 /// 77 const std::vector<Loop*> &getSubLoops() const { return SubLoops; } 78 typedef std::vector<Loop*>::const_iterator iterator; 79 iterator begin() const { return SubLoops.begin(); } 80 iterator end() const { return SubLoops.end(); } 81 82 /// getBlocks - Get a list of the basic blocks which make up this loop. 83 /// 84 const std::vector<BasicBlock*> &getBlocks() const { return Blocks; } 85 typedef std::vector<BasicBlock*>::const_iterator block_iterator; 86 block_iterator block_begin() const { return Blocks.begin(); } 87 block_iterator block_end() const { return Blocks.end(); } 88 89 /// isLoopExit - True if terminator in the block can branch to another block 90 /// that is outside of the current loop. 91 /// 92 bool isLoopExit(const BasicBlock *BB) const; 93 94 /// getNumBackEdges - Calculate the number of back edges to the loop header 95 /// 96 unsigned getNumBackEdges() const; 97 98 /// isLoopInvariant - Return true if the specified value is loop invariant 99 /// 100 bool isLoopInvariant(Value *V) const; 101 102 //===--------------------------------------------------------------------===// 103 // APIs for simple analysis of the loop. 104 // 105 // Note that all of these methods can fail on general loops (ie, there may not 106 // be a preheader, etc). For best success, the loop simplification and 107 // induction variable canonicalization pass should be used to normalize loops 108 // for easy analysis. These methods assume canonical loops. 109 110 /// getExitBlocks - Return all of the successor blocks of this loop. These 111 /// are the blocks _outside of the current loop_ which are branched to. 112 /// 113 void getExitBlocks(std::vector<BasicBlock*> &Blocks) const; 114 115 /// getLoopPreheader - If there is a preheader for this loop, return it. A 116 /// loop has a preheader if there is only one edge to the header of the loop 117 /// from outside of the loop. If this is the case, the block branching to the 118 /// header of the loop is the preheader node. 119 /// 120 /// This method returns null if there is no preheader for the loop. 121 /// 122 BasicBlock *getLoopPreheader() const; 123 124 /// getLoopLatch - If there is a latch block for this loop, return it. A 125 /// latch block is the canonical backedge for a loop. A loop header in normal 126 /// form has two edges into it: one from a preheader and one from a latch 127 /// block. 128 BasicBlock *getLoopLatch() const; 129 130 /// getCanonicalInductionVariable - Check to see if the loop has a canonical 131 /// induction variable: an integer recurrence that starts at 0 and increments 132 /// by one each time through the loop. If so, return the phi node that 133 /// corresponds to it. 134 /// 135 PHINode *getCanonicalInductionVariable() const; 136 137 /// getCanonicalInductionVariableIncrement - Return the LLVM value that holds 138 /// the canonical induction variable value for the "next" iteration of the 139 /// loop. This always succeeds if getCanonicalInductionVariable succeeds. 140 /// 141 Instruction *getCanonicalInductionVariableIncrement() const; 142 143 /// getTripCount - Return a loop-invariant LLVM value indicating the number of 144 /// times the loop will be executed. Note that this means that the backedge 145 /// of the loop executes N-1 times. If the trip-count cannot be determined, 146 /// this returns null. 147 /// 148 Value *getTripCount() const; 149 150 /// isLCSSAForm - Return true if the Loop is in LCSSA form 151 bool isLCSSAForm() const; 152 153 //===--------------------------------------------------------------------===// 154 // APIs for updating loop information after changing the CFG 155 // 156 157 /// addBasicBlockToLoop - This method is used by other analyses to update loop 158 /// information. NewBB is set to be a new member of the current loop. 159 /// Because of this, it is added as a member of all parent loops, and is added 160 /// to the specified LoopInfo object as being in the current basic block. It 161 /// is not valid to replace the loop header with this method. 162 /// 163 void addBasicBlockToLoop(BasicBlock *NewBB, LoopInfo &LI); 164 165 /// replaceChildLoopWith - This is used when splitting loops up. It replaces 166 /// the OldChild entry in our children list with NewChild, and updates the 167 /// parent pointer of OldChild to be null and the NewChild to be this loop. 168 /// This updates the loop depth of the new child. 169 void replaceChildLoopWith(Loop *OldChild, Loop *NewChild); 170 171 /// addChildLoop - Add the specified loop to be a child of this loop. This 172 /// updates the loop depth of the new child. 173 /// 174 void addChildLoop(Loop *NewChild); 175 176 /// removeChildLoop - This removes the specified child from being a subloop of 177 /// this loop. The loop is not deleted, as it will presumably be inserted 178 /// into another loop. 179 Loop *removeChildLoop(iterator OldChild); 180 181 /// addBlockEntry - This adds a basic block directly to the basic block list. 182 /// This should only be used by transformations that create new loops. Other 183 /// transformations should use addBasicBlockToLoop. 184 void addBlockEntry(BasicBlock *BB) { 185 Blocks.push_back(BB); 186 } 187 188 /// moveToHeader - This method is used to move BB (which must be part of this 189 /// loop) to be the loop header of the loop (the block that dominates all 190 /// others). 191 void moveToHeader(BasicBlock *BB) { 192 if (Blocks[0] == BB) return; 193 for (unsigned i = 0; ; ++i) { 194 assert(i != Blocks.size() && "Loop does not contain BB!"); 195 if (Blocks[i] == BB) { 196 Blocks[i] = Blocks[0]; 197 Blocks[0] = BB; 198 return; 199 } 200 } 201 } 202 203 /// removeBlockFromLoop - This removes the specified basic block from the 204 /// current loop, updating the Blocks as appropriate. This does not update 205 /// the mapping in the LoopInfo class. 206 void removeBlockFromLoop(BasicBlock *BB); 207 208 void print(std::ostream &O, unsigned Depth = 0) const; 209 void dump() const; 210private: 211 friend class LoopInfo; 212 Loop(BasicBlock *BB) : ParentLoop(0) { 213 Blocks.push_back(BB); 214 } 215}; 216 217 218 219//===----------------------------------------------------------------------===// 220/// LoopInfo - This class builds and contains all of the top level loop 221/// structures in the specified function. 222/// 223class LoopInfo : public FunctionPass { 224 // BBMap - Mapping of basic blocks to the inner most loop they occur in 225 std::map<BasicBlock*, Loop*> BBMap; 226 std::vector<Loop*> TopLevelLoops; 227 friend class Loop; 228public: 229 ~LoopInfo() { releaseMemory(); } 230 231 /// iterator/begin/end - The interface to the top-level loops in the current 232 /// function. 233 /// 234 typedef std::vector<Loop*>::const_iterator iterator; 235 iterator begin() const { return TopLevelLoops.begin(); } 236 iterator end() const { return TopLevelLoops.end(); } 237 238 /// getLoopFor - Return the inner most loop that BB lives in. If a basic 239 /// block is in no loop (for example the entry node), null is returned. 240 /// 241 Loop *getLoopFor(const BasicBlock *BB) const { 242 std::map<BasicBlock *, Loop*>::const_iterator I= 243 BBMap.find(const_cast<BasicBlock*>(BB)); 244 return I != BBMap.end() ? I->second : 0; 245 } 246 247 /// operator[] - same as getLoopFor... 248 /// 249 const Loop *operator[](const BasicBlock *BB) const { 250 return getLoopFor(BB); 251 } 252 253 /// getLoopDepth - Return the loop nesting level of the specified block... 254 /// 255 unsigned getLoopDepth(const BasicBlock *BB) const { 256 const Loop *L = getLoopFor(BB); 257 return L ? L->getLoopDepth() : 0; 258 } 259 260 // isLoopHeader - True if the block is a loop header node 261 bool isLoopHeader(BasicBlock *BB) const { 262 const Loop *L = getLoopFor(BB); 263 return L && L->getHeader() == BB; 264 } 265 266 /// runOnFunction - Calculate the natural loop information. 267 /// 268 virtual bool runOnFunction(Function &F); 269 270 virtual void releaseMemory(); 271 void print(std::ostream &O, const Module* = 0) const; 272 273 virtual void getAnalysisUsage(AnalysisUsage &AU) const; 274 275 /// removeLoop - This removes the specified top-level loop from this loop info 276 /// object. The loop is not deleted, as it will presumably be inserted into 277 /// another loop. 278 Loop *removeLoop(iterator I); 279 280 /// changeLoopFor - Change the top-level loop that contains BB to the 281 /// specified loop. This should be used by transformations that restructure 282 /// the loop hierarchy tree. 283 void changeLoopFor(BasicBlock *BB, Loop *L); 284 285 /// changeTopLevelLoop - Replace the specified loop in the top-level loops 286 /// list with the indicated loop. 287 void changeTopLevelLoop(Loop *OldLoop, Loop *NewLoop); 288 289 /// addTopLevelLoop - This adds the specified loop to the collection of 290 /// top-level loops. 291 void addTopLevelLoop(Loop *New) { 292 assert(New->getParentLoop() == 0 && "Loop already in subloop!"); 293 TopLevelLoops.push_back(New); 294 } 295 296 /// removeBlock - This method completely removes BB from all data structures, 297 /// including all of the Loop objects it is nested in and our mapping from 298 /// BasicBlocks to loops. 299 void removeBlock(BasicBlock *BB); 300 301private: 302 void Calculate(ETForest &EF); 303 Loop *ConsiderForLoop(BasicBlock *BB, ETForest &EF); 304 void MoveSiblingLoopInto(Loop *NewChild, Loop *NewParent); 305 void InsertLoopInto(Loop *L, Loop *Parent); 306}; 307 308 309// Allow clients to walk the list of nested loops... 310template <> struct GraphTraits<const Loop*> { 311 typedef const Loop NodeType; 312 typedef std::vector<Loop*>::const_iterator ChildIteratorType; 313 314 static NodeType *getEntryNode(const Loop *L) { return L; } 315 static inline ChildIteratorType child_begin(NodeType *N) { 316 return N->begin(); 317 } 318 static inline ChildIteratorType child_end(NodeType *N) { 319 return N->end(); 320 } 321}; 322 323template <> struct GraphTraits<Loop*> { 324 typedef Loop NodeType; 325 typedef std::vector<Loop*>::const_iterator ChildIteratorType; 326 327 static NodeType *getEntryNode(Loop *L) { return L; } 328 static inline ChildIteratorType child_begin(NodeType *N) { 329 return N->begin(); 330 } 331 static inline ChildIteratorType child_end(NodeType *N) { 332 return N->end(); 333 } 334}; 335 336} // End llvm namespace 337 338// Make sure that any clients of this file link in LoopInfo.cpp 339FORCE_DEFINING_FILE_TO_BE_LINKED(LoopInfo) 340 341#endif 342