lib/Analysis/LoopPass.cpp

   1 //===- LoopPass.cpp - Loop Pass and Loop Pass Manager ---------------------===//
   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 implements LoopPass and LPPassManager. All loop optimization
  11 // and transformation passes are derived from LoopPass. LPPassManager is
  12 // responsible for managing LoopPasses.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "llvm/Analysis/LoopPass.h"
  17 #include <queue>
  18 using namespace llvm;
  19
  20 //===----------------------------------------------------------------------===//
  21 // LoopQueue
  22
  23 namespace llvm {
  24
  25 // Compare Two loops based on their depth in loop nest.
  26 class LoopCompare {
  27 public:
  28   bool operator()( Loop *L1, Loop *L2) const {
  29     // Loops with highest depth has the highest priority.
  30     return L1->getLoopDepth() < L2->getLoopDepth();
  31   }
  32 };
  33
  34 // Loop queue used by Loop Pass Manager. This is a wrapper class
  35 // that hides implemenation detail (use of priority_queue) inside .cpp file.
  36 class LoopQueue {
  37 public:
  38   inline void push(Loop *L) { LPQ.push(L); }
  39   inline void pop() { LPQ.pop(); }
  40   inline Loop *top() { return LPQ.top(); }
  41   inline bool empty() { return LPQ.empty(); }
  42 private:
  43   std::priority_queue<Loop *, std::vector<Loop *>, LoopCompare> LPQ;
  44 };
  45
  46 } // End of LLVM namespace
  47
  48 //===----------------------------------------------------------------------===//
  49 // LPPassManager
  50 //
  51 /// LPPassManager manages FPPassManagers and CalLGraphSCCPasses.
  52
  53 LPPassManager::LPPassManager(int Depth) : PMDataManager(Depth) {
  54   skipThisLoop = false;
  55   redoThisLoop = false;
  56   LQ = new LoopQueue();
  57 }
  58
  59 LPPassManager::~LPPassManager() {
  60   delete LQ;
  61 }
  62
  63 /// Delete loop from the loop queue. This is used by Loop pass to inform
  64 /// Loop Pass Manager that it should skip rest of the passes for this loop.
  65 void LPPassManager::deleteLoopFromQueue(Loop *L) {
  66   // Do not pop loop from LQ here. It will be done by runOnFunction while loop.
  67   skipThisLoop = true;
  68 }
  69
  70 // Reoptimize this loop. LPPassManager will re-insert this loop into the
  71 // queue. This allows LoopPass to change loop nest for the loop. This
  72 // utility may send LPPassManager into infinite loops so use caution.
  73 void LPPassManager::redoLoop(Loop *L) {
  74   redoThisLoop = true;
  75 }
  76
  77 // Recurse through all subloops and all loops  into LQ.
  78 static void addLoopIntoQueue(Loop *L, LoopQueue *LQ) {
  79   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
  80     addLoopIntoQueue(*I, LQ);
  81   LQ->push(L);
  82 }
  83
  84 /// run - Execute all of the passes scheduled for execution.  Keep track of
  85 /// whether any of the passes modifies the function, and if so, return true.
  86 bool LPPassManager::runOnFunction(Function &F) {
  87   LoopInfo &LI = getAnalysis<LoopInfo>();
  88   bool Changed = false;
  89
  90   // Populate Loop Queue
  91   for (LoopInfo::iterator I = LI.begin(), E = LI.end(); I != E; ++I)
  92     addLoopIntoQueue(*I, LQ);
  93
  94   std::string Msg1 = "Executing Pass '";
  95   std::string Msg3 = "' Made Modification '";
  96
  97   // Walk Loops
  98   while (!LQ->empty()) {
  99
 100     Loop *L  = LQ->top();
 101     skipThisLoop = false;
 102     redoThisLoop = false;
 103
 104     // Run all passes on current SCC
 105     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 106
 107       Pass *P = getContainedPass(Index);
 108       AnalysisUsage AnUsage;
 109       P->getAnalysisUsage(AnUsage);
 110
 111       std::string Msg2 = "' on Loop ...\n'";
 112       dumpPassInfo(P, Msg1, Msg2);
 113       dumpAnalysisSetInfo("Required", P, AnUsage.getRequiredSet());
 114
 115       initializeAnalysisImpl(P);
 116
 117       StartPassTimer(P);
 118       LoopPass *LP = dynamic_cast<LoopPass *>(P);
 119       assert (LP && "Invalid LPPassManager member");
 120       LP->runOnLoop(L, *this);
 121       StopPassTimer(P);
 122
 123       if (Changed)
 124         dumpPassInfo(P, Msg3, Msg2);
 125       dumpAnalysisSetInfo("Preserved", P, AnUsage.getPreservedSet());
 126
 127       removeNotPreservedAnalysis(P);
 128       recordAvailableAnalysis(P);
 129       removeDeadPasses(P, Msg2);
 130
 131       if (skipThisLoop)
 132         // Do not run other passes on this loop.
 133         break;
 134     }
 135
 136     // Pop the loop from queue after running all passes.
 137     LQ->pop();
 138
 139     if (redoThisLoop)
 140       LQ->push(L);
 141   }
 142
 143   return Changed;
 144 }
 145
 146
 147 //===----------------------------------------------------------------------===//
 148 // LoopPass
 149
 150 /// Assign pass manager to manage this pass.
 151 void LoopPass::assignPassManager(PMStack &PMS,
 152                                  PassManagerType PreferredType) {
 153   // Find LPPassManager
 154   while (!PMS.empty()) {
 155     if (PMS.top()->getPassManagerType() > PMT_LoopPassManager)
 156       PMS.pop();
 157     else;
 158     break;
 159   }
 160
 161   LPPassManager *LPPM = dynamic_cast<LPPassManager *>(PMS.top());
 162
 163   // Create new Loop Pass Manager if it does not exist.
 164   if (!LPPM) {
 165
 166     assert (!PMS.empty() && "Unable to create Loop Pass Manager");
 167     PMDataManager *PMD = PMS.top();
 168
 169     // [1] Create new Call Graph Pass Manager
 170     LPPM = new LPPassManager(PMD->getDepth() + 1);
 171
 172     // [2] Set up new manager's top level manager
 173     PMTopLevelManager *TPM = PMD->getTopLevelManager();
 174     TPM->addIndirectPassManager(LPPM);
 175
 176     // [3] Assign manager to manage this new manager. This may create
 177     // and push new managers into PMS
 178     Pass *P = dynamic_cast<Pass *>(LPPM);
 179     P->assignPassManager(PMS);
 180
 181     // [4] Push new manager into PMS
 182     PMS.push(LPPM);
 183   }
 184
 185   LPPM->add(this);
 186 }
 187