include/llvm/Analysis/LoopPass.h

   1 //===- LoopPass.h - LoopPass class ----------------------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Devang Patel and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines LoopPass class. All loop optimization
  11 // and transformation passes are derived from LoopPass.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_LOOP_PASS_H
  16 #define LLVM_LOOP_PASS_H
  17
  18 #include "llvm/Analysis/LoopInfo.h"
  19 #include "llvm/Pass.h"
  20 #include "llvm/PassManagers.h"
  21 #include "llvm/Function.h"
  22
  23 namespace llvm {
  24
  25 class LPPassManager;
  26 class Loop;
  27 class Function;
  28
  29 class LoopPass : public Pass {
  30
  31  public:
  32   // runOnLoop - THis method should be implemented by the subclass to perform
  33   // whatever action is necessary for the specfied Loop.
  34   virtual bool runOnLoop (Loop *L, LPPassManager &LPM) = 0;
  35   virtual bool runOnFunctionBody (Function &F, LPPassManager &LPM) {
  36     return false;
  37   }
  38
  39   /// Assign pass manager to manager this pass
  40   virtual void assignPassManager(PMStack &PMS,
  41                                  PassManagerType PMT = PMT_LoopPassManager);
  42
  43 };
  44
  45 class LPPassManager : public FunctionPass, public PMDataManager {
  46
  47 public:
  48   LPPassManager(int Depth);
  49
  50   /// run - Execute all of the passes scheduled for execution.  Keep track of
  51   /// whether any of the passes modifies the module, and if so, return true.
  52   bool runOnFunction(Function &F);
  53
  54   /// Pass Manager itself does not invalidate any analysis info.
  55   void getAnalysisUsage(AnalysisUsage &Info) const {
  56     // LPPassManager needs LoopInfo. In the long term LoopInfo class will
  57     // be consumed by LPPassManager.
  58     Info.addRequired<LoopInfo>();
  59     Info.setPreservesAll();
  60   }
  61
  62   virtual const char *getPassName() const {
  63     return "Loop Pass Manager";
  64   }
  65
  66   // Print passes managed by this manager
  67   void dumpPassStructure(unsigned Offset) {
  68     llvm::cerr << std::string(Offset*2, ' ') << "Loop Pass Manager\n";
  69     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
  70       Pass *P = getContainedPass(Index);
  71       P->dumpPassStructure(Offset + 1);
  72       dumpLastUses(P, Offset+1);
  73     }
  74   }
  75
  76   Pass *getContainedPass(unsigned N) {
  77     assert ( N < PassVector.size() && "Pass number out of range!");
  78     Pass *FP = static_cast<Pass *>(PassVector[N]);
  79     return FP;
  80   }
  81
  82   virtual PassManagerType getPassManagerType() const {
  83     return PMT_LoopPassManager;
  84   }
  85
  86 public:
  87   // Delete loop from the loop queue. This is used by Loop pass to inform
  88   // Loop Pass Manager that it should skip rest of the passes for this loop.
  89   void deleteLoopFromQueue(Loop *L);
  90
  91   // Reoptimize this loop. LPPassManager will re-insert this loop into the
  92   // queue. This allows LoopPass to change loop nest for the loop. This
  93   // utility may send LPPassManager into infinite loops so use caution.
  94   void redoLoop(Loop *L);
  95 private:
  96   std::deque<Loop *> LQ;
  97   bool skipThisLoop;
  98   bool redoThisLoop;
  99 };
 100
 101 } // End llvm namespace
 102
 103 #endif