Cache size of PassVector to speed up getNumContainedPasses().
[oota-llvm.git] / lib / VMCore / PassManager.cpp
1 //===- PassManager.cpp - LLVM Pass Infrastructure Implementation ----------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements the LLVM Pass Manager infrastructure.
11 //
12 //===----------------------------------------------------------------------===//
13
14
15 #include "llvm/PassManagers.h"
16 #include "llvm/PassManager.h"
17 #include "llvm/Assembly/PrintModulePass.h"
18 #include "llvm/Assembly/Writer.h"
19 #include "llvm/Support/CommandLine.h"
20 #include "llvm/Support/Debug.h"
21 #include "llvm/Support/Timer.h"
22 #include "llvm/Module.h"
23 #include "llvm/Support/ErrorHandling.h"
24 #include "llvm/Support/ManagedStatic.h"
25 #include "llvm/Support/PassNameParser.h"
26 #include "llvm/Support/raw_ostream.h"
27 #include "llvm/Support/Mutex.h"
28 #include <algorithm>
29 #include <map>
30 using namespace llvm;
31
32 // See PassManagers.h for Pass Manager infrastructure overview.
33
34 namespace llvm {
35
36 //===----------------------------------------------------------------------===//
37 // Pass debugging information.  Often it is useful to find out what pass is
38 // running when a crash occurs in a utility.  When this library is compiled with
39 // debugging on, a command line option (--debug-pass) is enabled that causes the
40 // pass name to be printed before it executes.
41 //
42
43 // Different debug levels that can be enabled...
44 enum PassDebugLevel {
45   None, Arguments, Structure, Executions, Details
46 };
47
48 static cl::opt<enum PassDebugLevel>
49 PassDebugging("debug-pass", cl::Hidden,
50                   cl::desc("Print PassManager debugging information"),
51                   cl::values(
52   clEnumVal(None      , "disable debug output"),
53   clEnumVal(Arguments , "print pass arguments to pass to 'opt'"),
54   clEnumVal(Structure , "print pass structure before run()"),
55   clEnumVal(Executions, "print pass name before it is executed"),
56   clEnumVal(Details   , "print pass details when it is executed"),
57                              clEnumValEnd));
58
59 typedef llvm::cl::list<const llvm::PassInfo *, bool, PassNameParser>
60 PassOptionList;
61
62 // Print IR out before/after specified passes.
63 static PassOptionList
64 PrintBefore("print-before",
65             llvm::cl::desc("Print IR before specified passes"),
66             cl::Hidden);
67
68 static PassOptionList
69 PrintAfter("print-after",
70            llvm::cl::desc("Print IR after specified passes"),
71            cl::Hidden);
72
73 static cl::opt<bool>
74 PrintBeforeAll("print-before-all",
75                llvm::cl::desc("Print IR before each pass"),
76                cl::init(false));
77 static cl::opt<bool>
78 PrintAfterAll("print-after-all",
79               llvm::cl::desc("Print IR after each pass"),
80               cl::init(false));
81
82 /// This is a helper to determine whether to print IR before or
83 /// after a pass.
84
85 static bool ShouldPrintBeforeOrAfterPass(const PassInfo *PI,
86                                          PassOptionList &PassesToPrint) {
87   for (unsigned i = 0, ie = PassesToPrint.size(); i < ie; ++i) {
88     const llvm::PassInfo *PassInf = PassesToPrint[i];
89     if (PassInf)
90       if (PassInf->getPassArgument() == PI->getPassArgument()) {
91         return true;
92       }
93   }
94   return false;
95 }
96
97 /// This is a utility to check whether a pass should have IR dumped
98 /// before it.
99 static bool ShouldPrintBeforePass(const PassInfo *PI) {
100   return PrintBeforeAll || ShouldPrintBeforeOrAfterPass(PI, PrintBefore);
101 }
102
103 /// This is a utility to check whether a pass should have IR dumped
104 /// after it.
105 static bool ShouldPrintAfterPass(const PassInfo *PI) {
106   return PrintAfterAll || ShouldPrintBeforeOrAfterPass(PI, PrintAfter);
107 }
108
109 } // End of llvm namespace
110
111 /// isPassDebuggingExecutionsOrMore - Return true if -debug-pass=Executions
112 /// or higher is specified.
113 bool PMDataManager::isPassDebuggingExecutionsOrMore() const {
114   return PassDebugging >= Executions;
115 }
116
117
118
119
120 void PassManagerPrettyStackEntry::print(raw_ostream &OS) const {
121   if (V == 0 && M == 0)
122     OS << "Releasing pass '";
123   else
124     OS << "Running pass '";
125
126   OS << P->getPassName() << "'";
127
128   if (M) {
129     OS << " on module '" << M->getModuleIdentifier() << "'.\n";
130     return;
131   }
132   if (V == 0) {
133     OS << '\n';
134     return;
135   }
136
137   OS << " on ";
138   if (isa<Function>(V))
139     OS << "function";
140   else if (isa<BasicBlock>(V))
141     OS << "basic block";
142   else
143     OS << "value";
144
145   OS << " '";
146   WriteAsOperand(OS, V, /*PrintTy=*/false, M);
147   OS << "'\n";
148 }
149
150
151 namespace {
152
153 //===----------------------------------------------------------------------===//
154 // BBPassManager
155 //
156 /// BBPassManager manages BasicBlockPass. It batches all the
157 /// pass together and sequence them to process one basic block before
158 /// processing next basic block.
159 class BBPassManager : public PMDataManager, public FunctionPass {
160
161 public:
162   static char ID;
163   explicit BBPassManager()
164     : PMDataManager(), FunctionPass(ID) {}
165
166   /// Execute all of the passes scheduled for execution.  Keep track of
167   /// whether any of the passes modifies the function, and if so, return true.
168   bool runOnFunction(Function &F);
169
170   /// Pass Manager itself does not invalidate any analysis info.
171   void getAnalysisUsage(AnalysisUsage &Info) const {
172     Info.setPreservesAll();
173   }
174
175   bool doInitialization(Module &M);
176   bool doInitialization(Function &F);
177   bool doFinalization(Module &M);
178   bool doFinalization(Function &F);
179
180   virtual PMDataManager *getAsPMDataManager() { return this; }
181   virtual Pass *getAsPass() { return this; }
182
183   virtual const char *getPassName() const {
184     return "BasicBlock Pass Manager";
185   }
186
187   // Print passes managed by this manager
188   void dumpPassStructure(unsigned Offset) {
189     llvm::dbgs().indent(Offset*2) << "BasicBlockPass Manager\n";
190     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
191       BasicBlockPass *BP = getContainedPass(Index);
192       BP->dumpPassStructure(Offset + 1);
193       dumpLastUses(BP, Offset+1);
194     }
195   }
196
197   BasicBlockPass *getContainedPass(unsigned N) {
198     assert(N < PassVectorSize && "Pass number out of range!");
199     BasicBlockPass *BP = static_cast<BasicBlockPass *>(PassVector[N]);
200     return BP;
201   }
202
203   virtual PassManagerType getPassManagerType() const {
204     return PMT_BasicBlockPassManager;
205   }
206 };
207
208 char BBPassManager::ID = 0;
209 }
210
211 namespace llvm {
212
213 //===----------------------------------------------------------------------===//
214 // FunctionPassManagerImpl
215 //
216 /// FunctionPassManagerImpl manages FPPassManagers
217 class FunctionPassManagerImpl : public Pass,
218                                 public PMDataManager,
219                                 public PMTopLevelManager {
220   virtual void anchor();
221 private:
222   bool wasRun;
223 public:
224   static char ID;
225   explicit FunctionPassManagerImpl() :
226     Pass(PT_PassManager, ID), PMDataManager(),
227     PMTopLevelManager(new FPPassManager()), wasRun(false) {}
228
229   /// add - Add a pass to the queue of passes to run.  This passes ownership of
230   /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
231   /// will be destroyed as well, so there is no need to delete the pass.  This
232   /// implies that all passes MUST be allocated with 'new'.
233   void add(Pass *P) {
234     schedulePass(P);
235   }
236
237   /// createPrinterPass - Get a function printer pass.
238   Pass *createPrinterPass(raw_ostream &O, const std::string &Banner) const {
239     return createPrintFunctionPass(Banner, &O);
240   }
241
242   // Prepare for running an on the fly pass, freeing memory if needed
243   // from a previous run.
244   void releaseMemoryOnTheFly();
245
246   /// run - Execute all of the passes scheduled for execution.  Keep track of
247   /// whether any of the passes modifies the module, and if so, return true.
248   bool run(Function &F);
249
250   /// doInitialization - Run all of the initializers for the function passes.
251   ///
252   bool doInitialization(Module &M);
253
254   /// doFinalization - Run all of the finalizers for the function passes.
255   ///
256   bool doFinalization(Module &M);
257
258
259   virtual PMDataManager *getAsPMDataManager() { return this; }
260   virtual Pass *getAsPass() { return this; }
261   virtual PassManagerType getTopLevelPassManagerType() {
262     return PMT_FunctionPassManager;
263   }
264
265   /// Pass Manager itself does not invalidate any analysis info.
266   void getAnalysisUsage(AnalysisUsage &Info) const {
267     Info.setPreservesAll();
268   }
269
270   FPPassManager *getContainedManager(unsigned N) {
271     assert(N < PassManagers.size() && "Pass number out of range!");
272     FPPassManager *FP = static_cast<FPPassManager *>(PassManagers[N]);
273     return FP;
274   }
275 };
276
277 void FunctionPassManagerImpl::anchor() {}
278
279 char FunctionPassManagerImpl::ID = 0;
280
281 //===----------------------------------------------------------------------===//
282 // MPPassManager
283 //
284 /// MPPassManager manages ModulePasses and function pass managers.
285 /// It batches all Module passes and function pass managers together and
286 /// sequences them to process one module.
287 class MPPassManager : public Pass, public PMDataManager {
288 public:
289   static char ID;
290   explicit MPPassManager() :
291     Pass(PT_PassManager, ID), PMDataManager() { }
292
293   // Delete on the fly managers.
294   virtual ~MPPassManager() {
295     for (std::map<Pass *, FunctionPassManagerImpl *>::iterator
296            I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end();
297          I != E; ++I) {
298       FunctionPassManagerImpl *FPP = I->second;
299       delete FPP;
300     }
301   }
302
303   /// createPrinterPass - Get a module printer pass.
304   Pass *createPrinterPass(raw_ostream &O, const std::string &Banner) const {
305     return createPrintModulePass(&O, false, Banner);
306   }
307
308   /// run - Execute all of the passes scheduled for execution.  Keep track of
309   /// whether any of the passes modifies the module, and if so, return true.
310   bool runOnModule(Module &M);
311
312   /// Pass Manager itself does not invalidate any analysis info.
313   void getAnalysisUsage(AnalysisUsage &Info) const {
314     Info.setPreservesAll();
315   }
316
317   /// Add RequiredPass into list of lower level passes required by pass P.
318   /// RequiredPass is run on the fly by Pass Manager when P requests it
319   /// through getAnalysis interface.
320   virtual void addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass);
321
322   /// Return function pass corresponding to PassInfo PI, that is
323   /// required by module pass MP. Instantiate analysis pass, by using
324   /// its runOnFunction() for function F.
325   virtual Pass* getOnTheFlyPass(Pass *MP, AnalysisID PI, Function &F);
326
327   virtual const char *getPassName() const {
328     return "Module Pass Manager";
329   }
330
331   virtual PMDataManager *getAsPMDataManager() { return this; }
332   virtual Pass *getAsPass() { return this; }
333
334   // Print passes managed by this manager
335   void dumpPassStructure(unsigned Offset) {
336     llvm::dbgs().indent(Offset*2) << "ModulePass Manager\n";
337     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
338       ModulePass *MP = getContainedPass(Index);
339       MP->dumpPassStructure(Offset + 1);
340       std::map<Pass *, FunctionPassManagerImpl *>::const_iterator I =
341         OnTheFlyManagers.find(MP);
342       if (I != OnTheFlyManagers.end())
343         I->second->dumpPassStructure(Offset + 2);
344       dumpLastUses(MP, Offset+1);
345     }
346   }
347
348   ModulePass *getContainedPass(unsigned N) {
349     assert(N < PassVectorSize && "Pass number out of range!");
350     return static_cast<ModulePass *>(PassVector[N]);
351   }
352
353   virtual PassManagerType getPassManagerType() const {
354     return PMT_ModulePassManager;
355   }
356
357  private:
358   /// Collection of on the fly FPPassManagers. These managers manage
359   /// function passes that are required by module passes.
360   std::map<Pass *, FunctionPassManagerImpl *> OnTheFlyManagers;
361 };
362
363 char MPPassManager::ID = 0;
364 //===----------------------------------------------------------------------===//
365 // PassManagerImpl
366 //
367
368 /// PassManagerImpl manages MPPassManagers
369 class PassManagerImpl : public Pass,
370                         public PMDataManager,
371                         public PMTopLevelManager {
372   virtual void anchor();
373
374 public:
375   static char ID;
376   explicit PassManagerImpl() :
377     Pass(PT_PassManager, ID), PMDataManager(),
378                               PMTopLevelManager(new MPPassManager()) {}
379
380   /// add - Add a pass to the queue of passes to run.  This passes ownership of
381   /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
382   /// will be destroyed as well, so there is no need to delete the pass.  This
383   /// implies that all passes MUST be allocated with 'new'.
384   void add(Pass *P) {
385     schedulePass(P);
386   }
387
388   /// createPrinterPass - Get a module printer pass.
389   Pass *createPrinterPass(raw_ostream &O, const std::string &Banner) const {
390     return createPrintModulePass(&O, false, Banner);
391   }
392
393   /// run - Execute all of the passes scheduled for execution.  Keep track of
394   /// whether any of the passes modifies the module, and if so, return true.
395   bool run(Module &M);
396
397   /// Pass Manager itself does not invalidate any analysis info.
398   void getAnalysisUsage(AnalysisUsage &Info) const {
399     Info.setPreservesAll();
400   }
401
402   virtual PMDataManager *getAsPMDataManager() { return this; }
403   virtual Pass *getAsPass() { return this; }
404   virtual PassManagerType getTopLevelPassManagerType() {
405     return PMT_ModulePassManager;
406   }
407
408   MPPassManager *getContainedManager(unsigned N) {
409     assert(N < PassManagers.size() && "Pass number out of range!");
410     MPPassManager *MP = static_cast<MPPassManager *>(PassManagers[N]);
411     return MP;
412   }
413 };
414
415 void PassManagerImpl::anchor() {}
416
417 char PassManagerImpl::ID = 0;
418 } // End of llvm namespace
419
420 namespace {
421
422 //===----------------------------------------------------------------------===//
423 /// TimingInfo Class - This class is used to calculate information about the
424 /// amount of time each pass takes to execute.  This only happens when
425 /// -time-passes is enabled on the command line.
426 ///
427
428 static ManagedStatic<sys::SmartMutex<true> > TimingInfoMutex;
429
430 class TimingInfo {
431   DenseMap<Pass*, Timer*> TimingData;
432   TimerGroup TG;
433 public:
434   // Use 'create' member to get this.
435   TimingInfo() : TG("... Pass execution timing report ...") {}
436
437   // TimingDtor - Print out information about timing information
438   ~TimingInfo() {
439     // Delete all of the timers, which accumulate their info into the
440     // TimerGroup.
441     for (DenseMap<Pass*, Timer*>::iterator I = TimingData.begin(),
442          E = TimingData.end(); I != E; ++I)
443       delete I->second;
444     // TimerGroup is deleted next, printing the report.
445   }
446
447   // createTheTimeInfo - This method either initializes the TheTimeInfo pointer
448   // to a non null value (if the -time-passes option is enabled) or it leaves it
449   // null.  It may be called multiple times.
450   static void createTheTimeInfo();
451
452   /// getPassTimer - Return the timer for the specified pass if it exists.
453   Timer *getPassTimer(Pass *P) {
454     if (P->getAsPMDataManager())
455       return 0;
456
457     sys::SmartScopedLock<true> Lock(*TimingInfoMutex);
458     Timer *&T = TimingData[P];
459     if (T == 0)
460       T = new Timer(P->getPassName(), TG);
461     return T;
462   }
463 };
464
465 } // End of anon namespace
466
467 static TimingInfo *TheTimeInfo;
468
469 //===----------------------------------------------------------------------===//
470 // PMTopLevelManager implementation
471
472 /// Initialize top level manager. Create first pass manager.
473 PMTopLevelManager::PMTopLevelManager(PMDataManager *PMDM) {
474   PMDM->setTopLevelManager(this);
475   addPassManager(PMDM);
476   activeStack.push(PMDM);
477 }
478
479 /// Set pass P as the last user of the given analysis passes.
480 void
481 PMTopLevelManager::setLastUser(ArrayRef<Pass*> AnalysisPasses, Pass *P) {
482   unsigned PDepth = 0;
483   if (P->getResolver())
484     PDepth = P->getResolver()->getPMDataManager().getDepth();
485
486   for (SmallVectorImpl<Pass *>::const_iterator I = AnalysisPasses.begin(),
487          E = AnalysisPasses.end(); I != E; ++I) {
488     Pass *AP = *I;
489     LastUser[AP] = P;
490
491     if (P == AP)
492       continue;
493
494     // Update the last users of passes that are required transitive by AP.
495     AnalysisUsage *AnUsage = findAnalysisUsage(AP);
496     const AnalysisUsage::VectorType &IDs = AnUsage->getRequiredTransitiveSet();
497     SmallVector<Pass *, 12> LastUses;
498     SmallVector<Pass *, 12> LastPMUses;
499     for (AnalysisUsage::VectorType::const_iterator I = IDs.begin(),
500          E = IDs.end(); I != E; ++I) {
501       Pass *AnalysisPass = findAnalysisPass(*I);
502       assert(AnalysisPass && "Expected analysis pass to exist.");
503       AnalysisResolver *AR = AnalysisPass->getResolver();
504       assert(AR && "Expected analysis resolver to exist.");
505       unsigned APDepth = AR->getPMDataManager().getDepth();
506
507       if (PDepth == APDepth)
508         LastUses.push_back(AnalysisPass);
509       else if (PDepth > APDepth)
510         LastPMUses.push_back(AnalysisPass);
511     }
512
513     setLastUser(LastUses, P);
514
515     // If this pass has a corresponding pass manager, push higher level
516     // analysis to this pass manager.
517     if (P->getResolver())
518       setLastUser(LastPMUses, P->getResolver()->getPMDataManager().getAsPass());
519
520
521     // If AP is the last user of other passes then make P last user of
522     // such passes.
523     for (DenseMap<Pass *, Pass *>::iterator LUI = LastUser.begin(),
524            LUE = LastUser.end(); LUI != LUE; ++LUI) {
525       if (LUI->second == AP)
526         // DenseMap iterator is not invalidated here because
527         // this is just updating existing entries.
528         LastUser[LUI->first] = P;
529     }
530   }
531 }
532
533 /// Collect passes whose last user is P
534 void PMTopLevelManager::collectLastUses(SmallVectorImpl<Pass *> &LastUses,
535                                         Pass *P) {
536   DenseMap<Pass *, SmallPtrSet<Pass *, 8> >::iterator DMI =
537     InversedLastUser.find(P);
538   if (DMI == InversedLastUser.end())
539     return;
540
541   SmallPtrSet<Pass *, 8> &LU = DMI->second;
542   for (SmallPtrSet<Pass *, 8>::iterator I = LU.begin(),
543          E = LU.end(); I != E; ++I) {
544     LastUses.push_back(*I);
545   }
546
547 }
548
549 AnalysisUsage *PMTopLevelManager::findAnalysisUsage(Pass *P) {
550   AnalysisUsage *AnUsage = NULL;
551   DenseMap<Pass *, AnalysisUsage *>::iterator DMI = AnUsageMap.find(P);
552   if (DMI != AnUsageMap.end())
553     AnUsage = DMI->second;
554   else {
555     AnUsage = new AnalysisUsage();
556     P->getAnalysisUsage(*AnUsage);
557     AnUsageMap[P] = AnUsage;
558   }
559   return AnUsage;
560 }
561
562 /// Schedule pass P for execution. Make sure that passes required by
563 /// P are run before P is run. Update analysis info maintained by
564 /// the manager. Remove dead passes. This is a recursive function.
565 void PMTopLevelManager::schedulePass(Pass *P) {
566
567   // TODO : Allocate function manager for this pass, other wise required set
568   // may be inserted into previous function manager
569
570   // Give pass a chance to prepare the stage.
571   P->preparePassManager(activeStack);
572
573   // If P is an analysis pass and it is available then do not
574   // generate the analysis again. Stale analysis info should not be
575   // available at this point.
576   const PassInfo *PI =
577     PassRegistry::getPassRegistry()->getPassInfo(P->getPassID());
578   if (PI && PI->isAnalysis() && findAnalysisPass(P->getPassID())) {
579     delete P;
580     return;
581   }
582
583   AnalysisUsage *AnUsage = findAnalysisUsage(P);
584
585   bool checkAnalysis = true;
586   while (checkAnalysis) {
587     checkAnalysis = false;
588
589     const AnalysisUsage::VectorType &RequiredSet = AnUsage->getRequiredSet();
590     for (AnalysisUsage::VectorType::const_iterator I = RequiredSet.begin(),
591            E = RequiredSet.end(); I != E; ++I) {
592
593       Pass *AnalysisPass = findAnalysisPass(*I);
594       if (!AnalysisPass) {
595         const PassInfo *PI = PassRegistry::getPassRegistry()->getPassInfo(*I);
596
597         if (PI == NULL) {
598           // Pass P is not in the global PassRegistry
599           dbgs() << "Pass '"  << P->getPassName() << "' is not initialized." << "\n";
600           dbgs() << "Verify if there is a pass dependency cycle." << "\n";
601           dbgs() << "Required Passes:" << "\n";
602           for (AnalysisUsage::VectorType::const_iterator I2 = RequiredSet.begin(),
603                  E = RequiredSet.end(); I2 != E && I2 != I; ++I2) {
604             Pass *AnalysisPass2 = findAnalysisPass(*I2);
605             if (AnalysisPass2) {
606               dbgs() << "\t" << AnalysisPass2->getPassName() << "\n";
607             }
608             else {
609               dbgs() << "\t"   << "Error: Required pass not found! Possible causes:"  << "\n";
610               dbgs() << "\t\t" << "- Pass misconfiguration (e.g.: missing macros)"    << "\n";
611               dbgs() << "\t\t" << "- Corruption of the global PassRegistry"           << "\n";
612             }
613           }
614         }
615
616         assert(PI && "Expected required passes to be initialized");
617         AnalysisPass = PI->createPass();
618         if (P->getPotentialPassManagerType () ==
619             AnalysisPass->getPotentialPassManagerType())
620           // Schedule analysis pass that is managed by the same pass manager.
621           schedulePass(AnalysisPass);
622         else if (P->getPotentialPassManagerType () >
623                  AnalysisPass->getPotentialPassManagerType()) {
624           // Schedule analysis pass that is managed by a new manager.
625           schedulePass(AnalysisPass);
626           // Recheck analysis passes to ensure that required analyses that
627           // are already checked are still available.
628           checkAnalysis = true;
629         }
630         else
631           // Do not schedule this analysis. Lower level analsyis
632           // passes are run on the fly.
633           delete AnalysisPass;
634       }
635     }
636   }
637
638   // Now all required passes are available.
639   if (ImmutablePass *IP = P->getAsImmutablePass()) {
640     // P is a immutable pass and it will be managed by this
641     // top level manager. Set up analysis resolver to connect them.
642     PMDataManager *DM = getAsPMDataManager();
643     AnalysisResolver *AR = new AnalysisResolver(*DM);
644     P->setResolver(AR);
645     DM->initializeAnalysisImpl(P);
646     addImmutablePass(IP);
647     DM->recordAvailableAnalysis(IP);
648     return;
649   }
650
651   if (PI && !PI->isAnalysis() && ShouldPrintBeforePass(PI)) {
652     Pass *PP = P->createPrinterPass(
653       dbgs(), std::string("*** IR Dump Before ") + P->getPassName() + " ***");
654     PP->assignPassManager(activeStack, getTopLevelPassManagerType());
655   }
656
657   // Add the requested pass to the best available pass manager.
658   P->assignPassManager(activeStack, getTopLevelPassManagerType());
659
660   if (PI && !PI->isAnalysis() && ShouldPrintAfterPass(PI)) {
661     Pass *PP = P->createPrinterPass(
662       dbgs(), std::string("*** IR Dump After ") + P->getPassName() + " ***");
663     PP->assignPassManager(activeStack, getTopLevelPassManagerType());
664   }
665 }
666
667 /// Find the pass that implements Analysis AID. Search immutable
668 /// passes and all pass managers. If desired pass is not found
669 /// then return NULL.
670 Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
671
672   // Check pass managers
673   for (SmallVectorImpl<PMDataManager *>::iterator I = PassManagers.begin(),
674          E = PassManagers.end(); I != E; ++I)
675     if (Pass *P = (*I)->findAnalysisPass(AID, false))
676       return P;
677
678   // Check other pass managers
679   for (SmallVectorImpl<PMDataManager *>::iterator
680          I = IndirectPassManagers.begin(),
681          E = IndirectPassManagers.end(); I != E; ++I)
682     if (Pass *P = (*I)->findAnalysisPass(AID, false))
683       return P;
684
685   // Check the immutable passes. Iterate in reverse order so that we find
686   // the most recently registered passes first.
687   for (SmallVector<ImmutablePass *, 8>::reverse_iterator I =
688        ImmutablePasses.rbegin(), E = ImmutablePasses.rend(); I != E; ++I) {
689     AnalysisID PI = (*I)->getPassID();
690     if (PI == AID)
691       return *I;
692
693     // If Pass not found then check the interfaces implemented by Immutable Pass
694     const PassInfo *PassInf =
695       PassRegistry::getPassRegistry()->getPassInfo(PI);
696     assert(PassInf && "Expected all immutable passes to be initialized");
697     const std::vector<const PassInfo*> &ImmPI =
698       PassInf->getInterfacesImplemented();
699     for (std::vector<const PassInfo*>::const_iterator II = ImmPI.begin(),
700          EE = ImmPI.end(); II != EE; ++II) {
701       if ((*II)->getTypeInfo() == AID)
702         return *I;
703     }
704   }
705
706   return 0;
707 }
708
709 // Print passes managed by this top level manager.
710 void PMTopLevelManager::dumpPasses() const {
711
712   if (PassDebugging < Structure)
713     return;
714
715   // Print out the immutable passes
716   for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
717     ImmutablePasses[i]->dumpPassStructure(0);
718   }
719
720   // Every class that derives from PMDataManager also derives from Pass
721   // (sometimes indirectly), but there's no inheritance relationship
722   // between PMDataManager and Pass, so we have to getAsPass to get
723   // from a PMDataManager* to a Pass*.
724   for (SmallVector<PMDataManager *, 8>::const_iterator I = PassManagers.begin(),
725          E = PassManagers.end(); I != E; ++I)
726     (*I)->getAsPass()->dumpPassStructure(1);
727 }
728
729 void PMTopLevelManager::dumpArguments() const {
730
731   if (PassDebugging < Arguments)
732     return;
733
734   dbgs() << "Pass Arguments: ";
735   for (SmallVector<ImmutablePass *, 8>::const_iterator I =
736        ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
737     if (const PassInfo *PI =
738         PassRegistry::getPassRegistry()->getPassInfo((*I)->getPassID())) {
739       assert(PI && "Expected all immutable passes to be initialized");
740       if (!PI->isAnalysisGroup())
741         dbgs() << " -" << PI->getPassArgument();
742     }
743   for (SmallVector<PMDataManager *, 8>::const_iterator I = PassManagers.begin(),
744          E = PassManagers.end(); I != E; ++I)
745     (*I)->dumpPassArguments();
746   dbgs() << "\n";
747 }
748
749 void PMTopLevelManager::initializeAllAnalysisInfo() {
750   for (SmallVectorImpl<PMDataManager *>::iterator I = PassManagers.begin(),
751          E = PassManagers.end(); I != E; ++I)
752     (*I)->initializeAnalysisInfo();
753
754   // Initailize other pass managers
755   for (SmallVectorImpl<PMDataManager *>::iterator
756        I = IndirectPassManagers.begin(), E = IndirectPassManagers.end();
757        I != E; ++I)
758     (*I)->initializeAnalysisInfo();
759
760   for (DenseMap<Pass *, Pass *>::iterator DMI = LastUser.begin(),
761         DME = LastUser.end(); DMI != DME; ++DMI) {
762     DenseMap<Pass *, SmallPtrSet<Pass *, 8> >::iterator InvDMI =
763       InversedLastUser.find(DMI->second);
764     if (InvDMI != InversedLastUser.end()) {
765       SmallPtrSet<Pass *, 8> &L = InvDMI->second;
766       L.insert(DMI->first);
767     } else {
768       SmallPtrSet<Pass *, 8> L; L.insert(DMI->first);
769       InversedLastUser[DMI->second] = L;
770     }
771   }
772 }
773
774 /// Destructor
775 PMTopLevelManager::~PMTopLevelManager() {
776   for (SmallVectorImpl<PMDataManager *>::iterator I = PassManagers.begin(),
777          E = PassManagers.end(); I != E; ++I)
778     delete *I;
779
780   for (SmallVectorImpl<ImmutablePass *>::iterator
781          I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
782     delete *I;
783
784   for (DenseMap<Pass *, AnalysisUsage *>::iterator DMI = AnUsageMap.begin(),
785          DME = AnUsageMap.end(); DMI != DME; ++DMI)
786     delete DMI->second;
787 }
788
789 //===----------------------------------------------------------------------===//
790 // PMDataManager implementation
791
792 /// Augement AvailableAnalysis by adding analysis made available by pass P.
793 void PMDataManager::recordAvailableAnalysis(Pass *P) {
794   AnalysisID PI = P->getPassID();
795
796   AvailableAnalysis[PI] = P;
797
798   assert(!AvailableAnalysis.empty());
799
800   // This pass is the current implementation of all of the interfaces it
801   // implements as well.
802   const PassInfo *PInf = PassRegistry::getPassRegistry()->getPassInfo(PI);
803   if (PInf == 0) return;
804   const std::vector<const PassInfo*> &II = PInf->getInterfacesImplemented();
805   for (unsigned i = 0, e = II.size(); i != e; ++i)
806     AvailableAnalysis[II[i]->getTypeInfo()] = P;
807 }
808
809 // Return true if P preserves high level analysis used by other
810 // passes managed by this manager
811 bool PMDataManager::preserveHigherLevelAnalysis(Pass *P) {
812   AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
813   if (AnUsage->getPreservesAll())
814     return true;
815
816   const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
817   for (SmallVectorImpl<Pass *>::iterator I = HigherLevelAnalysis.begin(),
818          E = HigherLevelAnalysis.end(); I  != E; ++I) {
819     Pass *P1 = *I;
820     if (P1->getAsImmutablePass() == 0 &&
821         std::find(PreservedSet.begin(), PreservedSet.end(),
822                   P1->getPassID()) ==
823            PreservedSet.end())
824       return false;
825   }
826
827   return true;
828 }
829
830 /// verifyPreservedAnalysis -- Verify analysis preserved by pass P.
831 void PMDataManager::verifyPreservedAnalysis(Pass *P) {
832   // Don't do this unless assertions are enabled.
833 #ifdef NDEBUG
834   return;
835 #endif
836   AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
837   const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
838
839   // Verify preserved analysis
840   for (AnalysisUsage::VectorType::const_iterator I = PreservedSet.begin(),
841          E = PreservedSet.end(); I != E; ++I) {
842     AnalysisID AID = *I;
843     if (Pass *AP = findAnalysisPass(AID, true)) {
844       TimeRegion PassTimer(getPassTimer(AP));
845       AP->verifyAnalysis();
846     }
847   }
848 }
849
850 /// Remove Analysis not preserved by Pass P
851 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
852   AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
853   if (AnUsage->getPreservesAll())
854     return;
855
856   const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
857   for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
858          E = AvailableAnalysis.end(); I != E; ) {
859     std::map<AnalysisID, Pass*>::iterator Info = I++;
860     if (Info->second->getAsImmutablePass() == 0 &&
861         std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
862         PreservedSet.end()) {
863       // Remove this analysis
864       if (PassDebugging >= Details) {
865         Pass *S = Info->second;
866         dbgs() << " -- '" <<  P->getPassName() << "' is not preserving '";
867         dbgs() << S->getPassName() << "'\n";
868       }
869       AvailableAnalysis.erase(Info);
870     }
871   }
872
873   // Check inherited analysis also. If P is not preserving analysis
874   // provided by parent manager then remove it here.
875   for (unsigned Index = 0; Index < PMT_Last; ++Index) {
876
877     if (!InheritedAnalysis[Index])
878       continue;
879
880     for (std::map<AnalysisID, Pass*>::iterator
881            I = InheritedAnalysis[Index]->begin(),
882            E = InheritedAnalysis[Index]->end(); I != E; ) {
883       std::map<AnalysisID, Pass *>::iterator Info = I++;
884       if (Info->second->getAsImmutablePass() == 0 &&
885           std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
886              PreservedSet.end()) {
887         // Remove this analysis
888         if (PassDebugging >= Details) {
889           Pass *S = Info->second;
890           dbgs() << " -- '" <<  P->getPassName() << "' is not preserving '";
891           dbgs() << S->getPassName() << "'\n";
892         }
893         InheritedAnalysis[Index]->erase(Info);
894       }
895     }
896   }
897 }
898
899 /// Remove analysis passes that are not used any longer
900 void PMDataManager::removeDeadPasses(Pass *P, StringRef Msg,
901                                      enum PassDebuggingString DBG_STR) {
902
903   SmallVector<Pass *, 12> DeadPasses;
904
905   // If this is a on the fly manager then it does not have TPM.
906   if (!TPM)
907     return;
908
909   TPM->collectLastUses(DeadPasses, P);
910
911   if (PassDebugging >= Details && !DeadPasses.empty()) {
912     dbgs() << " -*- '" <<  P->getPassName();
913     dbgs() << "' is the last user of following pass instances.";
914     dbgs() << " Free these instances\n";
915   }
916
917   for (SmallVectorImpl<Pass *>::iterator I = DeadPasses.begin(),
918          E = DeadPasses.end(); I != E; ++I)
919     freePass(*I, Msg, DBG_STR);
920 }
921
922 void PMDataManager::freePass(Pass *P, StringRef Msg,
923                              enum PassDebuggingString DBG_STR) {
924   dumpPassInfo(P, FREEING_MSG, DBG_STR, Msg);
925
926   {
927     // If the pass crashes releasing memory, remember this.
928     PassManagerPrettyStackEntry X(P);
929     TimeRegion PassTimer(getPassTimer(P));
930
931     P->releaseMemory();
932   }
933
934   AnalysisID PI = P->getPassID();
935   if (const PassInfo *PInf = PassRegistry::getPassRegistry()->getPassInfo(PI)) {
936     // Remove the pass itself (if it is not already removed).
937     AvailableAnalysis.erase(PI);
938
939     // Remove all interfaces this pass implements, for which it is also
940     // listed as the available implementation.
941     const std::vector<const PassInfo*> &II = PInf->getInterfacesImplemented();
942     for (unsigned i = 0, e = II.size(); i != e; ++i) {
943       std::map<AnalysisID, Pass*>::iterator Pos =
944         AvailableAnalysis.find(II[i]->getTypeInfo());
945       if (Pos != AvailableAnalysis.end() && Pos->second == P)
946         AvailableAnalysis.erase(Pos);
947     }
948   }
949 }
950
951 /// Add pass P into the PassVector. Update
952 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
953 void PMDataManager::add(Pass *P, bool ProcessAnalysis) {
954   // This manager is going to manage pass P. Set up analysis resolver
955   // to connect them.
956   AnalysisResolver *AR = new AnalysisResolver(*this);
957   P->setResolver(AR);
958
959   // If a FunctionPass F is the last user of ModulePass info M
960   // then the F's manager, not F, records itself as a last user of M.
961   SmallVector<Pass *, 12> TransferLastUses;
962
963   if (!ProcessAnalysis) {
964     // Add pass
965     PassVector.push_back(P);
966     ++PassVectorSize;
967     return;
968   }
969
970   // At the moment, this pass is the last user of all required passes.
971   SmallVector<Pass *, 12> LastUses;
972   SmallVector<Pass *, 8> RequiredPasses;
973   SmallVector<AnalysisID, 8> ReqAnalysisNotAvailable;
974
975   unsigned PDepth = this->getDepth();
976
977   collectRequiredAnalysis(RequiredPasses,
978                           ReqAnalysisNotAvailable, P);
979   for (SmallVectorImpl<Pass *>::iterator I = RequiredPasses.begin(),
980          E = RequiredPasses.end(); I != E; ++I) {
981     Pass *PRequired = *I;
982     unsigned RDepth = 0;
983
984     assert(PRequired->getResolver() && "Analysis Resolver is not set");
985     PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
986     RDepth = DM.getDepth();
987
988     if (PDepth == RDepth)
989       LastUses.push_back(PRequired);
990     else if (PDepth > RDepth) {
991       // Let the parent claim responsibility of last use
992       TransferLastUses.push_back(PRequired);
993       // Keep track of higher level analysis used by this manager.
994       HigherLevelAnalysis.push_back(PRequired);
995     } else
996       llvm_unreachable("Unable to accommodate Required Pass");
997   }
998
999   // Set P as P's last user until someone starts using P.
1000   // However, if P is a Pass Manager then it does not need
1001   // to record its last user.
1002   if (P->getAsPMDataManager() == 0)
1003     LastUses.push_back(P);
1004   TPM->setLastUser(LastUses, P);
1005
1006   if (!TransferLastUses.empty()) {
1007     Pass *My_PM = getAsPass();
1008     TPM->setLastUser(TransferLastUses, My_PM);
1009     TransferLastUses.clear();
1010   }
1011
1012   // Now, take care of required analyses that are not available.
1013   for (SmallVectorImpl<AnalysisID>::iterator
1014          I = ReqAnalysisNotAvailable.begin(),
1015          E = ReqAnalysisNotAvailable.end() ;I != E; ++I) {
1016     const PassInfo *PI = PassRegistry::getPassRegistry()->getPassInfo(*I);
1017     Pass *AnalysisPass = PI->createPass();
1018     this->addLowerLevelRequiredPass(P, AnalysisPass);
1019   }
1020
1021   // Take a note of analysis required and made available by this pass.
1022   // Remove the analysis not preserved by this pass
1023   removeNotPreservedAnalysis(P);
1024   recordAvailableAnalysis(P);
1025
1026   // Add pass
1027   PassVector.push_back(P);
1028   ++PassVectorSize;
1029 }
1030
1031
1032 /// Populate RP with analysis pass that are required by
1033 /// pass P and are available. Populate RP_NotAvail with analysis
1034 /// pass that are required by pass P but are not available.
1035 void PMDataManager::collectRequiredAnalysis(SmallVectorImpl<Pass *> &RP,
1036                                        SmallVectorImpl<AnalysisID> &RP_NotAvail,
1037                                             Pass *P) {
1038   AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
1039   const AnalysisUsage::VectorType &RequiredSet = AnUsage->getRequiredSet();
1040   for (AnalysisUsage::VectorType::const_iterator
1041          I = RequiredSet.begin(), E = RequiredSet.end(); I != E; ++I) {
1042     if (Pass *AnalysisPass = findAnalysisPass(*I, true))
1043       RP.push_back(AnalysisPass);
1044     else
1045       RP_NotAvail.push_back(*I);
1046   }
1047
1048   const AnalysisUsage::VectorType &IDs = AnUsage->getRequiredTransitiveSet();
1049   for (AnalysisUsage::VectorType::const_iterator I = IDs.begin(),
1050          E = IDs.end(); I != E; ++I) {
1051     if (Pass *AnalysisPass = findAnalysisPass(*I, true))
1052       RP.push_back(AnalysisPass);
1053     else
1054       RP_NotAvail.push_back(*I);
1055   }
1056 }
1057
1058 // All Required analyses should be available to the pass as it runs!  Here
1059 // we fill in the AnalysisImpls member of the pass so that it can
1060 // successfully use the getAnalysis() method to retrieve the
1061 // implementations it needs.
1062 //
1063 void PMDataManager::initializeAnalysisImpl(Pass *P) {
1064   AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
1065
1066   for (AnalysisUsage::VectorType::const_iterator
1067          I = AnUsage->getRequiredSet().begin(),
1068          E = AnUsage->getRequiredSet().end(); I != E; ++I) {
1069     Pass *Impl = findAnalysisPass(*I, true);
1070     if (Impl == 0)
1071       // This may be analysis pass that is initialized on the fly.
1072       // If that is not the case then it will raise an assert when it is used.
1073       continue;
1074     AnalysisResolver *AR = P->getResolver();
1075     assert(AR && "Analysis Resolver is not set");
1076     AR->addAnalysisImplsPair(*I, Impl);
1077   }
1078 }
1079
1080 /// Find the pass that implements Analysis AID. If desired pass is not found
1081 /// then return NULL.
1082 Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
1083
1084   // Check if AvailableAnalysis map has one entry.
1085   std::map<AnalysisID, Pass*>::const_iterator I =  AvailableAnalysis.find(AID);
1086
1087   if (I != AvailableAnalysis.end())
1088     return I->second;
1089
1090   // Search Parents through TopLevelManager
1091   if (SearchParent)
1092     return TPM->findAnalysisPass(AID);
1093
1094   return NULL;
1095 }
1096
1097 // Print list of passes that are last used by P.
1098 void PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{
1099
1100   SmallVector<Pass *, 12> LUses;
1101
1102   // If this is a on the fly manager then it does not have TPM.
1103   if (!TPM)
1104     return;
1105
1106   TPM->collectLastUses(LUses, P);
1107
1108   for (SmallVectorImpl<Pass *>::iterator I = LUses.begin(),
1109          E = LUses.end(); I != E; ++I) {
1110     llvm::dbgs() << "--" << std::string(Offset*2, ' ');
1111     (*I)->dumpPassStructure(0);
1112   }
1113 }
1114
1115 void PMDataManager::dumpPassArguments() const {
1116   for (SmallVectorImpl<Pass *>::const_iterator I = PassVector.begin(),
1117         E = PassVector.end(); I != E; ++I) {
1118     if (PMDataManager *PMD = (*I)->getAsPMDataManager())
1119       PMD->dumpPassArguments();
1120     else
1121       if (const PassInfo *PI =
1122             PassRegistry::getPassRegistry()->getPassInfo((*I)->getPassID()))
1123         if (!PI->isAnalysisGroup())
1124           dbgs() << " -" << PI->getPassArgument();
1125   }
1126 }
1127
1128 void PMDataManager::dumpPassInfo(Pass *P, enum PassDebuggingString S1,
1129                                  enum PassDebuggingString S2,
1130                                  StringRef Msg) {
1131   if (PassDebugging < Executions)
1132     return;
1133   dbgs() << (void*)this << std::string(getDepth()*2+1, ' ');
1134   switch (S1) {
1135   case EXECUTION_MSG:
1136     dbgs() << "Executing Pass '" << P->getPassName();
1137     break;
1138   case MODIFICATION_MSG:
1139     dbgs() << "Made Modification '" << P->getPassName();
1140     break;
1141   case FREEING_MSG:
1142     dbgs() << " Freeing Pass '" << P->getPassName();
1143     break;
1144   default:
1145     break;
1146   }
1147   switch (S2) {
1148   case ON_BASICBLOCK_MSG:
1149     dbgs() << "' on BasicBlock '" << Msg << "'...\n";
1150     break;
1151   case ON_FUNCTION_MSG:
1152     dbgs() << "' on Function '" << Msg << "'...\n";
1153     break;
1154   case ON_MODULE_MSG:
1155     dbgs() << "' on Module '"  << Msg << "'...\n";
1156     break;
1157   case ON_REGION_MSG:
1158     dbgs() << "' on Region '"  << Msg << "'...\n";
1159     break;
1160   case ON_LOOP_MSG:
1161     dbgs() << "' on Loop '" << Msg << "'...\n";
1162     break;
1163   case ON_CG_MSG:
1164     dbgs() << "' on Call Graph Nodes '" << Msg << "'...\n";
1165     break;
1166   default:
1167     break;
1168   }
1169 }
1170
1171 void PMDataManager::dumpRequiredSet(const Pass *P) const {
1172   if (PassDebugging < Details)
1173     return;
1174
1175   AnalysisUsage analysisUsage;
1176   P->getAnalysisUsage(analysisUsage);
1177   dumpAnalysisUsage("Required", P, analysisUsage.getRequiredSet());
1178 }
1179
1180 void PMDataManager::dumpPreservedSet(const Pass *P) const {
1181   if (PassDebugging < Details)
1182     return;
1183
1184   AnalysisUsage analysisUsage;
1185   P->getAnalysisUsage(analysisUsage);
1186   dumpAnalysisUsage("Preserved", P, analysisUsage.getPreservedSet());
1187 }
1188
1189 void PMDataManager::dumpAnalysisUsage(StringRef Msg, const Pass *P,
1190                                    const AnalysisUsage::VectorType &Set) const {
1191   assert(PassDebugging >= Details);
1192   if (Set.empty())
1193     return;
1194   dbgs() << (const void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:";
1195   for (unsigned i = 0; i != Set.size(); ++i) {
1196     if (i) dbgs() << ',';
1197     const PassInfo *PInf = PassRegistry::getPassRegistry()->getPassInfo(Set[i]);
1198     if (!PInf) {
1199       // Some preserved passes, such as AliasAnalysis, may not be initialized by
1200       // all drivers.
1201       dbgs() << " Uninitialized Pass";
1202       continue;
1203     }
1204     dbgs() << ' ' << PInf->getPassName();
1205   }
1206   dbgs() << '\n';
1207 }
1208
1209 /// Add RequiredPass into list of lower level passes required by pass P.
1210 /// RequiredPass is run on the fly by Pass Manager when P requests it
1211 /// through getAnalysis interface.
1212 /// This should be handled by specific pass manager.
1213 void PMDataManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
1214   if (TPM) {
1215     TPM->dumpArguments();
1216     TPM->dumpPasses();
1217   }
1218
1219   // Module Level pass may required Function Level analysis info
1220   // (e.g. dominator info). Pass manager uses on the fly function pass manager
1221   // to provide this on demand. In that case, in Pass manager terminology,
1222   // module level pass is requiring lower level analysis info managed by
1223   // lower level pass manager.
1224
1225   // When Pass manager is not able to order required analysis info, Pass manager
1226   // checks whether any lower level manager will be able to provide this
1227   // analysis info on demand or not.
1228 #ifndef NDEBUG
1229   dbgs() << "Unable to schedule '" << RequiredPass->getPassName();
1230   dbgs() << "' required by '" << P->getPassName() << "'\n";
1231 #endif
1232   llvm_unreachable("Unable to schedule pass");
1233 }
1234
1235 Pass *PMDataManager::getOnTheFlyPass(Pass *P, AnalysisID PI, Function &F) {
1236   llvm_unreachable("Unable to find on the fly pass");
1237 }
1238
1239 // Destructor
1240 PMDataManager::~PMDataManager() {
1241   for (SmallVectorImpl<Pass *>::iterator I = PassVector.begin(),
1242          E = PassVector.end(); I != E; ++I)
1243     delete *I;
1244 }
1245
1246 //===----------------------------------------------------------------------===//
1247 // NOTE: Is this the right place to define this method ?
1248 // getAnalysisIfAvailable - Return analysis result or null if it doesn't exist.
1249 Pass *AnalysisResolver::getAnalysisIfAvailable(AnalysisID ID, bool dir) const {
1250   return PM.findAnalysisPass(ID, dir);
1251 }
1252
1253 Pass *AnalysisResolver::findImplPass(Pass *P, AnalysisID AnalysisPI,
1254                                      Function &F) {
1255   return PM.getOnTheFlyPass(P, AnalysisPI, F);
1256 }
1257
1258 //===----------------------------------------------------------------------===//
1259 // BBPassManager implementation
1260
1261 /// Execute all of the passes scheduled for execution by invoking
1262 /// runOnBasicBlock method.  Keep track of whether any of the passes modifies
1263 /// the function, and if so, return true.
1264 bool BBPassManager::runOnFunction(Function &F) {
1265   if (F.isDeclaration())
1266     return false;
1267
1268   bool Changed = doInitialization(F);
1269
1270   for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
1271     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1272       BasicBlockPass *BP = getContainedPass(Index);
1273       bool LocalChanged = false;
1274
1275       dumpPassInfo(BP, EXECUTION_MSG, ON_BASICBLOCK_MSG, I->getName());
1276       dumpRequiredSet(BP);
1277
1278       initializeAnalysisImpl(BP);
1279
1280       {
1281         // If the pass crashes, remember this.
1282         PassManagerPrettyStackEntry X(BP, *I);
1283         TimeRegion PassTimer(getPassTimer(BP));
1284
1285         LocalChanged |= BP->runOnBasicBlock(*I);
1286       }
1287
1288       Changed |= LocalChanged;
1289       if (LocalChanged)
1290         dumpPassInfo(BP, MODIFICATION_MSG, ON_BASICBLOCK_MSG,
1291                      I->getName());
1292       dumpPreservedSet(BP);
1293
1294       verifyPreservedAnalysis(BP);
1295       removeNotPreservedAnalysis(BP);
1296       recordAvailableAnalysis(BP);
1297       removeDeadPasses(BP, I->getName(), ON_BASICBLOCK_MSG);
1298     }
1299
1300   return doFinalization(F) || Changed;
1301 }
1302
1303 // Implement doInitialization and doFinalization
1304 bool BBPassManager::doInitialization(Module &M) {
1305   bool Changed = false;
1306
1307   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1308     Changed |= getContainedPass(Index)->doInitialization(M);
1309
1310   return Changed;
1311 }
1312
1313 bool BBPassManager::doFinalization(Module &M) {
1314   bool Changed = false;
1315
1316   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1317     Changed |= getContainedPass(Index)->doFinalization(M);
1318
1319   return Changed;
1320 }
1321
1322 bool BBPassManager::doInitialization(Function &F) {
1323   bool Changed = false;
1324
1325   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1326     BasicBlockPass *BP = getContainedPass(Index);
1327     Changed |= BP->doInitialization(F);
1328   }
1329
1330   return Changed;
1331 }
1332
1333 bool BBPassManager::doFinalization(Function &F) {
1334   bool Changed = false;
1335
1336   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1337     BasicBlockPass *BP = getContainedPass(Index);
1338     Changed |= BP->doFinalization(F);
1339   }
1340
1341   return Changed;
1342 }
1343
1344
1345 //===----------------------------------------------------------------------===//
1346 // FunctionPassManager implementation
1347
1348 /// Create new Function pass manager
1349 FunctionPassManager::FunctionPassManager(Module *m) : M(m) {
1350   FPM = new FunctionPassManagerImpl();
1351   // FPM is the top level manager.
1352   FPM->setTopLevelManager(FPM);
1353
1354   AnalysisResolver *AR = new AnalysisResolver(*FPM);
1355   FPM->setResolver(AR);
1356 }
1357
1358 FunctionPassManager::~FunctionPassManager() {
1359   delete FPM;
1360 }
1361
1362 /// add - Add a pass to the queue of passes to run.  This passes
1363 /// ownership of the Pass to the PassManager.  When the
1364 /// PassManager_X is destroyed, the pass will be destroyed as well, so
1365 /// there is no need to delete the pass. (TODO delete passes.)
1366 /// This implies that all passes MUST be allocated with 'new'.
1367 void FunctionPassManager::add(Pass *P) {
1368   FPM->add(P);
1369 }
1370
1371 /// run - Execute all of the passes scheduled for execution.  Keep
1372 /// track of whether any of the passes modifies the function, and if
1373 /// so, return true.
1374 ///
1375 bool FunctionPassManager::run(Function &F) {
1376   if (F.isMaterializable()) {
1377     std::string errstr;
1378     if (F.Materialize(&errstr))
1379       report_fatal_error("Error reading bitcode file: " + Twine(errstr));
1380   }
1381   return FPM->run(F);
1382 }
1383
1384
1385 /// doInitialization - Run all of the initializers for the function passes.
1386 ///
1387 bool FunctionPassManager::doInitialization() {
1388   return FPM->doInitialization(*M);
1389 }
1390
1391 /// doFinalization - Run all of the finalizers for the function passes.
1392 ///
1393 bool FunctionPassManager::doFinalization() {
1394   return FPM->doFinalization(*M);
1395 }
1396
1397 //===----------------------------------------------------------------------===//
1398 // FunctionPassManagerImpl implementation
1399 //
1400 bool FunctionPassManagerImpl::doInitialization(Module &M) {
1401   bool Changed = false;
1402
1403   dumpArguments();
1404   dumpPasses();
1405
1406   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1407     Changed |= getContainedManager(Index)->doInitialization(M);
1408
1409   return Changed;
1410 }
1411
1412 bool FunctionPassManagerImpl::doFinalization(Module &M) {
1413   bool Changed = false;
1414
1415   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1416     Changed |= getContainedManager(Index)->doFinalization(M);
1417
1418   return Changed;
1419 }
1420
1421 /// cleanup - After running all passes, clean up pass manager cache.
1422 void FPPassManager::cleanup() {
1423  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1424     FunctionPass *FP = getContainedPass(Index);
1425     AnalysisResolver *AR = FP->getResolver();
1426     assert(AR && "Analysis Resolver is not set");
1427     AR->clearAnalysisImpls();
1428  }
1429 }
1430
1431 void FunctionPassManagerImpl::releaseMemoryOnTheFly() {
1432   if (!wasRun)
1433     return;
1434   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1435     FPPassManager *FPPM = getContainedManager(Index);
1436     for (unsigned Index = 0; Index < FPPM->getNumContainedPasses(); ++Index) {
1437       FPPM->getContainedPass(Index)->releaseMemory();
1438     }
1439   }
1440   wasRun = false;
1441 }
1442
1443 // Execute all the passes managed by this top level manager.
1444 // Return true if any function is modified by a pass.
1445 bool FunctionPassManagerImpl::run(Function &F) {
1446   bool Changed = false;
1447   TimingInfo::createTheTimeInfo();
1448
1449   initializeAllAnalysisInfo();
1450   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1451     Changed |= getContainedManager(Index)->runOnFunction(F);
1452
1453   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1454     getContainedManager(Index)->cleanup();
1455
1456   wasRun = true;
1457   return Changed;
1458 }
1459
1460 //===----------------------------------------------------------------------===//
1461 // FPPassManager implementation
1462
1463 char FPPassManager::ID = 0;
1464 /// Print passes managed by this manager
1465 void FPPassManager::dumpPassStructure(unsigned Offset) {
1466   dbgs().indent(Offset*2) << "FunctionPass Manager\n";
1467   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1468     FunctionPass *FP = getContainedPass(Index);
1469     FP->dumpPassStructure(Offset + 1);
1470     dumpLastUses(FP, Offset+1);
1471   }
1472 }
1473
1474
1475 /// Execute all of the passes scheduled for execution by invoking
1476 /// runOnFunction method.  Keep track of whether any of the passes modifies
1477 /// the function, and if so, return true.
1478 bool FPPassManager::runOnFunction(Function &F) {
1479   if (F.isDeclaration())
1480     return false;
1481
1482   bool Changed = false;
1483
1484   // Collect inherited analysis from Module level pass manager.
1485   populateInheritedAnalysis(TPM->activeStack);
1486
1487   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1488     FunctionPass *FP = getContainedPass(Index);
1489     bool LocalChanged = false;
1490
1491     dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getName());
1492     dumpRequiredSet(FP);
1493
1494     initializeAnalysisImpl(FP);
1495
1496     {
1497       PassManagerPrettyStackEntry X(FP, F);
1498       TimeRegion PassTimer(getPassTimer(FP));
1499
1500       LocalChanged |= FP->runOnFunction(F);
1501     }
1502
1503     Changed |= LocalChanged;
1504     if (LocalChanged)
1505       dumpPassInfo(FP, MODIFICATION_MSG, ON_FUNCTION_MSG, F.getName());
1506     dumpPreservedSet(FP);
1507
1508     verifyPreservedAnalysis(FP);
1509     removeNotPreservedAnalysis(FP);
1510     recordAvailableAnalysis(FP);
1511     removeDeadPasses(FP, F.getName(), ON_FUNCTION_MSG);
1512   }
1513   return Changed;
1514 }
1515
1516 bool FPPassManager::runOnModule(Module &M) {
1517   bool Changed = doInitialization(M);
1518
1519   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1520     Changed |= runOnFunction(*I);
1521
1522   return doFinalization(M) || Changed;
1523 }
1524
1525 bool FPPassManager::doInitialization(Module &M) {
1526   bool Changed = false;
1527
1528   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1529     Changed |= getContainedPass(Index)->doInitialization(M);
1530
1531   return Changed;
1532 }
1533
1534 bool FPPassManager::doFinalization(Module &M) {
1535   bool Changed = false;
1536
1537   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1538     Changed |= getContainedPass(Index)->doFinalization(M);
1539
1540   return Changed;
1541 }
1542
1543 //===----------------------------------------------------------------------===//
1544 // MPPassManager implementation
1545
1546 /// Execute all of the passes scheduled for execution by invoking
1547 /// runOnModule method.  Keep track of whether any of the passes modifies
1548 /// the module, and if so, return true.
1549 bool
1550 MPPassManager::runOnModule(Module &M) {
1551   bool Changed = false;
1552
1553   // Initialize on-the-fly passes
1554   for (std::map<Pass *, FunctionPassManagerImpl *>::iterator
1555        I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end();
1556        I != E; ++I) {
1557     FunctionPassManagerImpl *FPP = I->second;
1558     Changed |= FPP->doInitialization(M);
1559   }
1560
1561   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1562     ModulePass *MP = getContainedPass(Index);
1563     bool LocalChanged = false;
1564
1565     dumpPassInfo(MP, EXECUTION_MSG, ON_MODULE_MSG, M.getModuleIdentifier());
1566     dumpRequiredSet(MP);
1567
1568     initializeAnalysisImpl(MP);
1569
1570     {
1571       PassManagerPrettyStackEntry X(MP, M);
1572       TimeRegion PassTimer(getPassTimer(MP));
1573
1574       LocalChanged |= MP->runOnModule(M);
1575     }
1576
1577     Changed |= LocalChanged;
1578     if (LocalChanged)
1579       dumpPassInfo(MP, MODIFICATION_MSG, ON_MODULE_MSG,
1580                    M.getModuleIdentifier());
1581     dumpPreservedSet(MP);
1582
1583     verifyPreservedAnalysis(MP);
1584     removeNotPreservedAnalysis(MP);
1585     recordAvailableAnalysis(MP);
1586     removeDeadPasses(MP, M.getModuleIdentifier(), ON_MODULE_MSG);
1587   }
1588
1589   // Finalize on-the-fly passes
1590   for (std::map<Pass *, FunctionPassManagerImpl *>::iterator
1591        I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end();
1592        I != E; ++I) {
1593     FunctionPassManagerImpl *FPP = I->second;
1594     // We don't know when is the last time an on-the-fly pass is run,
1595     // so we need to releaseMemory / finalize here
1596     FPP->releaseMemoryOnTheFly();
1597     Changed |= FPP->doFinalization(M);
1598   }
1599   return Changed;
1600 }
1601
1602 /// Add RequiredPass into list of lower level passes required by pass P.
1603 /// RequiredPass is run on the fly by Pass Manager when P requests it
1604 /// through getAnalysis interface.
1605 void MPPassManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
1606   assert(P->getPotentialPassManagerType() == PMT_ModulePassManager &&
1607          "Unable to handle Pass that requires lower level Analysis pass");
1608   assert((P->getPotentialPassManagerType() <
1609           RequiredPass->getPotentialPassManagerType()) &&
1610          "Unable to handle Pass that requires lower level Analysis pass");
1611
1612   FunctionPassManagerImpl *FPP = OnTheFlyManagers[P];
1613   if (!FPP) {
1614     FPP = new FunctionPassManagerImpl();
1615     // FPP is the top level manager.
1616     FPP->setTopLevelManager(FPP);
1617
1618     OnTheFlyManagers[P] = FPP;
1619   }
1620   FPP->add(RequiredPass);
1621
1622   // Register P as the last user of RequiredPass.
1623   if (RequiredPass) {
1624     SmallVector<Pass *, 1> LU;
1625     LU.push_back(RequiredPass);
1626     FPP->setLastUser(LU,  P);
1627   }
1628 }
1629
1630 /// Return function pass corresponding to PassInfo PI, that is
1631 /// required by module pass MP. Instantiate analysis pass, by using
1632 /// its runOnFunction() for function F.
1633 Pass* MPPassManager::getOnTheFlyPass(Pass *MP, AnalysisID PI, Function &F){
1634   FunctionPassManagerImpl *FPP = OnTheFlyManagers[MP];
1635   assert(FPP && "Unable to find on the fly pass");
1636
1637   FPP->releaseMemoryOnTheFly();
1638   FPP->run(F);
1639   return ((PMTopLevelManager*)FPP)->findAnalysisPass(PI);
1640 }
1641
1642
1643 //===----------------------------------------------------------------------===//
1644 // PassManagerImpl implementation
1645 //
1646 /// run - Execute all of the passes scheduled for execution.  Keep track of
1647 /// whether any of the passes modifies the module, and if so, return true.
1648 bool PassManagerImpl::run(Module &M) {
1649   bool Changed = false;
1650   TimingInfo::createTheTimeInfo();
1651
1652   dumpArguments();
1653   dumpPasses();
1654
1655   initializeAllAnalysisInfo();
1656   for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1657     Changed |= getContainedManager(Index)->runOnModule(M);
1658   return Changed;
1659 }
1660
1661 //===----------------------------------------------------------------------===//
1662 // PassManager implementation
1663
1664 /// Create new pass manager
1665 PassManager::PassManager() {
1666   PM = new PassManagerImpl();
1667   // PM is the top level manager
1668   PM->setTopLevelManager(PM);
1669 }
1670
1671 PassManager::~PassManager() {
1672   delete PM;
1673 }
1674
1675 /// add - Add a pass to the queue of passes to run.  This passes ownership of
1676 /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
1677 /// will be destroyed as well, so there is no need to delete the pass.  This
1678 /// implies that all passes MUST be allocated with 'new'.
1679 void PassManager::add(Pass *P) {
1680   PM->add(P);
1681 }
1682
1683 /// run - Execute all of the passes scheduled for execution.  Keep track of
1684 /// whether any of the passes modifies the module, and if so, return true.
1685 bool PassManager::run(Module &M) {
1686   return PM->run(M);
1687 }
1688
1689 //===----------------------------------------------------------------------===//
1690 // TimingInfo Class - This class is used to calculate information about the
1691 // amount of time each pass takes to execute.  This only happens with
1692 // -time-passes is enabled on the command line.
1693 //
1694 bool llvm::TimePassesIsEnabled = false;
1695 static cl::opt<bool,true>
1696 EnableTiming("time-passes", cl::location(TimePassesIsEnabled),
1697             cl::desc("Time each pass, printing elapsed time for each on exit"));
1698
1699 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
1700 // a non null value (if the -time-passes option is enabled) or it leaves it
1701 // null.  It may be called multiple times.
1702 void TimingInfo::createTheTimeInfo() {
1703   if (!TimePassesIsEnabled || TheTimeInfo) return;
1704
1705   // Constructed the first time this is called, iff -time-passes is enabled.
1706   // This guarantees that the object will be constructed before static globals,
1707   // thus it will be destroyed before them.
1708   static ManagedStatic<TimingInfo> TTI;
1709   TheTimeInfo = &*TTI;
1710 }
1711
1712 /// If TimingInfo is enabled then start pass timer.
1713 Timer *llvm::getPassTimer(Pass *P) {
1714   if (TheTimeInfo)
1715     return TheTimeInfo->getPassTimer(P);
1716   return 0;
1717 }
1718
1719 //===----------------------------------------------------------------------===//
1720 // PMStack implementation
1721 //
1722
1723 // Pop Pass Manager from the stack and clear its analysis info.
1724 void PMStack::pop() {
1725
1726   PMDataManager *Top = this->top();
1727   Top->initializeAnalysisInfo();
1728
1729   S.pop_back();
1730 }
1731
1732 // Push PM on the stack and set its top level manager.
1733 void PMStack::push(PMDataManager *PM) {
1734   assert(PM && "Unable to push. Pass Manager expected");
1735   assert(PM->getDepth()==0 && "Pass Manager depth set too early");
1736
1737   if (!this->empty()) {
1738     assert(PM->getPassManagerType() > this->top()->getPassManagerType()
1739            && "pushing bad pass manager to PMStack");
1740     PMTopLevelManager *TPM = this->top()->getTopLevelManager();
1741
1742     assert(TPM && "Unable to find top level manager");
1743     TPM->addIndirectPassManager(PM);
1744     PM->setTopLevelManager(TPM);
1745     PM->setDepth(this->top()->getDepth()+1);
1746   }
1747   else {
1748     assert((PM->getPassManagerType() == PMT_ModulePassManager
1749            || PM->getPassManagerType() == PMT_FunctionPassManager)
1750            && "pushing bad pass manager to PMStack");
1751     PM->setDepth(1);
1752   }
1753
1754   S.push_back(PM);
1755 }
1756
1757 // Dump content of the pass manager stack.
1758 void PMStack::dump() const {
1759   for (std::vector<PMDataManager *>::const_iterator I = S.begin(),
1760          E = S.end(); I != E; ++I)
1761     dbgs() << (*I)->getAsPass()->getPassName() << ' ';
1762
1763   if (!S.empty())
1764     dbgs() << '\n';
1765 }
1766
1767 /// Find appropriate Module Pass Manager in the PM Stack and
1768 /// add self into that manager.
1769 void ModulePass::assignPassManager(PMStack &PMS,
1770                                    PassManagerType PreferredType) {
1771   // Find Module Pass Manager
1772   while (!PMS.empty()) {
1773     PassManagerType TopPMType = PMS.top()->getPassManagerType();
1774     if (TopPMType == PreferredType)
1775       break; // We found desired pass manager
1776     else if (TopPMType > PMT_ModulePassManager)
1777       PMS.pop();    // Pop children pass managers
1778     else
1779       break;
1780   }
1781   assert(!PMS.empty() && "Unable to find appropriate Pass Manager");
1782   PMS.top()->add(this);
1783 }
1784
1785 /// Find appropriate Function Pass Manager or Call Graph Pass Manager
1786 /// in the PM Stack and add self into that manager.
1787 void FunctionPass::assignPassManager(PMStack &PMS,
1788                                      PassManagerType PreferredType) {
1789
1790   // Find Function Pass Manager
1791   while (!PMS.empty()) {
1792     if (PMS.top()->getPassManagerType() > PMT_FunctionPassManager)
1793       PMS.pop();
1794     else
1795       break;
1796   }
1797
1798   // Create new Function Pass Manager if needed.
1799   FPPassManager *FPP;
1800   if (PMS.top()->getPassManagerType() == PMT_FunctionPassManager) {
1801     FPP = (FPPassManager *)PMS.top();
1802   } else {
1803     assert(!PMS.empty() && "Unable to create Function Pass Manager");
1804     PMDataManager *PMD = PMS.top();
1805
1806     // [1] Create new Function Pass Manager
1807     FPP = new FPPassManager();
1808     FPP->populateInheritedAnalysis(PMS);
1809
1810     // [2] Set up new manager's top level manager
1811     PMTopLevelManager *TPM = PMD->getTopLevelManager();
1812     TPM->addIndirectPassManager(FPP);
1813
1814     // [3] Assign manager to manage this new manager. This may create
1815     // and push new managers into PMS
1816     FPP->assignPassManager(PMS, PMD->getPassManagerType());
1817
1818     // [4] Push new manager into PMS
1819     PMS.push(FPP);
1820   }
1821
1822   // Assign FPP as the manager of this pass.
1823   FPP->add(this);
1824 }
1825
1826 /// Find appropriate Basic Pass Manager or Call Graph Pass Manager
1827 /// in the PM Stack and add self into that manager.
1828 void BasicBlockPass::assignPassManager(PMStack &PMS,
1829                                        PassManagerType PreferredType) {
1830   BBPassManager *BBP;
1831
1832   // Basic Pass Manager is a leaf pass manager. It does not handle
1833   // any other pass manager.
1834   if (!PMS.empty() &&
1835       PMS.top()->getPassManagerType() == PMT_BasicBlockPassManager) {
1836     BBP = (BBPassManager *)PMS.top();
1837   } else {
1838     // If leaf manager is not Basic Block Pass manager then create new
1839     // basic Block Pass manager.
1840     assert(!PMS.empty() && "Unable to create BasicBlock Pass Manager");
1841     PMDataManager *PMD = PMS.top();
1842
1843     // [1] Create new Basic Block Manager
1844     BBP = new BBPassManager();
1845
1846     // [2] Set up new manager's top level manager
1847     // Basic Block Pass Manager does not live by itself
1848     PMTopLevelManager *TPM = PMD->getTopLevelManager();
1849     TPM->addIndirectPassManager(BBP);
1850
1851     // [3] Assign manager to manage this new manager. This may create
1852     // and push new managers into PMS
1853     BBP->assignPassManager(PMS, PreferredType);
1854
1855     // [4] Push new manager into PMS
1856     PMS.push(BBP);
1857   }
1858
1859   // Assign BBP as the manager of this pass.
1860   BBP->add(this);
1861 }
1862
1863 PassManagerBase::~PassManagerBase() {}