lib/VMCore/PassManager.cpp

   1 //===- PassManager.cpp - LLVM Pass Infrastructure Implementation ----------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Devang Patel and is distributed under
   6 // the University of Illinois Open Source 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/PassManager.h"
  16 #include "llvm/Module.h"
  17 #include "llvm/ModuleProvider.h"
  18 #include "llvm/Support/Streams.h"
  19 #include <vector>
  20 #include <map>
  21 using namespace llvm;
  22
  23 //===----------------------------------------------------------------------===//
  24 // Overview:
  25 // The Pass Manager Infrastructure manages passes. It's responsibilities are:
  26 //
  27 //   o Manage optimization pass execution order
  28 //   o Make required Analysis information available before pass P is run
  29 //   o Release memory occupied by dead passes
  30 //   o If Analysis information is dirtied by a pass then regenerate Analysis
  31 //     information before it is consumed by another pass.
  32 //
  33 // Pass Manager Infrastructure uses multipe pass managers. They are PassManager,
  34 // FunctionPassManager, ModulePassManager, BasicBlockPassManager. This class
  35 // hierarcy uses multiple inheritance but pass managers do not derive from
  36 // another pass manager.
  37 //
  38 // PassManager and FunctionPassManager are two top level pass manager that
  39 // represents the external interface of this entire pass manager infrastucture.
  40 //
  41 // Important classes :
  42 //
  43 // [o] class PMTopLevelManager;
  44 //
  45 // Two top level managers, PassManager and FunctionPassManager, derive from
  46 // PMTopLevelManager. PMTopLevelManager manages information used by top level
  47 // managers such as last user info.
  48 //
  49 // [o] class PMDataManager;
  50 //
  51 // PMDataManager manages information, e.g. list of available analysis info,
  52 // used by a pass manager to manage execution order of passes. It also provides
  53 // a place to implement common pass manager APIs. All pass managers derive from
  54 // PMDataManager.
  55 //
  56 // [o] class BasicBlockPassManager : public FunctionPass, public PMDataManager;
  57 //
  58 // BasicBlockPassManager manages BasicBlockPasses.
  59 //
  60 // [o] class FunctionPassManager;
  61 //
  62 // This is a external interface used by JIT to manage FunctionPasses. This
  63 // interface relies on FunctionPassManagerImpl to do all the tasks.
  64 //
  65 // [o] class FunctionPassManagerImpl : public ModulePass, PMDataManager,
  66 //                                     public PMTopLevelManager;
  67 //
  68 // FunctionPassManagerImpl is a top level manager. It manages FunctionPasses
  69 // and BasicBlockPassManagers.
  70 //
  71 // [o] class ModulePassManager : public Pass, public PMDataManager;
  72 //
  73 // ModulePassManager manages ModulePasses and FunctionPassManagerImpls.
  74 //
  75 // [o] class PassManager;
  76 //
  77 // This is a external interface used by various tools to manages passes. It
  78 // relies on PassManagerImpl to do all the tasks.
  79 //
  80 // [o] class PassManagerImpl : public Pass, public PMDataManager,
  81 //                             public PMDTopLevelManager
  82 //
  83 // PassManagerImpl is a top level pass manager responsible for managing
  84 // ModulePassManagers.
  85 //===----------------------------------------------------------------------===//
  86
  87 namespace llvm {
  88
  89 //===----------------------------------------------------------------------===//
  90 // PMTopLevelManager
  91 //
  92 /// PMTopLevelManager manages LastUser info and collects common APIs used by
  93 /// top level pass managers.
  94 class PMTopLevelManager {
  95
  96 public:
  97
  98   inline std::vector<Pass *>::iterator passManagersBegin() {
  99     return PassManagers.begin();
 100   }
 101
 102   inline std::vector<Pass *>::iterator passManagersEnd() {
 103     return PassManagers.end();
 104   }
 105
 106   /// Schedule pass P for execution. Make sure that passes required by
 107   /// P are run before P is run. Update analysis info maintained by
 108   /// the manager. Remove dead passes. This is a recursive function.
 109   void schedulePass(Pass *P, Pass *PM);
 110
 111   /// This is implemented by top level pass manager and used by
 112   /// schedulePass() to add analysis info passes that are not available.
 113   virtual void addTopLevelPass(Pass  *P) = 0;
 114
 115   /// Set pass P as the last user of the given analysis passes.
 116   void setLastUser(std::vector<Pass *> &AnalysisPasses, Pass *P);
 117
 118   /// Collect passes whose last user is P
 119   void collectLastUses(std::vector<Pass *> &LastUses, Pass *P);
 120
 121   virtual ~PMTopLevelManager() {
 122     PassManagers.clear();
 123   }
 124
 125   /// Add immutable pass and initialize it.
 126   inline void addImmutablePass(ImmutablePass *P) {
 127     P->initializePass();
 128     ImmutablePasses.push_back(P);
 129   }
 130
 131   inline std::vector<ImmutablePass *>& getImmutablePasses() {
 132     return ImmutablePasses;
 133   }
 134
 135 private:
 136
 137   /// Collection of pass managers
 138   std::vector<Pass *> PassManagers;
 139
 140   // Map to keep track of last user of the analysis pass.
 141   // LastUser->second is the last user of Lastuser->first.
 142   std::map<Pass *, Pass *> LastUser;
 143
 144   /// Immutable passes are managed by top level manager.
 145   std::vector<ImmutablePass *> ImmutablePasses;
 146 };
 147
 148 /// Set pass P as the last user of the given analysis passes.
 149 void PMTopLevelManager::setLastUser(std::vector<Pass *> &AnalysisPasses,
 150                                     Pass *P) {
 151
 152   for (std::vector<Pass *>::iterator I = AnalysisPasses.begin(),
 153          E = AnalysisPasses.end(); I != E; ++I) {
 154     Pass *AP = *I;
 155     LastUser[AP] = P;
 156     // If AP is the last user of other passes then make P last user of
 157     // such passes.
 158     for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
 159            LUE = LastUser.end(); LUI != LUE; ++LUI) {
 160       if (LUI->second == AP)
 161         LastUser[LUI->first] = P;
 162     }
 163   }
 164
 165 }
 166
 167 /// Collect passes whose last user is P
 168 void PMTopLevelManager::collectLastUses(std::vector<Pass *> &LastUses,
 169                                             Pass *P) {
 170    for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
 171           LUE = LastUser.end(); LUI != LUE; ++LUI)
 172       if (LUI->second == P)
 173         LastUses.push_back(LUI->first);
 174 }
 175
 176 /// Schedule pass P for execution. Make sure that passes required by
 177 /// P are run before P is run. Update analysis info maintained by
 178 /// the manager. Remove dead passes. This is a recursive function.
 179 void PMTopLevelManager::schedulePass(Pass *P, Pass *PM) {
 180
 181   // TODO : Allocate function manager for this pass, other wise required set
 182   // may be inserted into previous function manager
 183
 184   AnalysisUsage AnUsage;
 185   P->getAnalysisUsage(AnUsage);
 186   const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
 187   for (std::vector<AnalysisID>::const_iterator I = RequiredSet.begin(),
 188          E = RequiredSet.end(); I != E; ++I) {
 189
 190     Pass *AnalysisPass = NULL; // FIXME PM->getAnalysisPass(*I, true);
 191     if (!AnalysisPass) {
 192       // Schedule this analysis run first.
 193       AnalysisPass = (*I)->createPass();
 194       schedulePass(AnalysisPass, PM);
 195     }
 196   }
 197
 198   // Now all required passes are available.
 199   addTopLevelPass(P);
 200 }
 201
 202
 203 //===----------------------------------------------------------------------===//
 204 // PMDataManager
 205
 206 /// PMDataManager provides the common place to manage the analysis data
 207 /// used by pass managers.
 208 class PMDataManager {
 209
 210 public:
 211
 212   PMDataManager() : TPM(NULL) {
 213     initializeAnalysisInfo();
 214   }
 215
 216   /// Return true IFF pass P's required analysis set does not required new
 217   /// manager.
 218   bool manageablePass(Pass *P);
 219
 220   Pass *getAnalysisPass(AnalysisID AID) const {
 221
 222     std::map<AnalysisID, Pass*>::const_iterator I =
 223       AvailableAnalysis.find(AID);
 224
 225     if (I != AvailableAnalysis.end())
 226       return NULL;
 227     else
 228       return I->second;
 229   }
 230
 231   /// Augment AvailableAnalysis by adding analysis made available by pass P.
 232   void recordAvailableAnalysis(Pass *P);
 233
 234   /// Remove Analysis that is not preserved by the pass
 235   void removeNotPreservedAnalysis(Pass *P);
 236
 237   /// Remove dead passes
 238   void removeDeadPasses(Pass *P);
 239
 240   /// Add pass P into the PassVector. Update
 241   /// AvailableAnalysis appropriately if ProcessAnalysis is true.
 242   void addPassToManager (Pass *P, bool ProcessAnalysis = true);
 243
 244   // Initialize available analysis information.
 245   void initializeAnalysisInfo() {
 246     AvailableAnalysis.clear();
 247     LastUser.clear();
 248
 249     // Include immutable passes into AvailableAnalysis vector.
 250     std::vector<ImmutablePass *> &ImmutablePasses =  TPM->getImmutablePasses();
 251     for (std::vector<ImmutablePass *>::iterator I = ImmutablePasses.begin(),
 252            E = ImmutablePasses.end(); I != E; ++I)
 253       recordAvailableAnalysis(*I);
 254   }
 255
 256   // All Required analyses should be available to the pass as it runs!  Here
 257   // we fill in the AnalysisImpls member of the pass so that it can
 258   // successfully use the getAnalysis() method to retrieve the
 259   // implementations it needs.
 260   //
 261  void initializeAnalysisImpl(Pass *P);
 262
 263   inline std::vector<Pass *>::iterator passVectorBegin() {
 264     return PassVector.begin();
 265   }
 266
 267   inline std::vector<Pass *>::iterator passVectorEnd() {
 268     return PassVector.end();
 269   }
 270
 271   inline void setLastUser(Pass *P, Pass *LU) {
 272     LastUser[P] = LU;
 273     // TODO : Check if pass P is available.
 274   }
 275
 276   // Access toplevel manager
 277   PMTopLevelManager *getTopLevelManager() { return TPM; }
 278   void setTopLevelManager(PMTopLevelManager *T) { TPM = T; }
 279
 280 private:
 281   // Set of available Analysis. This information is used while scheduling
 282   // pass. If a pass requires an analysis which is not not available then
 283   // equired analysis pass is scheduled to run before the pass itself is
 284   // scheduled to run.
 285   std::map<AnalysisID, Pass*> AvailableAnalysis;
 286
 287   // Map to keep track of last user of the analysis pass.
 288   // LastUser->second is the last user of Lastuser->first.
 289   std::map<Pass *, Pass *> LastUser;
 290
 291   // Collection of pass that are managed by this manager
 292   std::vector<Pass *> PassVector;
 293
 294   // Top level manager.
 295   // TODO : Make it a reference.
 296   PMTopLevelManager *TPM;
 297 };
 298
 299 /// BasicBlockPassManager_New manages BasicBlockPass. It batches all the
 300 /// pass together and sequence them to process one basic block before
 301 /// processing next basic block.
 302 class BasicBlockPassManager_New : public PMDataManager,
 303                                   public FunctionPass {
 304
 305 public:
 306   BasicBlockPassManager_New() { }
 307
 308   /// Add a pass into a passmanager queue.
 309   bool addPass(Pass *p);
 310
 311   /// Execute all of the passes scheduled for execution.  Keep track of
 312   /// whether any of the passes modifies the function, and if so, return true.
 313   bool runOnFunction(Function &F);
 314
 315   /// Return true IFF AnalysisID AID is currently available.
 316   /// TODO : Replace this method with getAnalysisPass()
 317   Pass *getAnalysisPassFromManager(AnalysisID AID);
 318
 319   /// Pass Manager itself does not invalidate any analysis info.
 320   void getAnalysisUsage(AnalysisUsage &Info) const {
 321     Info.setPreservesAll();
 322   }
 323
 324 private:
 325 };
 326
 327 /// FunctionPassManagerImpl_New manages FunctionPasses and BasicBlockPassManagers.
 328 /// It batches all function passes and basic block pass managers together and
 329 /// sequence them to process one function at a time before processing next
 330 /// function.
 331 class FunctionPassManagerImpl_New : public ModulePass,
 332                                     public PMDataManager,
 333                                     public PMTopLevelManager {
 334 public:
 335   FunctionPassManagerImpl_New(ModuleProvider *P) { /* TODO */ }
 336   FunctionPassManagerImpl_New() {
 337     activeBBPassManager = NULL;
 338   }
 339   ~FunctionPassManagerImpl_New() { /* TODO */ };
 340
 341   inline void addTopLevelPass(Pass *P) {
 342     addPass(P);
 343   }
 344
 345   /// add - Add a pass to the queue of passes to run.  This passes
 346   /// ownership of the Pass to the PassManager.  When the
 347   /// PassManager_X is destroyed, the pass will be destroyed as well, so
 348   /// there is no need to delete the pass. (TODO delete passes.)
 349   /// This implies that all passes MUST be allocated with 'new'.
 350   void add(Pass *P) {
 351     schedulePass(P, this);
 352   }
 353
 354   /// Add pass into the pass manager queue.
 355   bool addPass(Pass *P);
 356
 357   /// Execute all of the passes scheduled for execution.  Keep
 358   /// track of whether any of the passes modifies the function, and if
 359   /// so, return true.
 360   bool runOnModule(Module &M);
 361   bool runOnFunction(Function &F);
 362
 363   /// Return true IFF AnalysisID AID is currently available.
 364   /// TODO : Replace this method with getAnalysisPass()
 365   Pass *getAnalysisPassFromManager(AnalysisID AID);
 366
 367   /// doInitialization - Run all of the initializers for the function passes.
 368   ///
 369   bool doInitialization(Module &M);
 370
 371   /// doFinalization - Run all of the initializers for the function passes.
 372   ///
 373   bool doFinalization(Module &M);
 374
 375   /// Pass Manager itself does not invalidate any analysis info.
 376   void getAnalysisUsage(AnalysisUsage &Info) const {
 377     Info.setPreservesAll();
 378   }
 379
 380 private:
 381   // Active Pass Managers
 382   BasicBlockPassManager_New *activeBBPassManager;
 383 };
 384
 385 /// ModulePassManager_New manages ModulePasses and function pass managers.
 386 /// It batches all Module passes  passes and function pass managers together and
 387 /// sequence them to process one module.
 388 class ModulePassManager_New : public PMDataManager {
 389
 390 public:
 391   ModulePassManager_New() { activeFunctionPassManager = NULL; }
 392
 393   /// Add a pass into a passmanager queue.
 394   bool addPass(Pass *p);
 395
 396   /// run - Execute all of the passes scheduled for execution.  Keep track of
 397   /// whether any of the passes modifies the module, and if so, return true.
 398   bool runOnModule(Module &M);
 399
 400   /// Return true IFF AnalysisID AID is currently available.
 401   /// TODO : Replace this method with getAnalysisPass()
 402   Pass *getAnalysisPassFromManager(AnalysisID AID);
 403
 404   /// Pass Manager itself does not invalidate any analysis info.
 405   void getAnalysisUsage(AnalysisUsage &Info) const {
 406     Info.setPreservesAll();
 407   }
 408
 409 private:
 410   // Active Pass Manager
 411   FunctionPassManagerImpl_New *activeFunctionPassManager;
 412 };
 413
 414 /// PassManager_New manages ModulePassManagers
 415 class PassManagerImpl_New : public Pass,
 416                             public PMDataManager,
 417                             public PMTopLevelManager {
 418
 419 public:
 420
 421   /// add - Add a pass to the queue of passes to run.  This passes ownership of
 422   /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
 423   /// will be destroyed as well, so there is no need to delete the pass.  This
 424   /// implies that all passes MUST be allocated with 'new'.
 425   void add(Pass *P) {
 426     schedulePass(P, this);
 427   }
 428
 429   /// run - Execute all of the passes scheduled for execution.  Keep track of
 430   /// whether any of the passes modifies the module, and if so, return true.
 431   bool run(Module &M);
 432
 433   /// Return true IFF AnalysisID AID is currently available.
 434   /// TODO : Replace this method with getAnalysisPass()
 435   Pass *getAnalysisPassFromManager(AnalysisID AID);
 436
 437   /// Pass Manager itself does not invalidate any analysis info.
 438   void getAnalysisUsage(AnalysisUsage &Info) const {
 439     Info.setPreservesAll();
 440   }
 441
 442   inline void addTopLevelPass(Pass *P) {
 443     addPass(P);
 444   }
 445
 446 private:
 447
 448   /// Add a pass into a passmanager queue.
 449   bool addPass(Pass *p);
 450
 451   // Collection of pass managers
 452   std::vector<ModulePassManager_New *> PassManagers;
 453
 454   // Active Pass Manager
 455   ModulePassManager_New *activeManager;
 456 };
 457
 458 } // End of llvm namespace
 459
 460 //===----------------------------------------------------------------------===//
 461 // PMDataManager implementation
 462
 463 /// Return true IFF pass P's required analysis set does not required new
 464 /// manager.
 465 bool PMDataManager::manageablePass(Pass *P) {
 466
 467   // TODO
 468   // If this pass is not preserving information that is required by a
 469   // pass maintained by higher level pass manager then do not insert
 470   // this pass into current manager. Use new manager. For example,
 471   // For example, If FunctionPass F is not preserving ModulePass Info M1
 472   // that is used by another ModulePass M2 then do not insert F in
 473   // current function pass manager.
 474   return true;
 475 }
 476
 477 /// Augement AvailableAnalysis by adding analysis made available by pass P.
 478 void PMDataManager::recordAvailableAnalysis(Pass *P) {
 479
 480   if (const PassInfo *PI = P->getPassInfo()) {
 481     AvailableAnalysis[PI] = P;
 482
 483     //This pass is the current implementation of all of the interfaces it
 484     //implements as well.
 485     const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
 486     for (unsigned i = 0, e = II.size(); i != e; ++i)
 487       AvailableAnalysis[II[i]] = P;
 488   }
 489 }
 490
 491 /// Remove Analyss not preserved by Pass P
 492 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
 493   AnalysisUsage AnUsage;
 494   P->getAnalysisUsage(AnUsage);
 495
 496   if (AnUsage.getPreservesAll())
 497     return;
 498
 499   const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
 500   for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
 501          E = AvailableAnalysis.end(); I != E; ++I ) {
 502     if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) ==
 503         PreservedSet.end()) {
 504       // Remove this analysis
 505       std::map<AnalysisID, Pass*>::iterator J = I++;
 506       AvailableAnalysis.erase(J);
 507     }
 508   }
 509 }
 510
 511 /// Remove analysis passes that are not used any longer
 512 void PMDataManager::removeDeadPasses(Pass *P) {
 513
 514   for (std::map<Pass *, Pass *>::iterator I = LastUser.begin(),
 515          E = LastUser.end(); I !=E; ++I) {
 516     if (I->second == P) {
 517       Pass *deadPass = I->first;
 518       deadPass->releaseMemory();
 519
 520       std::map<AnalysisID, Pass*>::iterator Pos =
 521         AvailableAnalysis.find(deadPass->getPassInfo());
 522
 523       assert (Pos != AvailableAnalysis.end() &&
 524               "Pass is not available");
 525       AvailableAnalysis.erase(Pos);
 526     }
 527   }
 528 }
 529
 530 /// Add pass P into the PassVector. Update
 531 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
 532 void PMDataManager::addPassToManager(Pass *P,
 533                                      bool ProcessAnalysis) {
 534
 535   if (ProcessAnalysis) {
 536     // Take a note of analysis required and made available by this pass.
 537     // Remove the analysis not preserved by this pass
 538     initializeAnalysisImpl(P);
 539     removeNotPreservedAnalysis(P);
 540     recordAvailableAnalysis(P);
 541   }
 542
 543   // Add pass
 544   PassVector.push_back(P);
 545 }
 546
 547 // All Required analyses should be available to the pass as it runs!  Here
 548 // we fill in the AnalysisImpls member of the pass so that it can
 549 // successfully use the getAnalysis() method to retrieve the
 550 // implementations it needs.
 551 //
 552 void PMDataManager::initializeAnalysisImpl(Pass *P) {
 553   AnalysisUsage AnUsage;
 554   P->getAnalysisUsage(AnUsage);
 555
 556   for (std::vector<const PassInfo *>::const_iterator
 557          I = AnUsage.getRequiredSet().begin(),
 558          E = AnUsage.getRequiredSet().end(); I != E; ++I) {
 559     Pass *Impl = getAnalysisPass(*I);
 560     if (Impl == 0)
 561       assert(0 && "Analysis used but not available!");
 562     // TODO:  P->AnalysisImpls.push_back(std::make_pair(*I, Impl));
 563   }
 564 }
 565
 566 //===----------------------------------------------------------------------===//
 567 // BasicBlockPassManager_New implementation
 568
 569 /// Add pass P into PassVector and return true. If this pass is not
 570 /// manageable by this manager then return false.
 571 bool
 572 BasicBlockPassManager_New::addPass(Pass *P) {
 573
 574   BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
 575   if (!BP)
 576     return false;
 577
 578   // If this pass does not preserve anlysis that is used by other passes
 579   // managed by this manager than it is not a suiable pass for this manager.
 580   if (!manageablePass(P))
 581     return false;
 582
 583   addPassToManager (BP);
 584
 585   return true;
 586 }
 587
 588 /// Execute all of the passes scheduled for execution by invoking
 589 /// runOnBasicBlock method.  Keep track of whether any of the passes modifies
 590 /// the function, and if so, return true.
 591 bool
 592 BasicBlockPassManager_New::runOnFunction(Function &F) {
 593
 594   bool Changed = false;
 595   initializeAnalysisInfo();
 596
 597   for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
 598     for (std::vector<Pass *>::iterator itr = passVectorBegin(),
 599            e = passVectorEnd(); itr != e; ++itr) {
 600       Pass *P = *itr;
 601
 602       BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
 603       Changed |= BP->runOnBasicBlock(*I);
 604       removeNotPreservedAnalysis(P);
 605       recordAvailableAnalysis(P);
 606       removeDeadPasses(P);
 607     }
 608   return Changed;
 609 }
 610
 611 /// Return true IFF AnalysisID AID is currently available.
 612 /// TODO : Replace this method with getAnalysisPass()
 613 Pass * BasicBlockPassManager_New::getAnalysisPassFromManager(AnalysisID AID) {
 614   return getAnalysisPass(AID);
 615 }
 616
 617 //===----------------------------------------------------------------------===//
 618 // FunctionPassManager_New implementation
 619
 620 /// Create new Function pass manager
 621 FunctionPassManager_New::FunctionPassManager_New() {
 622   FPM = new FunctionPassManagerImpl_New();
 623 }
 624
 625 /// add - Add a pass to the queue of passes to run.  This passes
 626 /// ownership of the Pass to the PassManager.  When the
 627 /// PassManager_X is destroyed, the pass will be destroyed as well, so
 628 /// there is no need to delete the pass. (TODO delete passes.)
 629 /// This implies that all passes MUST be allocated with 'new'.
 630 void FunctionPassManager_New::add(Pass *P) {
 631   FPM->add(P);
 632 }
 633
 634 /// Execute all of the passes scheduled for execution.  Keep
 635 /// track of whether any of the passes modifies the function, and if
 636 /// so, return true.
 637 bool FunctionPassManager_New::runOnModule(Module &M) {
 638   return FPM->runOnModule(M);
 639 }
 640
 641 /// run - Execute all of the passes scheduled for execution.  Keep
 642 /// track of whether any of the passes modifies the function, and if
 643 /// so, return true.
 644 ///
 645 bool FunctionPassManager_New::run(Function &F) {
 646   std::string errstr;
 647   if (MP->materializeFunction(&F, &errstr)) {
 648     cerr << "Error reading bytecode file: " << errstr << "\n";
 649     abort();
 650   }
 651   return FPM->runOnFunction(F);
 652 }
 653
 654
 655 /// doInitialization - Run all of the initializers for the function passes.
 656 ///
 657 bool FunctionPassManager_New::doInitialization() {
 658   return FPM->doInitialization(*MP->getModule());
 659 }
 660
 661 /// doFinalization - Run all of the initializers for the function passes.
 662 ///
 663 bool FunctionPassManager_New::doFinalization() {
 664   return FPM->doFinalization(*MP->getModule());
 665 }
 666
 667 //===----------------------------------------------------------------------===//
 668 // FunctionPassManagerImpl_New implementation
 669
 670 /// Add pass P into the pass manager queue. If P is a BasicBlockPass then
 671 /// either use it into active basic block pass manager or create new basic
 672 /// block pass manager to handle pass P.
 673 bool
 674 FunctionPassManagerImpl_New::addPass(Pass *P) {
 675
 676   // If P is a BasicBlockPass then use BasicBlockPassManager_New.
 677   if (BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P)) {
 678
 679     if (!activeBBPassManager
 680         || !activeBBPassManager->addPass(BP)) {
 681
 682       // TODO : intialize AvailableAnalysis info
 683
 684       activeBBPassManager = new BasicBlockPassManager_New();
 685       addPassToManager(activeBBPassManager, false);
 686       if (!activeBBPassManager->addPass(BP))
 687         assert(0 && "Unable to add Pass");
 688     }
 689     return true;
 690   }
 691
 692   FunctionPass *FP = dynamic_cast<FunctionPass *>(P);
 693   if (!FP)
 694     return false;
 695
 696   // If this pass does not preserve anlysis that is used by other passes
 697   // managed by this manager than it is not a suiable pass for this manager.
 698   if (!manageablePass(P))
 699     return false;
 700
 701   addPassToManager (FP);
 702   // TODO : intialize AvailableAnalysis info
 703   activeBBPassManager = NULL;
 704   return true;
 705 }
 706
 707 /// Execute all of the passes scheduled for execution by invoking
 708 /// runOnFunction method.  Keep track of whether any of the passes modifies
 709 /// the function, and if so, return true.
 710 bool FunctionPassManagerImpl_New::runOnModule(Module &M) {
 711
 712   bool Changed = false;
 713   initializeAnalysisInfo();
 714
 715   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 716     for (std::vector<Pass *>::iterator itr = passVectorBegin(),
 717            e = passVectorEnd(); itr != e; ++itr) {
 718       Pass *P = *itr;
 719
 720       FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
 721       Changed |= FP->runOnFunction(*I);
 722       removeNotPreservedAnalysis(P);
 723       recordAvailableAnalysis(P);
 724       removeDeadPasses(P);
 725     }
 726   return Changed;
 727 }
 728
 729 /// Execute all of the passes scheduled for execution by invoking
 730 /// runOnFunction method.  Keep track of whether any of the passes modifies
 731 /// the function, and if so, return true.
 732 bool FunctionPassManagerImpl_New::runOnFunction(Function &F) {
 733
 734   bool Changed = false;
 735   initializeAnalysisInfo();
 736
 737   for (std::vector<Pass *>::iterator itr = passVectorBegin(),
 738          e = passVectorEnd(); itr != e; ++itr) {
 739     Pass *P = *itr;
 740
 741     FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
 742     Changed |= FP->runOnFunction(F);
 743     removeNotPreservedAnalysis(P);
 744     recordAvailableAnalysis(P);
 745     removeDeadPasses(P);
 746   }
 747   return Changed;
 748 }
 749
 750
 751 /// Return true IFF AnalysisID AID is currently available.
 752 /// TODO : Replace this method with getAnalysisPass()
 753 Pass *FunctionPassManagerImpl_New::getAnalysisPassFromManager(AnalysisID AID) {
 754
 755   Pass *P = getAnalysisPass(AID);
 756   if (P)
 757     return P;
 758
 759   if (activeBBPassManager &&
 760       activeBBPassManager->getAnalysisPass(AID) != 0)
 761     return activeBBPassManager->getAnalysisPass(AID);
 762
 763   // TODO : Check inactive managers
 764   return NULL;
 765 }
 766
 767 inline bool FunctionPassManagerImpl_New::doInitialization(Module &M) {
 768   bool Changed = false;
 769
 770   for (std::vector<Pass *>::iterator itr = passVectorBegin(),
 771          e = passVectorEnd(); itr != e; ++itr) {
 772     Pass *P = *itr;
 773
 774     FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
 775     Changed |= FP->doInitialization(M);
 776   }
 777
 778   return Changed;
 779 }
 780
 781 inline bool FunctionPassManagerImpl_New::doFinalization(Module &M) {
 782   bool Changed = false;
 783
 784   for (std::vector<Pass *>::iterator itr = passVectorBegin(),
 785          e = passVectorEnd(); itr != e; ++itr) {
 786     Pass *P = *itr;
 787
 788     FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
 789     Changed |= FP->doFinalization(M);
 790   }
 791
 792
 793   return Changed;
 794 }
 795
 796 //===----------------------------------------------------------------------===//
 797 // ModulePassManager implementation
 798
 799 /// Add P into pass vector if it is manageble. If P is a FunctionPass
 800 /// then use FunctionPassManagerImpl_New to manage it. Return false if P
 801 /// is not manageable by this manager.
 802 bool
 803 ModulePassManager_New::addPass(Pass *P) {
 804
 805   // If P is FunctionPass then use function pass maanager.
 806   if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P)) {
 807
 808     if (!activeFunctionPassManager
 809         || !activeFunctionPassManager->addPass(P)) {
 810
 811       // TODO : intialize AvailableAnalysis info
 812       activeFunctionPassManager = NULL;
 813
 814       activeFunctionPassManager = new FunctionPassManagerImpl_New();
 815       addPassToManager(activeFunctionPassManager, false);
 816       if (!activeFunctionPassManager->addPass(FP))
 817         assert(0 && "Unable to add pass");
 818     }
 819     return true;
 820   }
 821
 822   ModulePass *MP = dynamic_cast<ModulePass *>(P);
 823   if (!MP)
 824     return false;
 825
 826   // If this pass does not preserve anlysis that is used by other passes
 827   // managed by this manager than it is not a suiable pass for this manager.
 828   if (!manageablePass(P))
 829     return false;
 830
 831   addPassToManager(MP);
 832   // TODO : intialize AvailableAnalysis info
 833   activeFunctionPassManager = NULL;
 834   return true;
 835 }
 836
 837
 838 /// Execute all of the passes scheduled for execution by invoking
 839 /// runOnModule method.  Keep track of whether any of the passes modifies
 840 /// the module, and if so, return true.
 841 bool
 842 ModulePassManager_New::runOnModule(Module &M) {
 843   bool Changed = false;
 844   initializeAnalysisInfo();
 845
 846   for (std::vector<Pass *>::iterator itr = passVectorBegin(),
 847          e = passVectorEnd(); itr != e; ++itr) {
 848     Pass *P = *itr;
 849
 850     ModulePass *MP = dynamic_cast<ModulePass*>(P);
 851     Changed |= MP->runOnModule(M);
 852     removeNotPreservedAnalysis(P);
 853     recordAvailableAnalysis(P);
 854     removeDeadPasses(P);
 855   }
 856   return Changed;
 857 }
 858
 859 /// Return true IFF AnalysisID AID is currently available.
 860 /// TODO : Replace this method with getAnalysisPass()
 861 Pass *ModulePassManager_New::getAnalysisPassFromManager(AnalysisID AID) {
 862
 863   Pass *P = getAnalysisPass(AID);
 864   if (P)
 865     return P;
 866
 867   if (activeFunctionPassManager &&
 868       activeFunctionPassManager->getAnalysisPass(AID) != 0)
 869     return activeFunctionPassManager->getAnalysisPass(AID);
 870
 871   // TODO : Check inactive managers
 872   return NULL;
 873 }
 874
 875 //===----------------------------------------------------------------------===//
 876 // PassManagerImpl implementation
 877
 878 /// Return true IFF AnalysisID AID is currently available.
 879 /// TODO : Replace this method with getAnalysisPass()
 880 Pass *PassManagerImpl_New::getAnalysisPassFromManager(AnalysisID AID) {
 881
 882   Pass *P = NULL;
 883   for (std::vector<ModulePassManager_New *>::iterator itr = PassManagers.begin(),
 884          e = PassManagers.end(); !P && itr != e; ++itr)
 885     P  = (*itr)->getAnalysisPassFromManager(AID);
 886   return P;
 887 }
 888
 889 // PassManager_New implementation
 890 /// Add P into active pass manager or use new module pass manager to
 891 /// manage it.
 892 bool PassManagerImpl_New::addPass(Pass *P) {
 893
 894   if (!activeManager || !activeManager->addPass(P)) {
 895     activeManager = new ModulePassManager_New();
 896     PassManagers.push_back(activeManager);
 897     return activeManager->addPass(P);
 898   }
 899   return true;
 900 }
 901
 902 /// run - Execute all of the passes scheduled for execution.  Keep track of
 903 /// whether any of the passes modifies the module, and if so, return true.
 904 bool PassManagerImpl_New::run(Module &M) {
 905
 906   bool Changed = false;
 907   for (std::vector<ModulePassManager_New *>::iterator itr = PassManagers.begin(),
 908          e = PassManagers.end(); itr != e; ++itr) {
 909     ModulePassManager_New *pm = *itr;
 910     Changed |= pm->runOnModule(M);
 911   }
 912   return Changed;
 913 }
 914
 915 //===----------------------------------------------------------------------===//
 916 // PassManager implementation
 917
 918 /// Create new pass manager
 919 PassManager_New::PassManager_New() {
 920   PM = new PassManagerImpl_New();
 921 }
 922
 923 /// add - Add a pass to the queue of passes to run.  This passes ownership of
 924 /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
 925 /// will be destroyed as well, so there is no need to delete the pass.  This
 926 /// implies that all passes MUST be allocated with 'new'.
 927 void
 928 PassManager_New::add(Pass *P) {
 929   PM->add(P);
 930 }
 931
 932 /// run - Execute all of the passes scheduled for execution.  Keep track of
 933 /// whether any of the passes modifies the module, and if so, return true.
 934 bool
 935 PassManager_New::run(Module &M) {
 936   return PM->run(M);
 937 }
 938