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   // For immutable passes we have a direct mapping from ID to pass, so check
 690   // that first.
 691   if (Pass *P = ImmutablePassMap.lookup(AID))
 692     return P;
 693
 694   // Check pass managers
 695   for (PMDataManager *PassManager : PassManagers)
 696     if (Pass *P = PassManager->findAnalysisPass(AID, false))
 697       return P;
 698
 699   // Check other pass managers
 700   for (PMDataManager *IndirectPassManager : IndirectPassManagers)
 701     if (Pass *P = IndirectPassManager->findAnalysisPass(AID, false))
 702       return P;
 703
 704   return nullptr;
 705 }
 706
 707 const PassInfo *PMTopLevelManager::findAnalysisPassInfo(AnalysisID AID) const {
 708   const PassInfo *&PI = AnalysisPassInfos[AID];
 709   if (!PI)
 710     PI = PassRegistry::getPassRegistry()->getPassInfo(AID);
 711   else
 712     assert(PI == PassRegistry::getPassRegistry()->getPassInfo(AID) &&
 713            "The pass info pointer changed for an analysis ID!");
 714
 715   return PI;
 716 }
 717
 718 void PMTopLevelManager::addImmutablePass(ImmutablePass *P) {
 719   P->initializePass();
 720   ImmutablePasses.push_back(P);
 721
 722   // Add this pass to the map from its analysis ID. We clobber any prior runs
 723   // of the pass in the map so that the last one added is the one found when
 724   // doing lookups.
 725   AnalysisID AID = P->getPassID();
 726   ImmutablePassMap[AID] = P;
 727
 728   // Also add any interfaces implemented by the immutable pass to the map for
 729   // fast lookup.
 730   const PassInfo *PassInf = findAnalysisPassInfo(AID);
 731   assert(PassInf && "Expected all immutable passes to be initialized");
 732   const std::vector<const PassInfo*> &ImmPI =
 733     PassInf->getInterfacesImplemented();
 734   for (const PassInfo *ImmPI : ImmPI)
 735     ImmutablePassMap[ImmPI->getTypeInfo()] = P;
 736 }
 737
 738 // Print passes managed by this top level manager.
 739 void PMTopLevelManager::dumpPasses() const {
 740
 741   if (PassDebugging < Structure)
 742     return;
 743
 744   // Print out the immutable passes
 745   for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
 746     ImmutablePasses[i]->dumpPassStructure(0);
 747   }
 748
 749   // Every class that derives from PMDataManager also derives from Pass
 750   // (sometimes indirectly), but there's no inheritance relationship
 751   // between PMDataManager and Pass, so we have to getAsPass to get
 752   // from a PMDataManager* to a Pass*.
 753   for (PMDataManager *Manager : PassManagers)
 754     Manager->getAsPass()->dumpPassStructure(1);
 755 }
 756
 757 void PMTopLevelManager::dumpArguments() const {
 758
 759   if (PassDebugging < Arguments)
 760     return;
 761
 762   dbgs() << "Pass Arguments: ";
 763   for (SmallVectorImpl<ImmutablePass *>::const_iterator I =
 764        ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
 765     if (const PassInfo *PI = findAnalysisPassInfo((*I)->getPassID())) {
 766       assert(PI && "Expected all immutable passes to be initialized");
 767       if (!PI->isAnalysisGroup())
 768         dbgs() << " -" << PI->getPassArgument();
 769     }
 770   for (SmallVectorImpl<PMDataManager *>::const_iterator I =
 771        PassManagers.begin(), E = PassManagers.end(); I != E; ++I)
 772     (*I)->dumpPassArguments();
 773   dbgs() << "\n";
 774 }
 775
 776 void PMTopLevelManager::initializeAllAnalysisInfo() {
 777   for (SmallVectorImpl<PMDataManager *>::iterator I = PassManagers.begin(),
 778          E = PassManagers.end(); I != E; ++I)
 779     (*I)->initializeAnalysisInfo();
 780
 781   // Initailize other pass managers
 782   for (SmallVectorImpl<PMDataManager *>::iterator
 783        I = IndirectPassManagers.begin(), E = IndirectPassManagers.end();
 784        I != E; ++I)
 785     (*I)->initializeAnalysisInfo();
 786
 787   for (DenseMap<Pass *, Pass *>::iterator DMI = LastUser.begin(),
 788         DME = LastUser.end(); DMI != DME; ++DMI) {
 789     DenseMap<Pass *, SmallPtrSet<Pass *, 8> >::iterator InvDMI =
 790       InversedLastUser.find(DMI->second);
 791     if (InvDMI != InversedLastUser.end()) {
 792       SmallPtrSet<Pass *, 8> &L = InvDMI->second;
 793       L.insert(DMI->first);
 794     } else {
 795       SmallPtrSet<Pass *, 8> L; L.insert(DMI->first);
 796       InversedLastUser[DMI->second] = L;
 797     }
 798   }
 799 }
 800
 801 /// Destructor
 802 PMTopLevelManager::~PMTopLevelManager() {
 803   for (SmallVectorImpl<PMDataManager *>::iterator I = PassManagers.begin(),
 804          E = PassManagers.end(); I != E; ++I)
 805     delete *I;
 806
 807   for (SmallVectorImpl<ImmutablePass *>::iterator
 808          I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
 809     delete *I;
 810
 811   for (DenseMap<Pass *, AnalysisUsage *>::iterator DMI = AnUsageMap.begin(),
 812          DME = AnUsageMap.end(); DMI != DME; ++DMI)
 813     delete DMI->second;
 814 }
 815
 816 //===----------------------------------------------------------------------===//
 817 // PMDataManager implementation
 818
 819 /// Augement AvailableAnalysis by adding analysis made available by pass P.
 820 void PMDataManager::recordAvailableAnalysis(Pass *P) {
 821   AnalysisID PI = P->getPassID();
 822
 823   AvailableAnalysis[PI] = P;
 824
 825   assert(!AvailableAnalysis.empty());
 826
 827   // This pass is the current implementation of all of the interfaces it
 828   // implements as well.
 829   const PassInfo *PInf = TPM->findAnalysisPassInfo(PI);
 830   if (!PInf) return;
 831   const std::vector<const PassInfo*> &II = PInf->getInterfacesImplemented();
 832   for (unsigned i = 0, e = II.size(); i != e; ++i)
 833     AvailableAnalysis[II[i]->getTypeInfo()] = P;
 834 }
 835
 836 // Return true if P preserves high level analysis used by other
 837 // passes managed by this manager
 838 bool PMDataManager::preserveHigherLevelAnalysis(Pass *P) {
 839   AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
 840   if (AnUsage->getPreservesAll())
 841     return true;
 842
 843   const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
 844   for (SmallVectorImpl<Pass *>::iterator I = HigherLevelAnalysis.begin(),
 845          E = HigherLevelAnalysis.end(); I  != E; ++I) {
 846     Pass *P1 = *I;
 847     if (P1->getAsImmutablePass() == nullptr &&
 848         std::find(PreservedSet.begin(), PreservedSet.end(),
 849                   P1->getPassID()) ==
 850            PreservedSet.end())
 851       return false;
 852   }
 853
 854   return true;
 855 }
 856
 857 /// verifyPreservedAnalysis -- Verify analysis preserved by pass P.
 858 void PMDataManager::verifyPreservedAnalysis(Pass *P) {
 859   // Don't do this unless assertions are enabled.
 860 #ifdef NDEBUG
 861   return;
 862 #endif
 863   AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
 864   const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
 865
 866   // Verify preserved analysis
 867   for (AnalysisUsage::VectorType::const_iterator I = PreservedSet.begin(),
 868          E = PreservedSet.end(); I != E; ++I) {
 869     AnalysisID AID = *I;
 870     if (Pass *AP = findAnalysisPass(AID, true)) {
 871       TimeRegion PassTimer(getPassTimer(AP));
 872       AP->verifyAnalysis();
 873     }
 874   }
 875 }
 876
 877 /// Remove Analysis not preserved by Pass P
 878 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
 879   AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
 880   if (AnUsage->getPreservesAll())
 881     return;
 882
 883   const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
 884   for (DenseMap<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
 885          E = AvailableAnalysis.end(); I != E; ) {
 886     DenseMap<AnalysisID, Pass*>::iterator Info = I++;
 887     if (Info->second->getAsImmutablePass() == nullptr &&
 888         std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
 889         PreservedSet.end()) {
 890       // Remove this analysis
 891       if (PassDebugging >= Details) {
 892         Pass *S = Info->second;
 893         dbgs() << " -- '" <<  P->getPassName() << "' is not preserving '";
 894         dbgs() << S->getPassName() << "'\n";
 895       }
 896       AvailableAnalysis.erase(Info);
 897     }
 898   }
 899
 900   // Check inherited analysis also. If P is not preserving analysis
 901   // provided by parent manager then remove it here.
 902   for (unsigned Index = 0; Index < PMT_Last; ++Index) {
 903
 904     if (!InheritedAnalysis[Index])
 905       continue;
 906
 907     for (DenseMap<AnalysisID, Pass*>::iterator
 908            I = InheritedAnalysis[Index]->begin(),
 909            E = InheritedAnalysis[Index]->end(); I != E; ) {
 910       DenseMap<AnalysisID, Pass *>::iterator Info = I++;
 911       if (Info->second->getAsImmutablePass() == nullptr &&
 912           std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
 913              PreservedSet.end()) {
 914         // Remove this analysis
 915         if (PassDebugging >= Details) {
 916           Pass *S = Info->second;
 917           dbgs() << " -- '" <<  P->getPassName() << "' is not preserving '";
 918           dbgs() << S->getPassName() << "'\n";
 919         }
 920         InheritedAnalysis[Index]->erase(Info);
 921       }
 922     }
 923   }
 924 }
 925
 926 /// Remove analysis passes that are not used any longer
 927 void PMDataManager::removeDeadPasses(Pass *P, StringRef Msg,
 928                                      enum PassDebuggingString DBG_STR) {
 929
 930   SmallVector<Pass *, 12> DeadPasses;
 931
 932   // If this is a on the fly manager then it does not have TPM.
 933   if (!TPM)
 934     return;
 935
 936   TPM->collectLastUses(DeadPasses, P);
 937
 938   if (PassDebugging >= Details && !DeadPasses.empty()) {
 939     dbgs() << " -*- '" <<  P->getPassName();
 940     dbgs() << "' is the last user of following pass instances.";
 941     dbgs() << " Free these instances\n";
 942   }
 943
 944   for (SmallVectorImpl<Pass *>::iterator I = DeadPasses.begin(),
 945          E = DeadPasses.end(); I != E; ++I)
 946     freePass(*I, Msg, DBG_STR);
 947 }
 948
 949 void PMDataManager::freePass(Pass *P, StringRef Msg,
 950                              enum PassDebuggingString DBG_STR) {
 951   dumpPassInfo(P, FREEING_MSG, DBG_STR, Msg);
 952
 953   {
 954     // If the pass crashes releasing memory, remember this.
 955     PassManagerPrettyStackEntry X(P);
 956     TimeRegion PassTimer(getPassTimer(P));
 957
 958     P->releaseMemory();
 959   }
 960
 961   AnalysisID PI = P->getPassID();
 962   if (const PassInfo *PInf = TPM->findAnalysisPassInfo(PI)) {
 963     // Remove the pass itself (if it is not already removed).
 964     AvailableAnalysis.erase(PI);
 965
 966     // Remove all interfaces this pass implements, for which it is also
 967     // listed as the available implementation.
 968     const std::vector<const PassInfo*> &II = PInf->getInterfacesImplemented();
 969     for (unsigned i = 0, e = II.size(); i != e; ++i) {
 970       DenseMap<AnalysisID, Pass*>::iterator Pos =
 971         AvailableAnalysis.find(II[i]->getTypeInfo());
 972       if (Pos != AvailableAnalysis.end() && Pos->second == P)
 973         AvailableAnalysis.erase(Pos);
 974     }
 975   }
 976 }
 977
 978 /// Add pass P into the PassVector. Update
 979 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
 980 void PMDataManager::add(Pass *P, bool ProcessAnalysis) {
 981   // This manager is going to manage pass P. Set up analysis resolver
 982   // to connect them.
 983   AnalysisResolver *AR = new AnalysisResolver(*this);
 984   P->setResolver(AR);
 985
 986   // If a FunctionPass F is the last user of ModulePass info M
 987   // then the F's manager, not F, records itself as a last user of M.
 988   SmallVector<Pass *, 12> TransferLastUses;
 989
 990   if (!ProcessAnalysis) {
 991     // Add pass
 992     PassVector.push_back(P);
 993     return;
 994   }
 995
 996   // At the moment, this pass is the last user of all required passes.
 997   SmallVector<Pass *, 12> LastUses;
 998   SmallVector<Pass *, 8> UsedPasses;
 999   SmallVector<AnalysisID, 8> ReqAnalysisNotAvailable;
1000
1001   unsigned PDepth = this->getDepth();
1002
1003   collectRequiredAndUsedAnalyses(UsedPasses, ReqAnalysisNotAvailable, P);
1004   for (Pass *PUsed : UsedPasses) {
1005     unsigned RDepth = 0;
1006
1007     assert(PUsed->getResolver() && "Analysis Resolver is not set");
1008     PMDataManager &DM = PUsed->getResolver()->getPMDataManager();
1009     RDepth = DM.getDepth();
1010
1011     if (PDepth == RDepth)
1012       LastUses.push_back(PUsed);
1013     else if (PDepth > RDepth) {
1014       // Let the parent claim responsibility of last use
1015       TransferLastUses.push_back(PUsed);
1016       // Keep track of higher level analysis used by this manager.
1017       HigherLevelAnalysis.push_back(PUsed);
1018     } else
1019       llvm_unreachable("Unable to accommodate Used Pass");
1020   }
1021
1022   // Set P as P's last user until someone starts using P.
1023   // However, if P is a Pass Manager then it does not need
1024   // to record its last user.
1025   if (!P->getAsPMDataManager())
1026     LastUses.push_back(P);
1027   TPM->setLastUser(LastUses, P);
1028
1029   if (!TransferLastUses.empty()) {
1030     Pass *My_PM = getAsPass();
1031     TPM->setLastUser(TransferLastUses, My_PM);
1032     TransferLastUses.clear();
1033   }
1034
1035   // Now, take care of required analyses that are not available.
1036   for (AnalysisID ID : ReqAnalysisNotAvailable) {
1037     const PassInfo *PI = TPM->findAnalysisPassInfo(ID);
1038     Pass *AnalysisPass = PI->createPass();
1039     this->addLowerLevelRequiredPass(P, AnalysisPass);
1040   }
1041
1042   // Take a note of analysis required and made available by this pass.
1043   // Remove the analysis not preserved by this pass
1044   removeNotPreservedAnalysis(P);
1045   recordAvailableAnalysis(P);
1046
1047   // Add pass
1048   PassVector.push_back(P);
1049 }
1050
1051
1052 /// Populate UP with analysis pass that are used or required by
1053 /// pass P and are available. Populate RP_NotAvail with analysis
1054 /// pass that are required by pass P but are not available.
1055 void PMDataManager::collectRequiredAndUsedAnalyses(
1056     SmallVectorImpl<Pass *> &UP, SmallVectorImpl<AnalysisID> &RP_NotAvail,
1057     Pass *P) {
1058   AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
1059
1060   for (const auto &UsedID : AnUsage->getUsedSet())
1061     if (Pass *AnalysisPass = findAnalysisPass(UsedID, true))
1062       UP.push_back(AnalysisPass);
1063
1064   for (const auto &RequiredID : AnUsage->getRequiredSet())
1065     if (Pass *AnalysisPass = findAnalysisPass(RequiredID, true))
1066       UP.push_back(AnalysisPass);
1067     else
1068       RP_NotAvail.push_back(RequiredID);
1069
1070   for (const auto &RequiredID : AnUsage->getRequiredTransitiveSet())
1071     if (Pass *AnalysisPass = findAnalysisPass(RequiredID, true))
1072       UP.push_back(AnalysisPass);
1073     else
1074       RP_NotAvail.push_back(RequiredID);
1075 }
1076
1077 // All Required analyses should be available to the pass as it runs!  Here
1078 // we fill in the AnalysisImpls member of the pass so that it can
1079 // successfully use the getAnalysis() method to retrieve the
1080 // implementations it needs.
1081 //
1082 void PMDataManager::initializeAnalysisImpl(Pass *P) {
1083   AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
1084
1085   for (AnalysisUsage::VectorType::const_iterator
1086          I = AnUsage->getRequiredSet().begin(),
1087          E = AnUsage->getRequiredSet().end(); I != E; ++I) {
1088     Pass *Impl = findAnalysisPass(*I, true);
1089     if (!Impl)
1090       // This may be analysis pass that is initialized on the fly.
1091       // If that is not the case then it will raise an assert when it is used.
1092       continue;
1093     AnalysisResolver *AR = P->getResolver();
1094     assert(AR && "Analysis Resolver is not set");
1095     AR->addAnalysisImplsPair(*I, Impl);
1096   }
1097 }
1098
1099 /// Find the pass that implements Analysis AID. If desired pass is not found
1100 /// then return NULL.
1101 Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
1102
1103   // Check if AvailableAnalysis map has one entry.
1104   DenseMap<AnalysisID, Pass*>::const_iterator I =  AvailableAnalysis.find(AID);
1105
1106   if (I != AvailableAnalysis.end())
1107     return I->second;
1108
1109   // Search Parents through TopLevelManager
1110   if (SearchParent)
1111     return TPM->findAnalysisPass(AID);
1112
1113   return nullptr;
1114 }
1115
1116 // Print list of passes that are last used by P.
1117 void PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{
1118
1119   SmallVector<Pass *, 12> LUses;
1120
1121   // If this is a on the fly manager then it does not have TPM.
1122   if (!TPM)
1123     return;
1124
1125   TPM->collectLastUses(LUses, P);
1126
1127   for (SmallVectorImpl<Pass *>::iterator I = LUses.begin(),
1128          E = LUses.end(); I != E; ++I) {
1129     dbgs() << "--" << std::string(Offset*2, ' ');
1130     (*I)->dumpPassStructure(0);
1131   }
1132 }
1133
1134 void PMDataManager::dumpPassArguments() const {
1135   for (SmallVectorImpl<Pass *>::const_iterator I = PassVector.begin(),
1136         E = PassVector.end(); I != E; ++I) {
1137     if (PMDataManager *PMD = (*I)->getAsPMDataManager())
1138       PMD->dumpPassArguments();
1139     else
1140       if (const PassInfo *PI =
1141             TPM->findAnalysisPassInfo((*I)->getPassID()))
1142         if (!PI->isAnalysisGroup())
1143           dbgs() << " -" << PI->getPassArgument();
1144   }
1145 }
1146
1147 void PMDataManager::dumpPassInfo(Pass *P, enum PassDebuggingString S1,
1148                                  enum PassDebuggingString S2,
1149                                  StringRef Msg) {
1150   if (PassDebugging < Executions)
1151     return;
1152   dbgs() << "[" << sys::TimeValue::now().str() << "] " << (void *)this
1153          << std::string(getDepth() * 2 + 1, ' ');
1154   switch (S1) {
1155   case EXECUTION_MSG:
1156     dbgs() << "Executing Pass '" << P->getPassName();
1157     break;
1158   case MODIFICATION_MSG:
1159     dbgs() << "Made Modification '" << P->getPassName();
1160     break;
1161   case FREEING_MSG:
1162     dbgs() << " Freeing Pass '" << P->getPassName();
1163     break;
1164   default:
1165     break;
1166   }
1167   switch (S2) {
1168   case ON_BASICBLOCK_MSG:
1169     dbgs() << "' on BasicBlock '" << Msg << "'...\n";
1170     break;
1171   case ON_FUNCTION_MSG:
1172     dbgs() << "' on Function '" << Msg << "'...\n";
1173     break;
1174   case ON_MODULE_MSG:
1175     dbgs() << "' on Module '"  << Msg << "'...\n";
1176     break;
1177   case ON_REGION_MSG:
1178     dbgs() << "' on Region '"  << Msg << "'...\n";
1179     break;
1180   case ON_LOOP_MSG:
1181     dbgs() << "' on Loop '" << Msg << "'...\n";
1182     break;
1183   case ON_CG_MSG:
1184     dbgs() << "' on Call Graph Nodes '" << Msg << "'...\n";
1185     break;
1186   default:
1187     break;
1188   }
1189 }
1190
1191 void PMDataManager::dumpRequiredSet(const Pass *P) const {
1192   if (PassDebugging < Details)
1193     return;
1194
1195   AnalysisUsage analysisUsage;
1196   P->getAnalysisUsage(analysisUsage);
1197   dumpAnalysisUsage("Required", P, analysisUsage.getRequiredSet());
1198 }
1199
1200 void PMDataManager::dumpPreservedSet(const Pass *P) const {
1201   if (PassDebugging < Details)
1202     return;
1203
1204   AnalysisUsage analysisUsage;
1205   P->getAnalysisUsage(analysisUsage);
1206   dumpAnalysisUsage("Preserved", P, analysisUsage.getPreservedSet());
1207 }
1208
1209 void PMDataManager::dumpUsedSet(const Pass *P) const {
1210   if (PassDebugging < Details)
1211     return;
1212
1213   AnalysisUsage analysisUsage;
1214   P->getAnalysisUsage(analysisUsage);
1215   dumpAnalysisUsage("Used", P, analysisUsage.getUsedSet());
1216 }
1217
1218 void PMDataManager::dumpAnalysisUsage(StringRef Msg, const Pass *P,
1219                                    const AnalysisUsage::VectorType &Set) const {
1220   assert(PassDebugging >= Details);
1221   if (Set.empty())
1222     return;
1223   dbgs() << (const void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:";
1224   for (unsigned i = 0; i != Set.size(); ++i) {
1225     if (i) dbgs() << ',';
1226     const PassInfo *PInf = TPM->findAnalysisPassInfo(Set[i]);
1227     if (!PInf) {
1228       // Some preserved passes, such as AliasAnalysis, may not be initialized by
1229       // all drivers.
1230       dbgs() << " Uninitialized Pass";
1231       continue;
1232     }
1233     dbgs() << ' ' << PInf->getPassName();
1234   }
1235   dbgs() << '\n';
1236 }
1237
1238 /// Add RequiredPass into list of lower level passes required by pass P.
1239 /// RequiredPass is run on the fly by Pass Manager when P requests it
1240 /// through getAnalysis interface.
1241 /// This should be handled by specific pass manager.
1242 void PMDataManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
1243   if (TPM) {
1244     TPM->dumpArguments();
1245     TPM->dumpPasses();
1246   }
1247
1248   // Module Level pass may required Function Level analysis info
1249   // (e.g. dominator info). Pass manager uses on the fly function pass manager
1250   // to provide this on demand. In that case, in Pass manager terminology,
1251   // module level pass is requiring lower level analysis info managed by
1252   // lower level pass manager.
1253
1254   // When Pass manager is not able to order required analysis info, Pass manager
1255   // checks whether any lower level manager will be able to provide this
1256   // analysis info on demand or not.
1257 #ifndef NDEBUG
1258   dbgs() << "Unable to schedule '" << RequiredPass->getPassName();
1259   dbgs() << "' required by '" << P->getPassName() << "'\n";
1260 #endif
1261   llvm_unreachable("Unable to schedule pass");
1262 }
1263
1264 Pass *PMDataManager::getOnTheFlyPass(Pass *P, AnalysisID PI, Function &F) {
1265   llvm_unreachable("Unable to find on the fly pass");
1266 }
1267
1268 // Destructor
1269 PMDataManager::~PMDataManager() {
1270   for (SmallVectorImpl<Pass *>::iterator I = PassVector.begin(),
1271          E = PassVector.end(); I != E; ++I)
1272     delete *I;
1273 }
1274
1275 //===----------------------------------------------------------------------===//
1276 // NOTE: Is this the right place to define this method ?
1277 // getAnalysisIfAvailable - Return analysis result or null if it doesn't exist.
1278 Pass *AnalysisResolver::getAnalysisIfAvailable(AnalysisID ID, bool dir) const {
1279   return PM.findAnalysisPass(ID, dir);
1280 }
1281
1282 Pass *AnalysisResolver::findImplPass(Pass *P, AnalysisID AnalysisPI,
1283                                      Function &F) {
1284   return PM.getOnTheFlyPass(P, AnalysisPI, F);
1285 }
1286
1287 //===----------------------------------------------------------------------===//
1288 // BBPassManager implementation
1289
1290 /// Execute all of the passes scheduled for execution by invoking
1291 /// runOnBasicBlock method.  Keep track of whether any of the passes modifies
1292 /// the function, and if so, return true.
1293 bool BBPassManager::runOnFunction(Function &F) {
1294   if (F.isDeclaration())
1295     return false;
1296
1297   bool Changed = doInitialization(F);
1298
1299   for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
1300     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1301       BasicBlockPass *BP = getContainedPass(Index);
1302       bool LocalChanged = false;
1303
1304       dumpPassInfo(BP, EXECUTION_MSG, ON_BASICBLOCK_MSG, I->getName());
1305       dumpRequiredSet(BP);
1306
1307       initializeAnalysisImpl(BP);
1308
1309       {
1310         // If the pass crashes, remember this.
1311         PassManagerPrettyStackEntry X(BP, *I);
1312         TimeRegion PassTimer(getPassTimer(BP));
1313
1314         LocalChanged |= BP->runOnBasicBlock(*I);
1315       }
1316
1317       Changed |= LocalChanged;
1318       if (LocalChanged)
1319         dumpPassInfo(BP, MODIFICATION_MSG, ON_BASICBLOCK_MSG,
1320                      I->getName());
1321       dumpPreservedSet(BP);
1322       dumpUsedSet(BP);
1323
1324       verifyPreservedAnalysis(BP);
1325       removeNotPreservedAnalysis(BP);
1326       recordAvailableAnalysis(BP);
1327       removeDeadPasses(BP, I->getName(), ON_BASICBLOCK_MSG);
1328     }
1329
1330   return doFinalization(F) || Changed;
1331 }
1332
1333 // Implement doInitialization and doFinalization
1334 bool BBPassManager::doInitialization(Module &M) {
1335   bool Changed = false;
1336
1337   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1338     Changed |= getContainedPass(Index)->doInitialization(M);
1339
1340   return Changed;
1341 }
1342
1343 bool BBPassManager::doFinalization(Module &M) {
1344   bool Changed = false;
1345
1346   for (int Index = getNumContainedPasses() - 1; Index >= 0; --Index)
1347     Changed |= getContainedPass(Index)->doFinalization(M);
1348
1349   return Changed;
1350 }
1351
1352 bool BBPassManager::doInitialization(Function &F) {
1353   bool Changed = false;
1354
1355   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1356     BasicBlockPass *BP = getContainedPass(Index);
1357     Changed |= BP->doInitialization(F);
1358   }
1359
1360   return Changed;
1361 }
1362
1363 bool BBPassManager::doFinalization(Function &F) {
1364   bool Changed = false;
1365
1366   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1367     BasicBlockPass *BP = getContainedPass(Index);
1368     Changed |= BP->doFinalization(F);
1369   }
1370
1371   return Changed;
1372 }
1373
1374
1375 //===----------------------------------------------------------------------===//
1376 // FunctionPassManager implementation
1377
1378 /// Create new Function pass manager
1379 FunctionPassManager::FunctionPassManager(Module *m) : M(m) {
1380   FPM = new FunctionPassManagerImpl();
1381   // FPM is the top level manager.
1382   FPM->setTopLevelManager(FPM);
1383
1384   AnalysisResolver *AR = new AnalysisResolver(*FPM);
1385   FPM->setResolver(AR);
1386 }
1387
1388 FunctionPassManager::~FunctionPassManager() {
1389   delete FPM;
1390 }
1391
1392 void FunctionPassManager::add(Pass *P) {
1393   FPM->add(P);
1394 }
1395
1396 /// run - Execute all of the passes scheduled for execution.  Keep
1397 /// track of whether any of the passes modifies the function, and if
1398 /// so, return true.
1399 ///
1400 bool FunctionPassManager::run(Function &F) {
1401   if (std::error_code EC = F.materialize())
1402     report_fatal_error("Error reading bitcode file: " + EC.message());
1403   return FPM->run(F);
1404 }
1405
1406
1407 /// doInitialization - Run all of the initializers for the function passes.
1408 ///
1409 bool FunctionPassManager::doInitialization() {
1410   return FPM->doInitialization(*M);
1411 }
1412
1413 /// doFinalization - Run all of the finalizers for the function passes.
1414 ///
1415 bool FunctionPassManager::doFinalization() {
1416   return FPM->doFinalization(*M);
1417 }
1418
1419 //===----------------------------------------------------------------------===//
1420 // FunctionPassManagerImpl implementation
1421 //
1422 bool FunctionPassManagerImpl::doInitialization(Module &M) {
1423   bool Changed = false;
1424
1425   dumpArguments();
1426   dumpPasses();
1427
1428   for (ImmutablePass *ImPass : getImmutablePasses())
1429     Changed |= ImPass->doInitialization(M);
1430
1431   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1432     Changed |= getContainedManager(Index)->doInitialization(M);
1433
1434   return Changed;
1435 }
1436
1437 bool FunctionPassManagerImpl::doFinalization(Module &M) {
1438   bool Changed = false;
1439
1440   for (int Index = getNumContainedManagers() - 1; Index >= 0; --Index)
1441     Changed |= getContainedManager(Index)->doFinalization(M);
1442
1443   for (ImmutablePass *ImPass : getImmutablePasses())
1444     Changed |= ImPass->doFinalization(M);
1445
1446   return Changed;
1447 }
1448
1449 /// cleanup - After running all passes, clean up pass manager cache.
1450 void FPPassManager::cleanup() {
1451  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1452     FunctionPass *FP = getContainedPass(Index);
1453     AnalysisResolver *AR = FP->getResolver();
1454     assert(AR && "Analysis Resolver is not set");
1455     AR->clearAnalysisImpls();
1456  }
1457 }
1458
1459 void FunctionPassManagerImpl::releaseMemoryOnTheFly() {
1460   if (!wasRun)
1461     return;
1462   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1463     FPPassManager *FPPM = getContainedManager(Index);
1464     for (unsigned Index = 0; Index < FPPM->getNumContainedPasses(); ++Index) {
1465       FPPM->getContainedPass(Index)->releaseMemory();
1466     }
1467   }
1468   wasRun = false;
1469 }
1470
1471 // Execute all the passes managed by this top level manager.
1472 // Return true if any function is modified by a pass.
1473 bool FunctionPassManagerImpl::run(Function &F) {
1474   bool Changed = false;
1475   TimingInfo::createTheTimeInfo();
1476
1477   initializeAllAnalysisInfo();
1478   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1479     Changed |= getContainedManager(Index)->runOnFunction(F);
1480     F.getContext().yield();
1481   }
1482
1483   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1484     getContainedManager(Index)->cleanup();
1485
1486   wasRun = true;
1487   return Changed;
1488 }
1489
1490 //===----------------------------------------------------------------------===//
1491 // FPPassManager implementation
1492
1493 char FPPassManager::ID = 0;
1494 /// Print passes managed by this manager
1495 void FPPassManager::dumpPassStructure(unsigned Offset) {
1496   dbgs().indent(Offset*2) << "FunctionPass Manager\n";
1497   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1498     FunctionPass *FP = getContainedPass(Index);
1499     FP->dumpPassStructure(Offset + 1);
1500     dumpLastUses(FP, Offset+1);
1501   }
1502 }
1503
1504
1505 /// Execute all of the passes scheduled for execution by invoking
1506 /// runOnFunction method.  Keep track of whether any of the passes modifies
1507 /// the function, and if so, return true.
1508 bool FPPassManager::runOnFunction(Function &F) {
1509   if (F.isDeclaration())
1510     return false;
1511
1512   bool Changed = false;
1513
1514   // Collect inherited analysis from Module level pass manager.
1515   populateInheritedAnalysis(TPM->activeStack);
1516
1517   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1518     FunctionPass *FP = getContainedPass(Index);
1519     bool LocalChanged = false;
1520
1521     dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getName());
1522     dumpRequiredSet(FP);
1523
1524     initializeAnalysisImpl(FP);
1525
1526     {
1527       PassManagerPrettyStackEntry X(FP, F);
1528       TimeRegion PassTimer(getPassTimer(FP));
1529
1530       LocalChanged |= FP->runOnFunction(F);
1531     }
1532
1533     Changed |= LocalChanged;
1534     if (LocalChanged)
1535       dumpPassInfo(FP, MODIFICATION_MSG, ON_FUNCTION_MSG, F.getName());
1536     dumpPreservedSet(FP);
1537     dumpUsedSet(FP);
1538
1539     verifyPreservedAnalysis(FP);
1540     removeNotPreservedAnalysis(FP);
1541     recordAvailableAnalysis(FP);
1542     removeDeadPasses(FP, F.getName(), ON_FUNCTION_MSG);
1543   }
1544   return Changed;
1545 }
1546
1547 bool FPPassManager::runOnModule(Module &M) {
1548   bool Changed = false;
1549
1550   for (Function &F : M)
1551     Changed |= runOnFunction(F);
1552
1553   return Changed;
1554 }
1555
1556 bool FPPassManager::doInitialization(Module &M) {
1557   bool Changed = false;
1558
1559   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1560     Changed |= getContainedPass(Index)->doInitialization(M);
1561
1562   return Changed;
1563 }
1564
1565 bool FPPassManager::doFinalization(Module &M) {
1566   bool Changed = false;
1567
1568   for (int Index = getNumContainedPasses() - 1; Index >= 0; --Index)
1569     Changed |= getContainedPass(Index)->doFinalization(M);
1570
1571   return Changed;
1572 }
1573
1574 //===----------------------------------------------------------------------===//
1575 // MPPassManager implementation
1576
1577 /// Execute all of the passes scheduled for execution by invoking
1578 /// runOnModule method.  Keep track of whether any of the passes modifies
1579 /// the module, and if so, return true.
1580 bool
1581 MPPassManager::runOnModule(Module &M) {
1582   bool Changed = false;
1583
1584   // Initialize on-the-fly passes
1585   for (auto &OnTheFlyManager : OnTheFlyManagers) {
1586     FunctionPassManagerImpl *FPP = OnTheFlyManager.second;
1587     Changed |= FPP->doInitialization(M);
1588   }
1589
1590   // Initialize module passes
1591   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1592     Changed |= getContainedPass(Index)->doInitialization(M);
1593
1594   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1595     ModulePass *MP = getContainedPass(Index);
1596     bool LocalChanged = false;
1597
1598     dumpPassInfo(MP, EXECUTION_MSG, ON_MODULE_MSG, M.getModuleIdentifier());
1599     dumpRequiredSet(MP);
1600
1601     initializeAnalysisImpl(MP);
1602
1603     {
1604       PassManagerPrettyStackEntry X(MP, M);
1605       TimeRegion PassTimer(getPassTimer(MP));
1606
1607       LocalChanged |= MP->runOnModule(M);
1608     }
1609
1610     Changed |= LocalChanged;
1611     if (LocalChanged)
1612       dumpPassInfo(MP, MODIFICATION_MSG, ON_MODULE_MSG,
1613                    M.getModuleIdentifier());
1614     dumpPreservedSet(MP);
1615     dumpUsedSet(MP);
1616
1617     verifyPreservedAnalysis(MP);
1618     removeNotPreservedAnalysis(MP);
1619     recordAvailableAnalysis(MP);
1620     removeDeadPasses(MP, M.getModuleIdentifier(), ON_MODULE_MSG);
1621   }
1622
1623   // Finalize module passes
1624   for (int Index = getNumContainedPasses() - 1; Index >= 0; --Index)
1625     Changed |= getContainedPass(Index)->doFinalization(M);
1626
1627   // Finalize on-the-fly passes
1628   for (auto &OnTheFlyManager : OnTheFlyManagers) {
1629     FunctionPassManagerImpl *FPP = OnTheFlyManager.second;
1630     // We don't know when is the last time an on-the-fly pass is run,
1631     // so we need to releaseMemory / finalize here
1632     FPP->releaseMemoryOnTheFly();
1633     Changed |= FPP->doFinalization(M);
1634   }
1635
1636   return Changed;
1637 }
1638
1639 /// Add RequiredPass into list of lower level passes required by pass P.
1640 /// RequiredPass is run on the fly by Pass Manager when P requests it
1641 /// through getAnalysis interface.
1642 void MPPassManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
1643   assert(P->getPotentialPassManagerType() == PMT_ModulePassManager &&
1644          "Unable to handle Pass that requires lower level Analysis pass");
1645   assert((P->getPotentialPassManagerType() <
1646           RequiredPass->getPotentialPassManagerType()) &&
1647          "Unable to handle Pass that requires lower level Analysis pass");
1648   if (!RequiredPass)
1649     return;
1650
1651   FunctionPassManagerImpl *FPP = OnTheFlyManagers[P];
1652   if (!FPP) {
1653     FPP = new FunctionPassManagerImpl();
1654     // FPP is the top level manager.
1655     FPP->setTopLevelManager(FPP);
1656
1657     OnTheFlyManagers[P] = FPP;
1658   }
1659   const PassInfo *RequiredPassPI =
1660       TPM->findAnalysisPassInfo(RequiredPass->getPassID());
1661
1662   Pass *FoundPass = nullptr;
1663   if (RequiredPassPI && RequiredPassPI->isAnalysis()) {
1664     FoundPass =
1665       ((PMTopLevelManager*)FPP)->findAnalysisPass(RequiredPass->getPassID());
1666   }
1667   if (!FoundPass) {
1668     FoundPass = RequiredPass;
1669     // This should be guaranteed to add RequiredPass to the passmanager given
1670     // that we checked for an available analysis above.
1671     FPP->add(RequiredPass);
1672   }
1673   // Register P as the last user of FoundPass or RequiredPass.
1674   SmallVector<Pass *, 1> LU;
1675   LU.push_back(FoundPass);
1676   FPP->setLastUser(LU,  P);
1677 }
1678
1679 /// Return function pass corresponding to PassInfo PI, that is
1680 /// required by module pass MP. Instantiate analysis pass, by using
1681 /// its runOnFunction() for function F.
1682 Pass* MPPassManager::getOnTheFlyPass(Pass *MP, AnalysisID PI, Function &F){
1683   FunctionPassManagerImpl *FPP = OnTheFlyManagers[MP];
1684   assert(FPP && "Unable to find on the fly pass");
1685
1686   FPP->releaseMemoryOnTheFly();
1687   FPP->run(F);
1688   return ((PMTopLevelManager*)FPP)->findAnalysisPass(PI);
1689 }
1690
1691
1692 //===----------------------------------------------------------------------===//
1693 // PassManagerImpl implementation
1694
1695 //
1696 /// run - Execute all of the passes scheduled for execution.  Keep track of
1697 /// whether any of the passes modifies the module, and if so, return true.
1698 bool PassManagerImpl::run(Module &M) {
1699   bool Changed = false;
1700   TimingInfo::createTheTimeInfo();
1701
1702   dumpArguments();
1703   dumpPasses();
1704
1705   for (ImmutablePass *ImPass : getImmutablePasses())
1706     Changed |= ImPass->doInitialization(M);
1707
1708   initializeAllAnalysisInfo();
1709   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1710     Changed |= getContainedManager(Index)->runOnModule(M);
1711     M.getContext().yield();
1712   }
1713
1714   for (ImmutablePass *ImPass : getImmutablePasses())
1715     Changed |= ImPass->doFinalization(M);
1716
1717   return Changed;
1718 }
1719
1720 //===----------------------------------------------------------------------===//
1721 // PassManager implementation
1722
1723 /// Create new pass manager
1724 PassManager::PassManager() {
1725   PM = new PassManagerImpl();
1726   // PM is the top level manager
1727   PM->setTopLevelManager(PM);
1728 }
1729
1730 PassManager::~PassManager() {
1731   delete PM;
1732 }
1733
1734 void PassManager::add(Pass *P) {
1735   PM->add(P);
1736 }
1737
1738 /// run - Execute all of the passes scheduled for execution.  Keep track of
1739 /// whether any of the passes modifies the module, and if so, return true.
1740 bool PassManager::run(Module &M) {
1741   return PM->run(M);
1742 }
1743
1744 //===----------------------------------------------------------------------===//
1745 // TimingInfo implementation
1746
1747 bool llvm::TimePassesIsEnabled = false;
1748 static cl::opt<bool,true>
1749 EnableTiming("time-passes", cl::location(TimePassesIsEnabled),
1750             cl::desc("Time each pass, printing elapsed time for each on exit"));
1751
1752 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
1753 // a non-null value (if the -time-passes option is enabled) or it leaves it
1754 // null.  It may be called multiple times.
1755 void TimingInfo::createTheTimeInfo() {
1756   if (!TimePassesIsEnabled || TheTimeInfo) return;
1757
1758   // Constructed the first time this is called, iff -time-passes is enabled.
1759   // This guarantees that the object will be constructed before static globals,
1760   // thus it will be destroyed before them.
1761   static ManagedStatic<TimingInfo> TTI;
1762   TheTimeInfo = &*TTI;
1763 }
1764
1765 /// If TimingInfo is enabled then start pass timer.
1766 Timer *llvm::getPassTimer(Pass *P) {
1767   if (TheTimeInfo)
1768     return TheTimeInfo->getPassTimer(P);
1769   return nullptr;
1770 }
1771
1772 //===----------------------------------------------------------------------===//
1773 // PMStack implementation
1774 //
1775
1776 // Pop Pass Manager from the stack and clear its analysis info.
1777 void PMStack::pop() {
1778
1779   PMDataManager *Top = this->top();
1780   Top->initializeAnalysisInfo();
1781
1782   S.pop_back();
1783 }
1784
1785 // Push PM on the stack and set its top level manager.
1786 void PMStack::push(PMDataManager *PM) {
1787   assert(PM && "Unable to push. Pass Manager expected");
1788   assert(PM->getDepth()==0 && "Pass Manager depth set too early");
1789
1790   if (!this->empty()) {
1791     assert(PM->getPassManagerType() > this->top()->getPassManagerType()
1792            && "pushing bad pass manager to PMStack");
1793     PMTopLevelManager *TPM = this->top()->getTopLevelManager();
1794
1795     assert(TPM && "Unable to find top level manager");
1796     TPM->addIndirectPassManager(PM);
1797     PM->setTopLevelManager(TPM);
1798     PM->setDepth(this->top()->getDepth()+1);
1799   } else {
1800     assert((PM->getPassManagerType() == PMT_ModulePassManager
1801            || PM->getPassManagerType() == PMT_FunctionPassManager)
1802            && "pushing bad pass manager to PMStack");
1803     PM->setDepth(1);
1804   }
1805
1806   S.push_back(PM);
1807 }
1808
1809 // Dump content of the pass manager stack.
1810 void PMStack::dump() const {
1811   for (PMDataManager *Manager : S)
1812     dbgs() << Manager->getAsPass()->getPassName() << ' ';
1813
1814   if (!S.empty())
1815     dbgs() << '\n';
1816 }
1817
1818 /// Find appropriate Module Pass Manager in the PM Stack and
1819 /// add self into that manager.
1820 void ModulePass::assignPassManager(PMStack &PMS,
1821                                    PassManagerType PreferredType) {
1822   // Find Module Pass Manager
1823   while (!PMS.empty()) {
1824     PassManagerType TopPMType = PMS.top()->getPassManagerType();
1825     if (TopPMType == PreferredType)
1826       break; // We found desired pass manager
1827     else if (TopPMType > PMT_ModulePassManager)
1828       PMS.pop();    // Pop children pass managers
1829     else
1830       break;
1831   }
1832   assert(!PMS.empty() && "Unable to find appropriate Pass Manager");
1833   PMS.top()->add(this);
1834 }
1835
1836 /// Find appropriate Function Pass Manager or Call Graph Pass Manager
1837 /// in the PM Stack and add self into that manager.
1838 void FunctionPass::assignPassManager(PMStack &PMS,
1839                                      PassManagerType PreferredType) {
1840
1841   // Find Function Pass Manager
1842   while (!PMS.empty()) {
1843     if (PMS.top()->getPassManagerType() > PMT_FunctionPassManager)
1844       PMS.pop();
1845     else
1846       break;
1847   }
1848
1849   // Create new Function Pass Manager if needed.
1850   FPPassManager *FPP;
1851   if (PMS.top()->getPassManagerType() == PMT_FunctionPassManager) {
1852     FPP = (FPPassManager *)PMS.top();
1853   } else {
1854     assert(!PMS.empty() && "Unable to create Function Pass Manager");
1855     PMDataManager *PMD = PMS.top();
1856
1857     // [1] Create new Function Pass Manager
1858     FPP = new FPPassManager();
1859     FPP->populateInheritedAnalysis(PMS);
1860
1861     // [2] Set up new manager's top level manager
1862     PMTopLevelManager *TPM = PMD->getTopLevelManager();
1863     TPM->addIndirectPassManager(FPP);
1864
1865     // [3] Assign manager to manage this new manager. This may create
1866     // and push new managers into PMS
1867     FPP->assignPassManager(PMS, PMD->getPassManagerType());
1868
1869     // [4] Push new manager into PMS
1870     PMS.push(FPP);
1871   }
1872
1873   // Assign FPP as the manager of this pass.
1874   FPP->add(this);
1875 }
1876
1877 /// Find appropriate Basic Pass Manager or Call Graph Pass Manager
1878 /// in the PM Stack and add self into that manager.
1879 void BasicBlockPass::assignPassManager(PMStack &PMS,
1880                                        PassManagerType PreferredType) {
1881   BBPassManager *BBP;
1882
1883   // Basic Pass Manager is a leaf pass manager. It does not handle
1884   // any other pass manager.
1885   if (!PMS.empty() &&
1886       PMS.top()->getPassManagerType() == PMT_BasicBlockPassManager) {
1887     BBP = (BBPassManager *)PMS.top();
1888   } else {
1889     // If leaf manager is not Basic Block Pass manager then create new
1890     // basic Block Pass manager.
1891     assert(!PMS.empty() && "Unable to create BasicBlock Pass Manager");
1892     PMDataManager *PMD = PMS.top();
1893
1894     // [1] Create new Basic Block Manager
1895     BBP = new BBPassManager();
1896
1897     // [2] Set up new manager's top level manager
1898     // Basic Block Pass Manager does not live by itself
1899     PMTopLevelManager *TPM = PMD->getTopLevelManager();
1900     TPM->addIndirectPassManager(BBP);
1901
1902     // [3] Assign manager to manage this new manager. This may create
1903     // and push new managers into PMS
1904     BBP->assignPassManager(PMS, PreferredType);
1905
1906     // [4] Push new manager into PMS
1907     PMS.push(BBP);
1908   }
1909
1910   // Assign BBP as the manager of this pass.
1911   BBP->add(this);
1912 }
1913
1914 PassManagerBase::~PassManagerBase() {}