lib/VMCore/PassManager.cpp

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