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/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/System/Mutex.h"
33 // See PassManagers.h for Pass Manager infrastructure overview.
37 //===----------------------------------------------------------------------===//
38 // Pass debugging information. Often it is useful to find out what pass is
39 // running when a crash occurs in a utility. When this library is compiled with
40 // debugging on, a command line option (--debug-pass) is enabled that causes the
41 // pass name to be printed before it executes.
44 // Different debug levels that can be enabled...
46 None, Arguments, Structure, Executions, Details
49 static cl::opt<enum PassDebugLevel>
50 PassDebugging("debug-pass", cl::Hidden,
51 cl::desc("Print PassManager debugging information"),
53 clEnumVal(None , "disable debug output"),
54 clEnumVal(Arguments , "print pass arguments to pass to 'opt'"),
55 clEnumVal(Structure , "print pass structure before run()"),
56 clEnumVal(Executions, "print pass name before it is executed"),
57 clEnumVal(Details , "print pass details when it is executed"),
60 typedef llvm::cl::list<const llvm::PassInfo *, bool, PassNameParser>
63 // Print IR out before/after specified passes.
65 PrintBefore("print-before",
66 llvm::cl::desc("Print IR before specified passes"));
69 PrintAfter("print-after",
70 llvm::cl::desc("Print IR after specified passes"));
73 PrintBeforeAll("print-before-all",
74 llvm::cl::desc("Print IR before each pass"),
77 PrintAfterAll("print-after-all",
78 llvm::cl::desc("Print IR after each pass"),
81 /// This is a helper to determine whether to print IR before or
84 static bool ShouldPrintBeforeOrAfterPass(const void *PassID,
85 PassOptionList &PassesToPrint) {
86 if (const llvm::PassInfo *PI =
87 PassRegistry::getPassRegistry()->getPassInfo(PassID)) {
88 for (unsigned i = 0, ie = PassesToPrint.size(); i < ie; ++i) {
89 const llvm::PassInfo *PassInf = PassesToPrint[i];
91 if (PassInf->getPassArgument() == PI->getPassArgument()) {
100 /// This is a utility to check whether a pass should have IR dumped
102 static bool ShouldPrintBeforePass(const void *PassID) {
103 return PrintBeforeAll || ShouldPrintBeforeOrAfterPass(PassID, PrintBefore);
106 /// This is a utility to check whether a pass should have IR dumped
108 static bool ShouldPrintAfterPass(const void *PassID) {
109 return PrintAfterAll || ShouldPrintBeforeOrAfterPass(PassID, PrintAfter);
112 } // End of llvm namespace
114 /// isPassDebuggingExecutionsOrMore - Return true if -debug-pass=Executions
115 /// or higher is specified.
116 bool PMDataManager::isPassDebuggingExecutionsOrMore() const {
117 return PassDebugging >= Executions;
123 void PassManagerPrettyStackEntry::print(raw_ostream &OS) const {
124 if (V == 0 && M == 0)
125 OS << "Releasing pass '";
127 OS << "Running pass '";
129 OS << P->getPassName() << "'";
132 OS << " on module '" << M->getModuleIdentifier() << "'.\n";
141 if (isa<Function>(V))
143 else if (isa<BasicBlock>(V))
149 WriteAsOperand(OS, V, /*PrintTy=*/false, M);
156 //===----------------------------------------------------------------------===//
159 /// BBPassManager manages BasicBlockPass. It batches all the
160 /// pass together and sequence them to process one basic block before
161 /// processing next basic block.
162 class BBPassManager : public PMDataManager, public FunctionPass {
166 explicit BBPassManager(int Depth)
167 : PMDataManager(Depth), FunctionPass(ID) {}
169 /// Execute all of the passes scheduled for execution. Keep track of
170 /// whether any of the passes modifies the function, and if so, return true.
171 bool runOnFunction(Function &F);
173 /// Pass Manager itself does not invalidate any analysis info.
174 void getAnalysisUsage(AnalysisUsage &Info) const {
175 Info.setPreservesAll();
178 bool doInitialization(Module &M);
179 bool doInitialization(Function &F);
180 bool doFinalization(Module &M);
181 bool doFinalization(Function &F);
183 virtual PMDataManager *getAsPMDataManager() { return this; }
184 virtual Pass *getAsPass() { return this; }
186 virtual const char *getPassName() const {
187 return "BasicBlock Pass Manager";
190 // Print passes managed by this manager
191 void dumpPassStructure(unsigned Offset) {
192 llvm::dbgs() << std::string(Offset*2, ' ') << "BasicBlockPass Manager\n";
193 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
194 BasicBlockPass *BP = getContainedPass(Index);
195 BP->dumpPassStructure(Offset + 1);
196 dumpLastUses(BP, Offset+1);
200 BasicBlockPass *getContainedPass(unsigned N) {
201 assert(N < PassVector.size() && "Pass number out of range!");
202 BasicBlockPass *BP = static_cast<BasicBlockPass *>(PassVector[N]);
206 virtual PassManagerType getPassManagerType() const {
207 return PMT_BasicBlockPassManager;
211 char BBPassManager::ID = 0;
216 //===----------------------------------------------------------------------===//
217 // FunctionPassManagerImpl
219 /// FunctionPassManagerImpl manages FPPassManagers
220 class FunctionPassManagerImpl : public Pass,
221 public PMDataManager,
222 public PMTopLevelManager {
227 explicit FunctionPassManagerImpl(int Depth) :
228 Pass(PT_PassManager, ID), PMDataManager(Depth),
229 PMTopLevelManager(TLM_Function), 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; }
264 /// Pass Manager itself does not invalidate any analysis info.
265 void getAnalysisUsage(AnalysisUsage &Info) const {
266 Info.setPreservesAll();
269 inline void addTopLevelPass(Pass *P) {
270 if (ImmutablePass *IP = P->getAsImmutablePass()) {
271 // P is a immutable pass and it will be managed by this
272 // top level manager. Set up analysis resolver to connect them.
273 AnalysisResolver *AR = new AnalysisResolver(*this);
275 initializeAnalysisImpl(P);
276 addImmutablePass(IP);
277 recordAvailableAnalysis(IP);
279 P->assignPassManager(activeStack, PMT_FunctionPassManager);
284 FPPassManager *getContainedManager(unsigned N) {
285 assert(N < PassManagers.size() && "Pass number out of range!");
286 FPPassManager *FP = static_cast<FPPassManager *>(PassManagers[N]);
291 char FunctionPassManagerImpl::ID = 0;
293 //===----------------------------------------------------------------------===//
296 /// MPPassManager manages ModulePasses and function pass managers.
297 /// It batches all Module passes and function pass managers together and
298 /// sequences them to process one module.
299 class MPPassManager : public Pass, public PMDataManager {
302 explicit MPPassManager(int Depth) :
303 Pass(PT_PassManager, ID), PMDataManager(Depth) { }
305 // Delete on the fly managers.
306 virtual ~MPPassManager() {
307 for (std::map<Pass *, FunctionPassManagerImpl *>::iterator
308 I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end();
310 FunctionPassManagerImpl *FPP = I->second;
315 /// createPrinterPass - Get a module printer pass.
316 Pass *createPrinterPass(raw_ostream &O, const std::string &Banner) const {
317 return createPrintModulePass(&O, false, Banner);
320 /// run - Execute all of the passes scheduled for execution. Keep track of
321 /// whether any of the passes modifies the module, and if so, return true.
322 bool runOnModule(Module &M);
324 /// Pass Manager itself does not invalidate any analysis info.
325 void getAnalysisUsage(AnalysisUsage &Info) const {
326 Info.setPreservesAll();
329 /// Add RequiredPass into list of lower level passes required by pass P.
330 /// RequiredPass is run on the fly by Pass Manager when P requests it
331 /// through getAnalysis interface.
332 virtual void addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass);
334 /// Return function pass corresponding to PassInfo PI, that is
335 /// required by module pass MP. Instantiate analysis pass, by using
336 /// its runOnFunction() for function F.
337 virtual Pass* getOnTheFlyPass(Pass *MP, AnalysisID PI, Function &F);
339 virtual const char *getPassName() const {
340 return "Module Pass Manager";
343 virtual PMDataManager *getAsPMDataManager() { return this; }
344 virtual Pass *getAsPass() { return this; }
346 // Print passes managed by this manager
347 void dumpPassStructure(unsigned Offset) {
348 llvm::dbgs() << std::string(Offset*2, ' ') << "ModulePass Manager\n";
349 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
350 ModulePass *MP = getContainedPass(Index);
351 MP->dumpPassStructure(Offset + 1);
352 std::map<Pass *, FunctionPassManagerImpl *>::const_iterator I =
353 OnTheFlyManagers.find(MP);
354 if (I != OnTheFlyManagers.end())
355 I->second->dumpPassStructure(Offset + 2);
356 dumpLastUses(MP, Offset+1);
360 ModulePass *getContainedPass(unsigned N) {
361 assert(N < PassVector.size() && "Pass number out of range!");
362 return static_cast<ModulePass *>(PassVector[N]);
365 virtual PassManagerType getPassManagerType() const {
366 return PMT_ModulePassManager;
370 /// Collection of on the fly FPPassManagers. These managers manage
371 /// function passes that are required by module passes.
372 std::map<Pass *, FunctionPassManagerImpl *> OnTheFlyManagers;
375 char MPPassManager::ID = 0;
376 //===----------------------------------------------------------------------===//
380 /// PassManagerImpl manages MPPassManagers
381 class PassManagerImpl : public Pass,
382 public PMDataManager,
383 public PMTopLevelManager {
387 explicit PassManagerImpl(int Depth) :
388 Pass(PT_PassManager, ID), PMDataManager(Depth),
389 PMTopLevelManager(TLM_Pass) { }
391 /// add - Add a pass to the queue of passes to run. This passes ownership of
392 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
393 /// will be destroyed as well, so there is no need to delete the pass. This
394 /// implies that all passes MUST be allocated with 'new'.
399 /// createPrinterPass - Get a module printer pass.
400 Pass *createPrinterPass(raw_ostream &O, const std::string &Banner) const {
401 return createPrintModulePass(&O, false, Banner);
404 /// run - Execute all of the passes scheduled for execution. Keep track of
405 /// whether any of the passes modifies the module, and if so, return true.
408 /// Pass Manager itself does not invalidate any analysis info.
409 void getAnalysisUsage(AnalysisUsage &Info) const {
410 Info.setPreservesAll();
413 inline void addTopLevelPass(Pass *P) {
414 if (ImmutablePass *IP = P->getAsImmutablePass()) {
415 // P is a immutable pass and it will be managed by this
416 // top level manager. Set up analysis resolver to connect them.
417 AnalysisResolver *AR = new AnalysisResolver(*this);
419 initializeAnalysisImpl(P);
420 addImmutablePass(IP);
421 recordAvailableAnalysis(IP);
423 P->assignPassManager(activeStack, PMT_ModulePassManager);
427 virtual PMDataManager *getAsPMDataManager() { return this; }
428 virtual Pass *getAsPass() { return this; }
430 MPPassManager *getContainedManager(unsigned N) {
431 assert(N < PassManagers.size() && "Pass number out of range!");
432 MPPassManager *MP = static_cast<MPPassManager *>(PassManagers[N]);
437 char PassManagerImpl::ID = 0;
438 } // End of llvm namespace
442 //===----------------------------------------------------------------------===//
443 /// TimingInfo Class - This class is used to calculate information about the
444 /// amount of time each pass takes to execute. This only happens when
445 /// -time-passes is enabled on the command line.
448 static ManagedStatic<sys::SmartMutex<true> > TimingInfoMutex;
451 DenseMap<Pass*, Timer*> TimingData;
454 // Use 'create' member to get this.
455 TimingInfo() : TG("... Pass execution timing report ...") {}
457 // TimingDtor - Print out information about timing information
459 // Delete all of the timers, which accumulate their info into the
461 for (DenseMap<Pass*, Timer*>::iterator I = TimingData.begin(),
462 E = TimingData.end(); I != E; ++I)
464 // TimerGroup is deleted next, printing the report.
467 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer
468 // to a non null value (if the -time-passes option is enabled) or it leaves it
469 // null. It may be called multiple times.
470 static void createTheTimeInfo();
472 /// getPassTimer - Return the timer for the specified pass if it exists.
473 Timer *getPassTimer(Pass *P) {
474 if (P->getAsPMDataManager())
477 sys::SmartScopedLock<true> Lock(*TimingInfoMutex);
478 Timer *&T = TimingData[P];
480 T = new Timer(P->getPassName(), TG);
485 } // End of anon namespace
487 static TimingInfo *TheTimeInfo;
489 //===----------------------------------------------------------------------===//
490 // PMTopLevelManager implementation
492 /// Initialize top level manager. Create first pass manager.
493 PMTopLevelManager::PMTopLevelManager(enum TopLevelManagerType t) {
495 MPPassManager *MPP = new MPPassManager(1);
496 MPP->setTopLevelManager(this);
498 activeStack.push(MPP);
499 } else if (t == TLM_Function) {
500 FPPassManager *FPP = new FPPassManager(1);
501 FPP->setTopLevelManager(this);
503 activeStack.push(FPP);
507 /// Set pass P as the last user of the given analysis passes.
508 void PMTopLevelManager::setLastUser(SmallVector<Pass *, 12> &AnalysisPasses,
510 for (SmallVector<Pass *, 12>::iterator I = AnalysisPasses.begin(),
511 E = AnalysisPasses.end(); I != E; ++I) {
518 // If AP is the last user of other passes then make P last user of
520 for (DenseMap<Pass *, Pass *>::iterator LUI = LastUser.begin(),
521 LUE = LastUser.end(); LUI != LUE; ++LUI) {
522 if (LUI->second == AP)
523 // DenseMap iterator is not invalidated here because
524 // this is just updating exisitng entry.
525 LastUser[LUI->first] = P;
530 /// Collect passes whose last user is P
531 void PMTopLevelManager::collectLastUses(SmallVector<Pass *, 12> &LastUses,
533 DenseMap<Pass *, SmallPtrSet<Pass *, 8> >::iterator DMI =
534 InversedLastUser.find(P);
535 if (DMI == InversedLastUser.end())
538 SmallPtrSet<Pass *, 8> &LU = DMI->second;
539 for (SmallPtrSet<Pass *, 8>::iterator I = LU.begin(),
540 E = LU.end(); I != E; ++I) {
541 LastUses.push_back(*I);
546 AnalysisUsage *PMTopLevelManager::findAnalysisUsage(Pass *P) {
547 AnalysisUsage *AnUsage = NULL;
548 DenseMap<Pass *, AnalysisUsage *>::iterator DMI = AnUsageMap.find(P);
549 if (DMI != AnUsageMap.end())
550 AnUsage = DMI->second;
552 AnUsage = new AnalysisUsage();
553 P->getAnalysisUsage(*AnUsage);
554 AnUsageMap[P] = AnUsage;
559 /// Schedule pass P for execution. Make sure that passes required by
560 /// P are run before P is run. Update analysis info maintained by
561 /// the manager. Remove dead passes. This is a recursive function.
562 void PMTopLevelManager::schedulePass(Pass *P) {
564 // TODO : Allocate function manager for this pass, other wise required set
565 // may be inserted into previous function manager
567 // Give pass a chance to prepare the stage.
568 P->preparePassManager(activeStack);
570 // If P is an analysis pass and it is available then do not
571 // generate the analysis again. Stale analysis info should not be
572 // available at this point.
574 PassRegistry::getPassRegistry()->getPassInfo(P->getPassID());
575 if (PI && PI->isAnalysis() && findAnalysisPass(P->getPassID())) {
580 AnalysisUsage *AnUsage = findAnalysisUsage(P);
582 bool checkAnalysis = true;
583 while (checkAnalysis) {
584 checkAnalysis = false;
586 const AnalysisUsage::VectorType &RequiredSet = AnUsage->getRequiredSet();
587 for (AnalysisUsage::VectorType::const_iterator I = RequiredSet.begin(),
588 E = RequiredSet.end(); I != E; ++I) {
590 Pass *AnalysisPass = findAnalysisPass(*I);
592 const PassInfo *PI = PassRegistry::getPassRegistry()->getPassInfo(*I);
593 AnalysisPass = PI->createPass();
594 if (P->getPotentialPassManagerType () ==
595 AnalysisPass->getPotentialPassManagerType())
596 // Schedule analysis pass that is managed by the same pass manager.
597 schedulePass(AnalysisPass);
598 else if (P->getPotentialPassManagerType () >
599 AnalysisPass->getPotentialPassManagerType()) {
600 // Schedule analysis pass that is managed by a new manager.
601 schedulePass(AnalysisPass);
602 // Recheck analysis passes to ensure that required analysises that
603 // are already checked are still available.
604 checkAnalysis = true;
607 // Do not schedule this analysis. Lower level analsyis
608 // passes are run on the fly.
614 // Now all required passes are available.
618 /// Find the pass that implements Analysis AID. Search immutable
619 /// passes and all pass managers. If desired pass is not found
620 /// then return NULL.
621 Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
624 // Check pass managers
625 for (SmallVector<PMDataManager *, 8>::iterator I = PassManagers.begin(),
626 E = PassManagers.end(); P == NULL && I != E; ++I) {
627 PMDataManager *PMD = *I;
628 P = PMD->findAnalysisPass(AID, false);
631 // Check other pass managers
632 for (SmallVector<PMDataManager *, 8>::iterator
633 I = IndirectPassManagers.begin(),
634 E = IndirectPassManagers.end(); P == NULL && I != E; ++I)
635 P = (*I)->findAnalysisPass(AID, false);
637 for (SmallVector<ImmutablePass *, 8>::iterator I = ImmutablePasses.begin(),
638 E = ImmutablePasses.end(); P == NULL && I != E; ++I) {
639 AnalysisID PI = (*I)->getPassID();
643 // If Pass not found then check the interfaces implemented by Immutable Pass
645 const PassInfo *PassInf =
646 PassRegistry::getPassRegistry()->getPassInfo(PI);
647 const std::vector<const PassInfo*> &ImmPI =
648 PassInf->getInterfacesImplemented();
649 for (std::vector<const PassInfo*>::const_iterator II = ImmPI.begin(),
650 EE = ImmPI.end(); II != EE; ++II) {
651 if ((*II)->getTypeInfo() == AID)
660 // Print passes managed by this top level manager.
661 void PMTopLevelManager::dumpPasses() const {
663 if (PassDebugging < Structure)
666 // Print out the immutable passes
667 for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
668 ImmutablePasses[i]->dumpPassStructure(0);
671 // Every class that derives from PMDataManager also derives from Pass
672 // (sometimes indirectly), but there's no inheritance relationship
673 // between PMDataManager and Pass, so we have to getAsPass to get
674 // from a PMDataManager* to a Pass*.
675 for (SmallVector<PMDataManager *, 8>::const_iterator I = PassManagers.begin(),
676 E = PassManagers.end(); I != E; ++I)
677 (*I)->getAsPass()->dumpPassStructure(1);
680 void PMTopLevelManager::dumpArguments() const {
682 if (PassDebugging < Arguments)
685 dbgs() << "Pass Arguments: ";
686 for (SmallVector<PMDataManager *, 8>::const_iterator I = PassManagers.begin(),
687 E = PassManagers.end(); I != E; ++I)
688 (*I)->dumpPassArguments();
692 void PMTopLevelManager::initializeAllAnalysisInfo() {
693 for (SmallVector<PMDataManager *, 8>::iterator I = PassManagers.begin(),
694 E = PassManagers.end(); I != E; ++I)
695 (*I)->initializeAnalysisInfo();
697 // Initailize other pass managers
698 for (SmallVector<PMDataManager *, 8>::iterator
699 I = IndirectPassManagers.begin(), E = IndirectPassManagers.end();
701 (*I)->initializeAnalysisInfo();
703 for (DenseMap<Pass *, Pass *>::iterator DMI = LastUser.begin(),
704 DME = LastUser.end(); DMI != DME; ++DMI) {
705 DenseMap<Pass *, SmallPtrSet<Pass *, 8> >::iterator InvDMI =
706 InversedLastUser.find(DMI->second);
707 if (InvDMI != InversedLastUser.end()) {
708 SmallPtrSet<Pass *, 8> &L = InvDMI->second;
709 L.insert(DMI->first);
711 SmallPtrSet<Pass *, 8> L; L.insert(DMI->first);
712 InversedLastUser[DMI->second] = L;
718 PMTopLevelManager::~PMTopLevelManager() {
719 for (SmallVector<PMDataManager *, 8>::iterator I = PassManagers.begin(),
720 E = PassManagers.end(); I != E; ++I)
723 for (SmallVector<ImmutablePass *, 8>::iterator
724 I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
727 for (DenseMap<Pass *, AnalysisUsage *>::iterator DMI = AnUsageMap.begin(),
728 DME = AnUsageMap.end(); DMI != DME; ++DMI)
732 //===----------------------------------------------------------------------===//
733 // PMDataManager implementation
735 /// Augement AvailableAnalysis by adding analysis made available by pass P.
736 void PMDataManager::recordAvailableAnalysis(Pass *P) {
737 AnalysisID PI = P->getPassID();
739 AvailableAnalysis[PI] = P;
741 assert(!AvailableAnalysis.empty());
743 // This pass is the current implementation of all of the interfaces it
744 // implements as well.
745 const PassInfo *PInf = PassRegistry::getPassRegistry()->getPassInfo(PI);
746 if (PInf == 0) return;
747 const std::vector<const PassInfo*> &II = PInf->getInterfacesImplemented();
748 for (unsigned i = 0, e = II.size(); i != e; ++i)
749 AvailableAnalysis[II[i]->getTypeInfo()] = P;
752 // Return true if P preserves high level analysis used by other
753 // passes managed by this manager
754 bool PMDataManager::preserveHigherLevelAnalysis(Pass *P) {
755 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
756 if (AnUsage->getPreservesAll())
759 const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
760 for (SmallVector<Pass *, 8>::iterator I = HigherLevelAnalysis.begin(),
761 E = HigherLevelAnalysis.end(); I != E; ++I) {
763 if (P1->getAsImmutablePass() == 0 &&
764 std::find(PreservedSet.begin(), PreservedSet.end(),
773 /// verifyPreservedAnalysis -- Verify analysis preserved by pass P.
774 void PMDataManager::verifyPreservedAnalysis(Pass *P) {
775 // Don't do this unless assertions are enabled.
779 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
780 const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
782 // Verify preserved analysis
783 for (AnalysisUsage::VectorType::const_iterator I = PreservedSet.begin(),
784 E = PreservedSet.end(); I != E; ++I) {
786 if (Pass *AP = findAnalysisPass(AID, true)) {
787 TimeRegion PassTimer(getPassTimer(AP));
788 AP->verifyAnalysis();
793 /// Remove Analysis not preserved by Pass P
794 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
795 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
796 if (AnUsage->getPreservesAll())
799 const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
800 for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
801 E = AvailableAnalysis.end(); I != E; ) {
802 std::map<AnalysisID, Pass*>::iterator Info = I++;
803 if (Info->second->getAsImmutablePass() == 0 &&
804 std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
805 PreservedSet.end()) {
806 // Remove this analysis
807 if (PassDebugging >= Details) {
808 Pass *S = Info->second;
809 dbgs() << " -- '" << P->getPassName() << "' is not preserving '";
810 dbgs() << S->getPassName() << "'\n";
812 AvailableAnalysis.erase(Info);
816 // Check inherited analysis also. If P is not preserving analysis
817 // provided by parent manager then remove it here.
818 for (unsigned Index = 0; Index < PMT_Last; ++Index) {
820 if (!InheritedAnalysis[Index])
823 for (std::map<AnalysisID, Pass*>::iterator
824 I = InheritedAnalysis[Index]->begin(),
825 E = InheritedAnalysis[Index]->end(); I != E; ) {
826 std::map<AnalysisID, Pass *>::iterator Info = I++;
827 if (Info->second->getAsImmutablePass() == 0 &&
828 std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
829 PreservedSet.end()) {
830 // Remove this analysis
831 if (PassDebugging >= Details) {
832 Pass *S = Info->second;
833 dbgs() << " -- '" << P->getPassName() << "' is not preserving '";
834 dbgs() << S->getPassName() << "'\n";
836 InheritedAnalysis[Index]->erase(Info);
842 /// Remove analysis passes that are not used any longer
843 void PMDataManager::removeDeadPasses(Pass *P, StringRef Msg,
844 enum PassDebuggingString DBG_STR) {
846 SmallVector<Pass *, 12> DeadPasses;
848 // If this is a on the fly manager then it does not have TPM.
852 TPM->collectLastUses(DeadPasses, P);
854 if (PassDebugging >= Details && !DeadPasses.empty()) {
855 dbgs() << " -*- '" << P->getPassName();
856 dbgs() << "' is the last user of following pass instances.";
857 dbgs() << " Free these instances\n";
860 for (SmallVector<Pass *, 12>::iterator I = DeadPasses.begin(),
861 E = DeadPasses.end(); I != E; ++I)
862 freePass(*I, Msg, DBG_STR);
865 void PMDataManager::freePass(Pass *P, StringRef Msg,
866 enum PassDebuggingString DBG_STR) {
867 dumpPassInfo(P, FREEING_MSG, DBG_STR, Msg);
870 // If the pass crashes releasing memory, remember this.
871 PassManagerPrettyStackEntry X(P);
872 TimeRegion PassTimer(getPassTimer(P));
877 AnalysisID PI = P->getPassID();
878 if (const PassInfo *PInf = PassRegistry::getPassRegistry()->getPassInfo(PI)) {
879 // Remove the pass itself (if it is not already removed).
880 AvailableAnalysis.erase(PI);
882 // Remove all interfaces this pass implements, for which it is also
883 // listed as the available implementation.
884 const std::vector<const PassInfo*> &II = PInf->getInterfacesImplemented();
885 for (unsigned i = 0, e = II.size(); i != e; ++i) {
886 std::map<AnalysisID, Pass*>::iterator Pos =
887 AvailableAnalysis.find(II[i]->getTypeInfo());
888 if (Pos != AvailableAnalysis.end() && Pos->second == P)
889 AvailableAnalysis.erase(Pos);
894 /// Add pass P into the PassVector. Update
895 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
896 void PMDataManager::add(Pass *P, bool ProcessAnalysis) {
897 // This manager is going to manage pass P. Set up analysis resolver
899 AnalysisResolver *AR = new AnalysisResolver(*this);
902 // If a FunctionPass F is the last user of ModulePass info M
903 // then the F's manager, not F, records itself as a last user of M.
904 SmallVector<Pass *, 12> TransferLastUses;
906 if (!ProcessAnalysis) {
908 PassVector.push_back(P);
912 // At the moment, this pass is the last user of all required passes.
913 SmallVector<Pass *, 12> LastUses;
914 SmallVector<Pass *, 8> RequiredPasses;
915 SmallVector<AnalysisID, 8> ReqAnalysisNotAvailable;
917 unsigned PDepth = this->getDepth();
919 collectRequiredAnalysis(RequiredPasses,
920 ReqAnalysisNotAvailable, P);
921 for (SmallVector<Pass *, 8>::iterator I = RequiredPasses.begin(),
922 E = RequiredPasses.end(); I != E; ++I) {
923 Pass *PRequired = *I;
926 assert(PRequired->getResolver() && "Analysis Resolver is not set");
927 PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
928 RDepth = DM.getDepth();
930 if (PDepth == RDepth)
931 LastUses.push_back(PRequired);
932 else if (PDepth > RDepth) {
933 // Let the parent claim responsibility of last use
934 TransferLastUses.push_back(PRequired);
935 // Keep track of higher level analysis used by this manager.
936 HigherLevelAnalysis.push_back(PRequired);
938 llvm_unreachable("Unable to accomodate Required Pass");
941 // Set P as P's last user until someone starts using P.
942 // However, if P is a Pass Manager then it does not need
943 // to record its last user.
944 if (P->getAsPMDataManager() == 0)
945 LastUses.push_back(P);
946 TPM->setLastUser(LastUses, P);
948 if (!TransferLastUses.empty()) {
949 Pass *My_PM = getAsPass();
950 TPM->setLastUser(TransferLastUses, My_PM);
951 TransferLastUses.clear();
954 // Now, take care of required analysises that are not available.
955 for (SmallVector<AnalysisID, 8>::iterator
956 I = ReqAnalysisNotAvailable.begin(),
957 E = ReqAnalysisNotAvailable.end() ;I != E; ++I) {
958 const PassInfo *PI = PassRegistry::getPassRegistry()->getPassInfo(*I);
959 Pass *AnalysisPass = PI->createPass();
960 this->addLowerLevelRequiredPass(P, AnalysisPass);
963 // Take a note of analysis required and made available by this pass.
964 // Remove the analysis not preserved by this pass
965 removeNotPreservedAnalysis(P);
966 recordAvailableAnalysis(P);
969 PassVector.push_back(P);
973 /// Populate RP with analysis pass that are required by
974 /// pass P and are available. Populate RP_NotAvail with analysis
975 /// pass that are required by pass P but are not available.
976 void PMDataManager::collectRequiredAnalysis(SmallVector<Pass *, 8>&RP,
977 SmallVector<AnalysisID, 8> &RP_NotAvail,
979 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
980 const AnalysisUsage::VectorType &RequiredSet = AnUsage->getRequiredSet();
981 for (AnalysisUsage::VectorType::const_iterator
982 I = RequiredSet.begin(), E = RequiredSet.end(); I != E; ++I) {
983 if (Pass *AnalysisPass = findAnalysisPass(*I, true))
984 RP.push_back(AnalysisPass);
986 RP_NotAvail.push_back(*I);
989 const AnalysisUsage::VectorType &IDs = AnUsage->getRequiredTransitiveSet();
990 for (AnalysisUsage::VectorType::const_iterator I = IDs.begin(),
991 E = IDs.end(); I != E; ++I) {
992 if (Pass *AnalysisPass = findAnalysisPass(*I, true))
993 RP.push_back(AnalysisPass);
995 RP_NotAvail.push_back(*I);
999 // All Required analyses should be available to the pass as it runs! Here
1000 // we fill in the AnalysisImpls member of the pass so that it can
1001 // successfully use the getAnalysis() method to retrieve the
1002 // implementations it needs.
1004 void PMDataManager::initializeAnalysisImpl(Pass *P) {
1005 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
1007 for (AnalysisUsage::VectorType::const_iterator
1008 I = AnUsage->getRequiredSet().begin(),
1009 E = AnUsage->getRequiredSet().end(); I != E; ++I) {
1010 Pass *Impl = findAnalysisPass(*I, true);
1012 // This may be analysis pass that is initialized on the fly.
1013 // If that is not the case then it will raise an assert when it is used.
1015 AnalysisResolver *AR = P->getResolver();
1016 assert(AR && "Analysis Resolver is not set");
1017 AR->addAnalysisImplsPair(*I, Impl);
1021 /// Find the pass that implements Analysis AID. If desired pass is not found
1022 /// then return NULL.
1023 Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
1025 // Check if AvailableAnalysis map has one entry.
1026 std::map<AnalysisID, Pass*>::const_iterator I = AvailableAnalysis.find(AID);
1028 if (I != AvailableAnalysis.end())
1031 // Search Parents through TopLevelManager
1033 return TPM->findAnalysisPass(AID);
1038 // Print list of passes that are last used by P.
1039 void PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{
1041 SmallVector<Pass *, 12> LUses;
1043 // If this is a on the fly manager then it does not have TPM.
1047 TPM->collectLastUses(LUses, P);
1049 for (SmallVector<Pass *, 12>::iterator I = LUses.begin(),
1050 E = LUses.end(); I != E; ++I) {
1051 llvm::dbgs() << "--" << std::string(Offset*2, ' ');
1052 (*I)->dumpPassStructure(0);
1056 void PMDataManager::dumpPassArguments() const {
1057 for (SmallVector<Pass *, 8>::const_iterator I = PassVector.begin(),
1058 E = PassVector.end(); I != E; ++I) {
1059 if (PMDataManager *PMD = (*I)->getAsPMDataManager())
1060 PMD->dumpPassArguments();
1062 if (const PassInfo *PI =
1063 PassRegistry::getPassRegistry()->getPassInfo((*I)->getPassID()))
1064 if (!PI->isAnalysisGroup())
1065 dbgs() << " -" << PI->getPassArgument();
1069 void PMDataManager::dumpPassInfo(Pass *P, enum PassDebuggingString S1,
1070 enum PassDebuggingString S2,
1072 if (PassDebugging < Executions)
1074 dbgs() << (void*)this << std::string(getDepth()*2+1, ' ');
1077 dbgs() << "Executing Pass '" << P->getPassName();
1079 case MODIFICATION_MSG:
1080 dbgs() << "Made Modification '" << P->getPassName();
1083 dbgs() << " Freeing Pass '" << P->getPassName();
1089 case ON_BASICBLOCK_MSG:
1090 dbgs() << "' on BasicBlock '" << Msg << "'...\n";
1092 case ON_FUNCTION_MSG:
1093 dbgs() << "' on Function '" << Msg << "'...\n";
1096 dbgs() << "' on Module '" << Msg << "'...\n";
1099 dbgs() << "' on Loop '" << Msg << "'...\n";
1102 dbgs() << "' on Call Graph Nodes '" << Msg << "'...\n";
1109 void PMDataManager::dumpRequiredSet(const Pass *P) const {
1110 if (PassDebugging < Details)
1113 AnalysisUsage analysisUsage;
1114 P->getAnalysisUsage(analysisUsage);
1115 dumpAnalysisUsage("Required", P, analysisUsage.getRequiredSet());
1118 void PMDataManager::dumpPreservedSet(const Pass *P) const {
1119 if (PassDebugging < Details)
1122 AnalysisUsage analysisUsage;
1123 P->getAnalysisUsage(analysisUsage);
1124 dumpAnalysisUsage("Preserved", P, analysisUsage.getPreservedSet());
1127 void PMDataManager::dumpAnalysisUsage(StringRef Msg, const Pass *P,
1128 const AnalysisUsage::VectorType &Set) const {
1129 assert(PassDebugging >= Details);
1132 dbgs() << (void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:";
1133 for (unsigned i = 0; i != Set.size(); ++i) {
1134 if (i) dbgs() << ',';
1135 const PassInfo *PInf = PassRegistry::getPassRegistry()->getPassInfo(Set[i]);
1136 dbgs() << ' ' << PInf->getPassName();
1141 /// Add RequiredPass into list of lower level passes required by pass P.
1142 /// RequiredPass is run on the fly by Pass Manager when P requests it
1143 /// through getAnalysis interface.
1144 /// This should be handled by specific pass manager.
1145 void PMDataManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
1147 TPM->dumpArguments();
1151 // Module Level pass may required Function Level analysis info
1152 // (e.g. dominator info). Pass manager uses on the fly function pass manager
1153 // to provide this on demand. In that case, in Pass manager terminology,
1154 // module level pass is requiring lower level analysis info managed by
1155 // lower level pass manager.
1157 // When Pass manager is not able to order required analysis info, Pass manager
1158 // checks whether any lower level manager will be able to provide this
1159 // analysis info on demand or not.
1161 dbgs() << "Unable to schedule '" << RequiredPass->getPassName();
1162 dbgs() << "' required by '" << P->getPassName() << "'\n";
1164 llvm_unreachable("Unable to schedule pass");
1167 Pass *PMDataManager::getOnTheFlyPass(Pass *P, AnalysisID PI, Function &F) {
1168 assert(0 && "Unable to find on the fly pass");
1173 PMDataManager::~PMDataManager() {
1174 for (SmallVector<Pass *, 8>::iterator I = PassVector.begin(),
1175 E = PassVector.end(); I != E; ++I)
1179 //===----------------------------------------------------------------------===//
1180 // NOTE: Is this the right place to define this method ?
1181 // getAnalysisIfAvailable - Return analysis result or null if it doesn't exist.
1182 Pass *AnalysisResolver::getAnalysisIfAvailable(AnalysisID ID, bool dir) const {
1183 return PM.findAnalysisPass(ID, dir);
1186 Pass *AnalysisResolver::findImplPass(Pass *P, AnalysisID AnalysisPI,
1188 return PM.getOnTheFlyPass(P, AnalysisPI, F);
1191 //===----------------------------------------------------------------------===//
1192 // BBPassManager implementation
1194 /// Execute all of the passes scheduled for execution by invoking
1195 /// runOnBasicBlock method. Keep track of whether any of the passes modifies
1196 /// the function, and if so, return true.
1197 bool BBPassManager::runOnFunction(Function &F) {
1198 if (F.isDeclaration())
1201 bool Changed = doInitialization(F);
1203 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
1204 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1205 BasicBlockPass *BP = getContainedPass(Index);
1206 bool LocalChanged = false;
1208 dumpPassInfo(BP, EXECUTION_MSG, ON_BASICBLOCK_MSG, I->getName());
1209 dumpRequiredSet(BP);
1211 initializeAnalysisImpl(BP);
1214 // If the pass crashes, remember this.
1215 PassManagerPrettyStackEntry X(BP, *I);
1216 TimeRegion PassTimer(getPassTimer(BP));
1218 LocalChanged |= BP->runOnBasicBlock(*I);
1221 Changed |= LocalChanged;
1223 dumpPassInfo(BP, MODIFICATION_MSG, ON_BASICBLOCK_MSG,
1225 dumpPreservedSet(BP);
1227 verifyPreservedAnalysis(BP);
1228 removeNotPreservedAnalysis(BP);
1229 recordAvailableAnalysis(BP);
1230 removeDeadPasses(BP, I->getName(), ON_BASICBLOCK_MSG);
1233 return doFinalization(F) || Changed;
1236 // Implement doInitialization and doFinalization
1237 bool BBPassManager::doInitialization(Module &M) {
1238 bool Changed = false;
1240 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1241 Changed |= getContainedPass(Index)->doInitialization(M);
1246 bool BBPassManager::doFinalization(Module &M) {
1247 bool Changed = false;
1249 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1250 Changed |= getContainedPass(Index)->doFinalization(M);
1255 bool BBPassManager::doInitialization(Function &F) {
1256 bool Changed = false;
1258 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1259 BasicBlockPass *BP = getContainedPass(Index);
1260 Changed |= BP->doInitialization(F);
1266 bool BBPassManager::doFinalization(Function &F) {
1267 bool Changed = false;
1269 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1270 BasicBlockPass *BP = getContainedPass(Index);
1271 Changed |= BP->doFinalization(F);
1278 //===----------------------------------------------------------------------===//
1279 // FunctionPassManager implementation
1281 /// Create new Function pass manager
1282 FunctionPassManager::FunctionPassManager(Module *m) : M(m) {
1283 FPM = new FunctionPassManagerImpl(0);
1284 // FPM is the top level manager.
1285 FPM->setTopLevelManager(FPM);
1287 AnalysisResolver *AR = new AnalysisResolver(*FPM);
1288 FPM->setResolver(AR);
1291 FunctionPassManager::~FunctionPassManager() {
1295 /// addImpl - Add a pass to the queue of passes to run, without
1296 /// checking whether to add a printer pass.
1297 void FunctionPassManager::addImpl(Pass *P) {
1301 /// add - Add a pass to the queue of passes to run. This passes
1302 /// ownership of the Pass to the PassManager. When the
1303 /// PassManager_X is destroyed, the pass will be destroyed as well, so
1304 /// there is no need to delete the pass. (TODO delete passes.)
1305 /// This implies that all passes MUST be allocated with 'new'.
1306 void FunctionPassManager::add(Pass *P) {
1307 // If this is a not a function pass, don't add a printer for it.
1308 const void *PassID = P->getPassID();
1309 if (P->getPassKind() == PT_Function)
1310 if (ShouldPrintBeforePass(PassID))
1311 addImpl(P->createPrinterPass(dbgs(), std::string("*** IR Dump Before ")
1312 + P->getPassName() + " ***"));
1316 if (P->getPassKind() == PT_Function)
1317 if (ShouldPrintAfterPass(PassID))
1318 addImpl(P->createPrinterPass(dbgs(), std::string("*** IR Dump After ")
1319 + P->getPassName() + " ***"));
1322 /// run - Execute all of the passes scheduled for execution. Keep
1323 /// track of whether any of the passes modifies the function, and if
1324 /// so, return true.
1326 bool FunctionPassManager::run(Function &F) {
1327 if (F.isMaterializable()) {
1329 if (F.Materialize(&errstr))
1330 report_fatal_error("Error reading bitcode file: " + Twine(errstr));
1336 /// doInitialization - Run all of the initializers for the function passes.
1338 bool FunctionPassManager::doInitialization() {
1339 return FPM->doInitialization(*M);
1342 /// doFinalization - Run all of the finalizers for the function passes.
1344 bool FunctionPassManager::doFinalization() {
1345 return FPM->doFinalization(*M);
1348 //===----------------------------------------------------------------------===//
1349 // FunctionPassManagerImpl implementation
1351 bool FunctionPassManagerImpl::doInitialization(Module &M) {
1352 bool Changed = false;
1357 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1358 Changed |= getContainedManager(Index)->doInitialization(M);
1363 bool FunctionPassManagerImpl::doFinalization(Module &M) {
1364 bool Changed = false;
1366 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1367 Changed |= getContainedManager(Index)->doFinalization(M);
1372 /// cleanup - After running all passes, clean up pass manager cache.
1373 void FPPassManager::cleanup() {
1374 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1375 FunctionPass *FP = getContainedPass(Index);
1376 AnalysisResolver *AR = FP->getResolver();
1377 assert(AR && "Analysis Resolver is not set");
1378 AR->clearAnalysisImpls();
1382 void FunctionPassManagerImpl::releaseMemoryOnTheFly() {
1385 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1386 FPPassManager *FPPM = getContainedManager(Index);
1387 for (unsigned Index = 0; Index < FPPM->getNumContainedPasses(); ++Index) {
1388 FPPM->getContainedPass(Index)->releaseMemory();
1394 // Execute all the passes managed by this top level manager.
1395 // Return true if any function is modified by a pass.
1396 bool FunctionPassManagerImpl::run(Function &F) {
1397 bool Changed = false;
1398 TimingInfo::createTheTimeInfo();
1400 initializeAllAnalysisInfo();
1401 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1402 Changed |= getContainedManager(Index)->runOnFunction(F);
1404 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1405 getContainedManager(Index)->cleanup();
1411 //===----------------------------------------------------------------------===//
1412 // FPPassManager implementation
1414 char FPPassManager::ID = 0;
1415 /// Print passes managed by this manager
1416 void FPPassManager::dumpPassStructure(unsigned Offset) {
1417 llvm::dbgs() << std::string(Offset*2, ' ') << "FunctionPass Manager\n";
1418 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1419 FunctionPass *FP = getContainedPass(Index);
1420 FP->dumpPassStructure(Offset + 1);
1421 dumpLastUses(FP, Offset+1);
1426 /// Execute all of the passes scheduled for execution by invoking
1427 /// runOnFunction method. Keep track of whether any of the passes modifies
1428 /// the function, and if so, return true.
1429 bool FPPassManager::runOnFunction(Function &F) {
1430 if (F.isDeclaration())
1433 bool Changed = false;
1435 // Collect inherited analysis from Module level pass manager.
1436 populateInheritedAnalysis(TPM->activeStack);
1438 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1439 FunctionPass *FP = getContainedPass(Index);
1440 bool LocalChanged = false;
1442 dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getName());
1443 dumpRequiredSet(FP);
1445 initializeAnalysisImpl(FP);
1448 PassManagerPrettyStackEntry X(FP, F);
1449 TimeRegion PassTimer(getPassTimer(FP));
1451 LocalChanged |= FP->runOnFunction(F);
1454 Changed |= LocalChanged;
1456 dumpPassInfo(FP, MODIFICATION_MSG, ON_FUNCTION_MSG, F.getName());
1457 dumpPreservedSet(FP);
1459 verifyPreservedAnalysis(FP);
1460 removeNotPreservedAnalysis(FP);
1461 recordAvailableAnalysis(FP);
1462 removeDeadPasses(FP, F.getName(), ON_FUNCTION_MSG);
1467 bool FPPassManager::runOnModule(Module &M) {
1468 bool Changed = doInitialization(M);
1470 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1473 return doFinalization(M) || Changed;
1476 bool FPPassManager::doInitialization(Module &M) {
1477 bool Changed = false;
1479 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1480 Changed |= getContainedPass(Index)->doInitialization(M);
1485 bool FPPassManager::doFinalization(Module &M) {
1486 bool Changed = false;
1488 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1489 Changed |= getContainedPass(Index)->doFinalization(M);
1494 //===----------------------------------------------------------------------===//
1495 // MPPassManager implementation
1497 /// Execute all of the passes scheduled for execution by invoking
1498 /// runOnModule method. Keep track of whether any of the passes modifies
1499 /// the module, and if so, return true.
1501 MPPassManager::runOnModule(Module &M) {
1502 bool Changed = false;
1504 // Initialize on-the-fly passes
1505 for (std::map<Pass *, FunctionPassManagerImpl *>::iterator
1506 I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end();
1508 FunctionPassManagerImpl *FPP = I->second;
1509 Changed |= FPP->doInitialization(M);
1512 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1513 ModulePass *MP = getContainedPass(Index);
1514 bool LocalChanged = false;
1516 dumpPassInfo(MP, EXECUTION_MSG, ON_MODULE_MSG, M.getModuleIdentifier());
1517 dumpRequiredSet(MP);
1519 initializeAnalysisImpl(MP);
1522 PassManagerPrettyStackEntry X(MP, M);
1523 TimeRegion PassTimer(getPassTimer(MP));
1525 LocalChanged |= MP->runOnModule(M);
1528 Changed |= LocalChanged;
1530 dumpPassInfo(MP, MODIFICATION_MSG, ON_MODULE_MSG,
1531 M.getModuleIdentifier());
1532 dumpPreservedSet(MP);
1534 verifyPreservedAnalysis(MP);
1535 removeNotPreservedAnalysis(MP);
1536 recordAvailableAnalysis(MP);
1537 removeDeadPasses(MP, M.getModuleIdentifier(), ON_MODULE_MSG);
1540 // Finalize on-the-fly passes
1541 for (std::map<Pass *, FunctionPassManagerImpl *>::iterator
1542 I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end();
1544 FunctionPassManagerImpl *FPP = I->second;
1545 // We don't know when is the last time an on-the-fly pass is run,
1546 // so we need to releaseMemory / finalize here
1547 FPP->releaseMemoryOnTheFly();
1548 Changed |= FPP->doFinalization(M);
1553 /// Add RequiredPass into list of lower level passes required by pass P.
1554 /// RequiredPass is run on the fly by Pass Manager when P requests it
1555 /// through getAnalysis interface.
1556 void MPPassManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
1557 assert(P->getPotentialPassManagerType() == PMT_ModulePassManager &&
1558 "Unable to handle Pass that requires lower level Analysis pass");
1559 assert((P->getPotentialPassManagerType() <
1560 RequiredPass->getPotentialPassManagerType()) &&
1561 "Unable to handle Pass that requires lower level Analysis pass");
1563 FunctionPassManagerImpl *FPP = OnTheFlyManagers[P];
1565 FPP = new FunctionPassManagerImpl(0);
1566 // FPP is the top level manager.
1567 FPP->setTopLevelManager(FPP);
1569 OnTheFlyManagers[P] = FPP;
1571 FPP->add(RequiredPass);
1573 // Register P as the last user of RequiredPass.
1574 SmallVector<Pass *, 12> LU;
1575 LU.push_back(RequiredPass);
1576 FPP->setLastUser(LU, P);
1579 /// Return function pass corresponding to PassInfo PI, that is
1580 /// required by module pass MP. Instantiate analysis pass, by using
1581 /// its runOnFunction() for function F.
1582 Pass* MPPassManager::getOnTheFlyPass(Pass *MP, AnalysisID PI, Function &F){
1583 FunctionPassManagerImpl *FPP = OnTheFlyManagers[MP];
1584 assert(FPP && "Unable to find on the fly pass");
1586 FPP->releaseMemoryOnTheFly();
1588 return ((PMTopLevelManager*)FPP)->findAnalysisPass(PI);
1592 //===----------------------------------------------------------------------===//
1593 // PassManagerImpl implementation
1595 /// run - Execute all of the passes scheduled for execution. Keep track of
1596 /// whether any of the passes modifies the module, and if so, return true.
1597 bool PassManagerImpl::run(Module &M) {
1598 bool Changed = false;
1599 TimingInfo::createTheTimeInfo();
1604 initializeAllAnalysisInfo();
1605 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1606 Changed |= getContainedManager(Index)->runOnModule(M);
1610 //===----------------------------------------------------------------------===//
1611 // PassManager implementation
1613 /// Create new pass manager
1614 PassManager::PassManager() {
1615 PM = new PassManagerImpl(0);
1616 // PM is the top level manager
1617 PM->setTopLevelManager(PM);
1620 PassManager::~PassManager() {
1624 /// addImpl - Add a pass to the queue of passes to run, without
1625 /// checking whether to add a printer pass.
1626 void PassManager::addImpl(Pass *P) {
1630 /// add - Add a pass to the queue of passes to run. This passes ownership of
1631 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
1632 /// will be destroyed as well, so there is no need to delete the pass. This
1633 /// implies that all passes MUST be allocated with 'new'.
1634 void PassManager::add(Pass *P) {
1635 const void* PassID = P->getPassID();
1636 if (ShouldPrintBeforePass(PassID))
1637 addImpl(P->createPrinterPass(dbgs(), std::string("*** IR Dump Before ")
1638 + P->getPassName() + " ***"));
1642 if (ShouldPrintAfterPass(PassID))
1643 addImpl(P->createPrinterPass(dbgs(), std::string("*** IR Dump After ")
1644 + P->getPassName() + " ***"));
1647 /// run - Execute all of the passes scheduled for execution. Keep track of
1648 /// whether any of the passes modifies the module, and if so, return true.
1649 bool PassManager::run(Module &M) {
1653 //===----------------------------------------------------------------------===//
1654 // TimingInfo Class - This class is used to calculate information about the
1655 // amount of time each pass takes to execute. This only happens with
1656 // -time-passes is enabled on the command line.
1658 bool llvm::TimePassesIsEnabled = false;
1659 static cl::opt<bool,true>
1660 EnableTiming("time-passes", cl::location(TimePassesIsEnabled),
1661 cl::desc("Time each pass, printing elapsed time for each on exit"));
1663 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
1664 // a non null value (if the -time-passes option is enabled) or it leaves it
1665 // null. It may be called multiple times.
1666 void TimingInfo::createTheTimeInfo() {
1667 if (!TimePassesIsEnabled || TheTimeInfo) return;
1669 // Constructed the first time this is called, iff -time-passes is enabled.
1670 // This guarantees that the object will be constructed before static globals,
1671 // thus it will be destroyed before them.
1672 static ManagedStatic<TimingInfo> TTI;
1673 TheTimeInfo = &*TTI;
1676 /// If TimingInfo is enabled then start pass timer.
1677 Timer *llvm::getPassTimer(Pass *P) {
1679 return TheTimeInfo->getPassTimer(P);
1683 //===----------------------------------------------------------------------===//
1684 // PMStack implementation
1687 // Pop Pass Manager from the stack and clear its analysis info.
1688 void PMStack::pop() {
1690 PMDataManager *Top = this->top();
1691 Top->initializeAnalysisInfo();
1696 // Push PM on the stack and set its top level manager.
1697 void PMStack::push(PMDataManager *PM) {
1698 assert(PM && "Unable to push. Pass Manager expected");
1700 if (!this->empty()) {
1701 PMTopLevelManager *TPM = this->top()->getTopLevelManager();
1703 assert(TPM && "Unable to find top level manager");
1704 TPM->addIndirectPassManager(PM);
1705 PM->setTopLevelManager(TPM);
1711 // Dump content of the pass manager stack.
1712 void PMStack::dump() const {
1713 for (std::vector<PMDataManager *>::const_iterator I = S.begin(),
1714 E = S.end(); I != E; ++I)
1715 printf("%s ", (*I)->getAsPass()->getPassName());
1721 /// Find appropriate Module Pass Manager in the PM Stack and
1722 /// add self into that manager.
1723 void ModulePass::assignPassManager(PMStack &PMS,
1724 PassManagerType PreferredType) {
1725 // Find Module Pass Manager
1726 while (!PMS.empty()) {
1727 PassManagerType TopPMType = PMS.top()->getPassManagerType();
1728 if (TopPMType == PreferredType)
1729 break; // We found desired pass manager
1730 else if (TopPMType > PMT_ModulePassManager)
1731 PMS.pop(); // Pop children pass managers
1735 assert(!PMS.empty() && "Unable to find appropriate Pass Manager");
1736 PMS.top()->add(this);
1739 /// Find appropriate Function Pass Manager or Call Graph Pass Manager
1740 /// in the PM Stack and add self into that manager.
1741 void FunctionPass::assignPassManager(PMStack &PMS,
1742 PassManagerType PreferredType) {
1744 // Find Module Pass Manager
1745 while (!PMS.empty()) {
1746 if (PMS.top()->getPassManagerType() > PMT_FunctionPassManager)
1752 // Create new Function Pass Manager if needed.
1754 if (PMS.top()->getPassManagerType() == PMT_FunctionPassManager) {
1755 FPP = (FPPassManager *)PMS.top();
1757 assert(!PMS.empty() && "Unable to create Function Pass Manager");
1758 PMDataManager *PMD = PMS.top();
1760 // [1] Create new Function Pass Manager
1761 FPP = new FPPassManager(PMD->getDepth() + 1);
1762 FPP->populateInheritedAnalysis(PMS);
1764 // [2] Set up new manager's top level manager
1765 PMTopLevelManager *TPM = PMD->getTopLevelManager();
1766 TPM->addIndirectPassManager(FPP);
1768 // [3] Assign manager to manage this new manager. This may create
1769 // and push new managers into PMS
1770 FPP->assignPassManager(PMS, PMD->getPassManagerType());
1772 // [4] Push new manager into PMS
1776 // Assign FPP as the manager of this pass.
1780 /// Find appropriate Basic Pass Manager or Call Graph Pass Manager
1781 /// in the PM Stack and add self into that manager.
1782 void BasicBlockPass::assignPassManager(PMStack &PMS,
1783 PassManagerType PreferredType) {
1786 // Basic Pass Manager is a leaf pass manager. It does not handle
1787 // any other pass manager.
1789 PMS.top()->getPassManagerType() == PMT_BasicBlockPassManager) {
1790 BBP = (BBPassManager *)PMS.top();
1792 // If leaf manager is not Basic Block Pass manager then create new
1793 // basic Block Pass manager.
1794 assert(!PMS.empty() && "Unable to create BasicBlock Pass Manager");
1795 PMDataManager *PMD = PMS.top();
1797 // [1] Create new Basic Block Manager
1798 BBP = new BBPassManager(PMD->getDepth() + 1);
1800 // [2] Set up new manager's top level manager
1801 // Basic Block Pass Manager does not live by itself
1802 PMTopLevelManager *TPM = PMD->getTopLevelManager();
1803 TPM->addIndirectPassManager(BBP);
1805 // [3] Assign manager to manage this new manager. This may create
1806 // and push new managers into PMS
1807 BBP->assignPassManager(PMS, PreferredType);
1809 // [4] Push new manager into PMS
1813 // Assign BBP as the manager of this pass.
1817 PassManagerBase::~PassManagerBase() {}