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 private:
 126
 127   /// Collection of pass managers
 128   std::vector<Pass *> PassManagers;
 129
 130   // Map to keep track of last user of the analysis pass.
 131   // LastUser->second is the last user of Lastuser->first.
 132   std::map<Pass *, Pass *> LastUser;
 133 };
 134
 135 /// Set pass P as the last user of the given analysis passes.
 136 void PMTopLevelManager::setLastUser(std::vector<Pass *> &AnalysisPasses,
 137                                     Pass *P) {
 138
 139   for (std::vector<Pass *>::iterator I = AnalysisPasses.begin(),
 140          E = AnalysisPasses.end(); I != E; ++I) {
 141     Pass *AP = *I;
 142     LastUser[AP] = P;
 143     // If AP is the last user of other passes then make P last user of
 144     // such passes.
 145     for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
 146            LUE = LastUser.end(); LUI != LUE; ++LUI) {
 147       if (LUI->second == AP)
 148         LastUser[LUI->first] = P;
 149     }
 150   }
 151
 152 }
 153
 154 /// Collect passes whose last user is P
 155 void PMTopLevelManager::collectLastUses(std::vector<Pass *> &LastUses,
 156                                             Pass *P) {
 157    for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
 158           LUE = LastUser.end(); LUI != LUE; ++LUI)
 159       if (LUI->second == P)
 160         LastUses.push_back(LUI->first);
 161 }
 162
 163
 164
 165 /// PMDataManager provides the common place to manage the analysis data
 166 /// used by pass managers.
 167 class PMDataManager {
 168
 169 public:
 170
 171   /// Return true IFF pass P's required analysis set does not required new
 172   /// manager.
 173   bool manageablePass(Pass *P);
 174
 175   Pass *getAnalysisPass(AnalysisID AID) const {
 176
 177     std::map<AnalysisID, Pass*>::const_iterator I =
 178       AvailableAnalysis.find(AID);
 179
 180     if (I != AvailableAnalysis.end())
 181       return NULL;
 182     else
 183       return I->second;
 184   }
 185
 186   /// Augment AvailableAnalysis by adding analysis made available by pass P.
 187   void recordAvailableAnalysis(Pass *P);
 188
 189   /// Remove Analysis that is not preserved by the pass
 190   void removeNotPreservedAnalysis(Pass *P);
 191
 192   /// Remove dead passes
 193   void removeDeadPasses(Pass *P);
 194
 195   /// Add pass P into the PassVector. Update
 196   /// AvailableAnalysis appropriately if ProcessAnalysis is true.
 197   void addPassToManager (Pass *P, bool ProcessAnalysis = true);
 198
 199   // Initialize available analysis information.
 200   void initializeAnalysisInfo() {
 201     AvailableAnalysis.clear();
 202     LastUser.clear();
 203   }
 204
 205   // All Required analyses should be available to the pass as it runs!  Here
 206   // we fill in the AnalysisImpls member of the pass so that it can
 207   // successfully use the getAnalysis() method to retrieve the
 208   // implementations it needs.
 209   //
 210  void initializeAnalysisImpl(Pass *P);
 211
 212   inline std::vector<Pass *>::iterator passVectorBegin() {
 213     return PassVector.begin();
 214   }
 215
 216   inline std::vector<Pass *>::iterator passVectorEnd() {
 217     return PassVector.end();
 218   }
 219
 220   inline void setLastUser(Pass *P, Pass *LU) {
 221     LastUser[P] = LU;
 222     // TODO : Check if pass P is available.
 223   }
 224
 225 private:
 226   // Set of available Analysis. This information is used while scheduling
 227   // pass. If a pass requires an analysis which is not not available then
 228   // equired analysis pass is scheduled to run before the pass itself is
 229   // scheduled to run.
 230   std::map<AnalysisID, Pass*> AvailableAnalysis;
 231
 232   // Map to keep track of last user of the analysis pass.
 233   // LastUser->second is the last user of Lastuser->first.
 234   std::map<Pass *, Pass *> LastUser;
 235
 236   // Collection of pass that are managed by this manager
 237   std::vector<Pass *> PassVector;
 238 };
 239
 240 /// BasicBlockPassManager_New manages BasicBlockPass. It batches all the
 241 /// pass together and sequence them to process one basic block before
 242 /// processing next basic block.
 243 class BasicBlockPassManager_New : public PMDataManager,
 244                                   public FunctionPass {
 245
 246 public:
 247   BasicBlockPassManager_New() { }
 248
 249   /// Add a pass into a passmanager queue.
 250   bool addPass(Pass *p);
 251
 252   /// Execute all of the passes scheduled for execution.  Keep track of
 253   /// whether any of the passes modifies the function, and if so, return true.
 254   bool runOnFunction(Function &F);
 255
 256   /// Return true IFF AnalysisID AID is currently available.
 257   Pass *getAnalysisPassFromManager(AnalysisID AID);
 258
 259 private:
 260 };
 261
 262 /// FunctionPassManagerImpl_New manages FunctionPasses and BasicBlockPassManagers.
 263 /// It batches all function passes and basic block pass managers together and
 264 /// sequence them to process one function at a time before processing next
 265 /// function.
 266 class FunctionPassManagerImpl_New : public PMDataManager,
 267                                     public ModulePass {
 268 public:
 269   FunctionPassManagerImpl_New(ModuleProvider *P) { /* TODO */ }
 270   FunctionPassManagerImpl_New() {
 271     activeBBPassManager = NULL;
 272   }
 273   ~FunctionPassManagerImpl_New() { /* TODO */ };
 274
 275   /// add - Add a pass to the queue of passes to run.  This passes
 276   /// ownership of the Pass to the PassManager.  When the
 277   /// PassManager_X is destroyed, the pass will be destroyed as well, so
 278   /// there is no need to delete the pass. (TODO delete passes.)
 279   /// This implies that all passes MUST be allocated with 'new'.
 280   void add(Pass *P) { /* TODO*/  }
 281
 282   /// Add pass into the pass manager queue.
 283   bool addPass(Pass *P);
 284
 285   /// Execute all of the passes scheduled for execution.  Keep
 286   /// track of whether any of the passes modifies the function, and if
 287   /// so, return true.
 288   bool runOnModule(Module &M);
 289   bool runOnFunction(Function &F);
 290
 291   /// Return true IFF AnalysisID AID is currently available.
 292   Pass *getAnalysisPassFromManager(AnalysisID AID);
 293
 294   /// doInitialization - Run all of the initializers for the function passes.
 295   ///
 296   bool doInitialization(Module &M);
 297
 298   /// doFinalization - Run all of the initializers for the function passes.
 299   ///
 300   bool doFinalization(Module &M);
 301 private:
 302   // Active Pass Managers
 303   BasicBlockPassManager_New *activeBBPassManager;
 304 };
 305
 306 /// ModulePassManager_New manages ModulePasses and function pass managers.
 307 /// It batches all Module passes  passes and function pass managers together and
 308 /// sequence them to process one module.
 309 class ModulePassManager_New : public PMDataManager {
 310
 311 public:
 312   ModulePassManager_New() { activeFunctionPassManager = NULL; }
 313
 314   /// Add a pass into a passmanager queue.
 315   bool addPass(Pass *p);
 316
 317   /// run - Execute all of the passes scheduled for execution.  Keep track of
 318   /// whether any of the passes modifies the module, and if so, return true.
 319   bool runOnModule(Module &M);
 320
 321   /// Return true IFF AnalysisID AID is currently available.
 322   Pass *getAnalysisPassFromManager(AnalysisID AID);
 323
 324 private:
 325   // Active Pass Manager
 326   FunctionPassManagerImpl_New *activeFunctionPassManager;
 327 };
 328
 329 /// PassManager_New manages ModulePassManagers
 330 class PassManagerImpl_New : public PMDataManager {
 331
 332 public:
 333
 334   /// add - Add a pass to the queue of passes to run.  This passes ownership of
 335   /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
 336   /// will be destroyed as well, so there is no need to delete the pass.  This
 337   /// implies that all passes MUST be allocated with 'new'.
 338   void add(Pass *P);
 339
 340   /// run - Execute all of the passes scheduled for execution.  Keep track of
 341   /// whether any of the passes modifies the module, and if so, return true.
 342   bool run(Module &M);
 343
 344   /// Return true IFF AnalysisID AID is currently available.
 345   Pass *getAnalysisPassFromManager(AnalysisID AID);
 346
 347 private:
 348
 349   /// Add a pass into a passmanager queue. This is used by schedulePasses
 350   bool addPass(Pass *p);
 351
 352   /// Schedule pass P for execution. Make sure that passes required by
 353   /// P are run before P is run. Update analysis info maintained by
 354   /// the manager. Remove dead passes. This is a recursive function.
 355   void schedulePass(Pass *P);
 356
 357   /// Schedule all passes collected in pass queue using add(). Add all the
 358   /// schedule passes into various manager's queue using addPass().
 359   void schedulePasses();
 360
 361   // Collection of pass managers
 362   std::vector<ModulePassManager_New *> PassManagers;
 363
 364   // Active Pass Manager
 365   ModulePassManager_New *activeManager;
 366 };
 367
 368 } // End of llvm namespace
 369
 370 // PMDataManager implementation
 371
 372 /// Return true IFF pass P's required analysis set does not required new
 373 /// manager.
 374 bool PMDataManager::manageablePass(Pass *P) {
 375
 376   // TODO
 377   // If this pass is not preserving information that is required by a
 378   // pass maintained by higher level pass manager then do not insert
 379   // this pass into current manager. Use new manager. For example,
 380   // For example, If FunctionPass F is not preserving ModulePass Info M1
 381   // that is used by another ModulePass M2 then do not insert F in
 382   // current function pass manager.
 383   return true;
 384 }
 385
 386 /// Augement AvailableAnalysis by adding analysis made available by pass P.
 387 void PMDataManager::recordAvailableAnalysis(Pass *P) {
 388
 389   if (const PassInfo *PI = P->getPassInfo()) {
 390     AvailableAnalysis[PI] = P;
 391
 392     //This pass is the current implementation of all of the interfaces it
 393     //implements as well.
 394     const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
 395     for (unsigned i = 0, e = II.size(); i != e; ++i)
 396       AvailableAnalysis[II[i]] = P;
 397   }
 398 }
 399
 400 /// Remove Analyss not preserved by Pass P
 401 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
 402   AnalysisUsage AnUsage;
 403   P->getAnalysisUsage(AnUsage);
 404   const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
 405
 406   for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
 407          E = AvailableAnalysis.end(); I != E; ++I ) {
 408     if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) ==
 409         PreservedSet.end()) {
 410       // Remove this analysis
 411       std::map<AnalysisID, Pass*>::iterator J = I++;
 412       AvailableAnalysis.erase(J);
 413     }
 414   }
 415 }
 416
 417 /// Remove analysis passes that are not used any longer
 418 void PMDataManager::removeDeadPasses(Pass *P) {
 419
 420   for (std::map<Pass *, Pass *>::iterator I = LastUser.begin(),
 421          E = LastUser.end(); I !=E; ++I) {
 422     if (I->second == P) {
 423       Pass *deadPass = I->first;
 424       deadPass->releaseMemory();
 425
 426       std::map<AnalysisID, Pass*>::iterator Pos =
 427         AvailableAnalysis.find(deadPass->getPassInfo());
 428
 429       assert (Pos != AvailableAnalysis.end() &&
 430               "Pass is not available");
 431       AvailableAnalysis.erase(Pos);
 432     }
 433   }
 434 }
 435
 436 /// Add pass P into the PassVector. Update
 437 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
 438 void PMDataManager::addPassToManager (Pass *P,
 439                                               bool ProcessAnalysis) {
 440
 441   if (ProcessAnalysis) {
 442     // Take a note of analysis required and made available by this pass
 443     initializeAnalysisImpl(P);
 444     recordAvailableAnalysis(P);
 445
 446     // Remove the analysis not preserved by this pass
 447     removeNotPreservedAnalysis(P);
 448   }
 449
 450   // Add pass
 451   PassVector.push_back(P);
 452 }
 453
 454 // All Required analyses should be available to the pass as it runs!  Here
 455 // we fill in the AnalysisImpls member of the pass so that it can
 456 // successfully use the getAnalysis() method to retrieve the
 457 // implementations it needs.
 458 //
 459 void PMDataManager::initializeAnalysisImpl(Pass *P) {
 460   AnalysisUsage AnUsage;
 461   P->getAnalysisUsage(AnUsage);
 462
 463   for (std::vector<const PassInfo *>::const_iterator
 464          I = AnUsage.getRequiredSet().begin(),
 465          E = AnUsage.getRequiredSet().end(); I != E; ++I) {
 466     Pass *Impl = getAnalysisPass(*I);
 467     if (Impl == 0)
 468       assert(0 && "Analysis used but not available!");
 469     // TODO:  P->AnalysisImpls.push_back(std::make_pair(*I, Impl));
 470   }
 471 }
 472
 473 /// BasicBlockPassManager implementation
 474
 475 /// Add pass P into PassVector and return true. If this pass is not
 476 /// manageable by this manager then return false.
 477 bool
 478 BasicBlockPassManager_New::addPass(Pass *P) {
 479
 480   BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
 481   if (!BP)
 482     return false;
 483
 484   // If this pass does not preserve anlysis that is used by other passes
 485   // managed by this manager than it is not a suiable pass for this manager.
 486   if (!manageablePass(P))
 487     return false;
 488
 489   addPassToManager (BP);
 490
 491   return true;
 492 }
 493
 494 /// Execute all of the passes scheduled for execution by invoking
 495 /// runOnBasicBlock method.  Keep track of whether any of the passes modifies
 496 /// the function, and if so, return true.
 497 bool
 498 BasicBlockPassManager_New::runOnFunction(Function &F) {
 499
 500   bool Changed = false;
 501   initializeAnalysisInfo();
 502
 503   for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
 504     for (std::vector<Pass *>::iterator itr = passVectorBegin(),
 505            e = passVectorEnd(); itr != e; ++itr) {
 506       Pass *P = *itr;
 507
 508       recordAvailableAnalysis(P);
 509       BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
 510       Changed |= BP->runOnBasicBlock(*I);
 511       removeNotPreservedAnalysis(P);
 512       removeDeadPasses(P);
 513     }
 514   return Changed;
 515 }
 516
 517 /// Return true IFF AnalysisID AID is currently available.
 518 Pass * BasicBlockPassManager_New::getAnalysisPassFromManager(AnalysisID AID) {
 519   return getAnalysisPass(AID);
 520 }
 521
 522 // FunctionPassManager_New implementation
 523 /// Create new Function pass manager
 524 FunctionPassManager_New::FunctionPassManager_New() {
 525   FPM = new FunctionPassManagerImpl_New();
 526 }
 527
 528 /// add - Add a pass to the queue of passes to run.  This passes
 529 /// ownership of the Pass to the PassManager.  When the
 530 /// PassManager_X is destroyed, the pass will be destroyed as well, so
 531 /// there is no need to delete the pass. (TODO delete passes.)
 532 /// This implies that all passes MUST be allocated with 'new'.
 533 void FunctionPassManager_New::add(Pass *P) {
 534   FPM->add(P);
 535 }
 536
 537 /// Execute all of the passes scheduled for execution.  Keep
 538 /// track of whether any of the passes modifies the function, and if
 539 /// so, return true.
 540 bool FunctionPassManager_New::runOnModule(Module &M) {
 541   return FPM->runOnModule(M);
 542 }
 543
 544 /// run - Execute all of the passes scheduled for execution.  Keep
 545 /// track of whether any of the passes modifies the function, and if
 546 /// so, return true.
 547 ///
 548 bool FunctionPassManager_New::run(Function &F) {
 549   std::string errstr;
 550   if (MP->materializeFunction(&F, &errstr)) {
 551     cerr << "Error reading bytecode file: " << errstr << "\n";
 552     abort();
 553   }
 554   return FPM->runOnFunction(F);
 555 }
 556
 557
 558 /// doInitialization - Run all of the initializers for the function passes.
 559 ///
 560 bool FunctionPassManager_New::doInitialization() {
 561   return FPM->doInitialization(*MP->getModule());
 562 }
 563
 564 /// doFinalization - Run all of the initializers for the function passes.
 565 ///
 566 bool FunctionPassManager_New::doFinalization() {
 567   return FPM->doFinalization(*MP->getModule());
 568 }
 569
 570 // FunctionPassManagerImpl_New implementation
 571
 572 // FunctionPassManager
 573
 574 /// Add pass P into the pass manager queue. If P is a BasicBlockPass then
 575 /// either use it into active basic block pass manager or create new basic
 576 /// block pass manager to handle pass P.
 577 bool
 578 FunctionPassManagerImpl_New::addPass(Pass *P) {
 579
 580   // If P is a BasicBlockPass then use BasicBlockPassManager_New.
 581   if (BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P)) {
 582
 583     if (!activeBBPassManager
 584         || !activeBBPassManager->addPass(BP)) {
 585
 586       activeBBPassManager = new BasicBlockPassManager_New();
 587       addPassToManager(activeBBPassManager, false);
 588       if (!activeBBPassManager->addPass(BP))
 589         assert(0 && "Unable to add Pass");
 590     }
 591     return true;
 592   }
 593
 594   FunctionPass *FP = dynamic_cast<FunctionPass *>(P);
 595   if (!FP)
 596     return false;
 597
 598   // If this pass does not preserve anlysis that is used by other passes
 599   // managed by this manager than it is not a suiable pass for this manager.
 600   if (!manageablePass(P))
 601     return false;
 602
 603   addPassToManager (FP);
 604   activeBBPassManager = NULL;
 605   return true;
 606 }
 607
 608 /// Execute all of the passes scheduled for execution by invoking
 609 /// runOnFunction method.  Keep track of whether any of the passes modifies
 610 /// the function, and if so, return true.
 611 bool FunctionPassManagerImpl_New::runOnModule(Module &M) {
 612
 613   bool Changed = false;
 614   initializeAnalysisInfo();
 615
 616   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 617     for (std::vector<Pass *>::iterator itr = passVectorBegin(),
 618            e = passVectorEnd(); itr != e; ++itr) {
 619       Pass *P = *itr;
 620
 621       recordAvailableAnalysis(P);
 622       FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
 623       Changed |= FP->runOnFunction(*I);
 624       removeNotPreservedAnalysis(P);
 625       removeDeadPasses(P);
 626     }
 627   return Changed;
 628 }
 629
 630 /// Execute all of the passes scheduled for execution by invoking
 631 /// runOnFunction method.  Keep track of whether any of the passes modifies
 632 /// the function, and if so, return true.
 633 bool FunctionPassManagerImpl_New::runOnFunction(Function &F) {
 634
 635   bool Changed = false;
 636   initializeAnalysisInfo();
 637
 638   for (std::vector<Pass *>::iterator itr = passVectorBegin(),
 639          e = passVectorEnd(); itr != e; ++itr) {
 640     Pass *P = *itr;
 641
 642     recordAvailableAnalysis(P);
 643     FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
 644     Changed |= FP->runOnFunction(F);
 645     removeNotPreservedAnalysis(P);
 646     removeDeadPasses(P);
 647   }
 648   return Changed;
 649 }
 650
 651
 652 /// Return true IFF AnalysisID AID is currently available.
 653 Pass *FunctionPassManagerImpl_New::getAnalysisPassFromManager(AnalysisID AID) {
 654
 655   Pass *P = getAnalysisPass(AID);
 656   if (P)
 657     return P;
 658
 659   if (activeBBPassManager &&
 660       activeBBPassManager->getAnalysisPass(AID) != 0)
 661     return activeBBPassManager->getAnalysisPass(AID);
 662
 663   // TODO : Check inactive managers
 664   return NULL;
 665 }
 666
 667 inline bool FunctionPassManagerImpl_New::doInitialization(Module &M) {
 668   bool Changed = false;
 669
 670   for (std::vector<Pass *>::iterator itr = passVectorBegin(),
 671          e = passVectorEnd(); itr != e; ++itr) {
 672     Pass *P = *itr;
 673
 674     FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
 675     Changed |= FP->doInitialization(M);
 676   }
 677
 678   return Changed;
 679 }
 680
 681 inline bool FunctionPassManagerImpl_New::doFinalization(Module &M) {
 682   bool Changed = false;
 683
 684   for (std::vector<Pass *>::iterator itr = passVectorBegin(),
 685          e = passVectorEnd(); itr != e; ++itr) {
 686     Pass *P = *itr;
 687
 688     FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
 689     Changed |= FP->doFinalization(M);
 690   }
 691
 692
 693   return Changed;
 694 }
 695
 696
 697 // ModulePassManager implementation
 698
 699 /// Add P into pass vector if it is manageble. If P is a FunctionPass
 700 /// then use FunctionPassManagerImpl_New to manage it. Return false if P
 701 /// is not manageable by this manager.
 702 bool
 703 ModulePassManager_New::addPass(Pass *P) {
 704
 705   // If P is FunctionPass then use function pass maanager.
 706   if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P)) {
 707
 708     activeFunctionPassManager = NULL;
 709
 710     if (!activeFunctionPassManager
 711         || !activeFunctionPassManager->addPass(P)) {
 712
 713       activeFunctionPassManager = new FunctionPassManagerImpl_New();
 714       addPassToManager(activeFunctionPassManager, false);
 715       if (!activeFunctionPassManager->addPass(FP))
 716         assert(0 && "Unable to add pass");
 717     }
 718     return true;
 719   }
 720
 721   ModulePass *MP = dynamic_cast<ModulePass *>(P);
 722   if (!MP)
 723     return false;
 724
 725   // If this pass does not preserve anlysis that is used by other passes
 726   // managed by this manager than it is not a suiable pass for this manager.
 727   if (!manageablePass(P))
 728     return false;
 729
 730   addPassToManager(MP);
 731   activeFunctionPassManager = NULL;
 732   return true;
 733 }
 734
 735
 736 /// Execute all of the passes scheduled for execution by invoking
 737 /// runOnModule method.  Keep track of whether any of the passes modifies
 738 /// the module, and if so, return true.
 739 bool
 740 ModulePassManager_New::runOnModule(Module &M) {
 741   bool Changed = false;
 742   initializeAnalysisInfo();
 743
 744   for (std::vector<Pass *>::iterator itr = passVectorBegin(),
 745          e = passVectorEnd(); itr != e; ++itr) {
 746     Pass *P = *itr;
 747
 748     recordAvailableAnalysis(P);
 749     ModulePass *MP = dynamic_cast<ModulePass*>(P);
 750     Changed |= MP->runOnModule(M);
 751     removeNotPreservedAnalysis(P);
 752     removeDeadPasses(P);
 753   }
 754   return Changed;
 755 }
 756
 757 /// Return true IFF AnalysisID AID is currently available.
 758 Pass *ModulePassManager_New::getAnalysisPassFromManager(AnalysisID AID) {
 759
 760
 761   Pass *P = getAnalysisPass(AID);
 762   if (P)
 763     return P;
 764
 765   if (activeFunctionPassManager &&
 766       activeFunctionPassManager->getAnalysisPass(AID) != 0)
 767     return activeFunctionPassManager->getAnalysisPass(AID);
 768
 769   // TODO : Check inactive managers
 770   return NULL;
 771 }
 772
 773 /// Return true IFF AnalysisID AID is currently available.
 774 Pass *PassManagerImpl_New::getAnalysisPassFromManager(AnalysisID AID) {
 775
 776   Pass *P = NULL;
 777   for (std::vector<ModulePassManager_New *>::iterator itr = PassManagers.begin(),
 778          e = PassManagers.end(); !P && itr != e; ++itr)
 779     P  = (*itr)->getAnalysisPassFromManager(AID);
 780   return P;
 781 }
 782
 783 /// Schedule pass P for execution. Make sure that passes required by
 784 /// P are run before P is run. Update analysis info maintained by
 785 /// the manager. Remove dead passes. This is a recursive function.
 786 void PassManagerImpl_New::schedulePass(Pass *P) {
 787
 788   AnalysisUsage AnUsage;
 789   P->getAnalysisUsage(AnUsage);
 790   const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
 791   for (std::vector<AnalysisID>::const_iterator I = RequiredSet.begin(),
 792          E = RequiredSet.end(); I != E; ++I) {
 793
 794     Pass *AnalysisPass = getAnalysisPassFromManager(*I);
 795     if (!AnalysisPass) {
 796       // Schedule this analysis run first.
 797       AnalysisPass = (*I)->createPass();
 798       schedulePass(AnalysisPass);
 799     }
 800     setLastUser (AnalysisPass, P);
 801
 802     // Prolong live range of analyses that are needed after an analysis pass
 803     // is destroyed, for querying by subsequent passes
 804     const std::vector<AnalysisID> &IDs = AnUsage.getRequiredTransitiveSet();
 805     for (std::vector<AnalysisID>::const_iterator I = IDs.begin(),
 806            E = IDs.end(); I != E; ++I) {
 807       Pass *AP = getAnalysisPassFromManager(*I);
 808       assert (AP && "Analysis pass is not available");
 809       setLastUser(AP, P);
 810     }
 811   }
 812   addPass(P);
 813 }
 814
 815 /// Schedule all passes from the queue by adding them in their
 816 /// respective manager's queue.
 817 void PassManagerImpl_New::schedulePasses() {
 818   for (std::vector<Pass *>::iterator I = passVectorBegin(),
 819          E = passVectorEnd(); I != E; ++I)
 820     schedulePass (*I);
 821 }
 822
 823 /// Add pass P to the queue of passes to run.
 824 void PassManagerImpl_New::add(Pass *P) {
 825   // Do not process Analysis now. Analysis is process while scheduling
 826   // the pass vector.
 827   addPassToManager(P, false);
 828 }
 829
 830 // PassManager_New implementation
 831 /// Add P into active pass manager or use new module pass manager to
 832 /// manage it.
 833 bool PassManagerImpl_New::addPass(Pass *P) {
 834
 835   if (!activeManager || !activeManager->addPass(P)) {
 836     activeManager = new ModulePassManager_New();
 837     PassManagers.push_back(activeManager);
 838   }
 839
 840   return activeManager->addPass(P);
 841 }
 842
 843 /// run - Execute all of the passes scheduled for execution.  Keep track of
 844 /// whether any of the passes modifies the module, and if so, return true.
 845 bool PassManagerImpl_New::run(Module &M) {
 846
 847   schedulePasses();
 848   bool Changed = false;
 849   for (std::vector<ModulePassManager_New *>::iterator itr = PassManagers.begin(),
 850          e = PassManagers.end(); itr != e; ++itr) {
 851     ModulePassManager_New *pm = *itr;
 852     Changed |= pm->runOnModule(M);
 853   }
 854   return Changed;
 855 }
 856
 857 /// Create new pass manager
 858 PassManager_New::PassManager_New() {
 859   PM = new PassManagerImpl_New();
 860 }
 861
 862 /// add - Add a pass to the queue of passes to run.  This passes ownership of
 863 /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
 864 /// will be destroyed as well, so there is no need to delete the pass.  This
 865 /// implies that all passes MUST be allocated with 'new'.
 866 void
 867 PassManager_New::add(Pass *P) {
 868   PM->add(P);
 869 }
 870
 871 /// run - Execute all of the passes scheduled for execution.  Keep track of
 872 /// whether any of the passes modifies the module, and if so, return true.
 873 bool
 874 PassManager_New::run(Module &M) {
 875   return PM->run(M);
 876 }
 877