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/PassManagers.h"
  16 #include "llvm/Support/CommandLine.h"
  17 #include "llvm/Support/Timer.h"
  18 #include "llvm/Module.h"
  19 #include "llvm/ModuleProvider.h"
  20 #include "llvm/Support/Streams.h"
  21 #include "llvm/Support/ManagedStatic.h"
  22 #include <algorithm>
  23 #include <vector>
  24 #include <map>
  25
  26 // See PassManagers.h for Pass Manager infrastructure overview.
  27
  28 namespace llvm {
  29
  30 //===----------------------------------------------------------------------===//
  31 // Pass debugging information.  Often it is useful to find out what pass is
  32 // running when a crash occurs in a utility.  When this library is compiled with
  33 // debugging on, a command line option (--debug-pass) is enabled that causes the
  34 // pass name to be printed before it executes.
  35 //
  36
  37 // Different debug levels that can be enabled...
  38 enum PassDebugLevel {
  39   None, Arguments, Structure, Executions, Details
  40 };
  41
  42 static cl::opt<enum PassDebugLevel>
  43 PassDebugging("debug-pass", cl::Hidden,
  44                   cl::desc("Print PassManager debugging information"),
  45                   cl::values(
  46   clEnumVal(None      , "disable debug output"),
  47   clEnumVal(Arguments , "print pass arguments to pass to 'opt'"),
  48   clEnumVal(Structure , "print pass structure before run()"),
  49   clEnumVal(Executions, "print pass name before it is executed"),
  50   clEnumVal(Details   , "print pass details when it is executed"),
  51                              clEnumValEnd));
  52 } // End of llvm namespace
  53
  54 namespace {
  55
  56 //===----------------------------------------------------------------------===//
  57 // BBPassManager
  58 //
  59 /// BBPassManager manages BasicBlockPass. It batches all the
  60 /// pass together and sequence them to process one basic block before
  61 /// processing next basic block.
  62 class VISIBILITY_HIDDEN BBPassManager : public PMDataManager,
  63                                         public FunctionPass {
  64
  65 public:
  66   BBPassManager(int Depth) : PMDataManager(Depth) { }
  67
  68   /// Execute all of the passes scheduled for execution.  Keep track of
  69   /// whether any of the passes modifies the function, and if so, return true.
  70   bool runOnFunction(Function &F);
  71
  72   /// Pass Manager itself does not invalidate any analysis info.
  73   void getAnalysisUsage(AnalysisUsage &Info) const {
  74     Info.setPreservesAll();
  75   }
  76
  77   bool doInitialization(Module &M);
  78   bool doInitialization(Function &F);
  79   bool doFinalization(Module &M);
  80   bool doFinalization(Function &F);
  81
  82   virtual const char *getPassName() const {
  83     return "BasicBlock Pass  Manager";
  84   }
  85
  86   // Print passes managed by this manager
  87   void dumpPassStructure(unsigned Offset) {
  88     llvm::cerr << std::string(Offset*2, ' ') << "BasicBlockPass Manager\n";
  89     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
  90       BasicBlockPass *BP = getContainedPass(Index);
  91       BP->dumpPassStructure(Offset + 1);
  92       dumpLastUses(BP, Offset+1);
  93     }
  94   }
  95
  96   BasicBlockPass *getContainedPass(unsigned N) {
  97     assert ( N < PassVector.size() && "Pass number out of range!");
  98     BasicBlockPass *BP = static_cast<BasicBlockPass *>(PassVector[N]);
  99     return BP;
 100   }
 101
 102   virtual PassManagerType getPassManagerType() const {
 103     return PMT_BasicBlockPassManager;
 104   }
 105 };
 106
 107 }
 108
 109 namespace llvm {
 110
 111 //===----------------------------------------------------------------------===//
 112 // FunctionPassManagerImpl
 113 //
 114 /// FunctionPassManagerImpl manages FPPassManagers
 115 class FunctionPassManagerImpl : public Pass,
 116                                 public PMDataManager,
 117                                 public PMTopLevelManager {
 118 public:
 119
 120   FunctionPassManagerImpl(int Depth) : PMDataManager(Depth),
 121                                        PMTopLevelManager(TLM_Function) { }
 122
 123   /// add - Add a pass to the queue of passes to run.  This passes ownership of
 124   /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
 125   /// will be destroyed as well, so there is no need to delete the pass.  This
 126   /// implies that all passes MUST be allocated with 'new'.
 127   void add(Pass *P) {
 128     schedulePass(P);
 129   }
 130
 131   /// run - Execute all of the passes scheduled for execution.  Keep track of
 132   /// whether any of the passes modifies the module, and if so, return true.
 133   bool run(Function &F);
 134
 135   /// doInitialization - Run all of the initializers for the function passes.
 136   ///
 137   bool doInitialization(Module &M);
 138
 139   /// doFinalization - Run all of the initializers for the function passes.
 140   ///
 141   bool doFinalization(Module &M);
 142
 143   /// Pass Manager itself does not invalidate any analysis info.
 144   void getAnalysisUsage(AnalysisUsage &Info) const {
 145     Info.setPreservesAll();
 146   }
 147
 148   inline void addTopLevelPass(Pass *P) {
 149
 150     if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
 151
 152       // P is a immutable pass and it will be managed by this
 153       // top level manager. Set up analysis resolver to connect them.
 154       AnalysisResolver *AR = new AnalysisResolver(*this);
 155       P->setResolver(AR);
 156       initializeAnalysisImpl(P);
 157       addImmutablePass(IP);
 158       recordAvailableAnalysis(IP);
 159     } else {
 160       P->assignPassManager(activeStack);
 161     }
 162
 163   }
 164
 165   FPPassManager *getContainedManager(unsigned N) {
 166     assert ( N < PassManagers.size() && "Pass number out of range!");
 167     FPPassManager *FP = static_cast<FPPassManager *>(PassManagers[N]);
 168     return FP;
 169   }
 170
 171 };
 172
 173 //===----------------------------------------------------------------------===//
 174 // MPPassManager
 175 //
 176 /// MPPassManager manages ModulePasses and function pass managers.
 177 /// It batches all Module passes  passes and function pass managers together and
 178 /// sequence them to process one module.
 179 class MPPassManager : public Pass, public PMDataManager {
 180
 181 public:
 182   MPPassManager(int Depth) : PMDataManager(Depth) { }
 183
 184   /// run - Execute all of the passes scheduled for execution.  Keep track of
 185   /// whether any of the passes modifies the module, and if so, return true.
 186   bool runOnModule(Module &M);
 187
 188   /// Pass Manager itself does not invalidate any analysis info.
 189   void getAnalysisUsage(AnalysisUsage &Info) const {
 190     Info.setPreservesAll();
 191   }
 192
 193   virtual const char *getPassName() const {
 194     return "Module Pass Manager";
 195   }
 196
 197   // Print passes managed by this manager
 198   void dumpPassStructure(unsigned Offset) {
 199     llvm::cerr << std::string(Offset*2, ' ') << "ModulePass Manager\n";
 200     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 201       ModulePass *MP = getContainedPass(Index);
 202       MP->dumpPassStructure(Offset + 1);
 203       dumpLastUses(MP, Offset+1);
 204     }
 205   }
 206
 207   ModulePass *getContainedPass(unsigned N) {
 208     assert ( N < PassVector.size() && "Pass number out of range!");
 209     ModulePass *MP = static_cast<ModulePass *>(PassVector[N]);
 210     return MP;
 211   }
 212
 213   virtual PassManagerType getPassManagerType() const {
 214     return PMT_ModulePassManager;
 215   }
 216 };
 217
 218 //===----------------------------------------------------------------------===//
 219 // PassManagerImpl
 220 //
 221 /// PassManagerImpl manages MPPassManagers
 222 class PassManagerImpl : public Pass,
 223                         public PMDataManager,
 224                         public PMTopLevelManager {
 225
 226 public:
 227
 228   PassManagerImpl(int Depth) : PMDataManager(Depth),
 229                                PMTopLevelManager(TLM_Pass) { }
 230
 231   /// add - Add a pass to the queue of passes to run.  This passes ownership of
 232   /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
 233   /// will be destroyed as well, so there is no need to delete the pass.  This
 234   /// implies that all passes MUST be allocated with 'new'.
 235   void add(Pass *P) {
 236     schedulePass(P);
 237   }
 238
 239   /// run - Execute all of the passes scheduled for execution.  Keep track of
 240   /// whether any of the passes modifies the module, and if so, return true.
 241   bool run(Module &M);
 242
 243   /// Pass Manager itself does not invalidate any analysis info.
 244   void getAnalysisUsage(AnalysisUsage &Info) const {
 245     Info.setPreservesAll();
 246   }
 247
 248   inline void addTopLevelPass(Pass *P) {
 249
 250     if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
 251
 252       // P is a immutable pass and it will be managed by this
 253       // top level manager. Set up analysis resolver to connect them.
 254       AnalysisResolver *AR = new AnalysisResolver(*this);
 255       P->setResolver(AR);
 256       initializeAnalysisImpl(P);
 257       addImmutablePass(IP);
 258       recordAvailableAnalysis(IP);
 259     } else {
 260       P->assignPassManager(activeStack);
 261     }
 262
 263   }
 264
 265   MPPassManager *getContainedManager(unsigned N) {
 266     assert ( N < PassManagers.size() && "Pass number out of range!");
 267     MPPassManager *MP = static_cast<MPPassManager *>(PassManagers[N]);
 268     return MP;
 269   }
 270
 271 };
 272
 273 } // End of llvm namespace
 274
 275 namespace {
 276
 277 //===----------------------------------------------------------------------===//
 278 // TimingInfo Class - This class is used to calculate information about the
 279 // amount of time each pass takes to execute.  This only happens when
 280 // -time-passes is enabled on the command line.
 281 //
 282
 283 class VISIBILITY_HIDDEN TimingInfo {
 284   std::map<Pass*, Timer> TimingData;
 285   TimerGroup TG;
 286
 287 public:
 288   // Use 'create' member to get this.
 289   TimingInfo() : TG("... Pass execution timing report ...") {}
 290
 291   // TimingDtor - Print out information about timing information
 292   ~TimingInfo() {
 293     // Delete all of the timers...
 294     TimingData.clear();
 295     // TimerGroup is deleted next, printing the report.
 296   }
 297
 298   // createTheTimeInfo - This method either initializes the TheTimeInfo pointer
 299   // to a non null value (if the -time-passes option is enabled) or it leaves it
 300   // null.  It may be called multiple times.
 301   static void createTheTimeInfo();
 302
 303   void passStarted(Pass *P) {
 304
 305     if (dynamic_cast<PMDataManager *>(P))
 306       return;
 307
 308     std::map<Pass*, Timer>::iterator I = TimingData.find(P);
 309     if (I == TimingData.end())
 310       I=TimingData.insert(std::make_pair(P, Timer(P->getPassName(), TG))).first;
 311     I->second.startTimer();
 312   }
 313   void passEnded(Pass *P) {
 314
 315     if (dynamic_cast<PMDataManager *>(P))
 316       return;
 317
 318     std::map<Pass*, Timer>::iterator I = TimingData.find(P);
 319     assert (I != TimingData.end() && "passStarted/passEnded not nested right!");
 320     I->second.stopTimer();
 321   }
 322 };
 323
 324 static TimingInfo *TheTimeInfo;
 325
 326 } // End of anon namespace
 327
 328 //===----------------------------------------------------------------------===//
 329 // PMTopLevelManager implementation
 330
 331 /// Initialize top level manager. Create first pass manager.
 332 PMTopLevelManager::PMTopLevelManager (enum TopLevelManagerType t) {
 333
 334   if (t == TLM_Pass) {
 335     MPPassManager *MPP = new MPPassManager(1);
 336     MPP->setTopLevelManager(this);
 337     addPassManager(MPP);
 338     activeStack.push(MPP);
 339   }
 340   else if (t == TLM_Function) {
 341     FPPassManager *FPP = new FPPassManager(1);
 342     FPP->setTopLevelManager(this);
 343     addPassManager(FPP);
 344     activeStack.push(FPP);
 345   }
 346 }
 347
 348 /// Set pass P as the last user of the given analysis passes.
 349 void PMTopLevelManager::setLastUser(std::vector<Pass *> &AnalysisPasses,
 350                                     Pass *P) {
 351
 352   for (std::vector<Pass *>::iterator I = AnalysisPasses.begin(),
 353          E = AnalysisPasses.end(); I != E; ++I) {
 354     Pass *AP = *I;
 355     LastUser[AP] = P;
 356     // If AP is the last user of other passes then make P last user of
 357     // such passes.
 358     for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
 359            LUE = LastUser.end(); LUI != LUE; ++LUI) {
 360       if (LUI->second == AP)
 361         LastUser[LUI->first] = P;
 362     }
 363   }
 364 }
 365
 366 /// Collect passes whose last user is P
 367 void PMTopLevelManager::collectLastUses(std::vector<Pass *> &LastUses,
 368                                             Pass *P) {
 369    for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
 370           LUE = LastUser.end(); LUI != LUE; ++LUI)
 371       if (LUI->second == P)
 372         LastUses.push_back(LUI->first);
 373 }
 374
 375 /// Schedule pass P for execution. Make sure that passes required by
 376 /// P are run before P is run. Update analysis info maintained by
 377 /// the manager. Remove dead passes. This is a recursive function.
 378 void PMTopLevelManager::schedulePass(Pass *P) {
 379
 380   // TODO : Allocate function manager for this pass, other wise required set
 381   // may be inserted into previous function manager
 382
 383   // If this Analysis is already requested by one of the previous pass
 384   // and it is still available then do not insert new pass in the queue again.
 385   if (findAnalysisPass(P->getPassInfo()))
 386       return;
 387
 388   // Give pass a chance to prepare the stage.
 389   P->preparePassManager(activeStack);
 390
 391   AnalysisUsage AnUsage;
 392   P->getAnalysisUsage(AnUsage);
 393   const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
 394   for (std::vector<AnalysisID>::const_iterator I = RequiredSet.begin(),
 395          E = RequiredSet.end(); I != E; ++I) {
 396
 397     Pass *AnalysisPass = findAnalysisPass(*I);
 398     if (!AnalysisPass) {
 399       // Schedule this analysis run first.
 400       AnalysisPass = (*I)->createPass();
 401       schedulePass(AnalysisPass);
 402     }
 403   }
 404
 405   // Now all required passes are available.
 406   addTopLevelPass(P);
 407 }
 408
 409 /// Find the pass that implements Analysis AID. Search immutable
 410 /// passes and all pass managers. If desired pass is not found
 411 /// then return NULL.
 412 Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
 413
 414   Pass *P = NULL;
 415   // Check pass managers
 416   for (std::vector<Pass *>::iterator I = PassManagers.begin(),
 417          E = PassManagers.end(); P == NULL && I != E; ++I) {
 418     PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
 419     assert(PMD && "This is not a PassManager");
 420     P = PMD->findAnalysisPass(AID, false);
 421   }
 422
 423   // Check other pass managers
 424   for (std::vector<PMDataManager *>::iterator I = IndirectPassManagers.begin(),
 425          E = IndirectPassManagers.end(); P == NULL && I != E; ++I)
 426     P = (*I)->findAnalysisPass(AID, false);
 427
 428   for (std::vector<ImmutablePass *>::iterator I = ImmutablePasses.begin(),
 429          E = ImmutablePasses.end(); P == NULL && I != E; ++I) {
 430     const PassInfo *PI = (*I)->getPassInfo();
 431     if (PI == AID)
 432       P = *I;
 433
 434     // If Pass not found then check the interfaces implemented by Immutable Pass
 435     if (!P) {
 436       const std::vector<const PassInfo*> &ImmPI = PI->getInterfacesImplemented();
 437       if (std::find(ImmPI.begin(), ImmPI.end(), AID) != ImmPI.end())
 438         P = *I;
 439     }
 440   }
 441
 442   return P;
 443 }
 444
 445 // Print passes managed by this top level manager.
 446 void PMTopLevelManager::dumpPasses() const {
 447
 448   if (PassDebugging < Structure)
 449     return;
 450
 451   // Print out the immutable passes
 452   for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
 453     ImmutablePasses[i]->dumpPassStructure(0);
 454   }
 455
 456   for (std::vector<Pass *>::const_iterator I = PassManagers.begin(),
 457          E = PassManagers.end(); I != E; ++I)
 458     (*I)->dumpPassStructure(1);
 459 }
 460
 461 void PMTopLevelManager::dumpArguments() const {
 462
 463   if (PassDebugging < Arguments)
 464     return;
 465
 466   cerr << "Pass Arguments: ";
 467   for (std::vector<Pass *>::const_iterator I = PassManagers.begin(),
 468          E = PassManagers.end(); I != E; ++I) {
 469     PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
 470     assert(PMD && "This is not a PassManager");
 471     PMD->dumpPassArguments();
 472   }
 473   cerr << "\n";
 474 }
 475
 476 void PMTopLevelManager::initializeAllAnalysisInfo() {
 477
 478   for (std::vector<Pass *>::iterator I = PassManagers.begin(),
 479          E = PassManagers.end(); I != E; ++I) {
 480     PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
 481     assert(PMD && "This is not a PassManager");
 482     PMD->initializeAnalysisInfo();
 483   }
 484
 485   // Initailize other pass managers
 486   for (std::vector<PMDataManager *>::iterator I = IndirectPassManagers.begin(),
 487          E = IndirectPassManagers.end(); I != E; ++I)
 488     (*I)->initializeAnalysisInfo();
 489 }
 490
 491 /// Destructor
 492 PMTopLevelManager::~PMTopLevelManager() {
 493   for (std::vector<Pass *>::iterator I = PassManagers.begin(),
 494          E = PassManagers.end(); I != E; ++I)
 495     delete *I;
 496
 497   for (std::vector<ImmutablePass *>::iterator
 498          I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
 499     delete *I;
 500
 501   PassManagers.clear();
 502 }
 503
 504 //===----------------------------------------------------------------------===//
 505 // PMDataManager implementation
 506
 507 /// Return true IFF pass P's required analysis set does not required new
 508 /// manager.
 509 bool PMDataManager::manageablePass(Pass *P) {
 510
 511   // TODO
 512   // If this pass is not preserving information that is required by a
 513   // pass maintained by higher level pass manager then do not insert
 514   // this pass into current manager. Use new manager. For example,
 515   // For example, If FunctionPass F is not preserving ModulePass Info M1
 516   // that is used by another ModulePass M2 then do not insert F in
 517   // current function pass manager.
 518   return true;
 519 }
 520
 521 /// Augement AvailableAnalysis by adding analysis made available by pass P.
 522 void PMDataManager::recordAvailableAnalysis(Pass *P) {
 523
 524   if (const PassInfo *PI = P->getPassInfo()) {
 525     AvailableAnalysis[PI] = P;
 526
 527     //This pass is the current implementation of all of the interfaces it
 528     //implements as well.
 529     const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
 530     for (unsigned i = 0, e = II.size(); i != e; ++i)
 531       AvailableAnalysis[II[i]] = P;
 532   }
 533 }
 534
 535 /// Remove Analyss not preserved by Pass P
 536 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
 537   AnalysisUsage AnUsage;
 538   P->getAnalysisUsage(AnUsage);
 539
 540   if (AnUsage.getPreservesAll())
 541     return;
 542
 543   const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
 544   for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
 545          E = AvailableAnalysis.end(); I != E; ) {
 546     std::map<AnalysisID, Pass*>::iterator Info = I++;
 547     if (std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
 548         PreservedSet.end()) {
 549       // Remove this analysis
 550       if (!dynamic_cast<ImmutablePass*>(Info->second))
 551         AvailableAnalysis.erase(Info);
 552     }
 553   }
 554
 555   // Check inherited analysis also. If P is not preserving analysis
 556   // provided by parent manager then remove it here.
 557   for (unsigned Index = 0; Index < PMT_Last; ++Index) {
 558
 559     if (!InheritedAnalysis[Index])
 560       continue;
 561
 562     for (std::map<AnalysisID, Pass*>::iterator
 563            I = InheritedAnalysis[Index]->begin(),
 564            E = InheritedAnalysis[Index]->end(); I != E; ) {
 565       std::map<AnalysisID, Pass *>::iterator Info = I++;
 566       if (std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
 567           PreservedSet.end()) {
 568         // Remove this analysis
 569         if (!dynamic_cast<ImmutablePass*>(Info->second))
 570           InheritedAnalysis[Index]->erase(Info);
 571       }
 572     }
 573   }
 574
 575 }
 576
 577 /// Remove analysis passes that are not used any longer
 578 void PMDataManager::removeDeadPasses(Pass *P, std::string Msg,
 579                                      enum PassDebuggingString DBG_STR) {
 580
 581   std::vector<Pass *> DeadPasses;
 582   TPM->collectLastUses(DeadPasses, P);
 583
 584   for (std::vector<Pass *>::iterator I = DeadPasses.begin(),
 585          E = DeadPasses.end(); I != E; ++I) {
 586
 587     dumpPassInfo(*I, FREEING_MSG, DBG_STR, Msg);
 588
 589     if (TheTimeInfo) TheTimeInfo->passStarted(*I);
 590     (*I)->releaseMemory();
 591     if (TheTimeInfo) TheTimeInfo->passEnded(*I);
 592
 593     std::map<AnalysisID, Pass*>::iterator Pos =
 594       AvailableAnalysis.find((*I)->getPassInfo());
 595
 596     // It is possible that pass is already removed from the AvailableAnalysis
 597     if (Pos != AvailableAnalysis.end())
 598       AvailableAnalysis.erase(Pos);
 599   }
 600 }
 601
 602 /// Add pass P into the PassVector. Update
 603 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
 604 void PMDataManager::add(Pass *P,
 605                         bool ProcessAnalysis) {
 606
 607   // This manager is going to manage pass P. Set up analysis resolver
 608   // to connect them.
 609   AnalysisResolver *AR = new AnalysisResolver(*this);
 610   P->setResolver(AR);
 611
 612   // If a FunctionPass F is the last user of ModulePass info M
 613   // then the F's manager, not F, records itself as a last user of M.
 614   std::vector<Pass *> TransferLastUses;
 615
 616   if (ProcessAnalysis) {
 617
 618     // At the moment, this pass is the last user of all required passes.
 619     std::vector<Pass *> LastUses;
 620     std::vector<Pass *> RequiredPasses;
 621     unsigned PDepth = this->getDepth();
 622
 623     collectRequiredAnalysisPasses(RequiredPasses, P);
 624     for (std::vector<Pass *>::iterator I = RequiredPasses.begin(),
 625            E = RequiredPasses.end(); I != E; ++I) {
 626       Pass *PRequired = *I;
 627       unsigned RDepth = 0;
 628
 629       PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
 630       RDepth = DM.getDepth();
 631
 632       if (PDepth == RDepth)
 633         LastUses.push_back(PRequired);
 634       else if (PDepth >  RDepth) {
 635         // Let the parent claim responsibility of last use
 636         TransferLastUses.push_back(PRequired);
 637       } else {
 638         // Note : This feature is not yet implemented
 639         assert (0 &&
 640                 "Unable to handle Pass that requires lower level Analysis pass");
 641       }
 642     }
 643
 644     // Set P as P's last user until someone starts using P.
 645     // However, if P is a Pass Manager then it does not need
 646     // to record its last user.
 647     if (!dynamic_cast<PMDataManager *>(P))
 648       LastUses.push_back(P);
 649     TPM->setLastUser(LastUses, P);
 650
 651     if (!TransferLastUses.empty()) {
 652       Pass *My_PM = dynamic_cast<Pass *>(this);
 653       TPM->setLastUser(TransferLastUses, My_PM);
 654       TransferLastUses.clear();
 655     }
 656
 657     // Take a note of analysis required and made available by this pass.
 658     // Remove the analysis not preserved by this pass
 659     removeNotPreservedAnalysis(P);
 660     recordAvailableAnalysis(P);
 661   }
 662
 663   // Add pass
 664   PassVector.push_back(P);
 665 }
 666
 667 /// Populate RequiredPasses with the analysis pass that are required by
 668 /// pass P.
 669 void PMDataManager::collectRequiredAnalysisPasses(std::vector<Pass *> &RP,
 670                                                   Pass *P) {
 671   AnalysisUsage AnUsage;
 672   P->getAnalysisUsage(AnUsage);
 673   const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
 674   for (std::vector<AnalysisID>::const_iterator
 675          I = RequiredSet.begin(), E = RequiredSet.end();
 676        I != E; ++I) {
 677     Pass *AnalysisPass = findAnalysisPass(*I, true);
 678     assert (AnalysisPass && "Analysis pass is not available");
 679     RP.push_back(AnalysisPass);
 680   }
 681
 682   const std::vector<AnalysisID> &IDs = AnUsage.getRequiredTransitiveSet();
 683   for (std::vector<AnalysisID>::const_iterator I = IDs.begin(),
 684          E = IDs.end(); I != E; ++I) {
 685     Pass *AnalysisPass = findAnalysisPass(*I, true);
 686     assert (AnalysisPass && "Analysis pass is not available");
 687     RP.push_back(AnalysisPass);
 688   }
 689 }
 690
 691 // All Required analyses should be available to the pass as it runs!  Here
 692 // we fill in the AnalysisImpls member of the pass so that it can
 693 // successfully use the getAnalysis() method to retrieve the
 694 // implementations it needs.
 695 //
 696 void PMDataManager::initializeAnalysisImpl(Pass *P) {
 697   AnalysisUsage AnUsage;
 698   P->getAnalysisUsage(AnUsage);
 699
 700   for (std::vector<const PassInfo *>::const_iterator
 701          I = AnUsage.getRequiredSet().begin(),
 702          E = AnUsage.getRequiredSet().end(); I != E; ++I) {
 703     Pass *Impl = findAnalysisPass(*I, true);
 704     if (Impl == 0)
 705       assert(0 && "Analysis used but not available!");
 706     AnalysisResolver *AR = P->getResolver();
 707     AR->addAnalysisImplsPair(*I, Impl);
 708   }
 709 }
 710
 711 /// Find the pass that implements Analysis AID. If desired pass is not found
 712 /// then return NULL.
 713 Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
 714
 715   // Check if AvailableAnalysis map has one entry.
 716   std::map<AnalysisID, Pass*>::const_iterator I =  AvailableAnalysis.find(AID);
 717
 718   if (I != AvailableAnalysis.end())
 719     return I->second;
 720
 721   // Search Parents through TopLevelManager
 722   if (SearchParent)
 723     return TPM->findAnalysisPass(AID);
 724
 725   return NULL;
 726 }
 727
 728 // Print list of passes that are last used by P.
 729 void PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{
 730
 731   std::vector<Pass *> LUses;
 732
 733   assert (TPM && "Top Level Manager is missing");
 734   TPM->collectLastUses(LUses, P);
 735
 736   for (std::vector<Pass *>::iterator I = LUses.begin(),
 737          E = LUses.end(); I != E; ++I) {
 738     llvm::cerr << "--" << std::string(Offset*2, ' ');
 739     (*I)->dumpPassStructure(0);
 740   }
 741 }
 742
 743 void PMDataManager::dumpPassArguments() const {
 744   for(std::vector<Pass *>::const_iterator I = PassVector.begin(),
 745         E = PassVector.end(); I != E; ++I) {
 746     if (PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I))
 747       PMD->dumpPassArguments();
 748     else
 749       if (const PassInfo *PI = (*I)->getPassInfo())
 750         if (!PI->isAnalysisGroup())
 751           cerr << " -" << PI->getPassArgument();
 752   }
 753 }
 754
 755 void PMDataManager:: dumpPassInfo(Pass *P, enum PassDebuggingString S1,
 756                                   enum PassDebuggingString S2,
 757                                   std::string Msg) {
 758   if (PassDebugging < Executions)
 759     return;
 760   cerr << (void*)this << std::string(getDepth()*2+1, ' ');
 761   switch (S1) {
 762   case EXECUTION_MSG:
 763     cerr << "Executing Pass '" << P->getPassName();
 764     break;
 765   case MODIFICATION_MSG:
 766     cerr << "' Made Modification '" << P->getPassName();
 767     break;
 768   case FREEING_MSG:
 769     cerr << " Freeing Pass '" << P->getPassName();
 770     break;
 771   default:
 772     break;
 773   }
 774   switch (S2) {
 775   case ON_BASICBLOCK_MSG:
 776     cerr << "' on BasicBlock '" << Msg << "...\n";
 777     break;
 778   case ON_FUNCTION_MSG:
 779     cerr << "' on Function '" << Msg << "...\n";
 780     break;
 781   case ON_MODULE_MSG:
 782     cerr << "' on Module '"  << Msg << "...\n";
 783     break;
 784   case ON_LOOP_MSG:
 785     cerr << "' on Loop " << Msg << "...\n";
 786     break;
 787   case ON_CG_MSG:
 788     cerr << "' on Call Graph " << Msg << "...\n";
 789     break;
 790   default:
 791     break;
 792   }
 793 }
 794
 795 void PMDataManager::dumpAnalysisSetInfo(const char *Msg, Pass *P,
 796                                         const std::vector<AnalysisID> &Set)
 797   const {
 798   if (PassDebugging >= Details && !Set.empty()) {
 799     cerr << (void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:";
 800       for (unsigned i = 0; i != Set.size(); ++i) {
 801         if (i) cerr << ",";
 802         cerr << " " << Set[i]->getPassName();
 803       }
 804       cerr << "\n";
 805   }
 806 }
 807
 808 // Destructor
 809 PMDataManager::~PMDataManager() {
 810
 811   for (std::vector<Pass *>::iterator I = PassVector.begin(),
 812          E = PassVector.end(); I != E; ++I)
 813     delete *I;
 814
 815   PassVector.clear();
 816 }
 817
 818 //===----------------------------------------------------------------------===//
 819 // NOTE: Is this the right place to define this method ?
 820 // getAnalysisToUpdate - Return an analysis result or null if it doesn't exist
 821 Pass *AnalysisResolver::getAnalysisToUpdate(AnalysisID ID, bool dir) const {
 822   return PM.findAnalysisPass(ID, dir);
 823 }
 824
 825 //===----------------------------------------------------------------------===//
 826 // BBPassManager implementation
 827
 828 /// Execute all of the passes scheduled for execution by invoking
 829 /// runOnBasicBlock method.  Keep track of whether any of the passes modifies
 830 /// the function, and if so, return true.
 831 bool
 832 BBPassManager::runOnFunction(Function &F) {
 833
 834   if (F.isDeclaration())
 835     return false;
 836
 837   bool Changed = doInitialization(F);
 838
 839   for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
 840     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 841       BasicBlockPass *BP = getContainedPass(Index);
 842       AnalysisUsage AnUsage;
 843       BP->getAnalysisUsage(AnUsage);
 844
 845       dumpPassInfo(BP, EXECUTION_MSG, ON_BASICBLOCK_MSG, (*I).getName());
 846       dumpAnalysisSetInfo("Required", BP, AnUsage.getRequiredSet());
 847
 848       initializeAnalysisImpl(BP);
 849
 850       if (TheTimeInfo) TheTimeInfo->passStarted(BP);
 851       Changed |= BP->runOnBasicBlock(*I);
 852       if (TheTimeInfo) TheTimeInfo->passEnded(BP);
 853
 854       if (Changed)
 855         dumpPassInfo(BP, MODIFICATION_MSG, ON_BASICBLOCK_MSG, (*I).getName());
 856       dumpAnalysisSetInfo("Preserved", BP, AnUsage.getPreservedSet());
 857
 858       removeNotPreservedAnalysis(BP);
 859       recordAvailableAnalysis(BP);
 860       removeDeadPasses(BP, (*I).getName(), ON_BASICBLOCK_MSG);
 861
 862     }
 863   return Changed |= doFinalization(F);
 864 }
 865
 866 // Implement doInitialization and doFinalization
 867 inline bool BBPassManager::doInitialization(Module &M) {
 868   bool Changed = false;
 869
 870   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 871     BasicBlockPass *BP = getContainedPass(Index);
 872     Changed |= BP->doInitialization(M);
 873   }
 874
 875   return Changed;
 876 }
 877
 878 inline bool BBPassManager::doFinalization(Module &M) {
 879   bool Changed = false;
 880
 881   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 882     BasicBlockPass *BP = getContainedPass(Index);
 883     Changed |= BP->doFinalization(M);
 884   }
 885
 886   return Changed;
 887 }
 888
 889 inline bool BBPassManager::doInitialization(Function &F) {
 890   bool Changed = false;
 891
 892   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 893     BasicBlockPass *BP = getContainedPass(Index);
 894     Changed |= BP->doInitialization(F);
 895   }
 896
 897   return Changed;
 898 }
 899
 900 inline bool BBPassManager::doFinalization(Function &F) {
 901   bool Changed = false;
 902
 903   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 904     BasicBlockPass *BP = getContainedPass(Index);
 905     Changed |= BP->doFinalization(F);
 906   }
 907
 908   return Changed;
 909 }
 910
 911
 912 //===----------------------------------------------------------------------===//
 913 // FunctionPassManager implementation
 914
 915 /// Create new Function pass manager
 916 FunctionPassManager::FunctionPassManager(ModuleProvider *P) {
 917   FPM = new FunctionPassManagerImpl(0);
 918   // FPM is the top level manager.
 919   FPM->setTopLevelManager(FPM);
 920
 921   PMDataManager *PMD = dynamic_cast<PMDataManager *>(FPM);
 922   AnalysisResolver *AR = new AnalysisResolver(*PMD);
 923   FPM->setResolver(AR);
 924
 925   MP = P;
 926 }
 927
 928 FunctionPassManager::~FunctionPassManager() {
 929   delete FPM;
 930 }
 931
 932 /// add - Add a pass to the queue of passes to run.  This passes
 933 /// ownership of the Pass to the PassManager.  When the
 934 /// PassManager_X is destroyed, the pass will be destroyed as well, so
 935 /// there is no need to delete the pass. (TODO delete passes.)
 936 /// This implies that all passes MUST be allocated with 'new'.
 937 void FunctionPassManager::add(Pass *P) {
 938   FPM->add(P);
 939 }
 940
 941 /// run - Execute all of the passes scheduled for execution.  Keep
 942 /// track of whether any of the passes modifies the function, and if
 943 /// so, return true.
 944 ///
 945 bool FunctionPassManager::run(Function &F) {
 946   std::string errstr;
 947   if (MP->materializeFunction(&F, &errstr)) {
 948     cerr << "Error reading bytecode file: " << errstr << "\n";
 949     abort();
 950   }
 951   return FPM->run(F);
 952 }
 953
 954
 955 /// doInitialization - Run all of the initializers for the function passes.
 956 ///
 957 bool FunctionPassManager::doInitialization() {
 958   return FPM->doInitialization(*MP->getModule());
 959 }
 960
 961 /// doFinalization - Run all of the initializers for the function passes.
 962 ///
 963 bool FunctionPassManager::doFinalization() {
 964   return FPM->doFinalization(*MP->getModule());
 965 }
 966
 967 //===----------------------------------------------------------------------===//
 968 // FunctionPassManagerImpl implementation
 969 //
 970 inline bool FunctionPassManagerImpl::doInitialization(Module &M) {
 971   bool Changed = false;
 972
 973   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
 974     FPPassManager *FP = getContainedManager(Index);
 975     Changed |= FP->doInitialization(M);
 976   }
 977
 978   return Changed;
 979 }
 980
 981 inline bool FunctionPassManagerImpl::doFinalization(Module &M) {
 982   bool Changed = false;
 983
 984   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
 985     FPPassManager *FP = getContainedManager(Index);
 986     Changed |= FP->doFinalization(M);
 987   }
 988
 989   return Changed;
 990 }
 991
 992 // Execute all the passes managed by this top level manager.
 993 // Return true if any function is modified by a pass.
 994 bool FunctionPassManagerImpl::run(Function &F) {
 995
 996   bool Changed = false;
 997
 998   TimingInfo::createTheTimeInfo();
 999
1000   dumpArguments();
1001   dumpPasses();
1002
1003   initializeAllAnalysisInfo();
1004   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1005     FPPassManager *FP = getContainedManager(Index);
1006     Changed |= FP->runOnFunction(F);
1007   }
1008   return Changed;
1009 }
1010
1011 //===----------------------------------------------------------------------===//
1012 // FPPassManager implementation
1013
1014 /// Print passes managed by this manager
1015 void FPPassManager::dumpPassStructure(unsigned Offset) {
1016   llvm::cerr << std::string(Offset*2, ' ') << "FunctionPass Manager\n";
1017   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1018     FunctionPass *FP = getContainedPass(Index);
1019     FP->dumpPassStructure(Offset + 1);
1020     dumpLastUses(FP, Offset+1);
1021   }
1022 }
1023
1024
1025 /// Execute all of the passes scheduled for execution by invoking
1026 /// runOnFunction method.  Keep track of whether any of the passes modifies
1027 /// the function, and if so, return true.
1028 bool FPPassManager::runOnFunction(Function &F) {
1029
1030   bool Changed = false;
1031
1032   if (F.isDeclaration())
1033     return false;
1034
1035   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1036     FunctionPass *FP = getContainedPass(Index);
1037
1038     AnalysisUsage AnUsage;
1039     FP->getAnalysisUsage(AnUsage);
1040
1041     dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getName());
1042     dumpAnalysisSetInfo("Required", FP, AnUsage.getRequiredSet());
1043
1044     initializeAnalysisImpl(FP);
1045
1046     if (TheTimeInfo) TheTimeInfo->passStarted(FP);
1047     Changed |= FP->runOnFunction(F);
1048     if (TheTimeInfo) TheTimeInfo->passEnded(FP);
1049
1050     if (Changed)
1051       dumpPassInfo(FP, MODIFICATION_MSG, ON_FUNCTION_MSG, F.getName());
1052     dumpAnalysisSetInfo("Preserved", FP, AnUsage.getPreservedSet());
1053
1054     removeNotPreservedAnalysis(FP);
1055     recordAvailableAnalysis(FP);
1056     removeDeadPasses(FP, F.getName(), ON_FUNCTION_MSG);
1057   }
1058   return Changed;
1059 }
1060
1061 bool FPPassManager::runOnModule(Module &M) {
1062
1063   bool Changed = doInitialization(M);
1064
1065   for(Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1066     this->runOnFunction(*I);
1067
1068   return Changed |= doFinalization(M);
1069 }
1070
1071 inline bool FPPassManager::doInitialization(Module &M) {
1072   bool Changed = false;
1073
1074   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1075     FunctionPass *FP = getContainedPass(Index);
1076     Changed |= FP->doInitialization(M);
1077   }
1078
1079   return Changed;
1080 }
1081
1082 inline bool FPPassManager::doFinalization(Module &M) {
1083   bool Changed = false;
1084
1085   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1086     FunctionPass *FP = getContainedPass(Index);
1087     Changed |= FP->doFinalization(M);
1088   }
1089
1090   return Changed;
1091 }
1092
1093 //===----------------------------------------------------------------------===//
1094 // MPPassManager implementation
1095
1096 /// Execute all of the passes scheduled for execution by invoking
1097 /// runOnModule method.  Keep track of whether any of the passes modifies
1098 /// the module, and if so, return true.
1099 bool
1100 MPPassManager::runOnModule(Module &M) {
1101   bool Changed = false;
1102
1103   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1104     ModulePass *MP = getContainedPass(Index);
1105
1106     AnalysisUsage AnUsage;
1107     MP->getAnalysisUsage(AnUsage);
1108
1109     dumpPassInfo(MP, EXECUTION_MSG, ON_MODULE_MSG, M.getModuleIdentifier());
1110     dumpAnalysisSetInfo("Required", MP, AnUsage.getRequiredSet());
1111
1112     initializeAnalysisImpl(MP);
1113
1114     if (TheTimeInfo) TheTimeInfo->passStarted(MP);
1115     Changed |= MP->runOnModule(M);
1116     if (TheTimeInfo) TheTimeInfo->passEnded(MP);
1117
1118     if (Changed)
1119       dumpPassInfo(MP, MODIFICATION_MSG, ON_MODULE_MSG,
1120                    M.getModuleIdentifier());
1121     dumpAnalysisSetInfo("Preserved", MP, AnUsage.getPreservedSet());
1122
1123     removeNotPreservedAnalysis(MP);
1124     recordAvailableAnalysis(MP);
1125     removeDeadPasses(MP, M.getModuleIdentifier(), ON_MODULE_MSG);
1126   }
1127   return Changed;
1128 }
1129
1130 //===----------------------------------------------------------------------===//
1131 // PassManagerImpl implementation
1132 //
1133 /// run - Execute all of the passes scheduled for execution.  Keep track of
1134 /// whether any of the passes modifies the module, and if so, return true.
1135 bool PassManagerImpl::run(Module &M) {
1136
1137   bool Changed = false;
1138
1139   TimingInfo::createTheTimeInfo();
1140
1141   dumpArguments();
1142   dumpPasses();
1143
1144   initializeAllAnalysisInfo();
1145   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1146     MPPassManager *MP = getContainedManager(Index);
1147     Changed |= MP->runOnModule(M);
1148   }
1149   return Changed;
1150 }
1151
1152 //===----------------------------------------------------------------------===//
1153 // PassManager implementation
1154
1155 /// Create new pass manager
1156 PassManager::PassManager() {
1157   PM = new PassManagerImpl(0);
1158   // PM is the top level manager
1159   PM->setTopLevelManager(PM);
1160 }
1161
1162 PassManager::~PassManager() {
1163   delete PM;
1164 }
1165
1166 /// add - Add a pass to the queue of passes to run.  This passes ownership of
1167 /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
1168 /// will be destroyed as well, so there is no need to delete the pass.  This
1169 /// implies that all passes MUST be allocated with 'new'.
1170 void
1171 PassManager::add(Pass *P) {
1172   PM->add(P);
1173 }
1174
1175 /// run - Execute all of the passes scheduled for execution.  Keep track of
1176 /// whether any of the passes modifies the module, and if so, return true.
1177 bool
1178 PassManager::run(Module &M) {
1179   return PM->run(M);
1180 }
1181
1182 //===----------------------------------------------------------------------===//
1183 // TimingInfo Class - This class is used to calculate information about the
1184 // amount of time each pass takes to execute.  This only happens with
1185 // -time-passes is enabled on the command line.
1186 //
1187 bool llvm::TimePassesIsEnabled = false;
1188 static cl::opt<bool,true>
1189 EnableTiming("time-passes", cl::location(TimePassesIsEnabled),
1190             cl::desc("Time each pass, printing elapsed time for each on exit"));
1191
1192 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
1193 // a non null value (if the -time-passes option is enabled) or it leaves it
1194 // null.  It may be called multiple times.
1195 void TimingInfo::createTheTimeInfo() {
1196   if (!TimePassesIsEnabled || TheTimeInfo) return;
1197
1198   // Constructed the first time this is called, iff -time-passes is enabled.
1199   // This guarantees that the object will be constructed before static globals,
1200   // thus it will be destroyed before them.
1201   static ManagedStatic<TimingInfo> TTI;
1202   TheTimeInfo = &*TTI;
1203 }
1204
1205 /// If TimingInfo is enabled then start pass timer.
1206 void StartPassTimer(Pass *P) {
1207   if (TheTimeInfo)
1208     TheTimeInfo->passStarted(P);
1209 }
1210
1211 /// If TimingInfo is enabled then stop pass timer.
1212 void StopPassTimer(Pass *P) {
1213   if (TheTimeInfo)
1214     TheTimeInfo->passEnded(P);
1215 }
1216
1217 //===----------------------------------------------------------------------===//
1218 // PMStack implementation
1219 //
1220
1221 // Pop Pass Manager from the stack and clear its analysis info.
1222 void PMStack::pop() {
1223
1224   PMDataManager *Top = this->top();
1225   Top->initializeAnalysisInfo();
1226
1227   S.pop_back();
1228 }
1229
1230 // Push PM on the stack and set its top level manager.
1231 void PMStack::push(Pass *P) {
1232
1233   PMDataManager *Top = NULL;
1234   PMDataManager *PM = dynamic_cast<PMDataManager *>(P);
1235   assert (PM && "Unable to push. Pass Manager expected");
1236
1237   if (this->empty()) {
1238     Top = PM;
1239   }
1240   else {
1241     Top = this->top();
1242     PMTopLevelManager *TPM = Top->getTopLevelManager();
1243
1244     assert (TPM && "Unable to find top level manager");
1245     TPM->addIndirectPassManager(PM);
1246     PM->setTopLevelManager(TPM);
1247   }
1248
1249   AnalysisResolver *AR = new AnalysisResolver(*Top);
1250   P->setResolver(AR);
1251
1252   S.push_back(PM);
1253 }
1254
1255 // Dump content of the pass manager stack.
1256 void PMStack::dump() {
1257   for(std::deque<PMDataManager *>::iterator I = S.begin(),
1258         E = S.end(); I != E; ++I) {
1259     Pass *P = dynamic_cast<Pass *>(*I);
1260     printf ("%s ", P->getPassName());
1261   }
1262   if (!S.empty())
1263     printf ("\n");
1264 }
1265
1266 /// Find appropriate Module Pass Manager in the PM Stack and
1267 /// add self into that manager.
1268 void ModulePass::assignPassManager(PMStack &PMS,
1269                                    PassManagerType PreferredType) {
1270
1271   // Find Module Pass Manager
1272   while(!PMS.empty()) {
1273     PassManagerType TopPMType = PMS.top()->getPassManagerType();
1274     if (TopPMType == PreferredType)
1275       break; // We found desired pass manager
1276     else if (TopPMType > PMT_ModulePassManager)
1277       PMS.pop();    // Pop children pass managers
1278     else
1279       break;
1280   }
1281
1282   PMS.top()->add(this);
1283 }
1284
1285 /// Find appropriate Function Pass Manager or Call Graph Pass Manager
1286 /// in the PM Stack and add self into that manager.
1287 void FunctionPass::assignPassManager(PMStack &PMS,
1288                                      PassManagerType PreferredType) {
1289
1290   // Find Module Pass Manager (TODO : Or Call Graph Pass Manager)
1291   while(!PMS.empty()) {
1292     if (PMS.top()->getPassManagerType() > PMT_FunctionPassManager)
1293       PMS.pop();
1294     else
1295       break;
1296   }
1297   FPPassManager *FPP = dynamic_cast<FPPassManager *>(PMS.top());
1298
1299   // Create new Function Pass Manager
1300   if (!FPP) {
1301     assert(!PMS.empty() && "Unable to create Function Pass Manager");
1302     PMDataManager *PMD = PMS.top();
1303
1304     // [1] Create new Function Pass Manager
1305     FPP = new FPPassManager(PMD->getDepth() + 1);
1306
1307     // [2] Set up new manager's top level manager
1308     PMTopLevelManager *TPM = PMD->getTopLevelManager();
1309     TPM->addIndirectPassManager(FPP);
1310
1311     // [3] Assign manager to manage this new manager. This may create
1312     // and push new managers into PMS
1313     Pass *P = dynamic_cast<Pass *>(FPP);
1314
1315     // If Call Graph Pass Manager is active then use it to manage
1316     // this new Function Pass manager.
1317     if (PMD->getPassManagerType() == PMT_CallGraphPassManager)
1318       P->assignPassManager(PMS, PMT_CallGraphPassManager);
1319     else
1320       P->assignPassManager(PMS);
1321
1322     // [4] Push new manager into PMS
1323     PMS.push(FPP);
1324   }
1325
1326   // Assign FPP as the manager of this pass.
1327   FPP->add(this);
1328 }
1329
1330 /// Find appropriate Basic Pass Manager or Call Graph Pass Manager
1331 /// in the PM Stack and add self into that manager.
1332 void BasicBlockPass::assignPassManager(PMStack &PMS,
1333                                        PassManagerType PreferredType) {
1334
1335   BBPassManager *BBP = NULL;
1336
1337   // Basic Pass Manager is a leaf pass manager. It does not handle
1338   // any other pass manager.
1339   if (!PMS.empty()) {
1340     BBP = dynamic_cast<BBPassManager *>(PMS.top());
1341   }
1342
1343   // If leaf manager is not Basic Block Pass manager then create new
1344   // basic Block Pass manager.
1345
1346   if (!BBP) {
1347     assert(!PMS.empty() && "Unable to create BasicBlock Pass Manager");
1348     PMDataManager *PMD = PMS.top();
1349
1350     // [1] Create new Basic Block Manager
1351     BBP = new BBPassManager(PMD->getDepth() + 1);
1352
1353     // [2] Set up new manager's top level manager
1354     // Basic Block Pass Manager does not live by itself
1355     PMTopLevelManager *TPM = PMD->getTopLevelManager();
1356     TPM->addIndirectPassManager(BBP);
1357
1358     // [3] Assign manager to manage this new manager. This may create
1359     // and push new managers into PMS
1360     Pass *P = dynamic_cast<Pass *>(BBP);
1361     P->assignPassManager(PMS);
1362
1363     // [4] Push new manager into PMS
1364     PMS.push(BBP);
1365   }
1366
1367   // Assign BBP as the manager of this pass.
1368   BBP->add(this);
1369 }
1370
1371