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(int D) : TPM(NULL), Depth(D) {
 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     ForcedLastUses.clear();
 247     AvailableAnalysis.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   /// Populate RequiredPasses with the analysis pass that are required by
 257   /// pass P.
 258   void collectRequiredAnalysisPasses(std::vector<Pass *> &RequiredPasses,
 259                                      Pass *P);
 260
 261   /// All Required analyses should be available to the pass as it runs!  Here
 262   /// we fill in the AnalysisImpls member of the pass so that it can
 263   /// successfully use the getAnalysis() method to retrieve the
 264   /// implementations it needs.
 265   void initializeAnalysisImpl(Pass *P);
 266
 267   inline std::vector<Pass *>::iterator passVectorBegin() {
 268     return PassVector.begin();
 269   }
 270
 271   inline std::vector<Pass *>::iterator passVectorEnd() {
 272     return PassVector.end();
 273   }
 274
 275   // Access toplevel manager
 276   PMTopLevelManager *getTopLevelManager() { return TPM; }
 277   void setTopLevelManager(PMTopLevelManager *T) { TPM = T; }
 278
 279   unsigned getDepth() { return Depth; }
 280
 281 protected:
 282
 283   // Collection of pass whose last user asked this manager to claim
 284   // last use. If a FunctionPass F is the last user of ModulePass info M
 285   // then the F's manager, not F, records itself as a last user of M.
 286   std::vector<Pass *> ForcedLastUses;
 287
 288   // Top level manager.
 289   // TODO : Make it a reference.
 290   PMTopLevelManager *TPM;
 291
 292 private:
 293   // Set of available Analysis. This information is used while scheduling
 294   // pass. If a pass requires an analysis which is not not available then
 295   // equired analysis pass is scheduled to run before the pass itself is
 296   // scheduled to run.
 297   std::map<AnalysisID, Pass*> AvailableAnalysis;
 298
 299   // Collection of pass that are managed by this manager
 300   std::vector<Pass *> PassVector;
 301
 302   unsigned Depth;
 303 };
 304
 305 /// BasicBlockPassManager_New manages BasicBlockPass. It batches all the
 306 /// pass together and sequence them to process one basic block before
 307 /// processing next basic block.
 308 class BasicBlockPassManager_New : public PMDataManager,
 309                                   public FunctionPass {
 310
 311 public:
 312   BasicBlockPassManager_New(int D) : PMDataManager(D) { }
 313
 314   /// Add a pass into a passmanager queue.
 315   bool addPass(Pass *p);
 316
 317   /// Execute all of the passes scheduled for execution.  Keep track of
 318   /// whether any of the passes modifies the function, and if so, return true.
 319   bool runOnFunction(Function &F);
 320
 321   /// Return true IFF AnalysisID AID is currently available.
 322   /// TODO : Replace this method with getAnalysisPass()
 323   Pass *getAnalysisPassFromManager(AnalysisID AID);
 324
 325   /// Pass Manager itself does not invalidate any analysis info.
 326   void getAnalysisUsage(AnalysisUsage &Info) const {
 327     Info.setPreservesAll();
 328   }
 329
 330 private:
 331 };
 332
 333 /// FunctionPassManagerImpl_New manages FunctionPasses and BasicBlockPassManagers.
 334 /// It batches all function passes and basic block pass managers together and
 335 /// sequence them to process one function at a time before processing next
 336 /// function.
 337 class FunctionPassManagerImpl_New : public ModulePass,
 338                                     public PMDataManager,
 339                                     public PMTopLevelManager {
 340 public:
 341   FunctionPassManagerImpl_New(ModuleProvider *P, int D) :
 342     PMDataManager(D) { /* TODO */ }
 343   FunctionPassManagerImpl_New(int D) : PMDataManager(D) {
 344     activeBBPassManager = NULL;
 345   }
 346   ~FunctionPassManagerImpl_New() { /* TODO */ };
 347
 348   inline void addTopLevelPass(Pass *P) {
 349     addPass(P);
 350   }
 351
 352   /// add - Add a pass to the queue of passes to run.  This passes
 353   /// ownership of the Pass to the PassManager.  When the
 354   /// PassManager_X is destroyed, the pass will be destroyed as well, so
 355   /// there is no need to delete the pass. (TODO delete passes.)
 356   /// This implies that all passes MUST be allocated with 'new'.
 357   void add(Pass *P) {
 358     schedulePass(P, this);
 359   }
 360
 361   /// Add pass into the pass manager queue.
 362   bool addPass(Pass *P);
 363
 364   /// Execute all of the passes scheduled for execution.  Keep
 365   /// track of whether any of the passes modifies the function, and if
 366   /// so, return true.
 367   bool runOnModule(Module &M);
 368   bool runOnFunction(Function &F);
 369
 370   /// Return true IFF AnalysisID AID is currently available.
 371   /// TODO : Replace this method with getAnalysisPass()
 372   Pass *getAnalysisPassFromManager(AnalysisID AID);
 373
 374   /// doInitialization - Run all of the initializers for the function passes.
 375   ///
 376   bool doInitialization(Module &M);
 377
 378   /// doFinalization - Run all of the initializers for the function passes.
 379   ///
 380   bool doFinalization(Module &M);
 381
 382   /// Pass Manager itself does not invalidate any analysis info.
 383   void getAnalysisUsage(AnalysisUsage &Info) const {
 384     Info.setPreservesAll();
 385   }
 386
 387 private:
 388   // Active Pass Managers
 389   BasicBlockPassManager_New *activeBBPassManager;
 390 };
 391
 392 /// ModulePassManager_New manages ModulePasses and function pass managers.
 393 /// It batches all Module passes  passes and function pass managers together and
 394 /// sequence them to process one module.
 395 class ModulePassManager_New : public Pass,
 396                               public PMDataManager {
 397
 398 public:
 399   ModulePassManager_New(int D) : PMDataManager(D) {
 400     activeFunctionPassManager = NULL;
 401   }
 402
 403   /// Add a pass into a passmanager queue.
 404   bool addPass(Pass *p);
 405
 406   /// run - Execute all of the passes scheduled for execution.  Keep track of
 407   /// whether any of the passes modifies the module, and if so, return true.
 408   bool runOnModule(Module &M);
 409
 410   /// Return true IFF AnalysisID AID is currently available.
 411   /// TODO : Replace this method with getAnalysisPass()
 412   Pass *getAnalysisPassFromManager(AnalysisID AID);
 413
 414   /// Pass Manager itself does not invalidate any analysis info.
 415   void getAnalysisUsage(AnalysisUsage &Info) const {
 416     Info.setPreservesAll();
 417   }
 418
 419 private:
 420   // Active Pass Manager
 421   FunctionPassManagerImpl_New *activeFunctionPassManager;
 422 };
 423
 424 /// PassManager_New manages ModulePassManagers
 425 class PassManagerImpl_New : public Pass,
 426                             public PMDataManager,
 427                             public PMTopLevelManager {
 428
 429 public:
 430
 431   PassManagerImpl_New(int D) : PMDataManager(D) {}
 432
 433   /// add - Add a pass to the queue of passes to run.  This passes ownership of
 434   /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
 435   /// will be destroyed as well, so there is no need to delete the pass.  This
 436   /// implies that all passes MUST be allocated with 'new'.
 437   void add(Pass *P) {
 438     schedulePass(P, this);
 439   }
 440
 441   /// run - Execute all of the passes scheduled for execution.  Keep track of
 442   /// whether any of the passes modifies the module, and if so, return true.
 443   bool run(Module &M);
 444
 445   /// Return true IFF AnalysisID AID is currently available.
 446   /// TODO : Replace this method with getAnalysisPass()
 447   Pass *getAnalysisPassFromManager(AnalysisID AID);
 448
 449   /// Pass Manager itself does not invalidate any analysis info.
 450   void getAnalysisUsage(AnalysisUsage &Info) const {
 451     Info.setPreservesAll();
 452   }
 453
 454   inline void addTopLevelPass(Pass *P) {
 455     addPass(P);
 456   }
 457
 458 private:
 459
 460   /// Add a pass into a passmanager queue.
 461   bool addPass(Pass *p);
 462
 463   // Collection of pass managers
 464   std::vector<ModulePassManager_New *> PassManagers;
 465
 466   // Active Pass Manager
 467   ModulePassManager_New *activeManager;
 468 };
 469
 470 } // End of llvm namespace
 471
 472 //===----------------------------------------------------------------------===//
 473 // PMDataManager implementation
 474
 475 /// Return true IFF pass P's required analysis set does not required new
 476 /// manager.
 477 bool PMDataManager::manageablePass(Pass *P) {
 478
 479   // TODO
 480   // If this pass is not preserving information that is required by a
 481   // pass maintained by higher level pass manager then do not insert
 482   // this pass into current manager. Use new manager. For example,
 483   // For example, If FunctionPass F is not preserving ModulePass Info M1
 484   // that is used by another ModulePass M2 then do not insert F in
 485   // current function pass manager.
 486   return true;
 487 }
 488
 489 /// Augement AvailableAnalysis by adding analysis made available by pass P.
 490 void PMDataManager::recordAvailableAnalysis(Pass *P) {
 491
 492   if (const PassInfo *PI = P->getPassInfo()) {
 493     AvailableAnalysis[PI] = P;
 494
 495     //This pass is the current implementation of all of the interfaces it
 496     //implements as well.
 497     const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
 498     for (unsigned i = 0, e = II.size(); i != e; ++i)
 499       AvailableAnalysis[II[i]] = P;
 500   }
 501 }
 502
 503 /// Remove Analyss not preserved by Pass P
 504 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
 505   AnalysisUsage AnUsage;
 506   P->getAnalysisUsage(AnUsage);
 507
 508   if (AnUsage.getPreservesAll())
 509     return;
 510
 511   const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
 512   for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
 513          E = AvailableAnalysis.end(); I != E; ++I ) {
 514     if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) ==
 515         PreservedSet.end()) {
 516       // Remove this analysis
 517       std::map<AnalysisID, Pass*>::iterator J = I++;
 518       AvailableAnalysis.erase(J);
 519     }
 520   }
 521 }
 522
 523 /// Remove analysis passes that are not used any longer
 524 void PMDataManager::removeDeadPasses(Pass *P) {
 525
 526   std::vector<Pass *> DeadPasses;
 527   TPM->collectLastUses(DeadPasses, P);
 528
 529   for (std::vector<Pass *>::iterator I = DeadPasses.begin(),
 530          E = DeadPasses.end(); I != E; ++I) {
 531     (*I)->releaseMemory();
 532
 533     std::map<AnalysisID, Pass*>::iterator Pos =
 534       AvailableAnalysis.find((*I)->getPassInfo());
 535
 536     // It is possible that deadPass is already removed from the AvailableAnalysis
 537     if (Pos != AvailableAnalysis.end())
 538       AvailableAnalysis.erase(Pos);
 539   }
 540 }
 541
 542 /// Add pass P into the PassVector. Update
 543 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
 544 void PMDataManager::addPassToManager(Pass *P,
 545                                      bool ProcessAnalysis) {
 546
 547   if (ProcessAnalysis) {
 548
 549     // At the moment, this pass is the last user of all required passes.
 550     std::vector<Pass *> LastUses;
 551     std::vector<Pass *> RequiredPasses;
 552     unsigned PDepth = this->getDepth();
 553
 554     collectRequiredAnalysisPasses(RequiredPasses, P);
 555     for (std::vector<Pass *>::iterator I = RequiredPasses.begin(),
 556            E = RequiredPasses.end(); I != E; ++I) {
 557       Pass *PRequired = *I;
 558       unsigned RDepth = 0;
 559       //FIXME: RDepth = PRequired->getResolver()->getDepth();
 560       if (PDepth == RDepth)
 561         LastUses.push_back(PRequired);
 562       else if (PDepth >  RDepth) {
 563         // Let the parent claim responsibility of last use
 564         ForcedLastUses.push_back(PRequired);
 565       } else {
 566         // Note : This feature is not yet implemented
 567         assert (0 &&
 568                 "Unable to handle Pass that requires lower level Analysis pass");
 569       }
 570     }
 571
 572     if (!LastUses.empty())
 573       TPM->setLastUser(LastUses, P);
 574
 575     // Take a note of analysis required and made available by this pass.
 576     // Remove the analysis not preserved by this pass
 577     initializeAnalysisImpl(P);
 578     removeNotPreservedAnalysis(P);
 579     recordAvailableAnalysis(P);
 580   }
 581
 582   // Add pass
 583   PassVector.push_back(P);
 584 }
 585
 586 /// Populate RequiredPasses with the analysis pass that are required by
 587 /// pass P.
 588 void PMDataManager::collectRequiredAnalysisPasses(std::vector<Pass *> &RP,
 589                                                   Pass *P) {
 590   AnalysisUsage AnUsage;
 591   P->getAnalysisUsage(AnUsage);
 592   const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
 593   for (std::vector<AnalysisID>::const_iterator
 594          I = RequiredSet.begin(), E = RequiredSet.end();
 595        I != E; ++I) {
 596     Pass *AnalysisPass = NULL; //FIXME findAnalysisPass(*I,true);
 597     assert (AnalysisPass && "Analysis pass is not available");
 598     RP.push_back(AnalysisPass);
 599   }
 600 }
 601
 602 // All Required analyses should be available to the pass as it runs!  Here
 603 // we fill in the AnalysisImpls member of the pass so that it can
 604 // successfully use the getAnalysis() method to retrieve the
 605 // implementations it needs.
 606 //
 607 void PMDataManager::initializeAnalysisImpl(Pass *P) {
 608   AnalysisUsage AnUsage;
 609   P->getAnalysisUsage(AnUsage);
 610
 611   for (std::vector<const PassInfo *>::const_iterator
 612          I = AnUsage.getRequiredSet().begin(),
 613          E = AnUsage.getRequiredSet().end(); I != E; ++I) {
 614     Pass *Impl = getAnalysisPass(*I);
 615     if (Impl == 0)
 616       assert(0 && "Analysis used but not available!");
 617     // TODO:  P->AnalysisImpls.push_back(std::make_pair(*I, Impl));
 618   }
 619 }
 620
 621 //===----------------------------------------------------------------------===//
 622 // BasicBlockPassManager_New implementation
 623
 624 /// Add pass P into PassVector and return true. If this pass is not
 625 /// manageable by this manager then return false.
 626 bool
 627 BasicBlockPassManager_New::addPass(Pass *P) {
 628
 629   BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
 630   if (!BP)
 631     return false;
 632
 633   // If this pass does not preserve anlysis that is used by other passes
 634   // managed by this manager than it is not a suiable pass for this manager.
 635   if (!manageablePass(P))
 636     return false;
 637
 638   addPassToManager (BP);
 639
 640   return true;
 641 }
 642
 643 /// Execute all of the passes scheduled for execution by invoking
 644 /// runOnBasicBlock method.  Keep track of whether any of the passes modifies
 645 /// the function, and if so, return true.
 646 bool
 647 BasicBlockPassManager_New::runOnFunction(Function &F) {
 648
 649   bool Changed = false;
 650   initializeAnalysisInfo();
 651
 652   for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
 653     for (std::vector<Pass *>::iterator itr = passVectorBegin(),
 654            e = passVectorEnd(); itr != e; ++itr) {
 655       Pass *P = *itr;
 656
 657       BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
 658       Changed |= BP->runOnBasicBlock(*I);
 659       removeNotPreservedAnalysis(P);
 660       recordAvailableAnalysis(P);
 661       removeDeadPasses(P);
 662     }
 663   return Changed;
 664 }
 665
 666 /// Return true IFF AnalysisID AID is currently available.
 667 /// TODO : Replace this method with getAnalysisPass()
 668 Pass * BasicBlockPassManager_New::getAnalysisPassFromManager(AnalysisID AID) {
 669   return getAnalysisPass(AID);
 670 }
 671
 672 //===----------------------------------------------------------------------===//
 673 // FunctionPassManager_New implementation
 674
 675 /// Create new Function pass manager
 676 FunctionPassManager_New::FunctionPassManager_New() {
 677   FPM = new FunctionPassManagerImpl_New(0);
 678 }
 679
 680 /// add - Add a pass to the queue of passes to run.  This passes
 681 /// ownership of the Pass to the PassManager.  When the
 682 /// PassManager_X is destroyed, the pass will be destroyed as well, so
 683 /// there is no need to delete the pass. (TODO delete passes.)
 684 /// This implies that all passes MUST be allocated with 'new'.
 685 void FunctionPassManager_New::add(Pass *P) {
 686   FPM->add(P);
 687 }
 688
 689 /// Execute all of the passes scheduled for execution.  Keep
 690 /// track of whether any of the passes modifies the function, and if
 691 /// so, return true.
 692 bool FunctionPassManager_New::runOnModule(Module &M) {
 693   return FPM->runOnModule(M);
 694 }
 695
 696 /// run - Execute all of the passes scheduled for execution.  Keep
 697 /// track of whether any of the passes modifies the function, and if
 698 /// so, return true.
 699 ///
 700 bool FunctionPassManager_New::run(Function &F) {
 701   std::string errstr;
 702   if (MP->materializeFunction(&F, &errstr)) {
 703     cerr << "Error reading bytecode file: " << errstr << "\n";
 704     abort();
 705   }
 706   return FPM->runOnFunction(F);
 707 }
 708
 709
 710 /// doInitialization - Run all of the initializers for the function passes.
 711 ///
 712 bool FunctionPassManager_New::doInitialization() {
 713   return FPM->doInitialization(*MP->getModule());
 714 }
 715
 716 /// doFinalization - Run all of the initializers for the function passes.
 717 ///
 718 bool FunctionPassManager_New::doFinalization() {
 719   return FPM->doFinalization(*MP->getModule());
 720 }
 721
 722 //===----------------------------------------------------------------------===//
 723 // FunctionPassManagerImpl_New implementation
 724
 725 /// Add pass P into the pass manager queue. If P is a BasicBlockPass then
 726 /// either use it into active basic block pass manager or create new basic
 727 /// block pass manager to handle pass P.
 728 bool
 729 FunctionPassManagerImpl_New::addPass(Pass *P) {
 730
 731   // If P is a BasicBlockPass then use BasicBlockPassManager_New.
 732   if (BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P)) {
 733
 734     if (!activeBBPassManager || !activeBBPassManager->addPass(BP)) {
 735
 736       // If active manager exists then clear its analysis info.
 737       if (activeBBPassManager)
 738         activeBBPassManager->initializeAnalysisInfo();
 739
 740       // Create and add new manager
 741       activeBBPassManager =
 742         new BasicBlockPassManager_New(getDepth() + 1);
 743       addPassToManager(activeBBPassManager, false);
 744
 745       // Add pass into new manager. This time it must succeed.
 746       if (!activeBBPassManager->addPass(BP))
 747         assert(0 && "Unable to add Pass");
 748     }
 749
 750     if (!ForcedLastUses.empty())
 751       TPM->setLastUser(ForcedLastUses, this);
 752
 753     return true;
 754   }
 755
 756   FunctionPass *FP = dynamic_cast<FunctionPass *>(P);
 757   if (!FP)
 758     return false;
 759
 760   // If this pass does not preserve anlysis that is used by other passes
 761   // managed by this manager than it is not a suiable pass for this manager.
 762   if (!manageablePass(P))
 763     return false;
 764
 765   addPassToManager (FP);
 766
 767   // If active manager exists then clear its analysis info.
 768   if (activeBBPassManager) {
 769     activeBBPassManager->initializeAnalysisInfo();
 770     activeBBPassManager = NULL;
 771   }
 772
 773   return true;
 774 }
 775
 776 /// Execute all of the passes scheduled for execution by invoking
 777 /// runOnFunction method.  Keep track of whether any of the passes modifies
 778 /// the function, and if so, return true.
 779 bool FunctionPassManagerImpl_New::runOnModule(Module &M) {
 780
 781   bool Changed = false;
 782   initializeAnalysisInfo();
 783
 784   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 785     for (std::vector<Pass *>::iterator itr = passVectorBegin(),
 786            e = passVectorEnd(); itr != e; ++itr) {
 787       Pass *P = *itr;
 788
 789       FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
 790       Changed |= FP->runOnFunction(*I);
 791       removeNotPreservedAnalysis(P);
 792       recordAvailableAnalysis(P);
 793       removeDeadPasses(P);
 794     }
 795   return Changed;
 796 }
 797
 798 /// Execute all of the passes scheduled for execution by invoking
 799 /// runOnFunction method.  Keep track of whether any of the passes modifies
 800 /// the function, and if so, return true.
 801 bool FunctionPassManagerImpl_New::runOnFunction(Function &F) {
 802
 803   bool Changed = false;
 804   initializeAnalysisInfo();
 805
 806   for (std::vector<Pass *>::iterator itr = passVectorBegin(),
 807          e = passVectorEnd(); itr != e; ++itr) {
 808     Pass *P = *itr;
 809
 810     FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
 811     Changed |= FP->runOnFunction(F);
 812     removeNotPreservedAnalysis(P);
 813     recordAvailableAnalysis(P);
 814     removeDeadPasses(P);
 815   }
 816   return Changed;
 817 }
 818
 819
 820 /// Return true IFF AnalysisID AID is currently available.
 821 /// TODO : Replace this method with getAnalysisPass()
 822 Pass *FunctionPassManagerImpl_New::getAnalysisPassFromManager(AnalysisID AID) {
 823
 824   Pass *P = getAnalysisPass(AID);
 825   if (P)
 826     return P;
 827
 828   if (activeBBPassManager &&
 829       activeBBPassManager->getAnalysisPass(AID) != 0)
 830     return activeBBPassManager->getAnalysisPass(AID);
 831
 832   // TODO : Check inactive managers
 833   return NULL;
 834 }
 835
 836 inline bool FunctionPassManagerImpl_New::doInitialization(Module &M) {
 837   bool Changed = false;
 838
 839   for (std::vector<Pass *>::iterator itr = passVectorBegin(),
 840          e = passVectorEnd(); itr != e; ++itr) {
 841     Pass *P = *itr;
 842
 843     FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
 844     Changed |= FP->doInitialization(M);
 845   }
 846
 847   return Changed;
 848 }
 849
 850 inline bool FunctionPassManagerImpl_New::doFinalization(Module &M) {
 851   bool Changed = false;
 852
 853   for (std::vector<Pass *>::iterator itr = passVectorBegin(),
 854          e = passVectorEnd(); itr != e; ++itr) {
 855     Pass *P = *itr;
 856
 857     FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
 858     Changed |= FP->doFinalization(M);
 859   }
 860
 861
 862   return Changed;
 863 }
 864
 865 //===----------------------------------------------------------------------===//
 866 // ModulePassManager implementation
 867
 868 /// Add P into pass vector if it is manageble. If P is a FunctionPass
 869 /// then use FunctionPassManagerImpl_New to manage it. Return false if P
 870 /// is not manageable by this manager.
 871 bool
 872 ModulePassManager_New::addPass(Pass *P) {
 873
 874   // If P is FunctionPass then use function pass maanager.
 875   if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P)) {
 876
 877     if (!activeFunctionPassManager
 878         || !activeFunctionPassManager->addPass(P)) {
 879
 880       // If active manager exists then clear its analysis info.
 881       if (activeFunctionPassManager)
 882         activeFunctionPassManager->initializeAnalysisInfo();
 883
 884       // Create and add new manager
 885       activeFunctionPassManager =
 886         new FunctionPassManagerImpl_New(getDepth() + 1);
 887       addPassToManager(activeFunctionPassManager, false);
 888
 889       // Add pass into new manager. This time it must succeed.
 890       if (!activeFunctionPassManager->addPass(FP))
 891         assert(0 && "Unable to add pass");
 892     }
 893
 894     if (!ForcedLastUses.empty())
 895       TPM->setLastUser(ForcedLastUses, this);
 896
 897     return true;
 898   }
 899
 900   ModulePass *MP = dynamic_cast<ModulePass *>(P);
 901   if (!MP)
 902     return false;
 903
 904   // If this pass does not preserve anlysis that is used by other passes
 905   // managed by this manager than it is not a suiable pass for this manager.
 906   if (!manageablePass(P))
 907     return false;
 908
 909   addPassToManager(MP);
 910   // If active manager exists then clear its analysis info.
 911   if (activeFunctionPassManager) {
 912     activeFunctionPassManager->initializeAnalysisInfo();
 913     activeFunctionPassManager = NULL;
 914   }
 915
 916   return true;
 917 }
 918
 919
 920 /// Execute all of the passes scheduled for execution by invoking
 921 /// runOnModule method.  Keep track of whether any of the passes modifies
 922 /// the module, and if so, return true.
 923 bool
 924 ModulePassManager_New::runOnModule(Module &M) {
 925   bool Changed = false;
 926   initializeAnalysisInfo();
 927
 928   for (std::vector<Pass *>::iterator itr = passVectorBegin(),
 929          e = passVectorEnd(); itr != e; ++itr) {
 930     Pass *P = *itr;
 931
 932     ModulePass *MP = dynamic_cast<ModulePass*>(P);
 933     Changed |= MP->runOnModule(M);
 934     removeNotPreservedAnalysis(P);
 935     recordAvailableAnalysis(P);
 936     removeDeadPasses(P);
 937   }
 938   return Changed;
 939 }
 940
 941 /// Return true IFF AnalysisID AID is currently available.
 942 /// TODO : Replace this method with getAnalysisPass()
 943 Pass *ModulePassManager_New::getAnalysisPassFromManager(AnalysisID AID) {
 944
 945   Pass *P = getAnalysisPass(AID);
 946   if (P)
 947     return P;
 948
 949   if (activeFunctionPassManager &&
 950       activeFunctionPassManager->getAnalysisPass(AID) != 0)
 951     return activeFunctionPassManager->getAnalysisPass(AID);
 952
 953   // TODO : Check inactive managers
 954   return NULL;
 955 }
 956
 957 //===----------------------------------------------------------------------===//
 958 // PassManagerImpl implementation
 959
 960 /// Return true IFF AnalysisID AID is currently available.
 961 /// TODO : Replace this method with getAnalysisPass()
 962 Pass *PassManagerImpl_New::getAnalysisPassFromManager(AnalysisID AID) {
 963
 964   Pass *P = NULL;
 965   for (std::vector<ModulePassManager_New *>::iterator itr = PassManagers.begin(),
 966          e = PassManagers.end(); !P && itr != e; ++itr)
 967     P  = (*itr)->getAnalysisPassFromManager(AID);
 968   return P;
 969 }
 970
 971 // PassManager_New implementation
 972 /// Add P into active pass manager or use new module pass manager to
 973 /// manage it.
 974 bool PassManagerImpl_New::addPass(Pass *P) {
 975
 976   if (!activeManager || !activeManager->addPass(P)) {
 977     activeManager = new ModulePassManager_New(getDepth() + 1);
 978     PassManagers.push_back(activeManager);
 979     return activeManager->addPass(P);
 980   }
 981   return true;
 982 }
 983
 984 /// run - Execute all of the passes scheduled for execution.  Keep track of
 985 /// whether any of the passes modifies the module, and if so, return true.
 986 bool PassManagerImpl_New::run(Module &M) {
 987
 988   bool Changed = false;
 989   for (std::vector<ModulePassManager_New *>::iterator itr = PassManagers.begin(),
 990          e = PassManagers.end(); itr != e; ++itr) {
 991     ModulePassManager_New *pm = *itr;
 992     Changed |= pm->runOnModule(M);
 993   }
 994   return Changed;
 995 }
 996
 997 //===----------------------------------------------------------------------===//
 998 // PassManager implementation
 999
1000 /// Create new pass manager
1001 PassManager_New::PassManager_New() {
1002   PM = new PassManagerImpl_New(0);
1003 }
1004
1005 /// add - Add a pass to the queue of passes to run.  This passes ownership of
1006 /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
1007 /// will be destroyed as well, so there is no need to delete the pass.  This
1008 /// implies that all passes MUST be allocated with 'new'.
1009 void
1010 PassManager_New::add(Pass *P) {
1011   PM->add(P);
1012 }
1013
1014 /// run - Execute all of the passes scheduled for execution.  Keep track of
1015 /// whether any of the passes modifies the module, and if so, return true.
1016 bool
1017 PassManager_New::run(Module &M) {
1018   return PM->run(M);
1019 }
1020