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 using namespace llvm;
  18
  19 //===----------------------------------------------------------------------===//
  20 // LPPassManager
  21 //
  22 /// LPPassManager manages FPPassManagers and CalLGraphSCCPasses.
  23
  24 LPPassManager::LPPassManager(int Depth) : PMDataManager(Depth) {
  25   skipThisLoop = false;
  26   redoThisLoop = false;
  27   LI = NULL;
  28   CurrentLoop = NULL;
  29 }
  30
  31 /// Delete loop from the loop queue and loop hierarcy (LoopInfo).
  32 void LPPassManager::deleteLoopFromQueue(Loop *L) {
  33
  34   if (Loop *ParentLoop = L->getParentLoop()) { // Not a top-level loop.
  35     // Reparent all of the blocks in this loop.  Since BBLoop had a parent,
  36     // they are now all in it.
  37     for (Loop::block_iterator I = L->block_begin(), E = L->block_end();
  38          I != E; ++I)
  39       if (LI->getLoopFor(*I) == L)    // Don't change blocks in subloops.
  40         LI->changeLoopFor(*I, ParentLoop);
  41
  42     // Remove the loop from its parent loop.
  43     for (Loop::iterator I = ParentLoop->begin(), E = ParentLoop->end();;
  44          ++I) {
  45       assert(I != E && "Couldn't find loop");
  46       if (*I == L) {
  47         ParentLoop->removeChildLoop(I);
  48         break;
  49       }
  50     }
  51
  52     // Move all subloops into the parent loop.
  53     while (L->begin() != L->end())
  54       ParentLoop->addChildLoop(L->removeChildLoop(L->end()-1));
  55   } else {
  56     // Reparent all of the blocks in this loop.  Since BBLoop had no parent,
  57     // they no longer in a loop at all.
  58
  59     for (unsigned i = 0; i != L->getBlocks().size(); ++i) {
  60       // Don't change blocks in subloops.
  61       if (LI->getLoopFor(L->getBlocks()[i]) == L) {
  62         LI->removeBlock(L->getBlocks()[i]);
  63         --i;
  64       }
  65     }
  66
  67     // Remove the loop from the top-level LoopInfo object.
  68     for (LoopInfo::iterator I = LI->begin(), E = LI->end();; ++I) {
  69       assert(I != E && "Couldn't find loop");
  70       if (*I == L) {
  71         LI->removeLoop(I);
  72         break;
  73       }
  74     }
  75
  76     // Move all of the subloops to the top-level.
  77     while (L->begin() != L->end())
  78       LI->addTopLevelLoop(L->removeChildLoop(L->end()-1));
  79   }
  80
  81   delete L;
  82
  83   // If L is current loop then skip rest of the passes and let
  84   // runOnFunction remove L from LQ. Otherwise, remove L from LQ now
  85   // and continue applying other passes on CurrentLoop.
  86   if (CurrentLoop == L) {
  87     skipThisLoop = true;
  88     return;
  89   }
  90
  91   for (std::deque<Loop *>::iterator I = LQ.begin(),
  92          E = LQ.end(); I != E; ++I) {
  93     if (*I == L) {
  94       LQ.erase(I);
  95       break;
  96     }
  97   }
  98 }
  99
 100 // Inset loop into loop nest (LoopInfo) and loop queue (LQ).
 101 void LPPassManager::insertLoop(Loop *L, Loop *ParentLoop) {
 102
 103   assert (CurrentLoop != L && "Cannot insert CurrentLoop");
 104
 105   // Insert into loop nest
 106   if (ParentLoop)
 107     ParentLoop->addChildLoop(L);
 108   else
 109     LI->addTopLevelLoop(L);
 110
 111   // Insert L into loop queue
 112   if (L == CurrentLoop)
 113     redoLoop(L);
 114   else if (!ParentLoop)
 115     // This is top level loop.
 116     LQ.push_front(L);
 117   else {
 118     // Insert L after ParentLoop
 119     for (std::deque<Loop *>::iterator I = LQ.begin(),
 120            E = LQ.end(); I != E; ++I) {
 121       if (*I == ParentLoop) {
 122         // deque does not support insert after.
 123         ++I;
 124         LQ.insert(I, 1, L);
 125         break;
 126       }
 127     }
 128   }
 129 }
 130
 131 // Reoptimize this loop. LPPassManager will re-insert this loop into the
 132 // queue. This allows LoopPass to change loop nest for the loop. This
 133 // utility may send LPPassManager into infinite loops so use caution.
 134 void LPPassManager::redoLoop(Loop *L) {
 135   assert (CurrentLoop != L && "Can redo only CurrentLoop");
 136   redoThisLoop = true;
 137 }
 138
 139 // Recurse through all subloops and all loops  into LQ.
 140 static void addLoopIntoQueue(Loop *L, std::deque<Loop *> &LQ) {
 141   LQ.push_back(L);
 142   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
 143     addLoopIntoQueue(*I, LQ);
 144 }
 145
 146 /// Pass Manager itself does not invalidate any analysis info.
 147 void LPPassManager::getAnalysisUsage(AnalysisUsage &Info) const {
 148   // LPPassManager needs LoopInfo. In the long term LoopInfo class will
 149   // become part of LPPassManager.
 150   Info.addRequired<LoopInfo>();
 151   Info.setPreservesAll();
 152 }
 153
 154 /// run - Execute all of the passes scheduled for execution.  Keep track of
 155 /// whether any of the passes modifies the function, and if so, return true.
 156 bool LPPassManager::runOnFunction(Function &F) {
 157   LI = &getAnalysis<LoopInfo>();
 158   bool Changed = false;
 159
 160   // Populate Loop Queue
 161   for (LoopInfo::iterator I = LI->begin(), E = LI->end(); I != E; ++I)
 162     addLoopIntoQueue(*I, LQ);
 163
 164   // Initialization
 165   for (std::deque<Loop *>::const_iterator I = LQ.begin(), E = LQ.end();
 166        I != E; ++I) {
 167     Loop *L = *I;
 168     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 169       Pass *P = getContainedPass(Index);
 170       LoopPass *LP = dynamic_cast<LoopPass *>(P);
 171       if (LP)
 172         Changed |= LP->doInitialization(L, *this);
 173     }
 174   }
 175
 176   // Walk Loops
 177   while (!LQ.empty()) {
 178
 179     CurrentLoop  = LQ.back();
 180     skipThisLoop = false;
 181     redoThisLoop = false;
 182
 183     // Run all passes on current SCC
 184     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 185
 186       Pass *P = getContainedPass(Index);
 187       AnalysisUsage AnUsage;
 188       P->getAnalysisUsage(AnUsage);
 189
 190       dumpPassInfo(P, EXECUTION_MSG, ON_LOOP_MSG, "");
 191       dumpAnalysisSetInfo("Required", P, AnUsage.getRequiredSet());
 192
 193       initializeAnalysisImpl(P);
 194
 195       StartPassTimer(P);
 196       LoopPass *LP = dynamic_cast<LoopPass *>(P);
 197       assert (LP && "Invalid LPPassManager member");
 198       LP->runOnLoop(CurrentLoop, *this);
 199       StopPassTimer(P);
 200
 201       if (Changed)
 202         dumpPassInfo(P, MODIFICATION_MSG, ON_LOOP_MSG, "");
 203       dumpAnalysisSetInfo("Preserved", P, AnUsage.getPreservedSet());
 204
 205       removeNotPreservedAnalysis(P);
 206       recordAvailableAnalysis(P);
 207       removeDeadPasses(P, "", ON_LOOP_MSG);
 208
 209       if (skipThisLoop)
 210         // Do not run other passes on this loop.
 211         break;
 212     }
 213
 214     // Pop the loop from queue after running all passes.
 215     LQ.pop_back();
 216
 217     if (redoThisLoop)
 218       LQ.push_back(CurrentLoop);
 219   }
 220
 221   // Finalization
 222   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 223     Pass *P = getContainedPass(Index);
 224     LoopPass *LP = dynamic_cast <LoopPass *>(P);
 225     if (LP)
 226       Changed |= LP->doFinalization();
 227   }
 228
 229   return Changed;
 230 }
 231
 232
 233 //===----------------------------------------------------------------------===//
 234 // LoopPass
 235
 236 // Check if this pass is suitable for the current LPPassManager, if
 237 // available. This pass P is not suitable for a LPPassManager if P
 238 // is not preserving higher level analysis info used by other
 239 // LPPassManager passes. In such case, pop LPPassManager from the
 240 // stack. This will force assignPassManager() to create new
 241 // LPPassManger as expected.
 242 void LoopPass::preparePassManager(PMStack &PMS) {
 243
 244   // Find LPPassManager
 245   while (!PMS.empty()) {
 246     if (PMS.top()->getPassManagerType() > PMT_LoopPassManager)
 247       PMS.pop();
 248     else;
 249     break;
 250   }
 251
 252   LPPassManager *LPPM = dynamic_cast<LPPassManager *>(PMS.top());
 253
 254   // If this pass is destroying high level information that is used
 255   // by other passes that are managed by LPM then do not insert
 256   // this pass in current LPM. Use new LPPassManager.
 257   if (LPPM && !LPPM->preserveHigherLevelAnalysis(this))
 258     PMS.pop();
 259 }
 260
 261 /// Assign pass manager to manage this pass.
 262 void LoopPass::assignPassManager(PMStack &PMS,
 263                                  PassManagerType PreferredType) {
 264   // Find LPPassManager
 265   while (!PMS.empty()) {
 266     if (PMS.top()->getPassManagerType() > PMT_LoopPassManager)
 267       PMS.pop();
 268     else;
 269     break;
 270   }
 271
 272   LPPassManager *LPPM = dynamic_cast<LPPassManager *>(PMS.top());
 273
 274   // Create new Loop Pass Manager if it does not exist.
 275   if (!LPPM) {
 276
 277     assert (!PMS.empty() && "Unable to create Loop Pass Manager");
 278     PMDataManager *PMD = PMS.top();
 279
 280     // [1] Create new Call Graph Pass Manager
 281     LPPM = new LPPassManager(PMD->getDepth() + 1);
 282
 283     // [2] Set up new manager's top level manager
 284     PMTopLevelManager *TPM = PMD->getTopLevelManager();
 285     TPM->addIndirectPassManager(LPPM);
 286
 287     // [3] Assign manager to manage this new manager. This may create
 288     // and push new managers into PMS
 289     Pass *P = dynamic_cast<Pass *>(LPPM);
 290     TPM->schedulePass(P);
 291
 292     // [4] Push new manager into PMS
 293     PMS.push(LPPM);
 294   }
 295
 296   LPPM->add(this);
 297 }
 298