include/llvm/CodeGen/MachineLoopInfo.h

   1 //===- llvm/CodeGen/MachineLoopInfo.h - Natural Loop Calculator -*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the MachineLoopInfo class that is used to identify natural
  11 // loops and determine the loop depth of various nodes of the CFG.  Note that
  12 // natural 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_CODEGEN_MACHINE_LOOP_INFO_H
  31 #define LLVM_CODEGEN_MACHINE_LOOP_INFO_H
  32
  33 #include "llvm/CodeGen/MachineFunctionPass.h"
  34 #include "llvm/Analysis/LoopInfo.h"
  35
  36 namespace llvm {
  37
  38 class MachineLoop : public LoopBase<MachineBasicBlock, MachineLoop> {
  39 public:
  40   MachineLoop();
  41 private:
  42   friend class LoopInfoBase<MachineBasicBlock, MachineLoop>;
  43   explicit MachineLoop(MachineBasicBlock *MBB)
  44     : LoopBase<MachineBasicBlock, MachineLoop>(MBB) {}
  45 };
  46
  47 class MachineLoopInfo : public MachineFunctionPass {
  48   LoopInfoBase<MachineBasicBlock, MachineLoop> LI;
  49   friend class LoopBase<MachineBasicBlock, MachineLoop>;
  50
  51   void operator=(const MachineLoopInfo &);  // do not implement
  52   MachineLoopInfo(const MachineLoopInfo &); // do not implement
  53
  54   LoopInfoBase<MachineBasicBlock, MachineLoop>& getBase() { return LI; }
  55
  56 public:
  57   static char ID; // Pass identification, replacement for typeid
  58
  59   MachineLoopInfo() : MachineFunctionPass(&ID) {}
  60
  61   /// iterator/begin/end - The interface to the top-level loops in the current
  62   /// function.
  63   ///
  64   typedef LoopInfoBase<MachineBasicBlock, MachineLoop>::iterator iterator;
  65   inline iterator begin() const { return LI.begin(); }
  66   inline iterator end() const { return LI.end(); }
  67   bool empty() const { return LI.empty(); }
  68
  69   /// getLoopFor - Return the inner most loop that BB lives in.  If a basic
  70   /// block is in no loop (for example the entry node), null is returned.
  71   ///
  72   inline MachineLoop *getLoopFor(const MachineBasicBlock *BB) const {
  73     return LI.getLoopFor(BB);
  74   }
  75
  76   /// operator[] - same as getLoopFor...
  77   ///
  78   inline const MachineLoop *operator[](const MachineBasicBlock *BB) const {
  79     return LI.getLoopFor(BB);
  80   }
  81
  82   /// getLoopDepth - Return the loop nesting level of the specified block...
  83   ///
  84   inline unsigned getLoopDepth(const MachineBasicBlock *BB) const {
  85     return LI.getLoopDepth(BB);
  86   }
  87
  88   // isLoopHeader - True if the block is a loop header node
  89   inline bool isLoopHeader(MachineBasicBlock *BB) const {
  90     return LI.isLoopHeader(BB);
  91   }
  92
  93   /// runOnFunction - Calculate the natural loop information.
  94   ///
  95   virtual bool runOnMachineFunction(MachineFunction &F);
  96
  97   virtual void releaseMemory() { LI.releaseMemory(); }
  98
  99   virtual void getAnalysisUsage(AnalysisUsage &AU) const;
 100
 101   /// removeLoop - This removes the specified top-level loop from this loop info
 102   /// object.  The loop is not deleted, as it will presumably be inserted into
 103   /// another loop.
 104   inline MachineLoop *removeLoop(iterator I) { return LI.removeLoop(I); }
 105
 106   /// changeLoopFor - Change the top-level loop that contains BB to the
 107   /// specified loop.  This should be used by transformations that restructure
 108   /// the loop hierarchy tree.
 109   inline void changeLoopFor(MachineBasicBlock *BB, MachineLoop *L) {
 110     LI.changeLoopFor(BB, L);
 111   }
 112
 113   /// changeTopLevelLoop - Replace the specified loop in the top-level loops
 114   /// list with the indicated loop.
 115   inline void changeTopLevelLoop(MachineLoop *OldLoop, MachineLoop *NewLoop) {
 116     LI.changeTopLevelLoop(OldLoop, NewLoop);
 117   }
 118
 119   /// addTopLevelLoop - This adds the specified loop to the collection of
 120   /// top-level loops.
 121   inline void addTopLevelLoop(MachineLoop *New) {
 122     LI.addTopLevelLoop(New);
 123   }
 124
 125   /// removeBlock - This method completely removes BB from all data structures,
 126   /// including all of the Loop objects it is nested in and our mapping from
 127   /// MachineBasicBlocks to loops.
 128   void removeBlock(MachineBasicBlock *BB) {
 129     LI.removeBlock(BB);
 130   }
 131 };
 132
 133
 134 // Allow clients to walk the list of nested loops...
 135 template <> struct GraphTraits<const MachineLoop*> {
 136   typedef const MachineLoop NodeType;
 137   typedef MachineLoopInfo::iterator ChildIteratorType;
 138
 139   static NodeType *getEntryNode(const MachineLoop *L) { return L; }
 140   static inline ChildIteratorType child_begin(NodeType *N) {
 141     return N->begin();
 142   }
 143   static inline ChildIteratorType child_end(NodeType *N) {
 144     return N->end();
 145   }
 146 };
 147
 148 template <> struct GraphTraits<MachineLoop*> {
 149   typedef MachineLoop NodeType;
 150   typedef MachineLoopInfo::iterator ChildIteratorType;
 151
 152   static NodeType *getEntryNode(MachineLoop *L) { return L; }
 153   static inline ChildIteratorType child_begin(NodeType *N) {
 154     return N->begin();
 155   }
 156   static inline ChildIteratorType child_end(NodeType *N) {
 157     return N->end();
 158   }
 159 };
 160
 161 } // End llvm namespace
 162
 163 #endif