lib/IR/LegacyPassManager.cpp

   1 //===- LegacyPassManager.cpp - LLVM Pass Infrastructure Implementation ----===//
   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 the legacy LLVM Pass Manager infrastructure.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14
  15 #include "llvm/IR/LLVMContext.h"
  16 #include "llvm/IR/IRPrintingPasses.h"
  17 #include "llvm/IR/LegacyPassManager.h"
  18 #include "llvm/IR/LegacyPassManagers.h"
  19 #include "llvm/IR/LegacyPassNameParser.h"
  20 #include "llvm/IR/Module.h"
  21 #include "llvm/Support/CommandLine.h"
  22 #include "llvm/Support/Debug.h"
  23 #include "llvm/Support/ErrorHandling.h"
  24 #include "llvm/Support/ManagedStatic.h"
  25 #include "llvm/Support/Mutex.h"
  26 #include "llvm/Support/TimeValue.h"
  27 #include "llvm/Support/Timer.h"
  28 #include "llvm/Support/raw_ostream.h"
  29 #include <algorithm>
  30 #include <map>
  31 using namespace llvm;
  32 using namespace llvm::legacy;
  33
  34 // See PassManagers.h for Pass Manager infrastructure overview.
  35
  36 //===----------------------------------------------------------------------===//
  37 // Pass debugging information.  Often it is useful to find out what pass is
  38 // running when a crash occurs in a utility.  When this library is compiled with
  39 // debugging on, a command line option (--debug-pass) is enabled that causes the
  40 // pass name to be printed before it executes.
  41 //
  42
  43 namespace {
  44 // Different debug levels that can be enabled...
  45 enum PassDebugLevel {
  46   Disabled, Arguments, Structure, Executions, Details
  47 };
  48 }
  49
  50 static cl::opt<enum PassDebugLevel>
  51 PassDebugging("debug-pass", cl::Hidden,
  52                   cl::desc("Print PassManager debugging information"),
  53                   cl::values(
  54   clEnumVal(Disabled  , "disable debug output"),
  55   clEnumVal(Arguments , "print pass arguments to pass to 'opt'"),
  56   clEnumVal(Structure , "print pass structure before run()"),
  57   clEnumVal(Executions, "print pass name before it is executed"),
  58   clEnumVal(Details   , "print pass details when it is executed"),
  59                              clEnumValEnd));
  60
  61 namespace {
  62 typedef llvm::cl::list<const llvm::PassInfo *, bool, PassNameParser>
  63 PassOptionList;
  64 }
  65
  66 // Print IR out before/after specified passes.
  67 static PassOptionList
  68 PrintBefore("print-before",
  69             llvm::cl::desc("Print IR before specified passes"),
  70             cl::Hidden);
  71
  72 static PassOptionList
  73 PrintAfter("print-after",
  74            llvm::cl::desc("Print IR after specified passes"),
  75            cl::Hidden);
  76
  77 static cl::opt<bool>
  78 PrintBeforeAll("print-before-all",
  79                llvm::cl::desc("Print IR before each pass"),
  80                cl::init(false));
  81 static cl::opt<bool>
  82 PrintAfterAll("print-after-all",
  83               llvm::cl::desc("Print IR after each pass"),
  84               cl::init(false));
  85
  86 /// This is a helper to determine whether to print IR before or
  87 /// after a pass.
  88
  89 static bool ShouldPrintBeforeOrAfterPass(const PassInfo *PI,
  90                                          PassOptionList &PassesToPrint) {
  91   for (auto *PassInf : PassesToPrint) {
  92     if (PassInf)
  93       if (PassInf->getPassArgument() == PI->getPassArgument()) {
  94         return true;
  95       }
  96   }
  97   return false;
  98 }
  99
 100 /// This is a utility to check whether a pass should have IR dumped
 101 /// before it.
 102 static bool ShouldPrintBeforePass(const PassInfo *PI) {
 103   return PrintBeforeAll || ShouldPrintBeforeOrAfterPass(PI, PrintBefore);
 104 }
 105
 106 /// This is a utility to check whether a pass should have IR dumped
 107 /// after it.
 108 static bool ShouldPrintAfterPass(const PassInfo *PI) {
 109   return PrintAfterAll || ShouldPrintBeforeOrAfterPass(PI, PrintAfter);
 110 }
 111
 112 /// isPassDebuggingExecutionsOrMore - Return true if -debug-pass=Executions
 113 /// or higher is specified.
 114 bool PMDataManager::isPassDebuggingExecutionsOrMore() const {
 115   return PassDebugging >= Executions;
 116 }
 117
 118
 119
 120
 121 void PassManagerPrettyStackEntry::print(raw_ostream &OS) const {
 122   if (!V && !M)
 123     OS << "Releasing pass '";
 124   else
 125     OS << "Running pass '";
 126
 127   OS << P->getPassName() << "'";
 128
 129   if (M) {
 130     OS << " on module '" << M->getModuleIdentifier() << "'.\n";
 131     return;
 132   }
 133   if (!V) {
 134     OS << '\n';
 135     return;
 136   }
 137
 138   OS << " on ";
 139   if (isa<Function>(V))
 140     OS << "function";
 141   else if (isa<BasicBlock>(V))
 142     OS << "basic block";
 143   else
 144     OS << "value";
 145
 146   OS << " '";
 147   V->printAsOperand(OS, /*PrintTy=*/false, M);
 148   OS << "'\n";
 149 }
 150
 151
 152 namespace {
 153 //===----------------------------------------------------------------------===//
 154 // BBPassManager
 155 //
 156 /// BBPassManager manages BasicBlockPass. It batches all the
 157 /// pass together and sequence them to process one basic block before
 158 /// processing next basic block.
 159 class BBPassManager : public PMDataManager, public FunctionPass {
 160
 161 public:
 162   static char ID;
 163   explicit BBPassManager()
 164     : PMDataManager(), FunctionPass(ID) {}
 165
 166   /// Execute all of the passes scheduled for execution.  Keep track of
 167   /// whether any of the passes modifies the function, and if so, return true.
 168   bool runOnFunction(Function &F) override;
 169
 170   /// Pass Manager itself does not invalidate any analysis info.
 171   void getAnalysisUsage(AnalysisUsage &Info) const override {
 172     Info.setPreservesAll();
 173   }
 174
 175   bool doInitialization(Module &M) override;
 176   bool doInitialization(Function &F);
 177   bool doFinalization(Module &M) override;
 178   bool doFinalization(Function &F);
 179
 180   PMDataManager *getAsPMDataManager() override { return this; }
 181   Pass *getAsPass() override { return this; }
 182
 183   const char *getPassName() const override {
 184     return "BasicBlock Pass Manager";
 185   }
 186
 187   // Print passes managed by this manager
 188   void dumpPassStructure(unsigned Offset) override {
 189     dbgs().indent(Offset*2) << "BasicBlockPass Manager\n";
 190     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 191       BasicBlockPass *BP = getContainedPass(Index);
 192       BP->dumpPassStructure(Offset + 1);
 193       dumpLastUses(BP, Offset+1);
 194     }
 195   }
 196
 197   BasicBlockPass *getContainedPass(unsigned N) {
 198     assert(N < PassVector.size() && "Pass number out of range!");
 199     BasicBlockPass *BP = static_cast<BasicBlockPass *>(PassVector[N]);
 200     return BP;
 201   }
 202
 203   PassManagerType getPassManagerType() const override {
 204     return PMT_BasicBlockPassManager;
 205   }
 206 };
 207
 208 char BBPassManager::ID = 0;
 209 } // End anonymous namespace
 210
 211 namespace llvm {
 212 namespace legacy {
 213 //===----------------------------------------------------------------------===//
 214 // FunctionPassManagerImpl
 215 //
 216 /// FunctionPassManagerImpl manages FPPassManagers
 217 class FunctionPassManagerImpl : public Pass,
 218                                 public PMDataManager,
 219                                 public PMTopLevelManager {
 220   virtual void anchor();
 221 private:
 222   bool wasRun;
 223 public:
 224   static char ID;
 225   explicit FunctionPassManagerImpl() :
 226     Pass(PT_PassManager, ID), PMDataManager(),
 227     PMTopLevelManager(new FPPassManager()), wasRun(false) {}
 228
 229   /// \copydoc FunctionPassManager::add()
 230   void add(Pass *P) {
 231     schedulePass(P);
 232   }
 233
 234   /// createPrinterPass - Get a function printer pass.
 235   Pass *createPrinterPass(raw_ostream &O,
 236                           const std::string &Banner) const override {
 237     return createPrintFunctionPass(O, Banner);
 238   }
 239
 240   // Prepare for running an on the fly pass, freeing memory if needed
 241   // from a previous run.
 242   void releaseMemoryOnTheFly();
 243
 244   /// run - Execute all of the passes scheduled for execution.  Keep track of
 245   /// whether any of the passes modifies the module, and if so, return true.
 246   bool run(Function &F);
 247
 248   /// doInitialization - Run all of the initializers for the function passes.
 249   ///
 250   bool doInitialization(Module &M) override;
 251
 252   /// doFinalization - Run all of the finalizers for the function passes.
 253   ///
 254   bool doFinalization(Module &M) override;
 255
 256
 257   PMDataManager *getAsPMDataManager() override { return this; }
 258   Pass *getAsPass() override { return this; }
 259   PassManagerType getTopLevelPassManagerType() override {
 260     return PMT_FunctionPassManager;
 261   }
 262
 263   /// Pass Manager itself does not invalidate any analysis info.
 264   void getAnalysisUsage(AnalysisUsage &Info) const override {
 265     Info.setPreservesAll();
 266   }
 267
 268   FPPassManager *getContainedManager(unsigned N) {
 269     assert(N < PassManagers.size() && "Pass number out of range!");
 270     FPPassManager *FP = static_cast<FPPassManager *>(PassManagers[N]);
 271     return FP;
 272   }
 273 };
 274
 275 void FunctionPassManagerImpl::anchor() {}
 276
 277 char FunctionPassManagerImpl::ID = 0;
 278 } // End of legacy namespace
 279 } // End of llvm namespace
 280
 281 namespace {
 282 //===----------------------------------------------------------------------===//
 283 // MPPassManager
 284 //
 285 /// MPPassManager manages ModulePasses and function pass managers.
 286 /// It batches all Module passes and function pass managers together and
 287 /// sequences them to process one module.
 288 class MPPassManager : public Pass, public PMDataManager {
 289 public:
 290   static char ID;
 291   explicit MPPassManager() :
 292     Pass(PT_PassManager, ID), PMDataManager() { }
 293
 294   // Delete on the fly managers.
 295   ~MPPassManager() override {
 296     for (auto &OnTheFlyManager : OnTheFlyManagers) {
 297       FunctionPassManagerImpl *FPP = OnTheFlyManager.second;
 298       delete FPP;
 299     }
 300   }
 301
 302   /// createPrinterPass - Get a module printer pass.
 303   Pass *createPrinterPass(raw_ostream &O,
 304                           const std::string &Banner) const override {
 305     return createPrintModulePass(O, Banner);
 306   }
 307
 308   /// run - Execute all of the passes scheduled for execution.  Keep track of
 309   /// whether any of the passes modifies the module, and if so, return true.
 310   bool runOnModule(Module &M);
 311
 312   using llvm::Pass::doInitialization;
 313   using llvm::Pass::doFinalization;
 314
 315   /// doInitialization - Run all of the initializers for the module passes.
 316   ///
 317   bool doInitialization();
 318
 319   /// doFinalization - Run all of the finalizers for the module passes.
 320   ///
 321   bool doFinalization();
 322
 323   /// Pass Manager itself does not invalidate any analysis info.
 324   void getAnalysisUsage(AnalysisUsage &Info) const override {
 325     Info.setPreservesAll();
 326   }
 327
 328   /// Add RequiredPass into list of lower level passes required by pass P.
 329   /// RequiredPass is run on the fly by Pass Manager when P requests it
 330   /// through getAnalysis interface.
 331   void addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) override;
 332
 333   /// Return function pass corresponding to PassInfo PI, that is
 334   /// required by module pass MP. Instantiate analysis pass, by using
 335   /// its runOnFunction() for function F.
 336   Pass* getOnTheFlyPass(Pass *MP, AnalysisID PI, Function &F) override;
 337
 338   const char *getPassName() const override {
 339     return "Module Pass Manager";
 340   }
 341
 342   PMDataManager *getAsPMDataManager() override { return this; }
 343   Pass *getAsPass() override { return this; }
 344
 345   // Print passes managed by this manager
 346   void dumpPassStructure(unsigned Offset) override {
 347     dbgs().indent(Offset*2) << "ModulePass Manager\n";
 348     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 349       ModulePass *MP = getContainedPass(Index);
 350       MP->dumpPassStructure(Offset + 1);
 351       std::map<Pass *, FunctionPassManagerImpl *>::const_iterator I =
 352         OnTheFlyManagers.find(MP);
 353       if (I != OnTheFlyManagers.end())
 354         I->second->dumpPassStructure(Offset + 2);
 355       dumpLastUses(MP, Offset+1);
 356     }
 357   }
 358
 359   ModulePass *getContainedPass(unsigned N) {
 360     assert(N < PassVector.size() && "Pass number out of range!");
 361     return static_cast<ModulePass *>(PassVector[N]);
 362   }
 363
 364   PassManagerType getPassManagerType() const override {
 365     return PMT_ModulePassManager;
 366   }
 367
 368  private:
 369   /// Collection of on the fly FPPassManagers. These managers manage
 370   /// function passes that are required by module passes.
 371   std::map<Pass *, FunctionPassManagerImpl *> OnTheFlyManagers;
 372 };
 373
 374 char MPPassManager::ID = 0;
 375 } // End anonymous namespace
 376
 377 namespace llvm {
 378 namespace legacy {
 379 //===----------------------------------------------------------------------===//
 380 // PassManagerImpl
 381 //
 382
 383 /// PassManagerImpl manages MPPassManagers
 384 class PassManagerImpl : public Pass,
 385                         public PMDataManager,
 386                         public PMTopLevelManager {
 387   virtual void anchor();
 388
 389 public:
 390   static char ID;
 391   explicit PassManagerImpl() :
 392     Pass(PT_PassManager, ID), PMDataManager(),
 393                               PMTopLevelManager(new MPPassManager()) {}
 394
 395   /// \copydoc PassManager::add()
 396   void add(Pass *P) {
 397     schedulePass(P);
 398   }
 399
 400   /// createPrinterPass - Get a module printer pass.
 401   Pass *createPrinterPass(raw_ostream &O,
 402                           const std::string &Banner) const override {
 403     return createPrintModulePass(O, Banner);
 404   }
 405
 406   /// run - Execute all of the passes scheduled for execution.  Keep track of
 407   /// whether any of the passes modifies the module, and if so, return true.
 408   bool run(Module &M);
 409
 410   using llvm::Pass::doInitialization;
 411   using llvm::Pass::doFinalization;
 412
 413   /// doInitialization - Run all of the initializers for the module passes.
 414   ///
 415   bool doInitialization();
 416
 417   /// doFinalization - Run all of the finalizers for the module passes.
 418   ///
 419   bool doFinalization();
 420
 421   /// Pass Manager itself does not invalidate any analysis info.
 422   void getAnalysisUsage(AnalysisUsage &Info) const override {
 423     Info.setPreservesAll();
 424   }
 425
 426   PMDataManager *getAsPMDataManager() override { return this; }
 427   Pass *getAsPass() override { return this; }
 428   PassManagerType getTopLevelPassManagerType() override {
 429     return PMT_ModulePassManager;
 430   }
 431
 432   MPPassManager *getContainedManager(unsigned N) {
 433     assert(N < PassManagers.size() && "Pass number out of range!");
 434     MPPassManager *MP = static_cast<MPPassManager *>(PassManagers[N]);
 435     return MP;
 436   }
 437 };
 438
 439 void PassManagerImpl::anchor() {}
 440
 441 char PassManagerImpl::ID = 0;
 442 } // End of legacy namespace
 443 } // End of llvm namespace
 444
 445 namespace {
 446
 447 //===----------------------------------------------------------------------===//
 448 /// TimingInfo Class - This class is used to calculate information about the
 449 /// amount of time each pass takes to execute.  This only happens when
 450 /// -time-passes is enabled on the command line.
 451 ///
 452
 453 static ManagedStatic<sys::SmartMutex<true> > TimingInfoMutex;
 454
 455 class TimingInfo {
 456   DenseMap<Pass*, Timer*> TimingData;
 457   TimerGroup TG;
 458 public:
 459   // Use 'create' member to get this.
 460   TimingInfo() : TG("... Pass execution timing report ...") {}
 461
 462   // TimingDtor - Print out information about timing information
 463   ~TimingInfo() {
 464     // Delete all of the timers, which accumulate their info into the
 465     // TimerGroup.
 466     for (auto &I : TimingData)
 467       delete I.second;
 468     // TimerGroup is deleted next, printing the report.
 469   }
 470
 471   // createTheTimeInfo - This method either initializes the TheTimeInfo pointer
 472   // to a non-null value (if the -time-passes option is enabled) or it leaves it
 473   // null.  It may be called multiple times.
 474   static void createTheTimeInfo();
 475
 476   /// getPassTimer - Return the timer for the specified pass if it exists.
 477   Timer *getPassTimer(Pass *P) {
 478     if (P->getAsPMDataManager())
 479       return nullptr;
 480
 481     sys::SmartScopedLock<true> Lock(*TimingInfoMutex);
 482     Timer *&T = TimingData[P];
 483     if (!T)
 484       T = new Timer(P->getPassName(), TG);
 485     return T;
 486   }
 487 };
 488
 489 } // End of anon namespace
 490
 491 static TimingInfo *TheTimeInfo;
 492
 493 //===----------------------------------------------------------------------===//
 494 // PMTopLevelManager implementation
 495
 496 /// Initialize top level manager. Create first pass manager.
 497 PMTopLevelManager::PMTopLevelManager(PMDataManager *PMDM) {
 498   PMDM->setTopLevelManager(this);
 499   addPassManager(PMDM);
 500   activeStack.push(PMDM);
 501 }
 502
 503 /// Set pass P as the last user of the given analysis passes.
 504 void
 505 PMTopLevelManager::setLastUser(ArrayRef<Pass*> AnalysisPasses, Pass *P) {
 506   unsigned PDepth = 0;
 507   if (P->getResolver())
 508     PDepth = P->getResolver()->getPMDataManager().getDepth();
 509
 510   for (Pass *AP : AnalysisPasses) {
 511     LastUser[AP] = P;
 512
 513     if (P == AP)
 514       continue;
 515
 516     // Update the last users of passes that are required transitive by AP.
 517     AnalysisUsage *AnUsage = findAnalysisUsage(AP);
 518     const AnalysisUsage::VectorType &IDs = AnUsage->getRequiredTransitiveSet();
 519     SmallVector<Pass *, 12> LastUses;
 520     SmallVector<Pass *, 12> LastPMUses;
 521     for (AnalysisUsage::VectorType::const_iterator I = IDs.begin(),
 522          E = IDs.end(); I != E; ++I) {
 523       Pass *AnalysisPass = findAnalysisPass(*I);
 524       assert(AnalysisPass && "Expected analysis pass to exist.");
 525       AnalysisResolver *AR = AnalysisPass->getResolver();
 526       assert(AR && "Expected analysis resolver to exist.");
 527       unsigned APDepth = AR->getPMDataManager().getDepth();
 528
 529       if (PDepth == APDepth)
 530         LastUses.push_back(AnalysisPass);
 531       else if (PDepth > APDepth)
 532         LastPMUses.push_back(AnalysisPass);
 533     }
 534
 535     setLastUser(LastUses, P);
 536
 537     // If this pass has a corresponding pass manager, push higher level
 538     // analysis to this pass manager.
 539     if (P->getResolver())
 540       setLastUser(LastPMUses, P->getResolver()->getPMDataManager().getAsPass());
 541
 542
 543     // If AP is the last user of other passes then make P last user of
 544     // such passes.
 545     for (DenseMap<Pass *, Pass *>::iterator LUI = LastUser.begin(),
 546            LUE = LastUser.end(); LUI != LUE; ++LUI) {
 547       if (LUI->second == AP)
 548         // DenseMap iterator is not invalidated here because
 549         // this is just updating existing entries.
 550         LastUser[LUI->first] = P;
 551     }
 552   }
 553 }
 554
 555 /// Collect passes whose last user is P
 556 void PMTopLevelManager::collectLastUses(SmallVectorImpl<Pass *> &LastUses,
 557                                         Pass *P) {
 558   DenseMap<Pass *, SmallPtrSet<Pass *, 8> >::iterator DMI =
 559     InversedLastUser.find(P);
 560   if (DMI == InversedLastUser.end())
 561     return;
 562
 563   SmallPtrSet<Pass *, 8> &LU = DMI->second;
 564   for (Pass *LUP : LU) {
 565     LastUses.push_back(LUP);
 566   }
 567
 568 }
 569
 570 AnalysisUsage *PMTopLevelManager::findAnalysisUsage(Pass *P) {
 571   AnalysisUsage *AnUsage = nullptr;
 572   DenseMap<Pass *, AnalysisUsage *>::iterator DMI = AnUsageMap.find(P);
 573   if (DMI != AnUsageMap.end())
 574     AnUsage = DMI->second;
 575   else {
 576     AnUsage = new AnalysisUsage();
 577     P->getAnalysisUsage(*AnUsage);
 578     AnUsageMap[P] = AnUsage;
 579   }
 580   return AnUsage;
 581 }
 582
 583 /// Schedule pass P for execution. Make sure that passes required by
 584 /// P are run before P is run. Update analysis info maintained by
 585 /// the manager. Remove dead passes. This is a recursive function.
 586 void PMTopLevelManager::schedulePass(Pass *P) {
 587
 588   // TODO : Allocate function manager for this pass, other wise required set
 589   // may be inserted into previous function manager
 590
 591   // Give pass a chance to prepare the stage.
 592   P->preparePassManager(activeStack);
 593
 594   // If P is an analysis pass and it is available then do not
 595   // generate the analysis again. Stale analysis info should not be
 596   // available at this point.
 597   const PassInfo *PI = findAnalysisPassInfo(P->getPassID());
 598   if (PI && PI->isAnalysis() && findAnalysisPass(P->getPassID())) {
 599     delete P;
 600     return;
 601   }
 602
 603   AnalysisUsage *AnUsage = findAnalysisUsage(P);
 604
 605   bool checkAnalysis = true;
 606   while (checkAnalysis) {
 607     checkAnalysis = false;
 608
 609     const AnalysisUsage::VectorType &RequiredSet = AnUsage->getRequiredSet();
 610     for (AnalysisUsage::VectorType::const_iterator I = RequiredSet.begin(),
 611            E = RequiredSet.end(); I != E; ++I) {
 612
 613       Pass *AnalysisPass = findAnalysisPass(*I);
 614       if (!AnalysisPass) {
 615         const PassInfo *PI = findAnalysisPassInfo(*I);
 616
 617         if (!PI) {
 618           // Pass P is not in the global PassRegistry
 619           dbgs() << "Pass '"  << P->getPassName() << "' is not initialized." << "\n";
 620           dbgs() << "Verify if there is a pass dependency cycle." << "\n";
 621           dbgs() << "Required Passes:" << "\n";
 622           for (AnalysisUsage::VectorType::const_iterator I2 = RequiredSet.begin(),
 623                  E = RequiredSet.end(); I2 != E && I2 != I; ++I2) {
 624             Pass *AnalysisPass2 = findAnalysisPass(*I2);
 625             if (AnalysisPass2) {
 626               dbgs() << "\t" << AnalysisPass2->getPassName() << "\n";
 627             } else {
 628               dbgs() << "\t"   << "Error: Required pass not found! Possible causes:"  << "\n";
 629               dbgs() << "\t\t" << "- Pass misconfiguration (e.g.: missing macros)"    << "\n";
 630               dbgs() << "\t\t" << "- Corruption of the global PassRegistry"           << "\n";
 631             }
 632           }
 633         }
 634
 635         assert(PI && "Expected required passes to be initialized");
 636         AnalysisPass = PI->createPass();
 637         if (P->getPotentialPassManagerType () ==
 638             AnalysisPass->getPotentialPassManagerType())
 639           // Schedule analysis pass that is managed by the same pass manager.
 640           schedulePass(AnalysisPass);
 641         else if (P->getPotentialPassManagerType () >
 642                  AnalysisPass->getPotentialPassManagerType()) {
 643           // Schedule analysis pass that is managed by a new manager.
 644           schedulePass(AnalysisPass);
 645           // Recheck analysis passes to ensure that required analyses that
 646           // are already checked are still available.
 647           checkAnalysis = true;
 648         } else
 649           // Do not schedule this analysis. Lower level analysis
 650           // passes are run on the fly.
 651           delete AnalysisPass;
 652       }
 653     }
 654   }
 655
 656   // Now all required passes are available.
 657   if (ImmutablePass *IP = P->getAsImmutablePass()) {
 658     // P is a immutable pass and it will be managed by this
 659     // top level manager. Set up analysis resolver to connect them.
 660     PMDataManager *DM = getAsPMDataManager();
 661     AnalysisResolver *AR = new AnalysisResolver(*DM);
 662     P->setResolver(AR);
 663     DM->initializeAnalysisImpl(P);
 664     addImmutablePass(IP);
 665     DM->recordAvailableAnalysis(IP);
 666     return;
 667   }
 668
 669   if (PI && !PI->isAnalysis() && ShouldPrintBeforePass(PI)) {
 670     Pass *PP = P->createPrinterPass(
 671       dbgs(), std::string("*** IR Dump Before ") + P->getPassName() + " ***");
 672     PP->assignPassManager(activeStack, getTopLevelPassManagerType());
 673   }
 674
 675   // Add the requested pass to the best available pass manager.
 676   P->assignPassManager(activeStack, getTopLevelPassManagerType());
 677
 678   if (PI && !PI->isAnalysis() && ShouldPrintAfterPass(PI)) {
 679     Pass *PP = P->createPrinterPass(
 680       dbgs(), std::string("*** IR Dump After ") + P->getPassName() + " ***");
 681     PP->assignPassManager(activeStack, getTopLevelPassManagerType());
 682   }
 683 }
 684
 685 /// Find the pass that implements Analysis AID. Search immutable
 686 /// passes and all pass managers. If desired pass is not found
 687 /// then return NULL.
 688 Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
 689
 690   // Check pass managers
 691   for (PMDataManager *PassManager : PassManagers)
 692     if (Pass *P = PassManager->findAnalysisPass(AID, false))
 693       return P;
 694
 695   // Check other pass managers
 696   for (PMDataManager *IndirectPassManager : IndirectPassManagers)
 697     if (Pass *P = IndirectPassManager->findAnalysisPass(AID, false))
 698       return P;
 699
 700   // Check the immutable passes. Iterate in reverse order so that we find
 701   // the most recently registered passes first.
 702   for (auto I = ImmutablePasses.rbegin(), E = ImmutablePasses.rend(); I != E;
 703        ++I) {
 704     AnalysisID PI = (*I)->getPassID();
 705     if (PI == AID)
 706       return *I;
 707
 708     // If Pass not found then check the interfaces implemented by Immutable Pass
 709     const PassInfo *PassInf = findAnalysisPassInfo(PI);
 710     assert(PassInf && "Expected all immutable passes to be initialized");
 711     const std::vector<const PassInfo*> &ImmPI =
 712       PassInf->getInterfacesImplemented();
 713     for (const PassInfo *PI : ImmPI)
 714       if (PI->getTypeInfo() == AID)
 715         return *I;
 716   }
 717
 718   return nullptr;
 719 }
 720
 721 const PassInfo *PMTopLevelManager::findAnalysisPassInfo(AnalysisID AID) const {
 722   const PassInfo *&PI = AnalysisPassInfos[AID];
 723   if (!PI)
 724     PI = PassRegistry::getPassRegistry()->getPassInfo(AID);
 725   else
 726     assert(PI == PassRegistry::getPassRegistry()->getPassInfo(AID) &&
 727            "The pass info pointer changed for an analysis ID!");
 728
 729   return PI;
 730 }
 731
 732 // Print passes managed by this top level manager.
 733 void PMTopLevelManager::dumpPasses() const {
 734
 735   if (PassDebugging < Structure)
 736     return;
 737
 738   // Print out the immutable passes
 739   for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
 740     ImmutablePasses[i]->dumpPassStructure(0);
 741   }
 742
 743   // Every class that derives from PMDataManager also derives from Pass
 744   // (sometimes indirectly), but there's no inheritance relationship
 745   // between PMDataManager and Pass, so we have to getAsPass to get
 746   // from a PMDataManager* to a Pass*.
 747   for (PMDataManager *Manager : PassManagers)
 748     Manager->getAsPass()->dumpPassStructure(1);
 749 }
 750
 751 void PMTopLevelManager::dumpArguments() const {
 752
 753   if (PassDebugging < Arguments)
 754     return;
 755
 756   dbgs() << "Pass Arguments: ";
 757   for (SmallVectorImpl<ImmutablePass *>::const_iterator I =
 758        ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
 759     if (const PassInfo *PI = findAnalysisPassInfo((*I)->getPassID())) {
 760       assert(PI && "Expected all immutable passes to be initialized");
 761       if (!PI->isAnalysisGroup())
 762         dbgs() << " -" << PI->getPassArgument();
 763     }
 764   for (SmallVectorImpl<PMDataManager *>::const_iterator I =
 765        PassManagers.begin(), E = PassManagers.end(); I != E; ++I)
 766     (*I)->dumpPassArguments();
 767   dbgs() << "\n";
 768 }
 769
 770 void PMTopLevelManager::initializeAllAnalysisInfo() {
 771   for (SmallVectorImpl<PMDataManager *>::iterator I = PassManagers.begin(),
 772          E = PassManagers.end(); I != E; ++I)
 773     (*I)->initializeAnalysisInfo();
 774
 775   // Initailize other pass managers
 776   for (SmallVectorImpl<PMDataManager *>::iterator
 777        I = IndirectPassManagers.begin(), E = IndirectPassManagers.end();
 778        I != E; ++I)
 779     (*I)->initializeAnalysisInfo();
 780
 781   for (DenseMap<Pass *, Pass *>::iterator DMI = LastUser.begin(),
 782         DME = LastUser.end(); DMI != DME; ++DMI) {
 783     DenseMap<Pass *, SmallPtrSet<Pass *, 8> >::iterator InvDMI =
 784       InversedLastUser.find(DMI->second);
 785     if (InvDMI != InversedLastUser.end()) {
 786       SmallPtrSet<Pass *, 8> &L = InvDMI->second;
 787       L.insert(DMI->first);
 788     } else {
 789       SmallPtrSet<Pass *, 8> L; L.insert(DMI->first);
 790       InversedLastUser[DMI->second] = L;
 791     }
 792   }
 793 }
 794
 795 /// Destructor
 796 PMTopLevelManager::~PMTopLevelManager() {
 797   for (SmallVectorImpl<PMDataManager *>::iterator I = PassManagers.begin(),
 798          E = PassManagers.end(); I != E; ++I)
 799     delete *I;
 800
 801   for (SmallVectorImpl<ImmutablePass *>::iterator
 802          I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
 803     delete *I;
 804
 805   for (DenseMap<Pass *, AnalysisUsage *>::iterator DMI = AnUsageMap.begin(),
 806          DME = AnUsageMap.end(); DMI != DME; ++DMI)
 807     delete DMI->second;
 808 }
 809
 810 //===----------------------------------------------------------------------===//
 811 // PMDataManager implementation
 812
 813 /// Augement AvailableAnalysis by adding analysis made available by pass P.
 814 void PMDataManager::recordAvailableAnalysis(Pass *P) {
 815   AnalysisID PI = P->getPassID();
 816
 817   AvailableAnalysis[PI] = P;
 818
 819   assert(!AvailableAnalysis.empty());
 820
 821   // This pass is the current implementation of all of the interfaces it
 822   // implements as well.
 823   const PassInfo *PInf = TPM->findAnalysisPassInfo(PI);
 824   if (!PInf) return;
 825   const std::vector<const PassInfo*> &II = PInf->getInterfacesImplemented();
 826   for (unsigned i = 0, e = II.size(); i != e; ++i)
 827     AvailableAnalysis[II[i]->getTypeInfo()] = P;
 828 }
 829
 830 // Return true if P preserves high level analysis used by other
 831 // passes managed by this manager
 832 bool PMDataManager::preserveHigherLevelAnalysis(Pass *P) {
 833   AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
 834   if (AnUsage->getPreservesAll())
 835     return true;
 836
 837   const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
 838   for (SmallVectorImpl<Pass *>::iterator I = HigherLevelAnalysis.begin(),
 839          E = HigherLevelAnalysis.end(); I  != E; ++I) {
 840     Pass *P1 = *I;
 841     if (P1->getAsImmutablePass() == nullptr &&
 842         std::find(PreservedSet.begin(), PreservedSet.end(),
 843                   P1->getPassID()) ==
 844            PreservedSet.end())
 845       return false;
 846   }
 847
 848   return true;
 849 }
 850
 851 /// verifyPreservedAnalysis -- Verify analysis preserved by pass P.
 852 void PMDataManager::verifyPreservedAnalysis(Pass *P) {
 853   // Don't do this unless assertions are enabled.
 854 #ifdef NDEBUG
 855   return;
 856 #endif
 857   AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
 858   const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
 859
 860   // Verify preserved analysis
 861   for (AnalysisUsage::VectorType::const_iterator I = PreservedSet.begin(),
 862          E = PreservedSet.end(); I != E; ++I) {
 863     AnalysisID AID = *I;
 864     if (Pass *AP = findAnalysisPass(AID, true)) {
 865       TimeRegion PassTimer(getPassTimer(AP));
 866       AP->verifyAnalysis();
 867     }
 868   }
 869 }
 870
 871 /// Remove Analysis not preserved by Pass P
 872 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
 873   AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
 874   if (AnUsage->getPreservesAll())
 875     return;
 876
 877   const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
 878   for (DenseMap<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
 879          E = AvailableAnalysis.end(); I != E; ) {
 880     DenseMap<AnalysisID, Pass*>::iterator Info = I++;
 881     if (Info->second->getAsImmutablePass() == nullptr &&
 882         std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
 883         PreservedSet.end()) {
 884       // Remove this analysis
 885       if (PassDebugging >= Details) {
 886         Pass *S = Info->second;
 887         dbgs() << " -- '" <<  P->getPassName() << "' is not preserving '";
 888         dbgs() << S->getPassName() << "'\n";
 889       }
 890       AvailableAnalysis.erase(Info);
 891     }
 892   }
 893
 894   // Check inherited analysis also. If P is not preserving analysis
 895   // provided by parent manager then remove it here.
 896   for (unsigned Index = 0; Index < PMT_Last; ++Index) {
 897
 898     if (!InheritedAnalysis[Index])
 899       continue;
 900
 901     for (DenseMap<AnalysisID, Pass*>::iterator
 902            I = InheritedAnalysis[Index]->begin(),
 903            E = InheritedAnalysis[Index]->end(); I != E; ) {
 904       DenseMap<AnalysisID, Pass *>::iterator Info = I++;
 905       if (Info->second->getAsImmutablePass() == nullptr &&
 906           std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
 907              PreservedSet.end()) {
 908         // Remove this analysis
 909         if (PassDebugging >= Details) {
 910           Pass *S = Info->second;
 911           dbgs() << " -- '" <<  P->getPassName() << "' is not preserving '";
 912           dbgs() << S->getPassName() << "'\n";
 913         }
 914         InheritedAnalysis[Index]->erase(Info);
 915       }
 916     }
 917   }
 918 }
 919
 920 /// Remove analysis passes that are not used any longer
 921 void PMDataManager::removeDeadPasses(Pass *P, StringRef Msg,
 922                                      enum PassDebuggingString DBG_STR) {
 923
 924   SmallVector<Pass *, 12> DeadPasses;
 925
 926   // If this is a on the fly manager then it does not have TPM.
 927   if (!TPM)
 928     return;
 929
 930   TPM->collectLastUses(DeadPasses, P);
 931
 932   if (PassDebugging >= Details && !DeadPasses.empty()) {
 933     dbgs() << " -*- '" <<  P->getPassName();
 934     dbgs() << "' is the last user of following pass instances.";
 935     dbgs() << " Free these instances\n";
 936   }
 937
 938   for (SmallVectorImpl<Pass *>::iterator I = DeadPasses.begin(),
 939          E = DeadPasses.end(); I != E; ++I)
 940     freePass(*I, Msg, DBG_STR);
 941 }
 942
 943 void PMDataManager::freePass(Pass *P, StringRef Msg,
 944                              enum PassDebuggingString DBG_STR) {
 945   dumpPassInfo(P, FREEING_MSG, DBG_STR, Msg);
 946
 947   {
 948     // If the pass crashes releasing memory, remember this.
 949     PassManagerPrettyStackEntry X(P);
 950     TimeRegion PassTimer(getPassTimer(P));
 951
 952     P->releaseMemory();
 953   }
 954
 955   AnalysisID PI = P->getPassID();
 956   if (const PassInfo *PInf = TPM->findAnalysisPassInfo(PI)) {
 957     // Remove the pass itself (if it is not already removed).
 958     AvailableAnalysis.erase(PI);
 959
 960     // Remove all interfaces this pass implements, for which it is also
 961     // listed as the available implementation.
 962     const std::vector<const PassInfo*> &II = PInf->getInterfacesImplemented();
 963     for (unsigned i = 0, e = II.size(); i != e; ++i) {
 964       DenseMap<AnalysisID, Pass*>::iterator Pos =
 965         AvailableAnalysis.find(II[i]->getTypeInfo());
 966       if (Pos != AvailableAnalysis.end() && Pos->second == P)
 967         AvailableAnalysis.erase(Pos);
 968     }
 969   }
 970 }
 971
 972 /// Add pass P into the PassVector. Update
 973 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
 974 void PMDataManager::add(Pass *P, bool ProcessAnalysis) {
 975   // This manager is going to manage pass P. Set up analysis resolver
 976   // to connect them.
 977   AnalysisResolver *AR = new AnalysisResolver(*this);
 978   P->setResolver(AR);
 979
 980   // If a FunctionPass F is the last user of ModulePass info M
 981   // then the F's manager, not F, records itself as a last user of M.
 982   SmallVector<Pass *, 12> TransferLastUses;
 983
 984   if (!ProcessAnalysis) {
 985     // Add pass
 986     PassVector.push_back(P);
 987     return;
 988   }
 989
 990   // At the moment, this pass is the last user of all required passes.
 991   SmallVector<Pass *, 12> LastUses;
 992   SmallVector<Pass *, 8> RequiredPasses;
 993   SmallVector<AnalysisID, 8> ReqAnalysisNotAvailable;
 994
 995   unsigned PDepth = this->getDepth();
 996
 997   collectRequiredAnalysis(RequiredPasses,
 998                           ReqAnalysisNotAvailable, P);
 999   for (Pass *PRequired : RequiredPasses) {
1000     unsigned RDepth = 0;
1001
1002     assert(PRequired->getResolver() && "Analysis Resolver is not set");
1003     PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
1004     RDepth = DM.getDepth();
1005
1006     if (PDepth == RDepth)
1007       LastUses.push_back(PRequired);
1008     else if (PDepth > RDepth) {
1009       // Let the parent claim responsibility of last use
1010       TransferLastUses.push_back(PRequired);
1011       // Keep track of higher level analysis used by this manager.
1012       HigherLevelAnalysis.push_back(PRequired);
1013     } else
1014       llvm_unreachable("Unable to accommodate Required Pass");
1015   }
1016
1017   // Set P as P's last user until someone starts using P.
1018   // However, if P is a Pass Manager then it does not need
1019   // to record its last user.
1020   if (!P->getAsPMDataManager())
1021     LastUses.push_back(P);
1022   TPM->setLastUser(LastUses, P);
1023
1024   if (!TransferLastUses.empty()) {
1025     Pass *My_PM = getAsPass();
1026     TPM->setLastUser(TransferLastUses, My_PM);
1027     TransferLastUses.clear();
1028   }
1029
1030   // Now, take care of required analyses that are not available.
1031   for (AnalysisID ID : ReqAnalysisNotAvailable) {
1032     const PassInfo *PI = TPM->findAnalysisPassInfo(ID);
1033     Pass *AnalysisPass = PI->createPass();
1034     this->addLowerLevelRequiredPass(P, AnalysisPass);
1035   }
1036
1037   // Take a note of analysis required and made available by this pass.
1038   // Remove the analysis not preserved by this pass
1039   removeNotPreservedAnalysis(P);
1040   recordAvailableAnalysis(P);
1041
1042   // Add pass
1043   PassVector.push_back(P);
1044 }
1045
1046
1047 /// Populate RP with analysis pass that are required by
1048 /// pass P and are available. Populate RP_NotAvail with analysis
1049 /// pass that are required by pass P but are not available.
1050 void PMDataManager::collectRequiredAnalysis(SmallVectorImpl<Pass *> &RP,
1051                                        SmallVectorImpl<AnalysisID> &RP_NotAvail,
1052                                             Pass *P) {
1053   AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
1054   for (const auto &RequiredID : AnUsage->getRequiredSet())
1055     if (Pass *AnalysisPass = findAnalysisPass(RequiredID, true))
1056       RP.push_back(AnalysisPass);
1057     else
1058       RP_NotAvail.push_back(RequiredID);
1059
1060   for (const auto &RequiredID : AnUsage->getRequiredTransitiveSet())
1061     if (Pass *AnalysisPass = findAnalysisPass(RequiredID, true))
1062       RP.push_back(AnalysisPass);
1063     else
1064       RP_NotAvail.push_back(RequiredID);
1065 }
1066
1067 // All Required analyses should be available to the pass as it runs!  Here
1068 // we fill in the AnalysisImpls member of the pass so that it can
1069 // successfully use the getAnalysis() method to retrieve the
1070 // implementations it needs.
1071 //
1072 void PMDataManager::initializeAnalysisImpl(Pass *P) {
1073   AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
1074
1075   for (AnalysisUsage::VectorType::const_iterator
1076          I = AnUsage->getRequiredSet().begin(),
1077          E = AnUsage->getRequiredSet().end(); I != E; ++I) {
1078     Pass *Impl = findAnalysisPass(*I, true);
1079     if (!Impl)
1080       // This may be analysis pass that is initialized on the fly.
1081       // If that is not the case then it will raise an assert when it is used.
1082       continue;
1083     AnalysisResolver *AR = P->getResolver();
1084     assert(AR && "Analysis Resolver is not set");
1085     AR->addAnalysisImplsPair(*I, Impl);
1086   }
1087 }
1088
1089 /// Find the pass that implements Analysis AID. If desired pass is not found
1090 /// then return NULL.
1091 Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
1092
1093   // Check if AvailableAnalysis map has one entry.
1094   DenseMap<AnalysisID, Pass*>::const_iterator I =  AvailableAnalysis.find(AID);
1095
1096   if (I != AvailableAnalysis.end())
1097     return I->second;
1098
1099   // Search Parents through TopLevelManager
1100   if (SearchParent)
1101     return TPM->findAnalysisPass(AID);
1102
1103   return nullptr;
1104 }
1105
1106 // Print list of passes that are last used by P.
1107 void PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{
1108
1109   SmallVector<Pass *, 12> LUses;
1110
1111   // If this is a on the fly manager then it does not have TPM.
1112   if (!TPM)
1113     return;
1114
1115   TPM->collectLastUses(LUses, P);
1116
1117   for (SmallVectorImpl<Pass *>::iterator I = LUses.begin(),
1118          E = LUses.end(); I != E; ++I) {
1119     dbgs() << "--" << std::string(Offset*2, ' ');
1120     (*I)->dumpPassStructure(0);
1121   }
1122 }
1123
1124 void PMDataManager::dumpPassArguments() const {
1125   for (SmallVectorImpl<Pass *>::const_iterator I = PassVector.begin(),
1126         E = PassVector.end(); I != E; ++I) {
1127     if (PMDataManager *PMD = (*I)->getAsPMDataManager())
1128       PMD->dumpPassArguments();
1129     else
1130       if (const PassInfo *PI =
1131             TPM->findAnalysisPassInfo((*I)->getPassID()))
1132         if (!PI->isAnalysisGroup())
1133           dbgs() << " -" << PI->getPassArgument();
1134   }
1135 }
1136
1137 void PMDataManager::dumpPassInfo(Pass *P, enum PassDebuggingString S1,
1138                                  enum PassDebuggingString S2,
1139                                  StringRef Msg) {
1140   if (PassDebugging < Executions)
1141     return;
1142   dbgs() << "[" << sys::TimeValue::now().str() << "] " << (void *)this
1143          << std::string(getDepth() * 2 + 1, ' ');
1144   switch (S1) {
1145   case EXECUTION_MSG:
1146     dbgs() << "Executing Pass '" << P->getPassName();
1147     break;
1148   case MODIFICATION_MSG:
1149     dbgs() << "Made Modification '" << P->getPassName();
1150     break;
1151   case FREEING_MSG:
1152     dbgs() << " Freeing Pass '" << P->getPassName();
1153     break;
1154   default:
1155     break;
1156   }
1157   switch (S2) {
1158   case ON_BASICBLOCK_MSG:
1159     dbgs() << "' on BasicBlock '" << Msg << "'...\n";
1160     break;
1161   case ON_FUNCTION_MSG:
1162     dbgs() << "' on Function '" << Msg << "'...\n";
1163     break;
1164   case ON_MODULE_MSG:
1165     dbgs() << "' on Module '"  << Msg << "'...\n";
1166     break;
1167   case ON_REGION_MSG:
1168     dbgs() << "' on Region '"  << Msg << "'...\n";
1169     break;
1170   case ON_LOOP_MSG:
1171     dbgs() << "' on Loop '" << Msg << "'...\n";
1172     break;
1173   case ON_CG_MSG:
1174     dbgs() << "' on Call Graph Nodes '" << Msg << "'...\n";
1175     break;
1176   default:
1177     break;
1178   }
1179 }
1180
1181 void PMDataManager::dumpRequiredSet(const Pass *P) const {
1182   if (PassDebugging < Details)
1183     return;
1184
1185   AnalysisUsage analysisUsage;
1186   P->getAnalysisUsage(analysisUsage);
1187   dumpAnalysisUsage("Required", P, analysisUsage.getRequiredSet());
1188 }
1189
1190 void PMDataManager::dumpPreservedSet(const Pass *P) const {
1191   if (PassDebugging < Details)
1192     return;
1193
1194   AnalysisUsage analysisUsage;
1195   P->getAnalysisUsage(analysisUsage);
1196   dumpAnalysisUsage("Preserved", P, analysisUsage.getPreservedSet());
1197 }
1198
1199 void PMDataManager::dumpAnalysisUsage(StringRef Msg, const Pass *P,
1200                                    const AnalysisUsage::VectorType &Set) const {
1201   assert(PassDebugging >= Details);
1202   if (Set.empty())
1203     return;
1204   dbgs() << (const void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:";
1205   for (unsigned i = 0; i != Set.size(); ++i) {
1206     if (i) dbgs() << ',';
1207     const PassInfo *PInf = TPM->findAnalysisPassInfo(Set[i]);
1208     if (!PInf) {
1209       // Some preserved passes, such as AliasAnalysis, may not be initialized by
1210       // all drivers.
1211       dbgs() << " Uninitialized Pass";
1212       continue;
1213     }
1214     dbgs() << ' ' << PInf->getPassName();
1215   }
1216   dbgs() << '\n';
1217 }
1218
1219 /// Add RequiredPass into list of lower level passes required by pass P.
1220 /// RequiredPass is run on the fly by Pass Manager when P requests it
1221 /// through getAnalysis interface.
1222 /// This should be handled by specific pass manager.
1223 void PMDataManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
1224   if (TPM) {
1225     TPM->dumpArguments();
1226     TPM->dumpPasses();
1227   }
1228
1229   // Module Level pass may required Function Level analysis info
1230   // (e.g. dominator info). Pass manager uses on the fly function pass manager
1231   // to provide this on demand. In that case, in Pass manager terminology,
1232   // module level pass is requiring lower level analysis info managed by
1233   // lower level pass manager.
1234
1235   // When Pass manager is not able to order required analysis info, Pass manager
1236   // checks whether any lower level manager will be able to provide this
1237   // analysis info on demand or not.
1238 #ifndef NDEBUG
1239   dbgs() << "Unable to schedule '" << RequiredPass->getPassName();
1240   dbgs() << "' required by '" << P->getPassName() << "'\n";
1241 #endif
1242   llvm_unreachable("Unable to schedule pass");
1243 }
1244
1245 Pass *PMDataManager::getOnTheFlyPass(Pass *P, AnalysisID PI, Function &F) {
1246   llvm_unreachable("Unable to find on the fly pass");
1247 }
1248
1249 // Destructor
1250 PMDataManager::~PMDataManager() {
1251   for (SmallVectorImpl<Pass *>::iterator I = PassVector.begin(),
1252          E = PassVector.end(); I != E; ++I)
1253     delete *I;
1254 }
1255
1256 //===----------------------------------------------------------------------===//
1257 // NOTE: Is this the right place to define this method ?
1258 // getAnalysisIfAvailable - Return analysis result or null if it doesn't exist.
1259 Pass *AnalysisResolver::getAnalysisIfAvailable(AnalysisID ID, bool dir) const {
1260   return PM.findAnalysisPass(ID, dir);
1261 }
1262
1263 Pass *AnalysisResolver::findImplPass(Pass *P, AnalysisID AnalysisPI,
1264                                      Function &F) {
1265   return PM.getOnTheFlyPass(P, AnalysisPI, F);
1266 }
1267
1268 //===----------------------------------------------------------------------===//
1269 // BBPassManager implementation
1270
1271 /// Execute all of the passes scheduled for execution by invoking
1272 /// runOnBasicBlock method.  Keep track of whether any of the passes modifies
1273 /// the function, and if so, return true.
1274 bool BBPassManager::runOnFunction(Function &F) {
1275   if (F.isDeclaration())
1276     return false;
1277
1278   bool Changed = doInitialization(F);
1279
1280   for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
1281     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1282       BasicBlockPass *BP = getContainedPass(Index);
1283       bool LocalChanged = false;
1284
1285       dumpPassInfo(BP, EXECUTION_MSG, ON_BASICBLOCK_MSG, I->getName());
1286       dumpRequiredSet(BP);
1287
1288       initializeAnalysisImpl(BP);
1289
1290       {
1291         // If the pass crashes, remember this.
1292         PassManagerPrettyStackEntry X(BP, *I);
1293         TimeRegion PassTimer(getPassTimer(BP));
1294
1295         LocalChanged |= BP->runOnBasicBlock(*I);
1296       }
1297
1298       Changed |= LocalChanged;
1299       if (LocalChanged)
1300         dumpPassInfo(BP, MODIFICATION_MSG, ON_BASICBLOCK_MSG,
1301                      I->getName());
1302       dumpPreservedSet(BP);
1303
1304       verifyPreservedAnalysis(BP);
1305       removeNotPreservedAnalysis(BP);
1306       recordAvailableAnalysis(BP);
1307       removeDeadPasses(BP, I->getName(), ON_BASICBLOCK_MSG);
1308     }
1309
1310   return doFinalization(F) || Changed;
1311 }
1312
1313 // Implement doInitialization and doFinalization
1314 bool BBPassManager::doInitialization(Module &M) {
1315   bool Changed = false;
1316
1317   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1318     Changed |= getContainedPass(Index)->doInitialization(M);
1319
1320   return Changed;
1321 }
1322
1323 bool BBPassManager::doFinalization(Module &M) {
1324   bool Changed = false;
1325
1326   for (int Index = getNumContainedPasses() - 1; Index >= 0; --Index)
1327     Changed |= getContainedPass(Index)->doFinalization(M);
1328
1329   return Changed;
1330 }
1331
1332 bool BBPassManager::doInitialization(Function &F) {
1333   bool Changed = false;
1334
1335   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1336     BasicBlockPass *BP = getContainedPass(Index);
1337     Changed |= BP->doInitialization(F);
1338   }
1339
1340   return Changed;
1341 }
1342
1343 bool BBPassManager::doFinalization(Function &F) {
1344   bool Changed = false;
1345
1346   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1347     BasicBlockPass *BP = getContainedPass(Index);
1348     Changed |= BP->doFinalization(F);
1349   }
1350
1351   return Changed;
1352 }
1353
1354
1355 //===----------------------------------------------------------------------===//
1356 // FunctionPassManager implementation
1357
1358 /// Create new Function pass manager
1359 FunctionPassManager::FunctionPassManager(Module *m) : M(m) {
1360   FPM = new FunctionPassManagerImpl();
1361   // FPM is the top level manager.
1362   FPM->setTopLevelManager(FPM);
1363
1364   AnalysisResolver *AR = new AnalysisResolver(*FPM);
1365   FPM->setResolver(AR);
1366 }
1367
1368 FunctionPassManager::~FunctionPassManager() {
1369   delete FPM;
1370 }
1371
1372 void FunctionPassManager::add(Pass *P) {
1373   FPM->add(P);
1374 }
1375
1376 /// run - Execute all of the passes scheduled for execution.  Keep
1377 /// track of whether any of the passes modifies the function, and if
1378 /// so, return true.
1379 ///
1380 bool FunctionPassManager::run(Function &F) {
1381   if (std::error_code EC = F.materialize())
1382     report_fatal_error("Error reading bitcode file: " + EC.message());
1383   return FPM->run(F);
1384 }
1385
1386
1387 /// doInitialization - Run all of the initializers for the function passes.
1388 ///
1389 bool FunctionPassManager::doInitialization() {
1390   return FPM->doInitialization(*M);
1391 }
1392
1393 /// doFinalization - Run all of the finalizers for the function passes.
1394 ///
1395 bool FunctionPassManager::doFinalization() {
1396   return FPM->doFinalization(*M);
1397 }
1398
1399 //===----------------------------------------------------------------------===//
1400 // FunctionPassManagerImpl implementation
1401 //
1402 bool FunctionPassManagerImpl::doInitialization(Module &M) {
1403   bool Changed = false;
1404
1405   dumpArguments();
1406   dumpPasses();
1407
1408   for (ImmutablePass *ImPass : getImmutablePasses())
1409     Changed |= ImPass->doInitialization(M);
1410
1411   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1412     Changed |= getContainedManager(Index)->doInitialization(M);
1413
1414   return Changed;
1415 }
1416
1417 bool FunctionPassManagerImpl::doFinalization(Module &M) {
1418   bool Changed = false;
1419
1420   for (int Index = getNumContainedManagers() - 1; Index >= 0; --Index)
1421     Changed |= getContainedManager(Index)->doFinalization(M);
1422
1423   for (ImmutablePass *ImPass : getImmutablePasses())
1424     Changed |= ImPass->doFinalization(M);
1425
1426   return Changed;
1427 }
1428
1429 /// cleanup - After running all passes, clean up pass manager cache.
1430 void FPPassManager::cleanup() {
1431  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1432     FunctionPass *FP = getContainedPass(Index);
1433     AnalysisResolver *AR = FP->getResolver();
1434     assert(AR && "Analysis Resolver is not set");
1435     AR->clearAnalysisImpls();
1436  }
1437 }
1438
1439 void FunctionPassManagerImpl::releaseMemoryOnTheFly() {
1440   if (!wasRun)
1441     return;
1442   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1443     FPPassManager *FPPM = getContainedManager(Index);
1444     for (unsigned Index = 0; Index < FPPM->getNumContainedPasses(); ++Index) {
1445       FPPM->getContainedPass(Index)->releaseMemory();
1446     }
1447   }
1448   wasRun = false;
1449 }
1450
1451 // Execute all the passes managed by this top level manager.
1452 // Return true if any function is modified by a pass.
1453 bool FunctionPassManagerImpl::run(Function &F) {
1454   bool Changed = false;
1455   TimingInfo::createTheTimeInfo();
1456
1457   initializeAllAnalysisInfo();
1458   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1459     Changed |= getContainedManager(Index)->runOnFunction(F);
1460     F.getContext().yield();
1461   }
1462
1463   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1464     getContainedManager(Index)->cleanup();
1465
1466   wasRun = true;
1467   return Changed;
1468 }
1469
1470 //===----------------------------------------------------------------------===//
1471 // FPPassManager implementation
1472
1473 char FPPassManager::ID = 0;
1474 /// Print passes managed by this manager
1475 void FPPassManager::dumpPassStructure(unsigned Offset) {
1476   dbgs().indent(Offset*2) << "FunctionPass Manager\n";
1477   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1478     FunctionPass *FP = getContainedPass(Index);
1479     FP->dumpPassStructure(Offset + 1);
1480     dumpLastUses(FP, Offset+1);
1481   }
1482 }
1483
1484
1485 /// Execute all of the passes scheduled for execution by invoking
1486 /// runOnFunction method.  Keep track of whether any of the passes modifies
1487 /// the function, and if so, return true.
1488 bool FPPassManager::runOnFunction(Function &F) {
1489   if (F.isDeclaration())
1490     return false;
1491
1492   bool Changed = false;
1493
1494   // Collect inherited analysis from Module level pass manager.
1495   populateInheritedAnalysis(TPM->activeStack);
1496
1497   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1498     FunctionPass *FP = getContainedPass(Index);
1499     bool LocalChanged = false;
1500
1501     dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getName());
1502     dumpRequiredSet(FP);
1503
1504     initializeAnalysisImpl(FP);
1505
1506     {
1507       PassManagerPrettyStackEntry X(FP, F);
1508       TimeRegion PassTimer(getPassTimer(FP));
1509
1510       LocalChanged |= FP->runOnFunction(F);
1511     }
1512
1513     Changed |= LocalChanged;
1514     if (LocalChanged)
1515       dumpPassInfo(FP, MODIFICATION_MSG, ON_FUNCTION_MSG, F.getName());
1516     dumpPreservedSet(FP);
1517
1518     verifyPreservedAnalysis(FP);
1519     removeNotPreservedAnalysis(FP);
1520     recordAvailableAnalysis(FP);
1521     removeDeadPasses(FP, F.getName(), ON_FUNCTION_MSG);
1522   }
1523   return Changed;
1524 }
1525
1526 bool FPPassManager::runOnModule(Module &M) {
1527   bool Changed = false;
1528
1529   for (Function &F : M)
1530     Changed |= runOnFunction(F);
1531
1532   return Changed;
1533 }
1534
1535 bool FPPassManager::doInitialization(Module &M) {
1536   bool Changed = false;
1537
1538   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1539     Changed |= getContainedPass(Index)->doInitialization(M);
1540
1541   return Changed;
1542 }
1543
1544 bool FPPassManager::doFinalization(Module &M) {
1545   bool Changed = false;
1546
1547   for (int Index = getNumContainedPasses() - 1; Index >= 0; --Index)
1548     Changed |= getContainedPass(Index)->doFinalization(M);
1549
1550   return Changed;
1551 }
1552
1553 //===----------------------------------------------------------------------===//
1554 // MPPassManager implementation
1555
1556 /// Execute all of the passes scheduled for execution by invoking
1557 /// runOnModule method.  Keep track of whether any of the passes modifies
1558 /// the module, and if so, return true.
1559 bool
1560 MPPassManager::runOnModule(Module &M) {
1561   bool Changed = false;
1562
1563   // Initialize on-the-fly passes
1564   for (auto &OnTheFlyManager : OnTheFlyManagers) {
1565     FunctionPassManagerImpl *FPP = OnTheFlyManager.second;
1566     Changed |= FPP->doInitialization(M);
1567   }
1568
1569   // Initialize module passes
1570   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1571     Changed |= getContainedPass(Index)->doInitialization(M);
1572
1573   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1574     ModulePass *MP = getContainedPass(Index);
1575     bool LocalChanged = false;
1576
1577     dumpPassInfo(MP, EXECUTION_MSG, ON_MODULE_MSG, M.getModuleIdentifier());
1578     dumpRequiredSet(MP);
1579
1580     initializeAnalysisImpl(MP);
1581
1582     {
1583       PassManagerPrettyStackEntry X(MP, M);
1584       TimeRegion PassTimer(getPassTimer(MP));
1585
1586       LocalChanged |= MP->runOnModule(M);
1587     }
1588
1589     Changed |= LocalChanged;
1590     if (LocalChanged)
1591       dumpPassInfo(MP, MODIFICATION_MSG, ON_MODULE_MSG,
1592                    M.getModuleIdentifier());
1593     dumpPreservedSet(MP);
1594
1595     verifyPreservedAnalysis(MP);
1596     removeNotPreservedAnalysis(MP);
1597     recordAvailableAnalysis(MP);
1598     removeDeadPasses(MP, M.getModuleIdentifier(), ON_MODULE_MSG);
1599   }
1600
1601   // Finalize module passes
1602   for (int Index = getNumContainedPasses() - 1; Index >= 0; --Index)
1603     Changed |= getContainedPass(Index)->doFinalization(M);
1604
1605   // Finalize on-the-fly passes
1606   for (auto &OnTheFlyManager : OnTheFlyManagers) {
1607     FunctionPassManagerImpl *FPP = OnTheFlyManager.second;
1608     // We don't know when is the last time an on-the-fly pass is run,
1609     // so we need to releaseMemory / finalize here
1610     FPP->releaseMemoryOnTheFly();
1611     Changed |= FPP->doFinalization(M);
1612   }
1613
1614   return Changed;
1615 }
1616
1617 /// Add RequiredPass into list of lower level passes required by pass P.
1618 /// RequiredPass is run on the fly by Pass Manager when P requests it
1619 /// through getAnalysis interface.
1620 void MPPassManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
1621   assert(P->getPotentialPassManagerType() == PMT_ModulePassManager &&
1622          "Unable to handle Pass that requires lower level Analysis pass");
1623   assert((P->getPotentialPassManagerType() <
1624           RequiredPass->getPotentialPassManagerType()) &&
1625          "Unable to handle Pass that requires lower level Analysis pass");
1626   if (!RequiredPass)
1627     return;
1628
1629   FunctionPassManagerImpl *FPP = OnTheFlyManagers[P];
1630   if (!FPP) {
1631     FPP = new FunctionPassManagerImpl();
1632     // FPP is the top level manager.
1633     FPP->setTopLevelManager(FPP);
1634
1635     OnTheFlyManagers[P] = FPP;
1636   }
1637   const PassInfo *RequiredPassPI =
1638       TPM->findAnalysisPassInfo(RequiredPass->getPassID());
1639
1640   Pass *FoundPass = nullptr;
1641   if (RequiredPassPI && RequiredPassPI->isAnalysis()) {
1642     FoundPass =
1643       ((PMTopLevelManager*)FPP)->findAnalysisPass(RequiredPass->getPassID());
1644   }
1645   if (!FoundPass) {
1646     FoundPass = RequiredPass;
1647     // This should be guaranteed to add RequiredPass to the passmanager given
1648     // that we checked for an available analysis above.
1649     FPP->add(RequiredPass);
1650   }
1651   // Register P as the last user of FoundPass or RequiredPass.
1652   SmallVector<Pass *, 1> LU;
1653   LU.push_back(FoundPass);
1654   FPP->setLastUser(LU,  P);
1655 }
1656
1657 /// Return function pass corresponding to PassInfo PI, that is
1658 /// required by module pass MP. Instantiate analysis pass, by using
1659 /// its runOnFunction() for function F.
1660 Pass* MPPassManager::getOnTheFlyPass(Pass *MP, AnalysisID PI, Function &F){
1661   FunctionPassManagerImpl *FPP = OnTheFlyManagers[MP];
1662   assert(FPP && "Unable to find on the fly pass");
1663
1664   FPP->releaseMemoryOnTheFly();
1665   FPP->run(F);
1666   return ((PMTopLevelManager*)FPP)->findAnalysisPass(PI);
1667 }
1668
1669
1670 //===----------------------------------------------------------------------===//
1671 // PassManagerImpl implementation
1672
1673 //
1674 /// run - Execute all of the passes scheduled for execution.  Keep track of
1675 /// whether any of the passes modifies the module, and if so, return true.
1676 bool PassManagerImpl::run(Module &M) {
1677   bool Changed = false;
1678   TimingInfo::createTheTimeInfo();
1679
1680   dumpArguments();
1681   dumpPasses();
1682
1683   for (ImmutablePass *ImPass : getImmutablePasses())
1684     Changed |= ImPass->doInitialization(M);
1685
1686   initializeAllAnalysisInfo();
1687   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1688     Changed |= getContainedManager(Index)->runOnModule(M);
1689     M.getContext().yield();
1690   }
1691
1692   for (ImmutablePass *ImPass : getImmutablePasses())
1693     Changed |= ImPass->doFinalization(M);
1694
1695   return Changed;
1696 }
1697
1698 //===----------------------------------------------------------------------===//
1699 // PassManager implementation
1700
1701 /// Create new pass manager
1702 PassManager::PassManager() {
1703   PM = new PassManagerImpl();
1704   // PM is the top level manager
1705   PM->setTopLevelManager(PM);
1706 }
1707
1708 PassManager::~PassManager() {
1709   delete PM;
1710 }
1711
1712 void PassManager::add(Pass *P) {
1713   PM->add(P);
1714 }
1715
1716 /// run - Execute all of the passes scheduled for execution.  Keep track of
1717 /// whether any of the passes modifies the module, and if so, return true.
1718 bool PassManager::run(Module &M) {
1719   return PM->run(M);
1720 }
1721
1722 //===----------------------------------------------------------------------===//
1723 // TimingInfo implementation
1724
1725 bool llvm::TimePassesIsEnabled = false;
1726 static cl::opt<bool,true>
1727 EnableTiming("time-passes", cl::location(TimePassesIsEnabled),
1728             cl::desc("Time each pass, printing elapsed time for each on exit"));
1729
1730 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
1731 // a non-null value (if the -time-passes option is enabled) or it leaves it
1732 // null.  It may be called multiple times.
1733 void TimingInfo::createTheTimeInfo() {
1734   if (!TimePassesIsEnabled || TheTimeInfo) return;
1735
1736   // Constructed the first time this is called, iff -time-passes is enabled.
1737   // This guarantees that the object will be constructed before static globals,
1738   // thus it will be destroyed before them.
1739   static ManagedStatic<TimingInfo> TTI;
1740   TheTimeInfo = &*TTI;
1741 }
1742
1743 /// If TimingInfo is enabled then start pass timer.
1744 Timer *llvm::getPassTimer(Pass *P) {
1745   if (TheTimeInfo)
1746     return TheTimeInfo->getPassTimer(P);
1747   return nullptr;
1748 }
1749
1750 //===----------------------------------------------------------------------===//
1751 // PMStack implementation
1752 //
1753
1754 // Pop Pass Manager from the stack and clear its analysis info.
1755 void PMStack::pop() {
1756
1757   PMDataManager *Top = this->top();
1758   Top->initializeAnalysisInfo();
1759
1760   S.pop_back();
1761 }
1762
1763 // Push PM on the stack and set its top level manager.
1764 void PMStack::push(PMDataManager *PM) {
1765   assert(PM && "Unable to push. Pass Manager expected");
1766   assert(PM->getDepth()==0 && "Pass Manager depth set too early");
1767
1768   if (!this->empty()) {
1769     assert(PM->getPassManagerType() > this->top()->getPassManagerType()
1770            && "pushing bad pass manager to PMStack");
1771     PMTopLevelManager *TPM = this->top()->getTopLevelManager();
1772
1773     assert(TPM && "Unable to find top level manager");
1774     TPM->addIndirectPassManager(PM);
1775     PM->setTopLevelManager(TPM);
1776     PM->setDepth(this->top()->getDepth()+1);
1777   } else {
1778     assert((PM->getPassManagerType() == PMT_ModulePassManager
1779            || PM->getPassManagerType() == PMT_FunctionPassManager)
1780            && "pushing bad pass manager to PMStack");
1781     PM->setDepth(1);
1782   }
1783
1784   S.push_back(PM);
1785 }
1786
1787 // Dump content of the pass manager stack.
1788 void PMStack::dump() const {
1789   for (PMDataManager *Manager : S)
1790     dbgs() << Manager->getAsPass()->getPassName() << ' ';
1791
1792   if (!S.empty())
1793     dbgs() << '\n';
1794 }
1795
1796 /// Find appropriate Module Pass Manager in the PM Stack and
1797 /// add self into that manager.
1798 void ModulePass::assignPassManager(PMStack &PMS,
1799                                    PassManagerType PreferredType) {
1800   // Find Module Pass Manager
1801   while (!PMS.empty()) {
1802     PassManagerType TopPMType = PMS.top()->getPassManagerType();
1803     if (TopPMType == PreferredType)
1804       break; // We found desired pass manager
1805     else if (TopPMType > PMT_ModulePassManager)
1806       PMS.pop();    // Pop children pass managers
1807     else
1808       break;
1809   }
1810   assert(!PMS.empty() && "Unable to find appropriate Pass Manager");
1811   PMS.top()->add(this);
1812 }
1813
1814 /// Find appropriate Function Pass Manager or Call Graph Pass Manager
1815 /// in the PM Stack and add self into that manager.
1816 void FunctionPass::assignPassManager(PMStack &PMS,
1817                                      PassManagerType PreferredType) {
1818
1819   // Find Function Pass Manager
1820   while (!PMS.empty()) {
1821     if (PMS.top()->getPassManagerType() > PMT_FunctionPassManager)
1822       PMS.pop();
1823     else
1824       break;
1825   }
1826
1827   // Create new Function Pass Manager if needed.
1828   FPPassManager *FPP;
1829   if (PMS.top()->getPassManagerType() == PMT_FunctionPassManager) {
1830     FPP = (FPPassManager *)PMS.top();
1831   } else {
1832     assert(!PMS.empty() && "Unable to create Function Pass Manager");
1833     PMDataManager *PMD = PMS.top();
1834
1835     // [1] Create new Function Pass Manager
1836     FPP = new FPPassManager();
1837     FPP->populateInheritedAnalysis(PMS);
1838
1839     // [2] Set up new manager's top level manager
1840     PMTopLevelManager *TPM = PMD->getTopLevelManager();
1841     TPM->addIndirectPassManager(FPP);
1842
1843     // [3] Assign manager to manage this new manager. This may create
1844     // and push new managers into PMS
1845     FPP->assignPassManager(PMS, PMD->getPassManagerType());
1846
1847     // [4] Push new manager into PMS
1848     PMS.push(FPP);
1849   }
1850
1851   // Assign FPP as the manager of this pass.
1852   FPP->add(this);
1853 }
1854
1855 /// Find appropriate Basic Pass Manager or Call Graph Pass Manager
1856 /// in the PM Stack and add self into that manager.
1857 void BasicBlockPass::assignPassManager(PMStack &PMS,
1858                                        PassManagerType PreferredType) {
1859   BBPassManager *BBP;
1860
1861   // Basic Pass Manager is a leaf pass manager. It does not handle
1862   // any other pass manager.
1863   if (!PMS.empty() &&
1864       PMS.top()->getPassManagerType() == PMT_BasicBlockPassManager) {
1865     BBP = (BBPassManager *)PMS.top();
1866   } else {
1867     // If leaf manager is not Basic Block Pass manager then create new
1868     // basic Block Pass manager.
1869     assert(!PMS.empty() && "Unable to create BasicBlock Pass Manager");
1870     PMDataManager *PMD = PMS.top();
1871
1872     // [1] Create new Basic Block Manager
1873     BBP = new BBPassManager();
1874
1875     // [2] Set up new manager's top level manager
1876     // Basic Block Pass Manager does not live by itself
1877     PMTopLevelManager *TPM = PMD->getTopLevelManager();
1878     TPM->addIndirectPassManager(BBP);
1879
1880     // [3] Assign manager to manage this new manager. This may create
1881     // and push new managers into PMS
1882     BBP->assignPassManager(PMS, PreferredType);
1883
1884     // [4] Push new manager into PMS
1885     PMS.push(BBP);
1886   }
1887
1888   // Assign BBP as the manager of this pass.
1889   BBP->add(this);
1890 }
1891
1892 PassManagerBase::~PassManagerBase() {}