lib/Analysis/LoopPass.cpp

   1 //===- LoopPass.cpp - Loop Pass and Loop Pass Manager ---------------------===//
   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 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 "llvm/IR/IRPrintingPasses.h"
  18 #include "llvm/IR/LLVMContext.h"
  19 #include "llvm/IR/PassManager.h"
  20 #include "llvm/Support/Debug.h"
  21 #include "llvm/Support/Timer.h"
  22 #include "llvm/Support/raw_ostream.h"
  23 using namespace llvm;
  24
  25 #define DEBUG_TYPE "loop-pass-manager"
  26
  27 namespace {
  28
  29 /// PrintLoopPass - Print a Function corresponding to a Loop.
  30 ///
  31 class PrintLoopPassWrapper : public LoopPass {
  32   PrintLoopPass P;
  33
  34 public:
  35   static char ID;
  36   PrintLoopPassWrapper() : LoopPass(ID) {}
  37   PrintLoopPassWrapper(raw_ostream &OS, const std::string &Banner)
  38       : LoopPass(ID), P(OS, Banner) {}
  39
  40   void getAnalysisUsage(AnalysisUsage &AU) const override {
  41     AU.setPreservesAll();
  42   }
  43
  44   bool runOnLoop(Loop *L, LPPassManager &) override {
  45     P.run(*L);
  46     return false;
  47   }
  48 };
  49
  50 char PrintLoopPassWrapper::ID = 0;
  51 }
  52
  53 //===----------------------------------------------------------------------===//
  54 // LPPassManager
  55 //
  56
  57 char LPPassManager::ID = 0;
  58
  59 LPPassManager::LPPassManager()
  60   : FunctionPass(ID), PMDataManager() {
  61   LI = nullptr;
  62   CurrentLoop = nullptr;
  63 }
  64
  65 /// Delete loop from the loop queue and loop hierarchy (LoopInfo).
  66 void LPPassManager::deleteLoopFromQueue(Loop *L) {
  67   assert(CurrentLoop == L && "deleting a loop that is not being operated on");
  68   LI->updateUnloop(L);
  69 }
  70
  71 // Inset loop into loop nest (LoopInfo) and loop queue (LQ).
  72 Loop &LPPassManager::addLoop(Loop *ParentLoop) {
  73   // Create a new loop. LI will take ownership.
  74   Loop *L = new Loop();
  75
  76   // Insert into the loop nest and the loop queue.
  77   if (!ParentLoop) {
  78     // This is the top level loop.
  79     LI->addTopLevelLoop(L);
  80     LQ.push_front(L);
  81     return *L;
  82   }
  83
  84   ParentLoop->addChildLoop(L);
  85   // Insert L into the loop queue after the parent loop.
  86   for (auto I = LQ.begin(), E = LQ.end(); I != E; ++I) {
  87     if (*I == L->getParentLoop()) {
  88       // deque does not support insert after.
  89       ++I;
  90       LQ.insert(I, 1, L);
  91       break;
  92     }
  93   }
  94   return *L;
  95 }
  96
  97 /// cloneBasicBlockSimpleAnalysis - Invoke cloneBasicBlockAnalysis hook for
  98 /// all loop passes.
  99 void LPPassManager::cloneBasicBlockSimpleAnalysis(BasicBlock *From,
 100                                                   BasicBlock *To, Loop *L) {
 101   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 102     LoopPass *LP = getContainedPass(Index);
 103     LP->cloneBasicBlockAnalysis(From, To, L);
 104   }
 105 }
 106
 107 /// deleteSimpleAnalysisValue - Invoke deleteAnalysisValue hook for all passes.
 108 void LPPassManager::deleteSimpleAnalysisValue(Value *V, Loop *L) {
 109   if (BasicBlock *BB = dyn_cast<BasicBlock>(V)) {
 110     for (BasicBlock::iterator BI = BB->begin(), BE = BB->end(); BI != BE;
 111          ++BI) {
 112       Instruction &I = *BI;
 113       deleteSimpleAnalysisValue(&I, L);
 114     }
 115   }
 116   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 117     LoopPass *LP = getContainedPass(Index);
 118     LP->deleteAnalysisValue(V, L);
 119   }
 120 }
 121
 122 /// Invoke deleteAnalysisLoop hook for all passes.
 123 void LPPassManager::deleteSimpleAnalysisLoop(Loop *L) {
 124   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 125     LoopPass *LP = getContainedPass(Index);
 126     LP->deleteAnalysisLoop(L);
 127   }
 128 }
 129
 130
 131 // Recurse through all subloops and all loops  into LQ.
 132 static void addLoopIntoQueue(Loop *L, std::deque<Loop *> &LQ) {
 133   LQ.push_back(L);
 134   for (Loop::reverse_iterator I = L->rbegin(), E = L->rend(); I != E; ++I)
 135     addLoopIntoQueue(*I, LQ);
 136 }
 137
 138 /// Pass Manager itself does not invalidate any analysis info.
 139 void LPPassManager::getAnalysisUsage(AnalysisUsage &Info) const {
 140   // LPPassManager needs LoopInfo. In the long term LoopInfo class will
 141   // become part of LPPassManager.
 142   Info.addRequired<LoopInfoWrapperPass>();
 143   Info.setPreservesAll();
 144 }
 145
 146 /// run - Execute all of the passes scheduled for execution.  Keep track of
 147 /// whether any of the passes modifies the function, and if so, return true.
 148 bool LPPassManager::runOnFunction(Function &F) {
 149   auto &LIWP = getAnalysis<LoopInfoWrapperPass>();
 150   LI = &LIWP.getLoopInfo();
 151   bool Changed = false;
 152
 153   // Collect inherited analysis from Module level pass manager.
 154   populateInheritedAnalysis(TPM->activeStack);
 155
 156   // Populate the loop queue in reverse program order. There is no clear need to
 157   // process sibling loops in either forward or reverse order. There may be some
 158   // advantage in deleting uses in a later loop before optimizing the
 159   // definitions in an earlier loop. If we find a clear reason to process in
 160   // forward order, then a forward variant of LoopPassManager should be created.
 161   //
 162   // Note that LoopInfo::iterator visits loops in reverse program
 163   // order. Here, reverse_iterator gives us a forward order, and the LoopQueue
 164   // reverses the order a third time by popping from the back.
 165   for (LoopInfo::reverse_iterator I = LI->rbegin(), E = LI->rend(); I != E; ++I)
 166     addLoopIntoQueue(*I, LQ);
 167
 168   if (LQ.empty()) // No loops, skip calling finalizers
 169     return false;
 170
 171   // Initialization
 172   for (std::deque<Loop *>::const_iterator I = LQ.begin(), E = LQ.end();
 173        I != E; ++I) {
 174     Loop *L = *I;
 175     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 176       LoopPass *P = getContainedPass(Index);
 177       Changed |= P->doInitialization(L, *this);
 178     }
 179   }
 180
 181   // Walk Loops
 182   while (!LQ.empty()) {
 183
 184     CurrentLoop = LQ.back();
 185     // Run all passes on the current Loop.
 186     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 187       LoopPass *P = getContainedPass(Index);
 188
 189       dumpPassInfo(P, EXECUTION_MSG, ON_LOOP_MSG,
 190                    CurrentLoop->getHeader()->getName());
 191       dumpRequiredSet(P);
 192
 193       initializeAnalysisImpl(P);
 194
 195       {
 196         PassManagerPrettyStackEntry X(P, *CurrentLoop->getHeader());
 197         TimeRegion PassTimer(getPassTimer(P));
 198
 199         Changed |= P->runOnLoop(CurrentLoop, *this);
 200       }
 201
 202       if (Changed)
 203         dumpPassInfo(P, MODIFICATION_MSG, ON_LOOP_MSG,
 204                      CurrentLoop->isUnloop()
 205                          ? "<deleted>"
 206                          : CurrentLoop->getHeader()->getName());
 207       dumpPreservedSet(P);
 208
 209       if (CurrentLoop->isUnloop()) {
 210         // Notify passes that the loop is being deleted.
 211         deleteSimpleAnalysisLoop(CurrentLoop);
 212       } else {
 213         // Manually check that this loop is still healthy. This is done
 214         // instead of relying on LoopInfo::verifyLoop since LoopInfo
 215         // is a function pass and it's really expensive to verify every
 216         // loop in the function every time. That level of checking can be
 217         // enabled with the -verify-loop-info option.
 218         {
 219           TimeRegion PassTimer(getPassTimer(&LIWP));
 220           CurrentLoop->verifyLoop();
 221         }
 222
 223         // Then call the regular verifyAnalysis functions.
 224         verifyPreservedAnalysis(P);
 225
 226         F.getContext().yield();
 227       }
 228
 229       removeNotPreservedAnalysis(P);
 230       recordAvailableAnalysis(P);
 231       removeDeadPasses(P, CurrentLoop->isUnloop()
 232                               ? "<deleted>"
 233                               : CurrentLoop->getHeader()->getName(),
 234                        ON_LOOP_MSG);
 235
 236       if (CurrentLoop->isUnloop())
 237         // Do not run other passes on this loop.
 238         break;
 239     }
 240
 241     // If the loop was deleted, release all the loop passes. This frees up
 242     // some memory, and avoids trouble with the pass manager trying to call
 243     // verifyAnalysis on them.
 244     if (CurrentLoop->isUnloop()) {
 245       for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 246         Pass *P = getContainedPass(Index);
 247         freePass(P, "<deleted>", ON_LOOP_MSG);
 248       }
 249       delete CurrentLoop;
 250     }
 251
 252     // Pop the loop from queue after running all passes.
 253     LQ.pop_back();
 254   }
 255
 256   // Finalization
 257   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 258     LoopPass *P = getContainedPass(Index);
 259     Changed |= P->doFinalization();
 260   }
 261
 262   return Changed;
 263 }
 264
 265 /// Print passes managed by this manager
 266 void LPPassManager::dumpPassStructure(unsigned Offset) {
 267   errs().indent(Offset*2) << "Loop Pass Manager\n";
 268   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 269     Pass *P = getContainedPass(Index);
 270     P->dumpPassStructure(Offset + 1);
 271     dumpLastUses(P, Offset+1);
 272   }
 273 }
 274
 275
 276 //===----------------------------------------------------------------------===//
 277 // LoopPass
 278
 279 Pass *LoopPass::createPrinterPass(raw_ostream &O,
 280                                   const std::string &Banner) const {
 281   return new PrintLoopPassWrapper(O, Banner);
 282 }
 283
 284 // Check if this pass is suitable for the current LPPassManager, if
 285 // available. This pass P is not suitable for a LPPassManager if P
 286 // is not preserving higher level analysis info used by other
 287 // LPPassManager passes. In such case, pop LPPassManager from the
 288 // stack. This will force assignPassManager() to create new
 289 // LPPassManger as expected.
 290 void LoopPass::preparePassManager(PMStack &PMS) {
 291
 292   // Find LPPassManager
 293   while (!PMS.empty() &&
 294          PMS.top()->getPassManagerType() > PMT_LoopPassManager)
 295     PMS.pop();
 296
 297   // If this pass is destroying high level information that is used
 298   // by other passes that are managed by LPM then do not insert
 299   // this pass in current LPM. Use new LPPassManager.
 300   if (PMS.top()->getPassManagerType() == PMT_LoopPassManager &&
 301       !PMS.top()->preserveHigherLevelAnalysis(this))
 302     PMS.pop();
 303 }
 304
 305 /// Assign pass manager to manage this pass.
 306 void LoopPass::assignPassManager(PMStack &PMS,
 307                                  PassManagerType PreferredType) {
 308   // Find LPPassManager
 309   while (!PMS.empty() &&
 310          PMS.top()->getPassManagerType() > PMT_LoopPassManager)
 311     PMS.pop();
 312
 313   LPPassManager *LPPM;
 314   if (PMS.top()->getPassManagerType() == PMT_LoopPassManager)
 315     LPPM = (LPPassManager*)PMS.top();
 316   else {
 317     // Create new Loop Pass Manager if it does not exist.
 318     assert (!PMS.empty() && "Unable to create Loop Pass Manager");
 319     PMDataManager *PMD = PMS.top();
 320
 321     // [1] Create new Loop Pass Manager
 322     LPPM = new LPPassManager();
 323     LPPM->populateInheritedAnalysis(PMS);
 324
 325     // [2] Set up new manager's top level manager
 326     PMTopLevelManager *TPM = PMD->getTopLevelManager();
 327     TPM->addIndirectPassManager(LPPM);
 328
 329     // [3] Assign manager to manage this new manager. This may create
 330     // and push new managers into PMS
 331     Pass *P = LPPM->getAsPass();
 332     TPM->schedulePass(P);
 333
 334     // [4] Push new manager into PMS
 335     PMS.push(LPPM);
 336   }
 337
 338   LPPM->add(this);
 339 }
 340
 341 // Containing function has Attribute::OptimizeNone and transformation
 342 // passes should skip it.
 343 bool LoopPass::skipOptnoneFunction(const Loop *L) const {
 344   const Function *F = L->getHeader()->getParent();
 345   if (F && F->hasFnAttribute(Attribute::OptimizeNone)) {
 346     // FIXME: Report this to dbgs() only once per function.
 347     DEBUG(dbgs() << "Skipping pass '" << getPassName()
 348           << "' in function " << F->getName() << "\n");
 349     // FIXME: Delete loop from pass manager's queue?
 350     return true;
 351   }
 352   return false;
 353 }