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