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