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