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<PMDataManager *>::iterator I = PassManagers.begin(),
 459          E = PassManagers.end(); P == NULL && I != E; ++I) {
 460     PMDataManager *PMD = *I;
 461     P = PMD->findAnalysisPass(AID, false);
 462   }
 463
 464   // Check other pass managers
 465   for (std::vector<PMDataManager *>::iterator I = IndirectPassManagers.begin(),
 466          E = IndirectPassManagers.end(); P == NULL && I != E; ++I)
 467     P = (*I)->findAnalysisPass(AID, false);
 468
 469   for (std::vector<ImmutablePass *>::iterator I = ImmutablePasses.begin(),
 470          E = ImmutablePasses.end(); P == NULL && I != E; ++I) {
 471     const PassInfo *PI = (*I)->getPassInfo();
 472     if (PI == AID)
 473       P = *I;
 474
 475     // If Pass not found then check the interfaces implemented by Immutable Pass
 476     if (!P) {
 477       const std::vector<const PassInfo*> &ImmPI =
 478         PI->getInterfacesImplemented();
 479       if (std::find(ImmPI.begin(), ImmPI.end(), AID) != ImmPI.end())
 480         P = *I;
 481     }
 482   }
 483
 484   return P;
 485 }
 486
 487 // Print passes managed by this top level manager.
 488 void PMTopLevelManager::dumpPasses() const {
 489
 490   if (PassDebugging < Structure)
 491     return;
 492
 493   // Print out the immutable passes
 494   for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
 495     ImmutablePasses[i]->dumpPassStructure(0);
 496   }
 497
 498   // Every class that derives from PMDataManager also derives from Pass
 499   // (sometimes indirectly), but there's no inheritance relationship
 500   // between PMDataManager and Pass, so we have to dynamic_cast to get
 501   // from a PMDataManager* to a Pass*.
 502   for (std::vector<PMDataManager *>::const_iterator I = PassManagers.begin(),
 503          E = PassManagers.end(); I != E; ++I)
 504     dynamic_cast<Pass *>(*I)->dumpPassStructure(1);
 505 }
 506
 507 void PMTopLevelManager::dumpArguments() const {
 508
 509   if (PassDebugging < Arguments)
 510     return;
 511
 512   cerr << "Pass Arguments: ";
 513   for (std::vector<PMDataManager *>::const_iterator I = PassManagers.begin(),
 514          E = PassManagers.end(); I != E; ++I) {
 515     PMDataManager *PMD = *I;
 516     PMD->dumpPassArguments();
 517   }
 518   cerr << "\n";
 519 }
 520
 521 void PMTopLevelManager::initializeAllAnalysisInfo() {
 522
 523   for (std::vector<PMDataManager *>::iterator I = PassManagers.begin(),
 524          E = PassManagers.end(); I != E; ++I) {
 525     PMDataManager *PMD = *I;
 526     PMD->initializeAnalysisInfo();
 527   }
 528
 529   // Initailize other pass managers
 530   for (std::vector<PMDataManager *>::iterator I = IndirectPassManagers.begin(),
 531          E = IndirectPassManagers.end(); I != E; ++I)
 532     (*I)->initializeAnalysisInfo();
 533 }
 534
 535 /// Destructor
 536 PMTopLevelManager::~PMTopLevelManager() {
 537   for (std::vector<PMDataManager *>::iterator I = PassManagers.begin(),
 538          E = PassManagers.end(); I != E; ++I)
 539     delete *I;
 540
 541   for (std::vector<ImmutablePass *>::iterator
 542          I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
 543     delete *I;
 544 }
 545
 546 //===----------------------------------------------------------------------===//
 547 // PMDataManager implementation
 548
 549 /// Augement AvailableAnalysis by adding analysis made available by pass P.
 550 void PMDataManager::recordAvailableAnalysis(Pass *P) {
 551
 552   if (const PassInfo *PI = P->getPassInfo()) {
 553     AvailableAnalysis[PI] = P;
 554
 555     //This pass is the current implementation of all of the interfaces it
 556     //implements as well.
 557     const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
 558     for (unsigned i = 0, e = II.size(); i != e; ++i)
 559       AvailableAnalysis[II[i]] = P;
 560   }
 561 }
 562
 563 // Return true if P preserves high level analysis used by other
 564 // passes managed by this manager
 565 bool PMDataManager::preserveHigherLevelAnalysis(Pass *P) {
 566
 567   AnalysisUsage AnUsage;
 568   P->getAnalysisUsage(AnUsage);
 569
 570   if (AnUsage.getPreservesAll())
 571     return true;
 572
 573   const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
 574   for (std::vector<Pass *>::iterator I = HigherLevelAnalysis.begin(),
 575          E = HigherLevelAnalysis.end(); I  != E; ++I) {
 576     Pass *P1 = *I;
 577     if (!dynamic_cast<ImmutablePass*>(P1) &&
 578         std::find(PreservedSet.begin(), PreservedSet.end(),
 579                   P1->getPassInfo()) ==
 580            PreservedSet.end())
 581       return false;
 582   }
 583
 584   return true;
 585 }
 586
 587 /// verifyPreservedAnalysis -- Verify analysis presreved by pass P.
 588 void PMDataManager::verifyPreservedAnalysis(Pass *P) {
 589   AnalysisUsage AnUsage;
 590   P->getAnalysisUsage(AnUsage);
 591   const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
 592
 593   // Verify preserved analysis
 594   for (std::vector<AnalysisID>::const_iterator I = PreservedSet.begin(),
 595          E = PreservedSet.end(); I != E; ++I) {
 596     AnalysisID AID = *I;
 597     Pass *AP = findAnalysisPass(AID, true);
 598     if (AP)
 599       AP->verifyAnalysis();
 600   }
 601 }
 602
 603 /// Remove Analyss not preserved by Pass P
 604 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
 605   AnalysisUsage AnUsage;
 606   P->getAnalysisUsage(AnUsage);
 607   if (AnUsage.getPreservesAll())
 608     return;
 609
 610   const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
 611   for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
 612          E = AvailableAnalysis.end(); I != E; ) {
 613     std::map<AnalysisID, Pass*>::iterator Info = I++;
 614     if (!dynamic_cast<ImmutablePass*>(Info->second)
 615         && std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
 616            PreservedSet.end())
 617       // Remove this analysis
 618       AvailableAnalysis.erase(Info);
 619   }
 620
 621   // Check inherited analysis also. If P is not preserving analysis
 622   // provided by parent manager then remove it here.
 623   for (unsigned Index = 0; Index < PMT_Last; ++Index) {
 624
 625     if (!InheritedAnalysis[Index])
 626       continue;
 627
 628     for (std::map<AnalysisID, Pass*>::iterator
 629            I = InheritedAnalysis[Index]->begin(),
 630            E = InheritedAnalysis[Index]->end(); I != E; ) {
 631       std::map<AnalysisID, Pass *>::iterator Info = I++;
 632       if (!dynamic_cast<ImmutablePass*>(Info->second) &&
 633           std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
 634              PreservedSet.end())
 635         // Remove this analysis
 636         InheritedAnalysis[Index]->erase(Info);
 637     }
 638   }
 639
 640 }
 641
 642 /// Remove analysis passes that are not used any longer
 643 void PMDataManager::removeDeadPasses(Pass *P, const char *Msg,
 644                                      enum PassDebuggingString DBG_STR) {
 645
 646   SmallVector<Pass *, 12> DeadPasses;
 647
 648   // If this is a on the fly manager then it does not have TPM.
 649   if (!TPM)
 650     return;
 651
 652   TPM->collectLastUses(DeadPasses, P);
 653
 654   for (SmallVector<Pass *, 12>::iterator I = DeadPasses.begin(),
 655          E = DeadPasses.end(); I != E; ++I) {
 656
 657     dumpPassInfo(*I, FREEING_MSG, DBG_STR, Msg);
 658
 659     if (TheTimeInfo) TheTimeInfo->passStarted(*I);
 660     (*I)->releaseMemory();
 661     if (TheTimeInfo) TheTimeInfo->passEnded(*I);
 662
 663     std::map<AnalysisID, Pass*>::iterator Pos =
 664       AvailableAnalysis.find((*I)->getPassInfo());
 665
 666     // It is possible that pass is already removed from the AvailableAnalysis
 667     if (Pos != AvailableAnalysis.end())
 668       AvailableAnalysis.erase(Pos);
 669   }
 670 }
 671
 672 /// Add pass P into the PassVector. Update
 673 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
 674 void PMDataManager::add(Pass *P,
 675                         bool ProcessAnalysis) {
 676
 677   // This manager is going to manage pass P. Set up analysis resolver
 678   // to connect them.
 679   AnalysisResolver *AR = new AnalysisResolver(*this);
 680   P->setResolver(AR);
 681
 682   // If a FunctionPass F is the last user of ModulePass info M
 683   // then the F's manager, not F, records itself as a last user of M.
 684   SmallVector<Pass *, 12> TransferLastUses;
 685
 686   if (ProcessAnalysis) {
 687
 688     // At the moment, this pass is the last user of all required passes.
 689     SmallVector<Pass *, 12> LastUses;
 690     SmallVector<Pass *, 8> RequiredPasses;
 691     SmallVector<AnalysisID, 8> ReqAnalysisNotAvailable;
 692
 693     unsigned PDepth = this->getDepth();
 694
 695     collectRequiredAnalysis(RequiredPasses,
 696                             ReqAnalysisNotAvailable, P);
 697     for (SmallVector<Pass *, 8>::iterator I = RequiredPasses.begin(),
 698            E = RequiredPasses.end(); I != E; ++I) {
 699       Pass *PRequired = *I;
 700       unsigned RDepth = 0;
 701
 702       PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
 703       RDepth = DM.getDepth();
 704
 705       if (PDepth == RDepth)
 706         LastUses.push_back(PRequired);
 707       else if (PDepth >  RDepth) {
 708         // Let the parent claim responsibility of last use
 709         TransferLastUses.push_back(PRequired);
 710         // Keep track of higher level analysis used by this manager.
 711         HigherLevelAnalysis.push_back(PRequired);
 712       } else
 713         assert (0 && "Unable to accomodate Required Pass");
 714     }
 715
 716     // Set P as P's last user until someone starts using P.
 717     // However, if P is a Pass Manager then it does not need
 718     // to record its last user.
 719     if (!dynamic_cast<PMDataManager *>(P))
 720       LastUses.push_back(P);
 721     TPM->setLastUser(LastUses, P);
 722
 723     if (!TransferLastUses.empty()) {
 724       Pass *My_PM = dynamic_cast<Pass *>(this);
 725       TPM->setLastUser(TransferLastUses, My_PM);
 726       TransferLastUses.clear();
 727     }
 728
 729     // Now, take care of required analysises that are not available.
 730     for (SmallVector<AnalysisID, 8>::iterator
 731            I = ReqAnalysisNotAvailable.begin(),
 732            E = ReqAnalysisNotAvailable.end() ;I != E; ++I) {
 733       Pass *AnalysisPass = (*I)->createPass();
 734       this->addLowerLevelRequiredPass(P, AnalysisPass);
 735     }
 736
 737     // Take a note of analysis required and made available by this pass.
 738     // Remove the analysis not preserved by this pass
 739     removeNotPreservedAnalysis(P);
 740     recordAvailableAnalysis(P);
 741   }
 742
 743   // Add pass
 744   PassVector.push_back(P);
 745 }
 746
 747
 748 /// Populate RP with analysis pass that are required by
 749 /// pass P and are available. Populate RP_NotAvail with analysis
 750 /// pass that are required by pass P but are not available.
 751 void PMDataManager::collectRequiredAnalysis(SmallVector<Pass *, 8>&RP,
 752                                        SmallVector<AnalysisID, 8> &RP_NotAvail,
 753                                             Pass *P) {
 754   AnalysisUsage AnUsage;
 755   P->getAnalysisUsage(AnUsage);
 756   const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
 757   for (std::vector<AnalysisID>::const_iterator
 758          I = RequiredSet.begin(), E = RequiredSet.end();
 759        I != E; ++I) {
 760     AnalysisID AID = *I;
 761     if (Pass *AnalysisPass = findAnalysisPass(*I, true))
 762       RP.push_back(AnalysisPass);
 763     else
 764       RP_NotAvail.push_back(AID);
 765   }
 766
 767   const std::vector<AnalysisID> &IDs = AnUsage.getRequiredTransitiveSet();
 768   for (std::vector<AnalysisID>::const_iterator I = IDs.begin(),
 769          E = IDs.end(); I != E; ++I) {
 770     AnalysisID AID = *I;
 771     if (Pass *AnalysisPass = findAnalysisPass(*I, true))
 772       RP.push_back(AnalysisPass);
 773     else
 774       RP_NotAvail.push_back(AID);
 775   }
 776 }
 777
 778 // All Required analyses should be available to the pass as it runs!  Here
 779 // we fill in the AnalysisImpls member of the pass so that it can
 780 // successfully use the getAnalysis() method to retrieve the
 781 // implementations it needs.
 782 //
 783 void PMDataManager::initializeAnalysisImpl(Pass *P) {
 784   AnalysisUsage AnUsage;
 785   P->getAnalysisUsage(AnUsage);
 786
 787   for (std::vector<const PassInfo *>::const_iterator
 788          I = AnUsage.getRequiredSet().begin(),
 789          E = AnUsage.getRequiredSet().end(); I != E; ++I) {
 790     Pass *Impl = findAnalysisPass(*I, true);
 791     if (Impl == 0)
 792       // This may be analysis pass that is initialized on the fly.
 793       // If that is not the case then it will raise an assert when it is used.
 794       continue;
 795     AnalysisResolver *AR = P->getResolver();
 796     AR->addAnalysisImplsPair(*I, Impl);
 797   }
 798 }
 799
 800 /// Find the pass that implements Analysis AID. If desired pass is not found
 801 /// then return NULL.
 802 Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
 803
 804   // Check if AvailableAnalysis map has one entry.
 805   std::map<AnalysisID, Pass*>::const_iterator I =  AvailableAnalysis.find(AID);
 806
 807   if (I != AvailableAnalysis.end())
 808     return I->second;
 809
 810   // Search Parents through TopLevelManager
 811   if (SearchParent)
 812     return TPM->findAnalysisPass(AID);
 813
 814   return NULL;
 815 }
 816
 817 // Print list of passes that are last used by P.
 818 void PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{
 819
 820   SmallVector<Pass *, 12> LUses;
 821
 822   // If this is a on the fly manager then it does not have TPM.
 823   if (!TPM)
 824     return;
 825
 826   TPM->collectLastUses(LUses, P);
 827
 828   for (SmallVector<Pass *, 12>::iterator I = LUses.begin(),
 829          E = LUses.end(); I != E; ++I) {
 830     llvm::cerr << "--" << std::string(Offset*2, ' ');
 831     (*I)->dumpPassStructure(0);
 832   }
 833 }
 834
 835 void PMDataManager::dumpPassArguments() const {
 836   for(std::vector<Pass *>::const_iterator I = PassVector.begin(),
 837         E = PassVector.end(); I != E; ++I) {
 838     if (PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I))
 839       PMD->dumpPassArguments();
 840     else
 841       if (const PassInfo *PI = (*I)->getPassInfo())
 842         if (!PI->isAnalysisGroup())
 843           cerr << " -" << PI->getPassArgument();
 844   }
 845 }
 846
 847 void PMDataManager::dumpPassInfo(Pass *P, enum PassDebuggingString S1,
 848                                  enum PassDebuggingString S2,
 849                                  const char *Msg) {
 850   if (PassDebugging < Executions)
 851     return;
 852   cerr << (void*)this << std::string(getDepth()*2+1, ' ');
 853   switch (S1) {
 854   case EXECUTION_MSG:
 855     cerr << "Executing Pass '" << P->getPassName();
 856     break;
 857   case MODIFICATION_MSG:
 858     cerr << "Made Modification '" << P->getPassName();
 859     break;
 860   case FREEING_MSG:
 861     cerr << " Freeing Pass '" << P->getPassName();
 862     break;
 863   default:
 864     break;
 865   }
 866   switch (S2) {
 867   case ON_BASICBLOCK_MSG:
 868     cerr << "' on BasicBlock '" << Msg << "'...\n";
 869     break;
 870   case ON_FUNCTION_MSG:
 871     cerr << "' on Function '" << Msg << "'...\n";
 872     break;
 873   case ON_MODULE_MSG:
 874     cerr << "' on Module '"  << Msg << "'...\n";
 875     break;
 876   case ON_LOOP_MSG:
 877     cerr << "' on Loop " << Msg << "'...\n";
 878     break;
 879   case ON_CG_MSG:
 880     cerr << "' on Call Graph " << Msg << "'...\n";
 881     break;
 882   default:
 883     break;
 884   }
 885 }
 886
 887 void PMDataManager::dumpAnalysisSetInfo(const char *Msg, Pass *P,
 888                                         const std::vector<AnalysisID> &Set)
 889   const {
 890   if (PassDebugging >= Details && !Set.empty()) {
 891     cerr << (void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:";
 892       for (unsigned i = 0; i != Set.size(); ++i) {
 893         if (i) cerr << ",";
 894         cerr << " " << Set[i]->getPassName();
 895       }
 896       cerr << "\n";
 897   }
 898 }
 899
 900 /// Add RequiredPass into list of lower level passes required by pass P.
 901 /// RequiredPass is run on the fly by Pass Manager when P requests it
 902 /// through getAnalysis interface.
 903 /// This should be handled by specific pass manager.
 904 void PMDataManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
 905   if (TPM) {
 906     TPM->dumpArguments();
 907     TPM->dumpPasses();
 908   }
 909
 910   // Module Level pass may required Function Level analysis info
 911   // (e.g. dominator info). Pass manager uses on the fly function pass manager
 912   // to provide this on demand. In that case, in Pass manager terminology,
 913   // module level pass is requiring lower level analysis info managed by
 914   // lower level pass manager.
 915
 916   // When Pass manager is not able to order required analysis info, Pass manager
 917   // checks whether any lower level manager will be able to provide this
 918   // analysis info on demand or not.
 919   assert (0 && "Unable to handle Pass that requires lower level Analysis pass");
 920 }
 921
 922 // Destructor
 923 PMDataManager::~PMDataManager() {
 924
 925   for (std::vector<Pass *>::iterator I = PassVector.begin(),
 926          E = PassVector.end(); I != E; ++I)
 927     delete *I;
 928
 929 }
 930
 931 //===----------------------------------------------------------------------===//
 932 // NOTE: Is this the right place to define this method ?
 933 // getAnalysisToUpdate - Return an analysis result or null if it doesn't exist
 934 Pass *AnalysisResolver::getAnalysisToUpdate(AnalysisID ID, bool dir) const {
 935   return PM.findAnalysisPass(ID, dir);
 936 }
 937
 938 Pass *AnalysisResolver::findImplPass(Pass *P, const PassInfo *AnalysisPI,
 939                                      Function &F) {
 940   return PM.getOnTheFlyPass(P, AnalysisPI, F);
 941 }
 942
 943 //===----------------------------------------------------------------------===//
 944 // BBPassManager implementation
 945
 946 /// Execute all of the passes scheduled for execution by invoking
 947 /// runOnBasicBlock method.  Keep track of whether any of the passes modifies
 948 /// the function, and if so, return true.
 949 bool
 950 BBPassManager::runOnFunction(Function &F) {
 951
 952   if (F.isDeclaration())
 953     return false;
 954
 955   bool Changed = doInitialization(F);
 956
 957   for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
 958     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 959       BasicBlockPass *BP = getContainedPass(Index);
 960       AnalysisUsage AnUsage;
 961       BP->getAnalysisUsage(AnUsage);
 962
 963       dumpPassInfo(BP, EXECUTION_MSG, ON_BASICBLOCK_MSG, I->getNameStart());
 964       dumpAnalysisSetInfo("Required", BP, AnUsage.getRequiredSet());
 965
 966       initializeAnalysisImpl(BP);
 967
 968       if (TheTimeInfo) TheTimeInfo->passStarted(BP);
 969       Changed |= BP->runOnBasicBlock(*I);
 970       if (TheTimeInfo) TheTimeInfo->passEnded(BP);
 971
 972       if (Changed)
 973         dumpPassInfo(BP, MODIFICATION_MSG, ON_BASICBLOCK_MSG,
 974                      I->getNameStart());
 975       dumpAnalysisSetInfo("Preserved", BP, AnUsage.getPreservedSet());
 976
 977       verifyPreservedAnalysis(BP);
 978       removeNotPreservedAnalysis(BP);
 979       recordAvailableAnalysis(BP);
 980       removeDeadPasses(BP, I->getNameStart(), ON_BASICBLOCK_MSG);
 981     }
 982
 983   return Changed |= doFinalization(F);
 984 }
 985
 986 // Implement doInitialization and doFinalization
 987 inline bool BBPassManager::doInitialization(Module &M) {
 988   bool Changed = false;
 989
 990   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 991     BasicBlockPass *BP = getContainedPass(Index);
 992     Changed |= BP->doInitialization(M);
 993   }
 994
 995   return Changed;
 996 }
 997
 998 inline bool BBPassManager::doFinalization(Module &M) {
 999   bool Changed = false;
1000
1001   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1002     BasicBlockPass *BP = getContainedPass(Index);
1003     Changed |= BP->doFinalization(M);
1004   }
1005
1006   return Changed;
1007 }
1008
1009 inline bool BBPassManager::doInitialization(Function &F) {
1010   bool Changed = false;
1011
1012   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1013     BasicBlockPass *BP = getContainedPass(Index);
1014     Changed |= BP->doInitialization(F);
1015   }
1016
1017   return Changed;
1018 }
1019
1020 inline bool BBPassManager::doFinalization(Function &F) {
1021   bool Changed = false;
1022
1023   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1024     BasicBlockPass *BP = getContainedPass(Index);
1025     Changed |= BP->doFinalization(F);
1026   }
1027
1028   return Changed;
1029 }
1030
1031
1032 //===----------------------------------------------------------------------===//
1033 // FunctionPassManager implementation
1034
1035 /// Create new Function pass manager
1036 FunctionPassManager::FunctionPassManager(ModuleProvider *P) {
1037   FPM = new FunctionPassManagerImpl(0);
1038   // FPM is the top level manager.
1039   FPM->setTopLevelManager(FPM);
1040
1041   PMDataManager *PMD = dynamic_cast<PMDataManager *>(FPM);
1042   AnalysisResolver *AR = new AnalysisResolver(*PMD);
1043   FPM->setResolver(AR);
1044
1045   MP = P;
1046 }
1047
1048 FunctionPassManager::~FunctionPassManager() {
1049   delete FPM;
1050 }
1051
1052 /// add - Add a pass to the queue of passes to run.  This passes
1053 /// ownership of the Pass to the PassManager.  When the
1054 /// PassManager_X is destroyed, the pass will be destroyed as well, so
1055 /// there is no need to delete the pass. (TODO delete passes.)
1056 /// This implies that all passes MUST be allocated with 'new'.
1057 void FunctionPassManager::add(Pass *P) {
1058   FPM->add(P);
1059 }
1060
1061 /// run - Execute all of the passes scheduled for execution.  Keep
1062 /// track of whether any of the passes modifies the function, and if
1063 /// so, return true.
1064 ///
1065 bool FunctionPassManager::run(Function &F) {
1066   std::string errstr;
1067   if (MP->materializeFunction(&F, &errstr)) {
1068     cerr << "Error reading bitcode file: " << errstr << "\n";
1069     abort();
1070   }
1071   return FPM->run(F);
1072 }
1073
1074
1075 /// doInitialization - Run all of the initializers for the function passes.
1076 ///
1077 bool FunctionPassManager::doInitialization() {
1078   return FPM->doInitialization(*MP->getModule());
1079 }
1080
1081 /// doFinalization - Run all of the finalizers for the function passes.
1082 ///
1083 bool FunctionPassManager::doFinalization() {
1084   return FPM->doFinalization(*MP->getModule());
1085 }
1086
1087 //===----------------------------------------------------------------------===//
1088 // FunctionPassManagerImpl implementation
1089 //
1090 inline bool FunctionPassManagerImpl::doInitialization(Module &M) {
1091   bool Changed = false;
1092
1093   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1094     FPPassManager *FP = getContainedManager(Index);
1095     Changed |= FP->doInitialization(M);
1096   }
1097
1098   return Changed;
1099 }
1100
1101 inline bool FunctionPassManagerImpl::doFinalization(Module &M) {
1102   bool Changed = false;
1103
1104   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1105     FPPassManager *FP = getContainedManager(Index);
1106     Changed |= FP->doFinalization(M);
1107   }
1108
1109   return Changed;
1110 }
1111
1112 // Execute all the passes managed by this top level manager.
1113 // Return true if any function is modified by a pass.
1114 bool FunctionPassManagerImpl::run(Function &F) {
1115
1116   bool Changed = false;
1117
1118   TimingInfo::createTheTimeInfo();
1119
1120   dumpArguments();
1121   dumpPasses();
1122
1123   initializeAllAnalysisInfo();
1124   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1125     FPPassManager *FP = getContainedManager(Index);
1126     Changed |= FP->runOnFunction(F);
1127   }
1128   return Changed;
1129 }
1130
1131 //===----------------------------------------------------------------------===//
1132 // FPPassManager implementation
1133
1134 char FPPassManager::ID = 0;
1135 /// Print passes managed by this manager
1136 void FPPassManager::dumpPassStructure(unsigned Offset) {
1137   llvm::cerr << std::string(Offset*2, ' ') << "FunctionPass Manager\n";
1138   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1139     FunctionPass *FP = getContainedPass(Index);
1140     FP->dumpPassStructure(Offset + 1);
1141     dumpLastUses(FP, Offset+1);
1142   }
1143 }
1144
1145
1146 /// Execute all of the passes scheduled for execution by invoking
1147 /// runOnFunction method.  Keep track of whether any of the passes modifies
1148 /// the function, and if so, return true.
1149 bool FPPassManager::runOnFunction(Function &F) {
1150
1151   bool Changed = false;
1152
1153   if (F.isDeclaration())
1154     return false;
1155
1156   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1157     FunctionPass *FP = getContainedPass(Index);
1158
1159     AnalysisUsage AnUsage;
1160     FP->getAnalysisUsage(AnUsage);
1161
1162     dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getNameStart());
1163     dumpAnalysisSetInfo("Required", FP, AnUsage.getRequiredSet());
1164
1165     initializeAnalysisImpl(FP);
1166
1167     if (TheTimeInfo) TheTimeInfo->passStarted(FP);
1168     Changed |= FP->runOnFunction(F);
1169     if (TheTimeInfo) TheTimeInfo->passEnded(FP);
1170
1171     if (Changed)
1172       dumpPassInfo(FP, MODIFICATION_MSG, ON_FUNCTION_MSG, F.getNameStart());
1173     dumpAnalysisSetInfo("Preserved", FP, AnUsage.getPreservedSet());
1174
1175     verifyPreservedAnalysis(FP);
1176     removeNotPreservedAnalysis(FP);
1177     recordAvailableAnalysis(FP);
1178     removeDeadPasses(FP, F.getNameStart(), ON_FUNCTION_MSG);
1179   }
1180   return Changed;
1181 }
1182
1183 bool FPPassManager::runOnModule(Module &M) {
1184
1185   bool Changed = doInitialization(M);
1186
1187   for(Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1188     this->runOnFunction(*I);
1189
1190   return Changed |= doFinalization(M);
1191 }
1192
1193 inline bool FPPassManager::doInitialization(Module &M) {
1194   bool Changed = false;
1195
1196   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1197     FunctionPass *FP = getContainedPass(Index);
1198     Changed |= FP->doInitialization(M);
1199   }
1200
1201   return Changed;
1202 }
1203
1204 inline bool FPPassManager::doFinalization(Module &M) {
1205   bool Changed = false;
1206
1207   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1208     FunctionPass *FP = getContainedPass(Index);
1209     Changed |= FP->doFinalization(M);
1210   }
1211
1212   return Changed;
1213 }
1214
1215 //===----------------------------------------------------------------------===//
1216 // MPPassManager implementation
1217
1218 /// Execute all of the passes scheduled for execution by invoking
1219 /// runOnModule method.  Keep track of whether any of the passes modifies
1220 /// the module, and if so, return true.
1221 bool
1222 MPPassManager::runOnModule(Module &M) {
1223   bool Changed = false;
1224
1225   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1226     ModulePass *MP = getContainedPass(Index);
1227
1228     AnalysisUsage AnUsage;
1229     MP->getAnalysisUsage(AnUsage);
1230
1231     dumpPassInfo(MP, EXECUTION_MSG, ON_MODULE_MSG,
1232                  M.getModuleIdentifier().c_str());
1233     dumpAnalysisSetInfo("Required", MP, AnUsage.getRequiredSet());
1234
1235     initializeAnalysisImpl(MP);
1236
1237     if (TheTimeInfo) TheTimeInfo->passStarted(MP);
1238     Changed |= MP->runOnModule(M);
1239     if (TheTimeInfo) TheTimeInfo->passEnded(MP);
1240
1241     if (Changed)
1242       dumpPassInfo(MP, MODIFICATION_MSG, ON_MODULE_MSG,
1243                    M.getModuleIdentifier().c_str());
1244     dumpAnalysisSetInfo("Preserved", MP, AnUsage.getPreservedSet());
1245
1246     verifyPreservedAnalysis(MP);
1247     removeNotPreservedAnalysis(MP);
1248     recordAvailableAnalysis(MP);
1249     removeDeadPasses(MP, M.getModuleIdentifier().c_str(), ON_MODULE_MSG);
1250   }
1251   return Changed;
1252 }
1253
1254 /// Add RequiredPass into list of lower level passes required by pass P.
1255 /// RequiredPass is run on the fly by Pass Manager when P requests it
1256 /// through getAnalysis interface.
1257 void MPPassManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
1258
1259   assert (P->getPotentialPassManagerType() == PMT_ModulePassManager
1260           && "Unable to handle Pass that requires lower level Analysis pass");
1261   assert ((P->getPotentialPassManagerType() <
1262            RequiredPass->getPotentialPassManagerType())
1263           && "Unable to handle Pass that requires lower level Analysis pass");
1264
1265   FunctionPassManagerImpl *FPP = OnTheFlyManagers[P];
1266   if (!FPP) {
1267     FPP = new FunctionPassManagerImpl(0);
1268     // FPP is the top level manager.
1269     FPP->setTopLevelManager(FPP);
1270
1271     OnTheFlyManagers[P] = FPP;
1272   }
1273   FPP->add(RequiredPass);
1274
1275   // Register P as the last user of RequiredPass.
1276   SmallVector<Pass *, 12> LU;
1277   LU.push_back(RequiredPass);
1278   FPP->setLastUser(LU,  P);
1279 }
1280
1281 /// Return function pass corresponding to PassInfo PI, that is
1282 /// required by module pass MP. Instantiate analysis pass, by using
1283 /// its runOnFunction() for function F.
1284 Pass* MPPassManager::getOnTheFlyPass(Pass *MP, const PassInfo *PI,
1285                                      Function &F) {
1286    AnalysisID AID = PI;
1287   FunctionPassManagerImpl *FPP = OnTheFlyManagers[MP];
1288   assert (FPP && "Unable to find on the fly pass");
1289
1290   FPP->run(F);
1291   return (dynamic_cast<PMTopLevelManager *>(FPP))->findAnalysisPass(AID);
1292 }
1293
1294
1295 //===----------------------------------------------------------------------===//
1296 // PassManagerImpl implementation
1297 //
1298 /// run - Execute all of the passes scheduled for execution.  Keep track of
1299 /// whether any of the passes modifies the module, and if so, return true.
1300 bool PassManagerImpl::run(Module &M) {
1301
1302   bool Changed = false;
1303
1304   TimingInfo::createTheTimeInfo();
1305
1306   dumpArguments();
1307   dumpPasses();
1308
1309   initializeAllAnalysisInfo();
1310   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1311     MPPassManager *MP = getContainedManager(Index);
1312     Changed |= MP->runOnModule(M);
1313   }
1314   return Changed;
1315 }
1316
1317 //===----------------------------------------------------------------------===//
1318 // PassManager implementation
1319
1320 /// Create new pass manager
1321 PassManager::PassManager() {
1322   PM = new PassManagerImpl(0);
1323   // PM is the top level manager
1324   PM->setTopLevelManager(PM);
1325 }
1326
1327 PassManager::~PassManager() {
1328   delete PM;
1329 }
1330
1331 /// add - Add a pass to the queue of passes to run.  This passes ownership of
1332 /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
1333 /// will be destroyed as well, so there is no need to delete the pass.  This
1334 /// implies that all passes MUST be allocated with 'new'.
1335 void
1336 PassManager::add(Pass *P) {
1337   PM->add(P);
1338 }
1339
1340 /// run - Execute all of the passes scheduled for execution.  Keep track of
1341 /// whether any of the passes modifies the module, and if so, return true.
1342 bool
1343 PassManager::run(Module &M) {
1344   return PM->run(M);
1345 }
1346
1347 //===----------------------------------------------------------------------===//
1348 // TimingInfo Class - This class is used to calculate information about the
1349 // amount of time each pass takes to execute.  This only happens with
1350 // -time-passes is enabled on the command line.
1351 //
1352 bool llvm::TimePassesIsEnabled = false;
1353 static cl::opt<bool,true>
1354 EnableTiming("time-passes", cl::location(TimePassesIsEnabled),
1355             cl::desc("Time each pass, printing elapsed time for each on exit"));
1356
1357 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
1358 // a non null value (if the -time-passes option is enabled) or it leaves it
1359 // null.  It may be called multiple times.
1360 void TimingInfo::createTheTimeInfo() {
1361   if (!TimePassesIsEnabled || TheTimeInfo) return;
1362
1363   // Constructed the first time this is called, iff -time-passes is enabled.
1364   // This guarantees that the object will be constructed before static globals,
1365   // thus it will be destroyed before them.
1366   static ManagedStatic<TimingInfo> TTI;
1367   TheTimeInfo = &*TTI;
1368 }
1369
1370 /// If TimingInfo is enabled then start pass timer.
1371 void StartPassTimer(Pass *P) {
1372   if (TheTimeInfo)
1373     TheTimeInfo->passStarted(P);
1374 }
1375
1376 /// If TimingInfo is enabled then stop pass timer.
1377 void StopPassTimer(Pass *P) {
1378   if (TheTimeInfo)
1379     TheTimeInfo->passEnded(P);
1380 }
1381
1382 //===----------------------------------------------------------------------===//
1383 // PMStack implementation
1384 //
1385
1386 // Pop Pass Manager from the stack and clear its analysis info.
1387 void PMStack::pop() {
1388
1389   PMDataManager *Top = this->top();
1390   Top->initializeAnalysisInfo();
1391
1392   S.pop_back();
1393 }
1394
1395 // Push PM on the stack and set its top level manager.
1396 void PMStack::push(PMDataManager *PM) {
1397
1398   PMDataManager *Top = NULL;
1399   assert (PM && "Unable to push. Pass Manager expected");
1400
1401   if (this->empty()) {
1402     Top = PM;
1403   }
1404   else {
1405     Top = this->top();
1406     PMTopLevelManager *TPM = Top->getTopLevelManager();
1407
1408     assert (TPM && "Unable to find top level manager");
1409     TPM->addIndirectPassManager(PM);
1410     PM->setTopLevelManager(TPM);
1411   }
1412
1413   S.push_back(PM);
1414 }
1415
1416 // Dump content of the pass manager stack.
1417 void PMStack::dump() {
1418   for(std::deque<PMDataManager *>::iterator I = S.begin(),
1419         E = S.end(); I != E; ++I) {
1420     Pass *P = dynamic_cast<Pass *>(*I);
1421     printf("%s ", P->getPassName());
1422   }
1423   if (!S.empty())
1424     printf("\n");
1425 }
1426
1427 /// Find appropriate Module Pass Manager in the PM Stack and
1428 /// add self into that manager.
1429 void ModulePass::assignPassManager(PMStack &PMS,
1430                                    PassManagerType PreferredType) {
1431
1432   // Find Module Pass Manager
1433   while(!PMS.empty()) {
1434     PassManagerType TopPMType = PMS.top()->getPassManagerType();
1435     if (TopPMType == PreferredType)
1436       break; // We found desired pass manager
1437     else if (TopPMType > PMT_ModulePassManager)
1438       PMS.pop();    // Pop children pass managers
1439     else
1440       break;
1441   }
1442
1443   PMS.top()->add(this);
1444 }
1445
1446 /// Find appropriate Function Pass Manager or Call Graph Pass Manager
1447 /// in the PM Stack and add self into that manager.
1448 void FunctionPass::assignPassManager(PMStack &PMS,
1449                                      PassManagerType PreferredType) {
1450
1451   // Find Module Pass Manager (TODO : Or Call Graph Pass Manager)
1452   while(!PMS.empty()) {
1453     if (PMS.top()->getPassManagerType() > PMT_FunctionPassManager)
1454       PMS.pop();
1455     else
1456       break;
1457   }
1458   FPPassManager *FPP = dynamic_cast<FPPassManager *>(PMS.top());
1459
1460   // Create new Function Pass Manager
1461   if (!FPP) {
1462     assert(!PMS.empty() && "Unable to create Function Pass Manager");
1463     PMDataManager *PMD = PMS.top();
1464
1465     // [1] Create new Function Pass Manager
1466     FPP = new FPPassManager(PMD->getDepth() + 1);
1467
1468     // [2] Set up new manager's top level manager
1469     PMTopLevelManager *TPM = PMD->getTopLevelManager();
1470     TPM->addIndirectPassManager(FPP);
1471
1472     // [3] Assign manager to manage this new manager. This may create
1473     // and push new managers into PMS
1474     Pass *P = dynamic_cast<Pass *>(FPP);
1475
1476     // If Call Graph Pass Manager is active then use it to manage
1477     // this new Function Pass manager.
1478     if (PMD->getPassManagerType() == PMT_CallGraphPassManager)
1479       P->assignPassManager(PMS, PMT_CallGraphPassManager);
1480     else
1481       P->assignPassManager(PMS);
1482
1483     // [4] Push new manager into PMS
1484     PMS.push(FPP);
1485   }
1486
1487   // Assign FPP as the manager of this pass.
1488   FPP->add(this);
1489 }
1490
1491 /// Find appropriate Basic Pass Manager or Call Graph Pass Manager
1492 /// in the PM Stack and add self into that manager.
1493 void BasicBlockPass::assignPassManager(PMStack &PMS,
1494                                        PassManagerType PreferredType) {
1495
1496   BBPassManager *BBP = NULL;
1497
1498   // Basic Pass Manager is a leaf pass manager. It does not handle
1499   // any other pass manager.
1500   if (!PMS.empty())
1501     BBP = dynamic_cast<BBPassManager *>(PMS.top());
1502
1503   // If leaf manager is not Basic Block Pass manager then create new
1504   // basic Block Pass manager.
1505
1506   if (!BBP) {
1507     assert(!PMS.empty() && "Unable to create BasicBlock Pass Manager");
1508     PMDataManager *PMD = PMS.top();
1509
1510     // [1] Create new Basic Block Manager
1511     BBP = new BBPassManager(PMD->getDepth() + 1);
1512
1513     // [2] Set up new manager's top level manager
1514     // Basic Block Pass Manager does not live by itself
1515     PMTopLevelManager *TPM = PMD->getTopLevelManager();
1516     TPM->addIndirectPassManager(BBP);
1517
1518     // [3] Assign manager to manage this new manager. This may create
1519     // and push new managers into PMS
1520     Pass *P = dynamic_cast<Pass *>(BBP);
1521     P->assignPassManager(PMS);
1522
1523     // [4] Push new manager into PMS
1524     PMS.push(BBP);
1525   }
1526
1527   // Assign BBP as the manager of this pass.
1528   BBP->add(this);
1529 }
1530
1531 PassManagerBase::~PassManagerBase() {}