1 //===- PassManager.cpp - LLVM Pass Infrastructure Implementation ----------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the LLVM Pass Manager infrastructure.
12 //===----------------------------------------------------------------------===//
15 #include "llvm/PassManagers.h"
16 #include "llvm/PassManager.h"
17 #include "llvm/DebugInfoProbe.h"
18 #include "llvm/Assembly/PrintModulePass.h"
19 #include "llvm/Assembly/Writer.h"
20 #include "llvm/Support/CommandLine.h"
21 #include "llvm/Support/Debug.h"
22 #include "llvm/Support/Timer.h"
23 #include "llvm/Module.h"
24 #include "llvm/Support/ErrorHandling.h"
25 #include "llvm/Support/ManagedStatic.h"
26 #include "llvm/Support/PassNameParser.h"
27 #include "llvm/Support/raw_ostream.h"
28 #include "llvm/Support/Mutex.h"
29 #include "llvm/ADT/StringMap.h"
34 // See PassManagers.h for Pass Manager infrastructure overview.
38 //===----------------------------------------------------------------------===//
39 // Pass debugging information. Often it is useful to find out what pass is
40 // running when a crash occurs in a utility. When this library is compiled with
41 // debugging on, a command line option (--debug-pass) is enabled that causes the
42 // pass name to be printed before it executes.
45 // Different debug levels that can be enabled...
47 None, Arguments, Structure, Executions, Details
50 static cl::opt<enum PassDebugLevel>
51 PassDebugging("debug-pass", cl::Hidden,
52 cl::desc("Print PassManager debugging information"),
54 clEnumVal(None , "disable debug output"),
55 clEnumVal(Arguments , "print pass arguments to pass to 'opt'"),
56 clEnumVal(Structure , "print pass structure before run()"),
57 clEnumVal(Executions, "print pass name before it is executed"),
58 clEnumVal(Details , "print pass details when it is executed"),
61 typedef llvm::cl::list<const llvm::PassInfo *, bool, PassNameParser>
64 // Print IR out before/after specified passes.
66 PrintBefore("print-before",
67 llvm::cl::desc("Print IR before specified passes"),
71 PrintAfter("print-after",
72 llvm::cl::desc("Print IR after specified passes"),
76 PrintBeforeAll("print-before-all",
77 llvm::cl::desc("Print IR before each pass"),
80 PrintAfterAll("print-after-all",
81 llvm::cl::desc("Print IR after each pass"),
84 /// This is a helper to determine whether to print IR before or
87 static bool ShouldPrintBeforeOrAfterPass(const PassInfo *PI,
88 PassOptionList &PassesToPrint) {
89 for (unsigned i = 0, ie = PassesToPrint.size(); i < ie; ++i) {
90 const llvm::PassInfo *PassInf = PassesToPrint[i];
92 if (PassInf->getPassArgument() == PI->getPassArgument()) {
99 /// This is a utility to check whether a pass should have IR dumped
101 static bool ShouldPrintBeforePass(const PassInfo *PI) {
102 return PrintBeforeAll || ShouldPrintBeforeOrAfterPass(PI, PrintBefore);
105 /// This is a utility to check whether a pass should have IR dumped
107 static bool ShouldPrintAfterPass(const PassInfo *PI) {
108 return PrintAfterAll || ShouldPrintBeforeOrAfterPass(PI, PrintAfter);
111 } // End of llvm namespace
113 /// isPassDebuggingExecutionsOrMore - Return true if -debug-pass=Executions
114 /// or higher is specified.
115 bool PMDataManager::isPassDebuggingExecutionsOrMore() const {
116 return PassDebugging >= Executions;
122 void PassManagerPrettyStackEntry::print(raw_ostream &OS) const {
123 if (V == 0 && M == 0)
124 OS << "Releasing pass '";
126 OS << "Running pass '";
128 OS << P->getPassName() << "'";
131 OS << " on module '" << M->getModuleIdentifier() << "'.\n";
140 if (isa<Function>(V))
142 else if (isa<BasicBlock>(V))
148 WriteAsOperand(OS, V, /*PrintTy=*/false, M);
155 //===----------------------------------------------------------------------===//
158 /// BBPassManager manages BasicBlockPass. It batches all the
159 /// pass together and sequence them to process one basic block before
160 /// processing next basic block.
161 class BBPassManager : public PMDataManager, public FunctionPass {
165 explicit BBPassManager()
166 : PMDataManager(), FunctionPass(ID) {}
168 /// Execute all of the passes scheduled for execution. Keep track of
169 /// whether any of the passes modifies the function, and if so, return true.
170 bool runOnFunction(Function &F);
172 /// Pass Manager itself does not invalidate any analysis info.
173 void getAnalysisUsage(AnalysisUsage &Info) const {
174 Info.setPreservesAll();
177 bool doInitialization(Module &M);
178 bool doInitialization(Function &F);
179 bool doFinalization(Module &M);
180 bool doFinalization(Function &F);
182 virtual PMDataManager *getAsPMDataManager() { return this; }
183 virtual Pass *getAsPass() { return this; }
185 virtual const char *getPassName() const {
186 return "BasicBlock Pass Manager";
189 // Print passes managed by this manager
190 void dumpPassStructure(unsigned Offset) {
191 llvm::dbgs().indent(Offset*2) << "BasicBlockPass Manager\n";
192 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
193 BasicBlockPass *BP = getContainedPass(Index);
194 BP->dumpPassStructure(Offset + 1);
195 dumpLastUses(BP, Offset+1);
199 BasicBlockPass *getContainedPass(unsigned N) {
200 assert(N < PassVector.size() && "Pass number out of range!");
201 BasicBlockPass *BP = static_cast<BasicBlockPass *>(PassVector[N]);
205 virtual PassManagerType getPassManagerType() const {
206 return PMT_BasicBlockPassManager;
210 char BBPassManager::ID = 0;
215 //===----------------------------------------------------------------------===//
216 // FunctionPassManagerImpl
218 /// FunctionPassManagerImpl manages FPPassManagers
219 class FunctionPassManagerImpl : public Pass,
220 public PMDataManager,
221 public PMTopLevelManager {
222 virtual void anchor();
227 explicit FunctionPassManagerImpl() :
228 Pass(PT_PassManager, ID), PMDataManager(),
229 PMTopLevelManager(new FPPassManager()), wasRun(false) {}
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'.
239 /// createPrinterPass - Get a function printer pass.
240 Pass *createPrinterPass(raw_ostream &O, const std::string &Banner) const {
241 return createPrintFunctionPass(Banner, &O);
244 // Prepare for running an on the fly pass, freeing memory if needed
245 // from a previous run.
246 void releaseMemoryOnTheFly();
248 /// run - Execute all of the passes scheduled for execution. Keep track of
249 /// whether any of the passes modifies the module, and if so, return true.
250 bool run(Function &F);
252 /// doInitialization - Run all of the initializers for the function passes.
254 bool doInitialization(Module &M);
256 /// doFinalization - Run all of the finalizers for the function passes.
258 bool doFinalization(Module &M);
261 virtual PMDataManager *getAsPMDataManager() { return this; }
262 virtual Pass *getAsPass() { return this; }
263 virtual PassManagerType getTopLevelPassManagerType() {
264 return PMT_FunctionPassManager;
267 /// Pass Manager itself does not invalidate any analysis info.
268 void getAnalysisUsage(AnalysisUsage &Info) const {
269 Info.setPreservesAll();
272 FPPassManager *getContainedManager(unsigned N) {
273 assert(N < PassManagers.size() && "Pass number out of range!");
274 FPPassManager *FP = static_cast<FPPassManager *>(PassManagers[N]);
279 void FunctionPassManagerImpl::anchor() {}
281 char FunctionPassManagerImpl::ID = 0;
283 //===----------------------------------------------------------------------===//
286 /// MPPassManager manages ModulePasses and function pass managers.
287 /// It batches all Module passes and function pass managers together and
288 /// sequences them to process one module.
289 class MPPassManager : public Pass, public PMDataManager {
292 explicit MPPassManager() :
293 Pass(PT_PassManager, ID), PMDataManager() { }
295 // Delete on the fly managers.
296 virtual ~MPPassManager() {
297 for (std::map<Pass *, FunctionPassManagerImpl *>::iterator
298 I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end();
300 FunctionPassManagerImpl *FPP = I->second;
305 /// createPrinterPass - Get a module printer pass.
306 Pass *createPrinterPass(raw_ostream &O, const std::string &Banner) const {
307 return createPrintModulePass(&O, false, Banner);
310 /// run - Execute all of the passes scheduled for execution. Keep track of
311 /// whether any of the passes modifies the module, and if so, return true.
312 bool runOnModule(Module &M);
314 /// Pass Manager itself does not invalidate any analysis info.
315 void getAnalysisUsage(AnalysisUsage &Info) const {
316 Info.setPreservesAll();
319 /// Add RequiredPass into list of lower level passes required by pass P.
320 /// RequiredPass is run on the fly by Pass Manager when P requests it
321 /// through getAnalysis interface.
322 virtual void addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass);
324 /// Return function pass corresponding to PassInfo PI, that is
325 /// required by module pass MP. Instantiate analysis pass, by using
326 /// its runOnFunction() for function F.
327 virtual Pass* getOnTheFlyPass(Pass *MP, AnalysisID PI, Function &F);
329 virtual const char *getPassName() const {
330 return "Module Pass Manager";
333 virtual PMDataManager *getAsPMDataManager() { return this; }
334 virtual Pass *getAsPass() { return this; }
336 // Print passes managed by this manager
337 void dumpPassStructure(unsigned Offset) {
338 llvm::dbgs().indent(Offset*2) << "ModulePass Manager\n";
339 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
340 ModulePass *MP = getContainedPass(Index);
341 MP->dumpPassStructure(Offset + 1);
342 std::map<Pass *, FunctionPassManagerImpl *>::const_iterator I =
343 OnTheFlyManagers.find(MP);
344 if (I != OnTheFlyManagers.end())
345 I->second->dumpPassStructure(Offset + 2);
346 dumpLastUses(MP, Offset+1);
350 ModulePass *getContainedPass(unsigned N) {
351 assert(N < PassVector.size() && "Pass number out of range!");
352 return static_cast<ModulePass *>(PassVector[N]);
355 virtual PassManagerType getPassManagerType() const {
356 return PMT_ModulePassManager;
360 /// Collection of on the fly FPPassManagers. These managers manage
361 /// function passes that are required by module passes.
362 std::map<Pass *, FunctionPassManagerImpl *> OnTheFlyManagers;
365 char MPPassManager::ID = 0;
366 //===----------------------------------------------------------------------===//
370 /// PassManagerImpl manages MPPassManagers
371 class PassManagerImpl : public Pass,
372 public PMDataManager,
373 public PMTopLevelManager {
374 virtual void anchor();
378 explicit PassManagerImpl() :
379 Pass(PT_PassManager, ID), PMDataManager(),
380 PMTopLevelManager(new MPPassManager()) {}
382 /// add - Add a pass to the queue of passes to run. This passes ownership of
383 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
384 /// will be destroyed as well, so there is no need to delete the pass. This
385 /// implies that all passes MUST be allocated with 'new'.
390 /// createPrinterPass - Get a module printer pass.
391 Pass *createPrinterPass(raw_ostream &O, const std::string &Banner) const {
392 return createPrintModulePass(&O, false, Banner);
395 /// run - Execute all of the passes scheduled for execution. Keep track of
396 /// whether any of the passes modifies the module, and if so, return true.
399 /// Pass Manager itself does not invalidate any analysis info.
400 void getAnalysisUsage(AnalysisUsage &Info) const {
401 Info.setPreservesAll();
404 virtual PMDataManager *getAsPMDataManager() { return this; }
405 virtual Pass *getAsPass() { return this; }
406 virtual PassManagerType getTopLevelPassManagerType() {
407 return PMT_ModulePassManager;
410 MPPassManager *getContainedManager(unsigned N) {
411 assert(N < PassManagers.size() && "Pass number out of range!");
412 MPPassManager *MP = static_cast<MPPassManager *>(PassManagers[N]);
417 void PassManagerImpl::anchor() {}
419 char PassManagerImpl::ID = 0;
420 } // End of llvm namespace
424 //===----------------------------------------------------------------------===//
427 static DebugInfoProbeInfo *TheDebugProbe;
428 static void createDebugInfoProbe() {
429 if (TheDebugProbe) return;
431 // Constructed the first time this is called. This guarantees that the
432 // object will be constructed, if -enable-debug-info-probe is set,
433 // before static globals, thus it will be destroyed before them.
434 static ManagedStatic<DebugInfoProbeInfo> DIP;
435 TheDebugProbe = &*DIP;
438 //===----------------------------------------------------------------------===//
439 /// TimingInfo Class - This class is used to calculate information about the
440 /// amount of time each pass takes to execute. This only happens when
441 /// -time-passes is enabled on the command line.
444 static ManagedStatic<sys::SmartMutex<true> > TimingInfoMutex;
447 DenseMap<Pass*, Timer*> TimingData;
450 // Use 'create' member to get this.
451 TimingInfo() : TG("... Pass execution timing report ...") {}
453 // TimingDtor - Print out information about timing information
455 // Delete all of the timers, which accumulate their info into the
457 for (DenseMap<Pass*, Timer*>::iterator I = TimingData.begin(),
458 E = TimingData.end(); I != E; ++I)
460 // TimerGroup is deleted next, printing the report.
463 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer
464 // to a non null value (if the -time-passes option is enabled) or it leaves it
465 // null. It may be called multiple times.
466 static void createTheTimeInfo();
468 /// getPassTimer - Return the timer for the specified pass if it exists.
469 Timer *getPassTimer(Pass *P) {
470 if (P->getAsPMDataManager())
473 sys::SmartScopedLock<true> Lock(*TimingInfoMutex);
474 Timer *&T = TimingData[P];
476 T = new Timer(P->getPassName(), TG);
481 } // End of anon namespace
483 static TimingInfo *TheTimeInfo;
485 //===----------------------------------------------------------------------===//
486 // PMTopLevelManager implementation
488 /// Initialize top level manager. Create first pass manager.
489 PMTopLevelManager::PMTopLevelManager(PMDataManager *PMDM) {
490 PMDM->setTopLevelManager(this);
491 addPassManager(PMDM);
492 activeStack.push(PMDM);
495 /// Set pass P as the last user of the given analysis passes.
497 PMTopLevelManager::setLastUser(const SmallVectorImpl<Pass *> &AnalysisPasses,
500 if (P->getResolver())
501 PDepth = P->getResolver()->getPMDataManager().getDepth();
503 for (SmallVectorImpl<Pass *>::const_iterator I = AnalysisPasses.begin(),
504 E = AnalysisPasses.end(); I != E; ++I) {
511 // Update the last users of passes that are required transitive by AP.
512 AnalysisUsage *AnUsage = findAnalysisUsage(AP);
513 const AnalysisUsage::VectorType &IDs = AnUsage->getRequiredTransitiveSet();
514 SmallVector<Pass *, 12> LastUses;
515 SmallVector<Pass *, 12> LastPMUses;
516 for (AnalysisUsage::VectorType::const_iterator I = IDs.begin(),
517 E = IDs.end(); I != E; ++I) {
518 Pass *AnalysisPass = findAnalysisPass(*I);
519 assert(AnalysisPass && "Expected analysis pass to exist.");
520 AnalysisResolver *AR = AnalysisPass->getResolver();
521 assert(AR && "Expected analysis resolver to exist.");
522 unsigned APDepth = AR->getPMDataManager().getDepth();
524 if (PDepth == APDepth)
525 LastUses.push_back(AnalysisPass);
526 else if (PDepth > APDepth)
527 LastPMUses.push_back(AnalysisPass);
530 setLastUser(LastUses, P);
532 // If this pass has a corresponding pass manager, push higher level
533 // analysis to this pass manager.
534 if (P->getResolver())
535 setLastUser(LastPMUses, P->getResolver()->getPMDataManager().getAsPass());
538 // If AP is the last user of other passes then make P last user of
540 for (DenseMap<Pass *, Pass *>::iterator LUI = LastUser.begin(),
541 LUE = LastUser.end(); LUI != LUE; ++LUI) {
542 if (LUI->second == AP)
543 // DenseMap iterator is not invalidated here because
544 // this is just updating existing entries.
545 LastUser[LUI->first] = P;
550 /// Collect passes whose last user is P
551 void PMTopLevelManager::collectLastUses(SmallVectorImpl<Pass *> &LastUses,
553 DenseMap<Pass *, SmallPtrSet<Pass *, 8> >::iterator DMI =
554 InversedLastUser.find(P);
555 if (DMI == InversedLastUser.end())
558 SmallPtrSet<Pass *, 8> &LU = DMI->second;
559 for (SmallPtrSet<Pass *, 8>::iterator I = LU.begin(),
560 E = LU.end(); I != E; ++I) {
561 LastUses.push_back(*I);
566 AnalysisUsage *PMTopLevelManager::findAnalysisUsage(Pass *P) {
567 AnalysisUsage *AnUsage = NULL;
568 DenseMap<Pass *, AnalysisUsage *>::iterator DMI = AnUsageMap.find(P);
569 if (DMI != AnUsageMap.end())
570 AnUsage = DMI->second;
572 AnUsage = new AnalysisUsage();
573 P->getAnalysisUsage(*AnUsage);
574 AnUsageMap[P] = AnUsage;
579 /// Schedule pass P for execution. Make sure that passes required by
580 /// P are run before P is run. Update analysis info maintained by
581 /// the manager. Remove dead passes. This is a recursive function.
582 void PMTopLevelManager::schedulePass(Pass *P) {
584 // TODO : Allocate function manager for this pass, other wise required set
585 // may be inserted into previous function manager
587 // Give pass a chance to prepare the stage.
588 P->preparePassManager(activeStack);
590 // If P is an analysis pass and it is available then do not
591 // generate the analysis again. Stale analysis info should not be
592 // available at this point.
594 PassRegistry::getPassRegistry()->getPassInfo(P->getPassID());
595 if (PI && PI->isAnalysis() && findAnalysisPass(P->getPassID())) {
600 AnalysisUsage *AnUsage = findAnalysisUsage(P);
602 bool checkAnalysis = true;
603 while (checkAnalysis) {
604 checkAnalysis = false;
606 const AnalysisUsage::VectorType &RequiredSet = AnUsage->getRequiredSet();
607 for (AnalysisUsage::VectorType::const_iterator I = RequiredSet.begin(),
608 E = RequiredSet.end(); I != E; ++I) {
610 Pass *AnalysisPass = findAnalysisPass(*I);
612 const PassInfo *PI = PassRegistry::getPassRegistry()->getPassInfo(*I);
613 assert(PI && "Expected required passes to be initialized");
614 AnalysisPass = PI->createPass();
615 if (P->getPotentialPassManagerType () ==
616 AnalysisPass->getPotentialPassManagerType())
617 // Schedule analysis pass that is managed by the same pass manager.
618 schedulePass(AnalysisPass);
619 else if (P->getPotentialPassManagerType () >
620 AnalysisPass->getPotentialPassManagerType()) {
621 // Schedule analysis pass that is managed by a new manager.
622 schedulePass(AnalysisPass);
623 // Recheck analysis passes to ensure that required analyses that
624 // are already checked are still available.
625 checkAnalysis = true;
628 // Do not schedule this analysis. Lower level analsyis
629 // passes are run on the fly.
635 // Now all required passes are available.
636 if (ImmutablePass *IP = P->getAsImmutablePass()) {
637 // P is a immutable pass and it will be managed by this
638 // top level manager. Set up analysis resolver to connect them.
639 PMDataManager *DM = getAsPMDataManager();
640 AnalysisResolver *AR = new AnalysisResolver(*DM);
642 DM->initializeAnalysisImpl(P);
643 addImmutablePass(IP);
644 DM->recordAvailableAnalysis(IP);
648 if (PI && !PI->isAnalysis() && ShouldPrintBeforePass(PI)) {
649 Pass *PP = P->createPrinterPass(
650 dbgs(), std::string("*** IR Dump Before ") + P->getPassName() + " ***");
651 PP->assignPassManager(activeStack, getTopLevelPassManagerType());
654 // Add the requested pass to the best available pass manager.
655 P->assignPassManager(activeStack, getTopLevelPassManagerType());
657 if (PI && !PI->isAnalysis() && ShouldPrintAfterPass(PI)) {
658 Pass *PP = P->createPrinterPass(
659 dbgs(), std::string("*** IR Dump After ") + P->getPassName() + " ***");
660 PP->assignPassManager(activeStack, getTopLevelPassManagerType());
664 /// Find the pass that implements Analysis AID. Search immutable
665 /// passes and all pass managers. If desired pass is not found
666 /// then return NULL.
667 Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
669 // Check pass managers
670 for (SmallVectorImpl<PMDataManager *>::iterator I = PassManagers.begin(),
671 E = PassManagers.end(); I != E; ++I)
672 if (Pass *P = (*I)->findAnalysisPass(AID, false))
675 // Check other pass managers
676 for (SmallVectorImpl<PMDataManager *>::iterator
677 I = IndirectPassManagers.begin(),
678 E = IndirectPassManagers.end(); I != E; ++I)
679 if (Pass *P = (*I)->findAnalysisPass(AID, false))
682 // Check the immutable passes. Iterate in reverse order so that we find
683 // the most recently registered passes first.
684 for (SmallVector<ImmutablePass *, 8>::reverse_iterator I =
685 ImmutablePasses.rbegin(), E = ImmutablePasses.rend(); I != E; ++I) {
686 AnalysisID PI = (*I)->getPassID();
690 // If Pass not found then check the interfaces implemented by Immutable Pass
691 const PassInfo *PassInf =
692 PassRegistry::getPassRegistry()->getPassInfo(PI);
693 assert(PassInf && "Expected all immutable passes to be initialized");
694 const std::vector<const PassInfo*> &ImmPI =
695 PassInf->getInterfacesImplemented();
696 for (std::vector<const PassInfo*>::const_iterator II = ImmPI.begin(),
697 EE = ImmPI.end(); II != EE; ++II) {
698 if ((*II)->getTypeInfo() == AID)
706 // Print passes managed by this top level manager.
707 void PMTopLevelManager::dumpPasses() const {
709 if (PassDebugging < Structure)
712 // Print out the immutable passes
713 for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
714 ImmutablePasses[i]->dumpPassStructure(0);
717 // Every class that derives from PMDataManager also derives from Pass
718 // (sometimes indirectly), but there's no inheritance relationship
719 // between PMDataManager and Pass, so we have to getAsPass to get
720 // from a PMDataManager* to a Pass*.
721 for (SmallVector<PMDataManager *, 8>::const_iterator I = PassManagers.begin(),
722 E = PassManagers.end(); I != E; ++I)
723 (*I)->getAsPass()->dumpPassStructure(1);
726 void PMTopLevelManager::dumpArguments() const {
728 if (PassDebugging < Arguments)
731 dbgs() << "Pass Arguments: ";
732 for (SmallVector<ImmutablePass *, 8>::const_iterator I =
733 ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
734 if (const PassInfo *PI =
735 PassRegistry::getPassRegistry()->getPassInfo((*I)->getPassID())) {
736 assert(PI && "Expected all immutable passes to be initialized");
737 if (!PI->isAnalysisGroup())
738 dbgs() << " -" << PI->getPassArgument();
740 for (SmallVector<PMDataManager *, 8>::const_iterator I = PassManagers.begin(),
741 E = PassManagers.end(); I != E; ++I)
742 (*I)->dumpPassArguments();
746 void PMTopLevelManager::initializeAllAnalysisInfo() {
747 for (SmallVectorImpl<PMDataManager *>::iterator I = PassManagers.begin(),
748 E = PassManagers.end(); I != E; ++I)
749 (*I)->initializeAnalysisInfo();
751 // Initailize other pass managers
752 for (SmallVectorImpl<PMDataManager *>::iterator
753 I = IndirectPassManagers.begin(), E = IndirectPassManagers.end();
755 (*I)->initializeAnalysisInfo();
757 for (DenseMap<Pass *, Pass *>::iterator DMI = LastUser.begin(),
758 DME = LastUser.end(); DMI != DME; ++DMI) {
759 DenseMap<Pass *, SmallPtrSet<Pass *, 8> >::iterator InvDMI =
760 InversedLastUser.find(DMI->second);
761 if (InvDMI != InversedLastUser.end()) {
762 SmallPtrSet<Pass *, 8> &L = InvDMI->second;
763 L.insert(DMI->first);
765 SmallPtrSet<Pass *, 8> L; L.insert(DMI->first);
766 InversedLastUser[DMI->second] = L;
772 PMTopLevelManager::~PMTopLevelManager() {
773 for (SmallVectorImpl<PMDataManager *>::iterator I = PassManagers.begin(),
774 E = PassManagers.end(); I != E; ++I)
777 for (SmallVectorImpl<ImmutablePass *>::iterator
778 I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
781 for (DenseMap<Pass *, AnalysisUsage *>::iterator DMI = AnUsageMap.begin(),
782 DME = AnUsageMap.end(); DMI != DME; ++DMI)
786 //===----------------------------------------------------------------------===//
787 // PMDataManager implementation
789 /// Augement AvailableAnalysis by adding analysis made available by pass P.
790 void PMDataManager::recordAvailableAnalysis(Pass *P) {
791 AnalysisID PI = P->getPassID();
793 AvailableAnalysis[PI] = P;
795 assert(!AvailableAnalysis.empty());
797 // This pass is the current implementation of all of the interfaces it
798 // implements as well.
799 const PassInfo *PInf = PassRegistry::getPassRegistry()->getPassInfo(PI);
800 if (PInf == 0) return;
801 const std::vector<const PassInfo*> &II = PInf->getInterfacesImplemented();
802 for (unsigned i = 0, e = II.size(); i != e; ++i)
803 AvailableAnalysis[II[i]->getTypeInfo()] = P;
806 // Return true if P preserves high level analysis used by other
807 // passes managed by this manager
808 bool PMDataManager::preserveHigherLevelAnalysis(Pass *P) {
809 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
810 if (AnUsage->getPreservesAll())
813 const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
814 for (SmallVectorImpl<Pass *>::iterator I = HigherLevelAnalysis.begin(),
815 E = HigherLevelAnalysis.end(); I != E; ++I) {
817 if (P1->getAsImmutablePass() == 0 &&
818 std::find(PreservedSet.begin(), PreservedSet.end(),
827 /// verifyPreservedAnalysis -- Verify analysis preserved by pass P.
828 void PMDataManager::verifyPreservedAnalysis(Pass *P) {
829 // Don't do this unless assertions are enabled.
833 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
834 const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
836 // Verify preserved analysis
837 for (AnalysisUsage::VectorType::const_iterator I = PreservedSet.begin(),
838 E = PreservedSet.end(); I != E; ++I) {
840 if (Pass *AP = findAnalysisPass(AID, true)) {
841 TimeRegion PassTimer(getPassTimer(AP));
842 AP->verifyAnalysis();
847 /// Remove Analysis not preserved by Pass P
848 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
849 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
850 if (AnUsage->getPreservesAll())
853 const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
854 for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
855 E = AvailableAnalysis.end(); I != E; ) {
856 std::map<AnalysisID, Pass*>::iterator Info = I++;
857 if (Info->second->getAsImmutablePass() == 0 &&
858 std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
859 PreservedSet.end()) {
860 // Remove this analysis
861 if (PassDebugging >= Details) {
862 Pass *S = Info->second;
863 dbgs() << " -- '" << P->getPassName() << "' is not preserving '";
864 dbgs() << S->getPassName() << "'\n";
866 AvailableAnalysis.erase(Info);
870 // Check inherited analysis also. If P is not preserving analysis
871 // provided by parent manager then remove it here.
872 for (unsigned Index = 0; Index < PMT_Last; ++Index) {
874 if (!InheritedAnalysis[Index])
877 for (std::map<AnalysisID, Pass*>::iterator
878 I = InheritedAnalysis[Index]->begin(),
879 E = InheritedAnalysis[Index]->end(); I != E; ) {
880 std::map<AnalysisID, Pass *>::iterator Info = I++;
881 if (Info->second->getAsImmutablePass() == 0 &&
882 std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
883 PreservedSet.end()) {
884 // Remove this analysis
885 if (PassDebugging >= Details) {
886 Pass *S = Info->second;
887 dbgs() << " -- '" << P->getPassName() << "' is not preserving '";
888 dbgs() << S->getPassName() << "'\n";
890 InheritedAnalysis[Index]->erase(Info);
896 /// Remove analysis passes that are not used any longer
897 void PMDataManager::removeDeadPasses(Pass *P, StringRef Msg,
898 enum PassDebuggingString DBG_STR) {
900 SmallVector<Pass *, 12> DeadPasses;
902 // If this is a on the fly manager then it does not have TPM.
906 TPM->collectLastUses(DeadPasses, P);
908 if (PassDebugging >= Details && !DeadPasses.empty()) {
909 dbgs() << " -*- '" << P->getPassName();
910 dbgs() << "' is the last user of following pass instances.";
911 dbgs() << " Free these instances\n";
914 for (SmallVectorImpl<Pass *>::iterator I = DeadPasses.begin(),
915 E = DeadPasses.end(); I != E; ++I)
916 freePass(*I, Msg, DBG_STR);
919 void PMDataManager::freePass(Pass *P, StringRef Msg,
920 enum PassDebuggingString DBG_STR) {
921 dumpPassInfo(P, FREEING_MSG, DBG_STR, Msg);
924 // If the pass crashes releasing memory, remember this.
925 PassManagerPrettyStackEntry X(P);
926 TimeRegion PassTimer(getPassTimer(P));
931 AnalysisID PI = P->getPassID();
932 if (const PassInfo *PInf = PassRegistry::getPassRegistry()->getPassInfo(PI)) {
933 // Remove the pass itself (if it is not already removed).
934 AvailableAnalysis.erase(PI);
936 // Remove all interfaces this pass implements, for which it is also
937 // listed as the available implementation.
938 const std::vector<const PassInfo*> &II = PInf->getInterfacesImplemented();
939 for (unsigned i = 0, e = II.size(); i != e; ++i) {
940 std::map<AnalysisID, Pass*>::iterator Pos =
941 AvailableAnalysis.find(II[i]->getTypeInfo());
942 if (Pos != AvailableAnalysis.end() && Pos->second == P)
943 AvailableAnalysis.erase(Pos);
948 /// Add pass P into the PassVector. Update
949 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
950 void PMDataManager::add(Pass *P, bool ProcessAnalysis) {
951 // This manager is going to manage pass P. Set up analysis resolver
953 AnalysisResolver *AR = new AnalysisResolver(*this);
956 // If a FunctionPass F is the last user of ModulePass info M
957 // then the F's manager, not F, records itself as a last user of M.
958 SmallVector<Pass *, 12> TransferLastUses;
960 if (!ProcessAnalysis) {
962 PassVector.push_back(P);
966 // At the moment, this pass is the last user of all required passes.
967 SmallVector<Pass *, 12> LastUses;
968 SmallVector<Pass *, 8> RequiredPasses;
969 SmallVector<AnalysisID, 8> ReqAnalysisNotAvailable;
971 unsigned PDepth = this->getDepth();
973 collectRequiredAnalysis(RequiredPasses,
974 ReqAnalysisNotAvailable, P);
975 for (SmallVectorImpl<Pass *>::iterator I = RequiredPasses.begin(),
976 E = RequiredPasses.end(); I != E; ++I) {
977 Pass *PRequired = *I;
980 assert(PRequired->getResolver() && "Analysis Resolver is not set");
981 PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
982 RDepth = DM.getDepth();
984 if (PDepth == RDepth)
985 LastUses.push_back(PRequired);
986 else if (PDepth > RDepth) {
987 // Let the parent claim responsibility of last use
988 TransferLastUses.push_back(PRequired);
989 // Keep track of higher level analysis used by this manager.
990 HigherLevelAnalysis.push_back(PRequired);
992 llvm_unreachable("Unable to accommodate Required Pass");
995 // Set P as P's last user until someone starts using P.
996 // However, if P is a Pass Manager then it does not need
997 // to record its last user.
998 if (P->getAsPMDataManager() == 0)
999 LastUses.push_back(P);
1000 TPM->setLastUser(LastUses, P);
1002 if (!TransferLastUses.empty()) {
1003 Pass *My_PM = getAsPass();
1004 TPM->setLastUser(TransferLastUses, My_PM);
1005 TransferLastUses.clear();
1008 // Now, take care of required analyses that are not available.
1009 for (SmallVectorImpl<AnalysisID>::iterator
1010 I = ReqAnalysisNotAvailable.begin(),
1011 E = ReqAnalysisNotAvailable.end() ;I != E; ++I) {
1012 const PassInfo *PI = PassRegistry::getPassRegistry()->getPassInfo(*I);
1013 Pass *AnalysisPass = PI->createPass();
1014 this->addLowerLevelRequiredPass(P, AnalysisPass);
1017 // Take a note of analysis required and made available by this pass.
1018 // Remove the analysis not preserved by this pass
1019 removeNotPreservedAnalysis(P);
1020 recordAvailableAnalysis(P);
1023 PassVector.push_back(P);
1027 /// Populate RP with analysis pass that are required by
1028 /// pass P and are available. Populate RP_NotAvail with analysis
1029 /// pass that are required by pass P but are not available.
1030 void PMDataManager::collectRequiredAnalysis(SmallVectorImpl<Pass *> &RP,
1031 SmallVectorImpl<AnalysisID> &RP_NotAvail,
1033 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
1034 const AnalysisUsage::VectorType &RequiredSet = AnUsage->getRequiredSet();
1035 for (AnalysisUsage::VectorType::const_iterator
1036 I = RequiredSet.begin(), E = RequiredSet.end(); I != E; ++I) {
1037 if (Pass *AnalysisPass = findAnalysisPass(*I, true))
1038 RP.push_back(AnalysisPass);
1040 RP_NotAvail.push_back(*I);
1043 const AnalysisUsage::VectorType &IDs = AnUsage->getRequiredTransitiveSet();
1044 for (AnalysisUsage::VectorType::const_iterator I = IDs.begin(),
1045 E = IDs.end(); I != E; ++I) {
1046 if (Pass *AnalysisPass = findAnalysisPass(*I, true))
1047 RP.push_back(AnalysisPass);
1049 RP_NotAvail.push_back(*I);
1053 // All Required analyses should be available to the pass as it runs! Here
1054 // we fill in the AnalysisImpls member of the pass so that it can
1055 // successfully use the getAnalysis() method to retrieve the
1056 // implementations it needs.
1058 void PMDataManager::initializeAnalysisImpl(Pass *P) {
1059 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
1061 for (AnalysisUsage::VectorType::const_iterator
1062 I = AnUsage->getRequiredSet().begin(),
1063 E = AnUsage->getRequiredSet().end(); I != E; ++I) {
1064 Pass *Impl = findAnalysisPass(*I, true);
1066 // This may be analysis pass that is initialized on the fly.
1067 // If that is not the case then it will raise an assert when it is used.
1069 AnalysisResolver *AR = P->getResolver();
1070 assert(AR && "Analysis Resolver is not set");
1071 AR->addAnalysisImplsPair(*I, Impl);
1075 /// Find the pass that implements Analysis AID. If desired pass is not found
1076 /// then return NULL.
1077 Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
1079 // Check if AvailableAnalysis map has one entry.
1080 std::map<AnalysisID, Pass*>::const_iterator I = AvailableAnalysis.find(AID);
1082 if (I != AvailableAnalysis.end())
1085 // Search Parents through TopLevelManager
1087 return TPM->findAnalysisPass(AID);
1092 // Print list of passes that are last used by P.
1093 void PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{
1095 SmallVector<Pass *, 12> LUses;
1097 // If this is a on the fly manager then it does not have TPM.
1101 TPM->collectLastUses(LUses, P);
1103 for (SmallVectorImpl<Pass *>::iterator I = LUses.begin(),
1104 E = LUses.end(); I != E; ++I) {
1105 llvm::dbgs() << "--" << std::string(Offset*2, ' ');
1106 (*I)->dumpPassStructure(0);
1110 void PMDataManager::dumpPassArguments() const {
1111 for (SmallVectorImpl<Pass *>::const_iterator I = PassVector.begin(),
1112 E = PassVector.end(); I != E; ++I) {
1113 if (PMDataManager *PMD = (*I)->getAsPMDataManager())
1114 PMD->dumpPassArguments();
1116 if (const PassInfo *PI =
1117 PassRegistry::getPassRegistry()->getPassInfo((*I)->getPassID()))
1118 if (!PI->isAnalysisGroup())
1119 dbgs() << " -" << PI->getPassArgument();
1123 void PMDataManager::dumpPassInfo(Pass *P, enum PassDebuggingString S1,
1124 enum PassDebuggingString S2,
1126 if (PassDebugging < Executions)
1128 dbgs() << (void*)this << std::string(getDepth()*2+1, ' ');
1131 dbgs() << "Executing Pass '" << P->getPassName();
1133 case MODIFICATION_MSG:
1134 dbgs() << "Made Modification '" << P->getPassName();
1137 dbgs() << " Freeing Pass '" << P->getPassName();
1143 case ON_BASICBLOCK_MSG:
1144 dbgs() << "' on BasicBlock '" << Msg << "'...\n";
1146 case ON_FUNCTION_MSG:
1147 dbgs() << "' on Function '" << Msg << "'...\n";
1150 dbgs() << "' on Module '" << Msg << "'...\n";
1153 dbgs() << "' on Region '" << Msg << "'...\n";
1156 dbgs() << "' on Loop '" << Msg << "'...\n";
1159 dbgs() << "' on Call Graph Nodes '" << Msg << "'...\n";
1166 void PMDataManager::dumpRequiredSet(const Pass *P) const {
1167 if (PassDebugging < Details)
1170 AnalysisUsage analysisUsage;
1171 P->getAnalysisUsage(analysisUsage);
1172 dumpAnalysisUsage("Required", P, analysisUsage.getRequiredSet());
1175 void PMDataManager::dumpPreservedSet(const Pass *P) const {
1176 if (PassDebugging < Details)
1179 AnalysisUsage analysisUsage;
1180 P->getAnalysisUsage(analysisUsage);
1181 dumpAnalysisUsage("Preserved", P, analysisUsage.getPreservedSet());
1184 void PMDataManager::dumpAnalysisUsage(StringRef Msg, const Pass *P,
1185 const AnalysisUsage::VectorType &Set) const {
1186 assert(PassDebugging >= Details);
1189 dbgs() << (void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:";
1190 for (unsigned i = 0; i != Set.size(); ++i) {
1191 if (i) dbgs() << ',';
1192 const PassInfo *PInf = PassRegistry::getPassRegistry()->getPassInfo(Set[i]);
1194 // Some preserved passes, such as AliasAnalysis, may not be initialized by
1196 dbgs() << " Uninitialized Pass";
1199 dbgs() << ' ' << PInf->getPassName();
1204 /// Add RequiredPass into list of lower level passes required by pass P.
1205 /// RequiredPass is run on the fly by Pass Manager when P requests it
1206 /// through getAnalysis interface.
1207 /// This should be handled by specific pass manager.
1208 void PMDataManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
1210 TPM->dumpArguments();
1214 // Module Level pass may required Function Level analysis info
1215 // (e.g. dominator info). Pass manager uses on the fly function pass manager
1216 // to provide this on demand. In that case, in Pass manager terminology,
1217 // module level pass is requiring lower level analysis info managed by
1218 // lower level pass manager.
1220 // When Pass manager is not able to order required analysis info, Pass manager
1221 // checks whether any lower level manager will be able to provide this
1222 // analysis info on demand or not.
1224 dbgs() << "Unable to schedule '" << RequiredPass->getPassName();
1225 dbgs() << "' required by '" << P->getPassName() << "'\n";
1227 llvm_unreachable("Unable to schedule pass");
1230 Pass *PMDataManager::getOnTheFlyPass(Pass *P, AnalysisID PI, Function &F) {
1231 llvm_unreachable("Unable to find on the fly pass");
1235 PMDataManager::~PMDataManager() {
1236 for (SmallVectorImpl<Pass *>::iterator I = PassVector.begin(),
1237 E = PassVector.end(); I != E; ++I)
1241 //===----------------------------------------------------------------------===//
1242 // NOTE: Is this the right place to define this method ?
1243 // getAnalysisIfAvailable - Return analysis result or null if it doesn't exist.
1244 Pass *AnalysisResolver::getAnalysisIfAvailable(AnalysisID ID, bool dir) const {
1245 return PM.findAnalysisPass(ID, dir);
1248 Pass *AnalysisResolver::findImplPass(Pass *P, AnalysisID AnalysisPI,
1250 return PM.getOnTheFlyPass(P, AnalysisPI, F);
1253 //===----------------------------------------------------------------------===//
1254 // BBPassManager implementation
1256 /// Execute all of the passes scheduled for execution by invoking
1257 /// runOnBasicBlock method. Keep track of whether any of the passes modifies
1258 /// the function, and if so, return true.
1259 bool BBPassManager::runOnFunction(Function &F) {
1260 if (F.isDeclaration())
1263 bool Changed = doInitialization(F);
1265 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
1266 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1267 BasicBlockPass *BP = getContainedPass(Index);
1268 bool LocalChanged = false;
1270 dumpPassInfo(BP, EXECUTION_MSG, ON_BASICBLOCK_MSG, I->getName());
1271 dumpRequiredSet(BP);
1273 initializeAnalysisImpl(BP);
1276 // If the pass crashes, remember this.
1277 PassManagerPrettyStackEntry X(BP, *I);
1278 TimeRegion PassTimer(getPassTimer(BP));
1280 LocalChanged |= BP->runOnBasicBlock(*I);
1283 Changed |= LocalChanged;
1285 dumpPassInfo(BP, MODIFICATION_MSG, ON_BASICBLOCK_MSG,
1287 dumpPreservedSet(BP);
1289 verifyPreservedAnalysis(BP);
1290 removeNotPreservedAnalysis(BP);
1291 recordAvailableAnalysis(BP);
1292 removeDeadPasses(BP, I->getName(), ON_BASICBLOCK_MSG);
1295 return doFinalization(F) || Changed;
1298 // Implement doInitialization and doFinalization
1299 bool BBPassManager::doInitialization(Module &M) {
1300 bool Changed = false;
1302 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1303 Changed |= getContainedPass(Index)->doInitialization(M);
1308 bool BBPassManager::doFinalization(Module &M) {
1309 bool Changed = false;
1311 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1312 Changed |= getContainedPass(Index)->doFinalization(M);
1317 bool BBPassManager::doInitialization(Function &F) {
1318 bool Changed = false;
1320 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1321 BasicBlockPass *BP = getContainedPass(Index);
1322 Changed |= BP->doInitialization(F);
1328 bool BBPassManager::doFinalization(Function &F) {
1329 bool Changed = false;
1331 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1332 BasicBlockPass *BP = getContainedPass(Index);
1333 Changed |= BP->doFinalization(F);
1340 //===----------------------------------------------------------------------===//
1341 // FunctionPassManager implementation
1343 /// Create new Function pass manager
1344 FunctionPassManager::FunctionPassManager(Module *m) : M(m) {
1345 FPM = new FunctionPassManagerImpl();
1346 // FPM is the top level manager.
1347 FPM->setTopLevelManager(FPM);
1349 AnalysisResolver *AR = new AnalysisResolver(*FPM);
1350 FPM->setResolver(AR);
1353 FunctionPassManager::~FunctionPassManager() {
1357 /// add - Add a pass to the queue of passes to run. This passes
1358 /// ownership of the Pass to the PassManager. When the
1359 /// PassManager_X is destroyed, the pass will be destroyed as well, so
1360 /// there is no need to delete the pass. (TODO delete passes.)
1361 /// This implies that all passes MUST be allocated with 'new'.
1362 void FunctionPassManager::add(Pass *P) {
1366 /// run - Execute all of the passes scheduled for execution. Keep
1367 /// track of whether any of the passes modifies the function, and if
1368 /// so, return true.
1370 bool FunctionPassManager::run(Function &F) {
1371 if (F.isMaterializable()) {
1373 if (F.Materialize(&errstr))
1374 report_fatal_error("Error reading bitcode file: " + Twine(errstr));
1380 /// doInitialization - Run all of the initializers for the function passes.
1382 bool FunctionPassManager::doInitialization() {
1383 return FPM->doInitialization(*M);
1386 /// doFinalization - Run all of the finalizers for the function passes.
1388 bool FunctionPassManager::doFinalization() {
1389 return FPM->doFinalization(*M);
1392 //===----------------------------------------------------------------------===//
1393 // FunctionPassManagerImpl implementation
1395 bool FunctionPassManagerImpl::doInitialization(Module &M) {
1396 bool Changed = false;
1401 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1402 Changed |= getContainedManager(Index)->doInitialization(M);
1407 bool FunctionPassManagerImpl::doFinalization(Module &M) {
1408 bool Changed = false;
1410 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1411 Changed |= getContainedManager(Index)->doFinalization(M);
1416 /// cleanup - After running all passes, clean up pass manager cache.
1417 void FPPassManager::cleanup() {
1418 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1419 FunctionPass *FP = getContainedPass(Index);
1420 AnalysisResolver *AR = FP->getResolver();
1421 assert(AR && "Analysis Resolver is not set");
1422 AR->clearAnalysisImpls();
1426 void FunctionPassManagerImpl::releaseMemoryOnTheFly() {
1429 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1430 FPPassManager *FPPM = getContainedManager(Index);
1431 for (unsigned Index = 0; Index < FPPM->getNumContainedPasses(); ++Index) {
1432 FPPM->getContainedPass(Index)->releaseMemory();
1438 // Execute all the passes managed by this top level manager.
1439 // Return true if any function is modified by a pass.
1440 bool FunctionPassManagerImpl::run(Function &F) {
1441 bool Changed = false;
1442 TimingInfo::createTheTimeInfo();
1443 createDebugInfoProbe();
1445 initializeAllAnalysisInfo();
1446 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1447 Changed |= getContainedManager(Index)->runOnFunction(F);
1449 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1450 getContainedManager(Index)->cleanup();
1456 //===----------------------------------------------------------------------===//
1457 // FPPassManager implementation
1459 char FPPassManager::ID = 0;
1460 /// Print passes managed by this manager
1461 void FPPassManager::dumpPassStructure(unsigned Offset) {
1462 dbgs().indent(Offset*2) << "FunctionPass Manager\n";
1463 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1464 FunctionPass *FP = getContainedPass(Index);
1465 FP->dumpPassStructure(Offset + 1);
1466 dumpLastUses(FP, Offset+1);
1471 /// Execute all of the passes scheduled for execution by invoking
1472 /// runOnFunction method. Keep track of whether any of the passes modifies
1473 /// the function, and if so, return true.
1474 bool FPPassManager::runOnFunction(Function &F) {
1475 if (F.isDeclaration())
1478 bool Changed = false;
1480 // Collect inherited analysis from Module level pass manager.
1481 populateInheritedAnalysis(TPM->activeStack);
1483 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1484 FunctionPass *FP = getContainedPass(Index);
1485 bool LocalChanged = false;
1487 dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getName());
1488 dumpRequiredSet(FP);
1490 initializeAnalysisImpl(FP);
1492 TheDebugProbe->initialize(FP, F);
1494 PassManagerPrettyStackEntry X(FP, F);
1495 TimeRegion PassTimer(getPassTimer(FP));
1497 LocalChanged |= FP->runOnFunction(F);
1500 TheDebugProbe->finalize(FP, F);
1502 Changed |= LocalChanged;
1504 dumpPassInfo(FP, MODIFICATION_MSG, ON_FUNCTION_MSG, F.getName());
1505 dumpPreservedSet(FP);
1507 verifyPreservedAnalysis(FP);
1508 removeNotPreservedAnalysis(FP);
1509 recordAvailableAnalysis(FP);
1510 removeDeadPasses(FP, F.getName(), ON_FUNCTION_MSG);
1515 bool FPPassManager::runOnModule(Module &M) {
1516 bool Changed = doInitialization(M);
1518 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1519 Changed |= runOnFunction(*I);
1521 return doFinalization(M) || Changed;
1524 bool FPPassManager::doInitialization(Module &M) {
1525 bool Changed = false;
1527 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1528 Changed |= getContainedPass(Index)->doInitialization(M);
1533 bool FPPassManager::doFinalization(Module &M) {
1534 bool Changed = false;
1536 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1537 Changed |= getContainedPass(Index)->doFinalization(M);
1542 //===----------------------------------------------------------------------===//
1543 // MPPassManager implementation
1545 /// Execute all of the passes scheduled for execution by invoking
1546 /// runOnModule method. Keep track of whether any of the passes modifies
1547 /// the module, and if so, return true.
1549 MPPassManager::runOnModule(Module &M) {
1550 bool Changed = false;
1552 // Initialize on-the-fly passes
1553 for (std::map<Pass *, FunctionPassManagerImpl *>::iterator
1554 I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end();
1556 FunctionPassManagerImpl *FPP = I->second;
1557 Changed |= FPP->doInitialization(M);
1560 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1561 ModulePass *MP = getContainedPass(Index);
1562 bool LocalChanged = false;
1564 dumpPassInfo(MP, EXECUTION_MSG, ON_MODULE_MSG, M.getModuleIdentifier());
1565 dumpRequiredSet(MP);
1567 initializeAnalysisImpl(MP);
1570 PassManagerPrettyStackEntry X(MP, M);
1571 TimeRegion PassTimer(getPassTimer(MP));
1573 LocalChanged |= MP->runOnModule(M);
1576 Changed |= LocalChanged;
1578 dumpPassInfo(MP, MODIFICATION_MSG, ON_MODULE_MSG,
1579 M.getModuleIdentifier());
1580 dumpPreservedSet(MP);
1582 verifyPreservedAnalysis(MP);
1583 removeNotPreservedAnalysis(MP);
1584 recordAvailableAnalysis(MP);
1585 removeDeadPasses(MP, M.getModuleIdentifier(), ON_MODULE_MSG);
1588 // Finalize on-the-fly passes
1589 for (std::map<Pass *, FunctionPassManagerImpl *>::iterator
1590 I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end();
1592 FunctionPassManagerImpl *FPP = I->second;
1593 // We don't know when is the last time an on-the-fly pass is run,
1594 // so we need to releaseMemory / finalize here
1595 FPP->releaseMemoryOnTheFly();
1596 Changed |= FPP->doFinalization(M);
1601 /// Add RequiredPass into list of lower level passes required by pass P.
1602 /// RequiredPass is run on the fly by Pass Manager when P requests it
1603 /// through getAnalysis interface.
1604 void MPPassManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
1605 assert(P->getPotentialPassManagerType() == PMT_ModulePassManager &&
1606 "Unable to handle Pass that requires lower level Analysis pass");
1607 assert((P->getPotentialPassManagerType() <
1608 RequiredPass->getPotentialPassManagerType()) &&
1609 "Unable to handle Pass that requires lower level Analysis pass");
1611 FunctionPassManagerImpl *FPP = OnTheFlyManagers[P];
1613 FPP = new FunctionPassManagerImpl();
1614 // FPP is the top level manager.
1615 FPP->setTopLevelManager(FPP);
1617 OnTheFlyManagers[P] = FPP;
1619 FPP->add(RequiredPass);
1621 // Register P as the last user of RequiredPass.
1623 SmallVector<Pass *, 1> LU;
1624 LU.push_back(RequiredPass);
1625 FPP->setLastUser(LU, P);
1629 /// Return function pass corresponding to PassInfo PI, that is
1630 /// required by module pass MP. Instantiate analysis pass, by using
1631 /// its runOnFunction() for function F.
1632 Pass* MPPassManager::getOnTheFlyPass(Pass *MP, AnalysisID PI, Function &F){
1633 FunctionPassManagerImpl *FPP = OnTheFlyManagers[MP];
1634 assert(FPP && "Unable to find on the fly pass");
1636 FPP->releaseMemoryOnTheFly();
1638 return ((PMTopLevelManager*)FPP)->findAnalysisPass(PI);
1642 //===----------------------------------------------------------------------===//
1643 // PassManagerImpl implementation
1645 /// run - Execute all of the passes scheduled for execution. Keep track of
1646 /// whether any of the passes modifies the module, and if so, return true.
1647 bool PassManagerImpl::run(Module &M) {
1648 bool Changed = false;
1649 TimingInfo::createTheTimeInfo();
1650 createDebugInfoProbe();
1655 initializeAllAnalysisInfo();
1656 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1657 Changed |= getContainedManager(Index)->runOnModule(M);
1661 //===----------------------------------------------------------------------===//
1662 // PassManager implementation
1664 /// Create new pass manager
1665 PassManager::PassManager() {
1666 PM = new PassManagerImpl();
1667 // PM is the top level manager
1668 PM->setTopLevelManager(PM);
1671 PassManager::~PassManager() {
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) {
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) {
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.
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"));
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;
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;
1712 /// If TimingInfo is enabled then start pass timer.
1713 Timer *llvm::getPassTimer(Pass *P) {
1715 return TheTimeInfo->getPassTimer(P);
1719 //===----------------------------------------------------------------------===//
1720 // PMStack implementation
1723 // Pop Pass Manager from the stack and clear its analysis info.
1724 void PMStack::pop() {
1726 PMDataManager *Top = this->top();
1727 Top->initializeAnalysisInfo();
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");
1737 if (!this->empty()) {
1738 assert(PM->getPassManagerType() > this->top()->getPassManagerType()
1739 && "pushing bad pass manager to PMStack");
1740 PMTopLevelManager *TPM = this->top()->getTopLevelManager();
1742 assert(TPM && "Unable to find top level manager");
1743 TPM->addIndirectPassManager(PM);
1744 PM->setTopLevelManager(TPM);
1745 PM->setDepth(this->top()->getDepth()+1);
1748 assert((PM->getPassManagerType() == PMT_ModulePassManager
1749 || PM->getPassManagerType() == PMT_FunctionPassManager)
1750 && "pushing bad pass manager to PMStack");
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() << ' ';
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
1781 assert(!PMS.empty() && "Unable to find appropriate Pass Manager");
1782 PMS.top()->add(this);
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) {
1790 // Find Function Pass Manager
1791 while (!PMS.empty()) {
1792 if (PMS.top()->getPassManagerType() > PMT_FunctionPassManager)
1798 // Create new Function Pass Manager if needed.
1800 if (PMS.top()->getPassManagerType() == PMT_FunctionPassManager) {
1801 FPP = (FPPassManager *)PMS.top();
1803 assert(!PMS.empty() && "Unable to create Function Pass Manager");
1804 PMDataManager *PMD = PMS.top();
1806 // [1] Create new Function Pass Manager
1807 FPP = new FPPassManager();
1808 FPP->populateInheritedAnalysis(PMS);
1810 // [2] Set up new manager's top level manager
1811 PMTopLevelManager *TPM = PMD->getTopLevelManager();
1812 TPM->addIndirectPassManager(FPP);
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());
1818 // [4] Push new manager into PMS
1822 // Assign FPP as the manager of this pass.
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) {
1832 // Basic Pass Manager is a leaf pass manager. It does not handle
1833 // any other pass manager.
1835 PMS.top()->getPassManagerType() == PMT_BasicBlockPassManager) {
1836 BBP = (BBPassManager *)PMS.top();
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();
1843 // [1] Create new Basic Block Manager
1844 BBP = new BBPassManager();
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);
1851 // [3] Assign manager to manage this new manager. This may create
1852 // and push new managers into PMS
1853 BBP->assignPassManager(PMS, PreferredType);
1855 // [4] Push new manager into PMS
1859 // Assign BBP as the manager of this pass.
1863 PassManagerBase::~PassManagerBase() {}