1 //===- PassManager.cpp - LLVM Pass Infrastructure Implementation ----------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Devang Patel and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the LLVM Pass Manager infrastructure.
12 //===----------------------------------------------------------------------===//
15 #include "llvm/PassManagers.h"
16 #include "llvm/Support/CommandLine.h"
17 #include "llvm/Support/Timer.h"
18 #include "llvm/Module.h"
19 #include "llvm/ModuleProvider.h"
20 #include "llvm/Support/Streams.h"
21 #include "llvm/Support/ManagedStatic.h"
26 // See PassManagers.h for Pass Manager infrastructure overview.
30 //===----------------------------------------------------------------------===//
31 // Pass debugging information. Often it is useful to find out what pass is
32 // running when a crash occurs in a utility. When this library is compiled with
33 // debugging on, a command line option (--debug-pass) is enabled that causes the
34 // pass name to be printed before it executes.
37 // Different debug levels that can be enabled...
39 None, Arguments, Structure, Executions, Details
42 static cl::opt<enum PassDebugLevel>
43 PassDebugging("debug-pass", cl::Hidden,
44 cl::desc("Print PassManager debugging information"),
46 clEnumVal(None , "disable debug output"),
47 clEnumVal(Arguments , "print pass arguments to pass to 'opt'"),
48 clEnumVal(Structure , "print pass structure before run()"),
49 clEnumVal(Executions, "print pass name before it is executed"),
50 clEnumVal(Details , "print pass details when it is executed"),
52 } // End of llvm namespace
56 //===----------------------------------------------------------------------===//
59 /// BBPassManager manages BasicBlockPass. It batches all the
60 /// pass together and sequence them to process one basic block before
61 /// processing next basic block.
62 class VISIBILITY_HIDDEN BBPassManager : public PMDataManager,
66 BBPassManager(int Depth) : PMDataManager(Depth) { }
68 /// Execute all of the passes scheduled for execution. Keep track of
69 /// whether any of the passes modifies the function, and if so, return true.
70 bool runOnFunction(Function &F);
72 /// Pass Manager itself does not invalidate any analysis info.
73 void getAnalysisUsage(AnalysisUsage &Info) const {
74 Info.setPreservesAll();
77 bool doInitialization(Module &M);
78 bool doInitialization(Function &F);
79 bool doFinalization(Module &M);
80 bool doFinalization(Function &F);
82 virtual const char *getPassName() const {
83 return "BasicBlock Pass Manager";
86 // Print passes managed by this manager
87 void dumpPassStructure(unsigned Offset) {
88 llvm::cerr << std::string(Offset*2, ' ') << "BasicBlockPass Manager\n";
89 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
90 BasicBlockPass *BP = getContainedPass(Index);
91 BP->dumpPassStructure(Offset + 1);
92 dumpLastUses(BP, Offset+1);
96 BasicBlockPass *getContainedPass(unsigned N) {
97 assert ( N < PassVector.size() && "Pass number out of range!");
98 BasicBlockPass *BP = static_cast<BasicBlockPass *>(PassVector[N]);
102 virtual PassManagerType getPassManagerType() const {
103 return PMT_BasicBlockPassManager;
111 //===----------------------------------------------------------------------===//
112 // FunctionPassManagerImpl
114 /// FunctionPassManagerImpl manages FPPassManagers
115 class FunctionPassManagerImpl : public Pass,
116 public PMDataManager,
117 public PMTopLevelManager {
120 FunctionPassManagerImpl(int Depth) : PMDataManager(Depth),
121 PMTopLevelManager(TLM_Function) { }
123 /// add - Add a pass to the queue of passes to run. This passes ownership of
124 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
125 /// will be destroyed as well, so there is no need to delete the pass. This
126 /// implies that all passes MUST be allocated with 'new'.
131 /// run - Execute all of the passes scheduled for execution. Keep track of
132 /// whether any of the passes modifies the module, and if so, return true.
133 bool run(Function &F);
135 /// doInitialization - Run all of the initializers for the function passes.
137 bool doInitialization(Module &M);
139 /// doFinalization - Run all of the initializers for the function passes.
141 bool doFinalization(Module &M);
143 /// Pass Manager itself does not invalidate any analysis info.
144 void getAnalysisUsage(AnalysisUsage &Info) const {
145 Info.setPreservesAll();
148 inline void addTopLevelPass(Pass *P) {
150 if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
152 // P is a immutable pass and it will be managed by this
153 // top level manager. Set up analysis resolver to connect them.
154 AnalysisResolver *AR = new AnalysisResolver(*this);
156 initializeAnalysisImpl(P);
157 addImmutablePass(IP);
158 recordAvailableAnalysis(IP);
160 P->assignPassManager(activeStack);
165 FPPassManager *getContainedManager(unsigned N) {
166 assert ( N < PassManagers.size() && "Pass number out of range!");
167 FPPassManager *FP = static_cast<FPPassManager *>(PassManagers[N]);
173 //===----------------------------------------------------------------------===//
176 /// MPPassManager manages ModulePasses and function pass managers.
177 /// It batches all Module passes passes and function pass managers together and
178 /// sequence them to process one module.
179 class MPPassManager : public Pass, public PMDataManager {
182 MPPassManager(int Depth) : PMDataManager(Depth) { }
184 /// run - Execute all of the passes scheduled for execution. Keep track of
185 /// whether any of the passes modifies the module, and if so, return true.
186 bool runOnModule(Module &M);
188 /// Pass Manager itself does not invalidate any analysis info.
189 void getAnalysisUsage(AnalysisUsage &Info) const {
190 Info.setPreservesAll();
193 virtual const char *getPassName() const {
194 return "Module Pass Manager";
197 // Print passes managed by this manager
198 void dumpPassStructure(unsigned Offset) {
199 llvm::cerr << std::string(Offset*2, ' ') << "ModulePass Manager\n";
200 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
201 ModulePass *MP = getContainedPass(Index);
202 MP->dumpPassStructure(Offset + 1);
203 dumpLastUses(MP, Offset+1);
207 ModulePass *getContainedPass(unsigned N) {
208 assert ( N < PassVector.size() && "Pass number out of range!");
209 ModulePass *MP = static_cast<ModulePass *>(PassVector[N]);
213 virtual PassManagerType getPassManagerType() const {
214 return PMT_ModulePassManager;
218 //===----------------------------------------------------------------------===//
221 /// PassManagerImpl manages MPPassManagers
222 class PassManagerImpl : public Pass,
223 public PMDataManager,
224 public PMTopLevelManager {
228 PassManagerImpl(int Depth) : PMDataManager(Depth),
229 PMTopLevelManager(TLM_Pass) { }
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 /// run - Execute all of the passes scheduled for execution. Keep track of
240 /// whether any of the passes modifies the module, and if so, return true.
243 /// Pass Manager itself does not invalidate any analysis info.
244 void getAnalysisUsage(AnalysisUsage &Info) const {
245 Info.setPreservesAll();
248 inline void addTopLevelPass(Pass *P) {
250 if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
252 // P is a immutable pass and it will be managed by this
253 // top level manager. Set up analysis resolver to connect them.
254 AnalysisResolver *AR = new AnalysisResolver(*this);
256 initializeAnalysisImpl(P);
257 addImmutablePass(IP);
258 recordAvailableAnalysis(IP);
260 P->assignPassManager(activeStack);
265 MPPassManager *getContainedManager(unsigned N) {
266 assert ( N < PassManagers.size() && "Pass number out of range!");
267 MPPassManager *MP = static_cast<MPPassManager *>(PassManagers[N]);
273 } // End of llvm namespace
277 //===----------------------------------------------------------------------===//
278 // TimingInfo Class - This class is used to calculate information about the
279 // amount of time each pass takes to execute. This only happens when
280 // -time-passes is enabled on the command line.
283 class VISIBILITY_HIDDEN TimingInfo {
284 std::map<Pass*, Timer> TimingData;
288 // Use 'create' member to get this.
289 TimingInfo() : TG("... Pass execution timing report ...") {}
291 // TimingDtor - Print out information about timing information
293 // Delete all of the timers...
295 // TimerGroup is deleted next, printing the report.
298 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer
299 // to a non null value (if the -time-passes option is enabled) or it leaves it
300 // null. It may be called multiple times.
301 static void createTheTimeInfo();
303 void passStarted(Pass *P) {
305 if (dynamic_cast<PMDataManager *>(P))
308 std::map<Pass*, Timer>::iterator I = TimingData.find(P);
309 if (I == TimingData.end())
310 I=TimingData.insert(std::make_pair(P, Timer(P->getPassName(), TG))).first;
311 I->second.startTimer();
313 void passEnded(Pass *P) {
315 if (dynamic_cast<PMDataManager *>(P))
318 std::map<Pass*, Timer>::iterator I = TimingData.find(P);
319 assert (I != TimingData.end() && "passStarted/passEnded not nested right!");
320 I->second.stopTimer();
324 static TimingInfo *TheTimeInfo;
326 } // End of anon namespace
328 //===----------------------------------------------------------------------===//
329 // PMTopLevelManager implementation
331 /// Initialize top level manager. Create first pass manager.
332 PMTopLevelManager::PMTopLevelManager (enum TopLevelManagerType t) {
335 MPPassManager *MPP = new MPPassManager(1);
336 MPP->setTopLevelManager(this);
338 activeStack.push(MPP);
340 else if (t == TLM_Function) {
341 FPPassManager *FPP = new FPPassManager(1);
342 FPP->setTopLevelManager(this);
344 activeStack.push(FPP);
348 /// Set pass P as the last user of the given analysis passes.
349 void PMTopLevelManager::setLastUser(std::vector<Pass *> &AnalysisPasses,
352 for (std::vector<Pass *>::iterator I = AnalysisPasses.begin(),
353 E = AnalysisPasses.end(); I != E; ++I) {
360 // If AP is the last user of other passes then make P last user of
362 for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
363 LUE = LastUser.end(); LUI != LUE; ++LUI) {
364 if (LUI->second == AP)
365 LastUser[LUI->first] = P;
370 /// Collect passes whose last user is P
371 void PMTopLevelManager::collectLastUses(std::vector<Pass *> &LastUses,
373 for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
374 LUE = LastUser.end(); LUI != LUE; ++LUI)
375 if (LUI->second == P)
376 LastUses.push_back(LUI->first);
379 /// Schedule pass P for execution. Make sure that passes required by
380 /// P are run before P is run. Update analysis info maintained by
381 /// the manager. Remove dead passes. This is a recursive function.
382 void PMTopLevelManager::schedulePass(Pass *P) {
384 // TODO : Allocate function manager for this pass, other wise required set
385 // may be inserted into previous function manager
387 // If this Analysis is already requested by one of the previous pass
388 // and it is still available then do not insert new pass in the queue again.
389 if (findAnalysisPass(P->getPassInfo()))
392 // Give pass a chance to prepare the stage.
393 P->preparePassManager(activeStack);
395 AnalysisUsage AnUsage;
396 P->getAnalysisUsage(AnUsage);
397 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
398 for (std::vector<AnalysisID>::const_iterator I = RequiredSet.begin(),
399 E = RequiredSet.end(); I != E; ++I) {
401 Pass *AnalysisPass = findAnalysisPass(*I);
403 // Schedule this analysis run first.
404 AnalysisPass = (*I)->createPass();
405 schedulePass(AnalysisPass);
409 // Now all required passes are available.
413 /// Find the pass that implements Analysis AID. Search immutable
414 /// passes and all pass managers. If desired pass is not found
415 /// then return NULL.
416 Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
419 // Check pass managers
420 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
421 E = PassManagers.end(); P == NULL && I != E; ++I) {
422 PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
423 assert(PMD && "This is not a PassManager");
424 P = PMD->findAnalysisPass(AID, false);
427 // Check other pass managers
428 for (std::vector<PMDataManager *>::iterator I = IndirectPassManagers.begin(),
429 E = IndirectPassManagers.end(); P == NULL && I != E; ++I)
430 P = (*I)->findAnalysisPass(AID, false);
432 for (std::vector<ImmutablePass *>::iterator I = ImmutablePasses.begin(),
433 E = ImmutablePasses.end(); P == NULL && I != E; ++I) {
434 const PassInfo *PI = (*I)->getPassInfo();
438 // If Pass not found then check the interfaces implemented by Immutable Pass
440 const std::vector<const PassInfo*> &ImmPI = PI->getInterfacesImplemented();
441 if (std::find(ImmPI.begin(), ImmPI.end(), AID) != ImmPI.end())
449 // Print passes managed by this top level manager.
450 void PMTopLevelManager::dumpPasses() const {
452 if (PassDebugging < Structure)
455 // Print out the immutable passes
456 for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
457 ImmutablePasses[i]->dumpPassStructure(0);
460 for (std::vector<Pass *>::const_iterator I = PassManagers.begin(),
461 E = PassManagers.end(); I != E; ++I)
462 (*I)->dumpPassStructure(1);
465 void PMTopLevelManager::dumpArguments() const {
467 if (PassDebugging < Arguments)
470 cerr << "Pass Arguments: ";
471 for (std::vector<Pass *>::const_iterator I = PassManagers.begin(),
472 E = PassManagers.end(); I != E; ++I) {
473 PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
474 assert(PMD && "This is not a PassManager");
475 PMD->dumpPassArguments();
480 void PMTopLevelManager::initializeAllAnalysisInfo() {
482 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
483 E = PassManagers.end(); I != E; ++I) {
484 PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
485 assert(PMD && "This is not a PassManager");
486 PMD->initializeAnalysisInfo();
489 // Initailize other pass managers
490 for (std::vector<PMDataManager *>::iterator I = IndirectPassManagers.begin(),
491 E = IndirectPassManagers.end(); I != E; ++I)
492 (*I)->initializeAnalysisInfo();
496 PMTopLevelManager::~PMTopLevelManager() {
497 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
498 E = PassManagers.end(); I != E; ++I)
501 for (std::vector<ImmutablePass *>::iterator
502 I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
505 PassManagers.clear();
508 //===----------------------------------------------------------------------===//
509 // PMDataManager implementation
511 /// Return true IFF pass P's required analysis set does not required new
513 bool PMDataManager::manageablePass(Pass *P) {
516 // If this pass is not preserving information that is required by a
517 // pass maintained by higher level pass manager then do not insert
518 // this pass into current manager. Use new manager. For example,
519 // For example, If FunctionPass F is not preserving ModulePass Info M1
520 // that is used by another ModulePass M2 then do not insert F in
521 // current function pass manager.
525 /// Augement AvailableAnalysis by adding analysis made available by pass P.
526 void PMDataManager::recordAvailableAnalysis(Pass *P) {
528 if (const PassInfo *PI = P->getPassInfo()) {
529 AvailableAnalysis[PI] = P;
531 //This pass is the current implementation of all of the interfaces it
532 //implements as well.
533 const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
534 for (unsigned i = 0, e = II.size(); i != e; ++i)
535 AvailableAnalysis[II[i]] = P;
539 // Return true if P preserves high level analysis used by other
540 // passes managed by this manager
541 bool PMDataManager::preserveHigherLevelAnalysis(Pass *P) {
543 AnalysisUsage AnUsage;
544 P->getAnalysisUsage(AnUsage);
546 if (AnUsage.getPreservesAll())
549 const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
550 for (std::vector<Pass *>::iterator I = HigherLevelAnalysis.begin(),
551 E = HigherLevelAnalysis.end(); I != E; ++I) {
553 if (!dynamic_cast<ImmutablePass*>(P1)
554 && std::find(PreservedSet.begin(), PreservedSet.end(), P1->getPassInfo()) ==
562 /// Remove Analyss not preserved by Pass P
563 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
564 AnalysisUsage AnUsage;
565 P->getAnalysisUsage(AnUsage);
567 if (AnUsage.getPreservesAll())
570 const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
571 for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
572 E = AvailableAnalysis.end(); I != E; ) {
573 std::map<AnalysisID, Pass*>::iterator Info = I++;
574 if (!dynamic_cast<ImmutablePass*>(Info->second)
575 && std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
577 // Remove this analysis
578 AvailableAnalysis.erase(Info);
581 // Check inherited analysis also. If P is not preserving analysis
582 // provided by parent manager then remove it here.
583 for (unsigned Index = 0; Index < PMT_Last; ++Index) {
585 if (!InheritedAnalysis[Index])
588 for (std::map<AnalysisID, Pass*>::iterator
589 I = InheritedAnalysis[Index]->begin(),
590 E = InheritedAnalysis[Index]->end(); I != E; ) {
591 std::map<AnalysisID, Pass *>::iterator Info = I++;
592 if (!dynamic_cast<ImmutablePass*>(Info->second)
593 && std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
595 // Remove this analysis
596 InheritedAnalysis[Index]->erase(Info);
602 /// Remove analysis passes that are not used any longer
603 void PMDataManager::removeDeadPasses(Pass *P, std::string Msg,
604 enum PassDebuggingString DBG_STR) {
606 std::vector<Pass *> DeadPasses;
607 TPM->collectLastUses(DeadPasses, P);
609 for (std::vector<Pass *>::iterator I = DeadPasses.begin(),
610 E = DeadPasses.end(); I != E; ++I) {
612 dumpPassInfo(*I, FREEING_MSG, DBG_STR, Msg);
614 if (TheTimeInfo) TheTimeInfo->passStarted(*I);
615 (*I)->releaseMemory();
616 if (TheTimeInfo) TheTimeInfo->passEnded(*I);
618 std::map<AnalysisID, Pass*>::iterator Pos =
619 AvailableAnalysis.find((*I)->getPassInfo());
621 // It is possible that pass is already removed from the AvailableAnalysis
622 if (Pos != AvailableAnalysis.end())
623 AvailableAnalysis.erase(Pos);
627 /// Add pass P into the PassVector. Update
628 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
629 void PMDataManager::add(Pass *P,
630 bool ProcessAnalysis) {
632 // This manager is going to manage pass P. Set up analysis resolver
634 AnalysisResolver *AR = new AnalysisResolver(*this);
637 // If a FunctionPass F is the last user of ModulePass info M
638 // then the F's manager, not F, records itself as a last user of M.
639 std::vector<Pass *> TransferLastUses;
641 if (ProcessAnalysis) {
643 // At the moment, this pass is the last user of all required passes.
644 std::vector<Pass *> LastUses;
645 std::vector<Pass *> RequiredPasses;
646 unsigned PDepth = this->getDepth();
648 collectRequiredAnalysisPasses(RequiredPasses, P);
649 for (std::vector<Pass *>::iterator I = RequiredPasses.begin(),
650 E = RequiredPasses.end(); I != E; ++I) {
651 Pass *PRequired = *I;
654 PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
655 RDepth = DM.getDepth();
657 if (PDepth == RDepth)
658 LastUses.push_back(PRequired);
659 else if (PDepth > RDepth) {
660 // Let the parent claim responsibility of last use
661 TransferLastUses.push_back(PRequired);
662 // Keep track of higher level analysis used by this manager.
663 HigherLevelAnalysis.push_back(PRequired);
665 // Note : This feature is not yet implemented
667 "Unable to handle Pass that requires lower level Analysis pass");
671 // Set P as P's last user until someone starts using P.
672 // However, if P is a Pass Manager then it does not need
673 // to record its last user.
674 if (!dynamic_cast<PMDataManager *>(P))
675 LastUses.push_back(P);
676 TPM->setLastUser(LastUses, P);
678 if (!TransferLastUses.empty()) {
679 Pass *My_PM = dynamic_cast<Pass *>(this);
680 TPM->setLastUser(TransferLastUses, My_PM);
681 TransferLastUses.clear();
684 // Take a note of analysis required and made available by this pass.
685 // Remove the analysis not preserved by this pass
686 removeNotPreservedAnalysis(P);
687 recordAvailableAnalysis(P);
691 PassVector.push_back(P);
694 /// Populate RequiredPasses with the analysis pass that are required by
696 void PMDataManager::collectRequiredAnalysisPasses(std::vector<Pass *> &RP,
698 AnalysisUsage AnUsage;
699 P->getAnalysisUsage(AnUsage);
700 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
701 for (std::vector<AnalysisID>::const_iterator
702 I = RequiredSet.begin(), E = RequiredSet.end();
704 Pass *AnalysisPass = findAnalysisPass(*I, true);
705 assert (AnalysisPass && "Analysis pass is not available");
706 RP.push_back(AnalysisPass);
709 const std::vector<AnalysisID> &IDs = AnUsage.getRequiredTransitiveSet();
710 for (std::vector<AnalysisID>::const_iterator I = IDs.begin(),
711 E = IDs.end(); I != E; ++I) {
712 Pass *AnalysisPass = findAnalysisPass(*I, true);
713 assert (AnalysisPass && "Analysis pass is not available");
714 RP.push_back(AnalysisPass);
718 // All Required analyses should be available to the pass as it runs! Here
719 // we fill in the AnalysisImpls member of the pass so that it can
720 // successfully use the getAnalysis() method to retrieve the
721 // implementations it needs.
723 void PMDataManager::initializeAnalysisImpl(Pass *P) {
724 AnalysisUsage AnUsage;
725 P->getAnalysisUsage(AnUsage);
727 for (std::vector<const PassInfo *>::const_iterator
728 I = AnUsage.getRequiredSet().begin(),
729 E = AnUsage.getRequiredSet().end(); I != E; ++I) {
730 Pass *Impl = findAnalysisPass(*I, true);
732 assert(0 && "Analysis used but not available!");
733 AnalysisResolver *AR = P->getResolver();
734 AR->addAnalysisImplsPair(*I, Impl);
738 /// Find the pass that implements Analysis AID. If desired pass is not found
739 /// then return NULL.
740 Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
742 // Check if AvailableAnalysis map has one entry.
743 std::map<AnalysisID, Pass*>::const_iterator I = AvailableAnalysis.find(AID);
745 if (I != AvailableAnalysis.end())
748 // Search Parents through TopLevelManager
750 return TPM->findAnalysisPass(AID);
755 // Print list of passes that are last used by P.
756 void PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{
758 std::vector<Pass *> LUses;
760 assert (TPM && "Top Level Manager is missing");
761 TPM->collectLastUses(LUses, P);
763 for (std::vector<Pass *>::iterator I = LUses.begin(),
764 E = LUses.end(); I != E; ++I) {
765 llvm::cerr << "--" << std::string(Offset*2, ' ');
766 (*I)->dumpPassStructure(0);
770 void PMDataManager::dumpPassArguments() const {
771 for(std::vector<Pass *>::const_iterator I = PassVector.begin(),
772 E = PassVector.end(); I != E; ++I) {
773 if (PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I))
774 PMD->dumpPassArguments();
776 if (const PassInfo *PI = (*I)->getPassInfo())
777 if (!PI->isAnalysisGroup())
778 cerr << " -" << PI->getPassArgument();
782 void PMDataManager:: dumpPassInfo(Pass *P, enum PassDebuggingString S1,
783 enum PassDebuggingString S2,
785 if (PassDebugging < Executions)
787 cerr << (void*)this << std::string(getDepth()*2+1, ' ');
790 cerr << "Executing Pass '" << P->getPassName();
792 case MODIFICATION_MSG:
793 cerr << "' Made Modification '" << P->getPassName();
796 cerr << " Freeing Pass '" << P->getPassName();
802 case ON_BASICBLOCK_MSG:
803 cerr << "' on BasicBlock '" << Msg << "...\n";
805 case ON_FUNCTION_MSG:
806 cerr << "' on Function '" << Msg << "...\n";
809 cerr << "' on Module '" << Msg << "...\n";
812 cerr << "' on Loop " << Msg << "...\n";
815 cerr << "' on Call Graph " << Msg << "...\n";
822 void PMDataManager::dumpAnalysisSetInfo(const char *Msg, Pass *P,
823 const std::vector<AnalysisID> &Set)
825 if (PassDebugging >= Details && !Set.empty()) {
826 cerr << (void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:";
827 for (unsigned i = 0; i != Set.size(); ++i) {
829 cerr << " " << Set[i]->getPassName();
836 PMDataManager::~PMDataManager() {
838 for (std::vector<Pass *>::iterator I = PassVector.begin(),
839 E = PassVector.end(); I != E; ++I)
845 //===----------------------------------------------------------------------===//
846 // NOTE: Is this the right place to define this method ?
847 // getAnalysisToUpdate - Return an analysis result or null if it doesn't exist
848 Pass *AnalysisResolver::getAnalysisToUpdate(AnalysisID ID, bool dir) const {
849 return PM.findAnalysisPass(ID, dir);
852 //===----------------------------------------------------------------------===//
853 // BBPassManager implementation
855 /// Execute all of the passes scheduled for execution by invoking
856 /// runOnBasicBlock method. Keep track of whether any of the passes modifies
857 /// the function, and if so, return true.
859 BBPassManager::runOnFunction(Function &F) {
861 if (F.isDeclaration())
864 bool Changed = doInitialization(F);
866 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
867 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
868 BasicBlockPass *BP = getContainedPass(Index);
869 AnalysisUsage AnUsage;
870 BP->getAnalysisUsage(AnUsage);
872 dumpPassInfo(BP, EXECUTION_MSG, ON_BASICBLOCK_MSG, (*I).getName());
873 dumpAnalysisSetInfo("Required", BP, AnUsage.getRequiredSet());
875 initializeAnalysisImpl(BP);
877 if (TheTimeInfo) TheTimeInfo->passStarted(BP);
878 Changed |= BP->runOnBasicBlock(*I);
879 if (TheTimeInfo) TheTimeInfo->passEnded(BP);
882 dumpPassInfo(BP, MODIFICATION_MSG, ON_BASICBLOCK_MSG, (*I).getName());
883 dumpAnalysisSetInfo("Preserved", BP, AnUsage.getPreservedSet());
885 removeNotPreservedAnalysis(BP);
886 recordAvailableAnalysis(BP);
887 removeDeadPasses(BP, (*I).getName(), ON_BASICBLOCK_MSG);
890 return Changed |= doFinalization(F);
893 // Implement doInitialization and doFinalization
894 inline bool BBPassManager::doInitialization(Module &M) {
895 bool Changed = false;
897 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
898 BasicBlockPass *BP = getContainedPass(Index);
899 Changed |= BP->doInitialization(M);
905 inline bool BBPassManager::doFinalization(Module &M) {
906 bool Changed = false;
908 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
909 BasicBlockPass *BP = getContainedPass(Index);
910 Changed |= BP->doFinalization(M);
916 inline bool BBPassManager::doInitialization(Function &F) {
917 bool Changed = false;
919 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
920 BasicBlockPass *BP = getContainedPass(Index);
921 Changed |= BP->doInitialization(F);
927 inline bool BBPassManager::doFinalization(Function &F) {
928 bool Changed = false;
930 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
931 BasicBlockPass *BP = getContainedPass(Index);
932 Changed |= BP->doFinalization(F);
939 //===----------------------------------------------------------------------===//
940 // FunctionPassManager implementation
942 /// Create new Function pass manager
943 FunctionPassManager::FunctionPassManager(ModuleProvider *P) {
944 FPM = new FunctionPassManagerImpl(0);
945 // FPM is the top level manager.
946 FPM->setTopLevelManager(FPM);
948 PMDataManager *PMD = dynamic_cast<PMDataManager *>(FPM);
949 AnalysisResolver *AR = new AnalysisResolver(*PMD);
950 FPM->setResolver(AR);
955 FunctionPassManager::~FunctionPassManager() {
959 /// add - Add a pass to the queue of passes to run. This passes
960 /// ownership of the Pass to the PassManager. When the
961 /// PassManager_X is destroyed, the pass will be destroyed as well, so
962 /// there is no need to delete the pass. (TODO delete passes.)
963 /// This implies that all passes MUST be allocated with 'new'.
964 void FunctionPassManager::add(Pass *P) {
968 /// run - Execute all of the passes scheduled for execution. Keep
969 /// track of whether any of the passes modifies the function, and if
972 bool FunctionPassManager::run(Function &F) {
974 if (MP->materializeFunction(&F, &errstr)) {
975 cerr << "Error reading bytecode file: " << errstr << "\n";
982 /// doInitialization - Run all of the initializers for the function passes.
984 bool FunctionPassManager::doInitialization() {
985 return FPM->doInitialization(*MP->getModule());
988 /// doFinalization - Run all of the initializers for the function passes.
990 bool FunctionPassManager::doFinalization() {
991 return FPM->doFinalization(*MP->getModule());
994 //===----------------------------------------------------------------------===//
995 // FunctionPassManagerImpl implementation
997 inline bool FunctionPassManagerImpl::doInitialization(Module &M) {
998 bool Changed = false;
1000 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1001 FPPassManager *FP = getContainedManager(Index);
1002 Changed |= FP->doInitialization(M);
1008 inline bool FunctionPassManagerImpl::doFinalization(Module &M) {
1009 bool Changed = false;
1011 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1012 FPPassManager *FP = getContainedManager(Index);
1013 Changed |= FP->doFinalization(M);
1019 // Execute all the passes managed by this top level manager.
1020 // Return true if any function is modified by a pass.
1021 bool FunctionPassManagerImpl::run(Function &F) {
1023 bool Changed = false;
1025 TimingInfo::createTheTimeInfo();
1030 initializeAllAnalysisInfo();
1031 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1032 FPPassManager *FP = getContainedManager(Index);
1033 Changed |= FP->runOnFunction(F);
1038 //===----------------------------------------------------------------------===//
1039 // FPPassManager implementation
1041 /// Print passes managed by this manager
1042 void FPPassManager::dumpPassStructure(unsigned Offset) {
1043 llvm::cerr << std::string(Offset*2, ' ') << "FunctionPass Manager\n";
1044 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1045 FunctionPass *FP = getContainedPass(Index);
1046 FP->dumpPassStructure(Offset + 1);
1047 dumpLastUses(FP, Offset+1);
1052 /// Execute all of the passes scheduled for execution by invoking
1053 /// runOnFunction method. Keep track of whether any of the passes modifies
1054 /// the function, and if so, return true.
1055 bool FPPassManager::runOnFunction(Function &F) {
1057 bool Changed = false;
1059 if (F.isDeclaration())
1062 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1063 FunctionPass *FP = getContainedPass(Index);
1065 AnalysisUsage AnUsage;
1066 FP->getAnalysisUsage(AnUsage);
1068 dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getName());
1069 dumpAnalysisSetInfo("Required", FP, AnUsage.getRequiredSet());
1071 initializeAnalysisImpl(FP);
1073 if (TheTimeInfo) TheTimeInfo->passStarted(FP);
1074 Changed |= FP->runOnFunction(F);
1075 if (TheTimeInfo) TheTimeInfo->passEnded(FP);
1078 dumpPassInfo(FP, MODIFICATION_MSG, ON_FUNCTION_MSG, F.getName());
1079 dumpAnalysisSetInfo("Preserved", FP, AnUsage.getPreservedSet());
1081 removeNotPreservedAnalysis(FP);
1082 recordAvailableAnalysis(FP);
1083 removeDeadPasses(FP, F.getName(), ON_FUNCTION_MSG);
1088 bool FPPassManager::runOnModule(Module &M) {
1090 bool Changed = doInitialization(M);
1092 for(Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1093 this->runOnFunction(*I);
1095 return Changed |= doFinalization(M);
1098 inline bool FPPassManager::doInitialization(Module &M) {
1099 bool Changed = false;
1101 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1102 FunctionPass *FP = getContainedPass(Index);
1103 Changed |= FP->doInitialization(M);
1109 inline bool FPPassManager::doFinalization(Module &M) {
1110 bool Changed = false;
1112 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1113 FunctionPass *FP = getContainedPass(Index);
1114 Changed |= FP->doFinalization(M);
1120 //===----------------------------------------------------------------------===//
1121 // MPPassManager implementation
1123 /// Execute all of the passes scheduled for execution by invoking
1124 /// runOnModule method. Keep track of whether any of the passes modifies
1125 /// the module, and if so, return true.
1127 MPPassManager::runOnModule(Module &M) {
1128 bool Changed = false;
1130 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1131 ModulePass *MP = getContainedPass(Index);
1133 AnalysisUsage AnUsage;
1134 MP->getAnalysisUsage(AnUsage);
1136 dumpPassInfo(MP, EXECUTION_MSG, ON_MODULE_MSG, M.getModuleIdentifier());
1137 dumpAnalysisSetInfo("Required", MP, AnUsage.getRequiredSet());
1139 initializeAnalysisImpl(MP);
1141 if (TheTimeInfo) TheTimeInfo->passStarted(MP);
1142 Changed |= MP->runOnModule(M);
1143 if (TheTimeInfo) TheTimeInfo->passEnded(MP);
1146 dumpPassInfo(MP, MODIFICATION_MSG, ON_MODULE_MSG,
1147 M.getModuleIdentifier());
1148 dumpAnalysisSetInfo("Preserved", MP, AnUsage.getPreservedSet());
1150 removeNotPreservedAnalysis(MP);
1151 recordAvailableAnalysis(MP);
1152 removeDeadPasses(MP, M.getModuleIdentifier(), ON_MODULE_MSG);
1157 //===----------------------------------------------------------------------===//
1158 // PassManagerImpl implementation
1160 /// run - Execute all of the passes scheduled for execution. Keep track of
1161 /// whether any of the passes modifies the module, and if so, return true.
1162 bool PassManagerImpl::run(Module &M) {
1164 bool Changed = false;
1166 TimingInfo::createTheTimeInfo();
1171 initializeAllAnalysisInfo();
1172 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1173 MPPassManager *MP = getContainedManager(Index);
1174 Changed |= MP->runOnModule(M);
1179 //===----------------------------------------------------------------------===//
1180 // PassManager implementation
1182 /// Create new pass manager
1183 PassManager::PassManager() {
1184 PM = new PassManagerImpl(0);
1185 // PM is the top level manager
1186 PM->setTopLevelManager(PM);
1189 PassManager::~PassManager() {
1193 /// add - Add a pass to the queue of passes to run. This passes ownership of
1194 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
1195 /// will be destroyed as well, so there is no need to delete the pass. This
1196 /// implies that all passes MUST be allocated with 'new'.
1198 PassManager::add(Pass *P) {
1202 /// run - Execute all of the passes scheduled for execution. Keep track of
1203 /// whether any of the passes modifies the module, and if so, return true.
1205 PassManager::run(Module &M) {
1209 //===----------------------------------------------------------------------===//
1210 // TimingInfo Class - This class is used to calculate information about the
1211 // amount of time each pass takes to execute. This only happens with
1212 // -time-passes is enabled on the command line.
1214 bool llvm::TimePassesIsEnabled = false;
1215 static cl::opt<bool,true>
1216 EnableTiming("time-passes", cl::location(TimePassesIsEnabled),
1217 cl::desc("Time each pass, printing elapsed time for each on exit"));
1219 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
1220 // a non null value (if the -time-passes option is enabled) or it leaves it
1221 // null. It may be called multiple times.
1222 void TimingInfo::createTheTimeInfo() {
1223 if (!TimePassesIsEnabled || TheTimeInfo) return;
1225 // Constructed the first time this is called, iff -time-passes is enabled.
1226 // This guarantees that the object will be constructed before static globals,
1227 // thus it will be destroyed before them.
1228 static ManagedStatic<TimingInfo> TTI;
1229 TheTimeInfo = &*TTI;
1232 /// If TimingInfo is enabled then start pass timer.
1233 void StartPassTimer(Pass *P) {
1235 TheTimeInfo->passStarted(P);
1238 /// If TimingInfo is enabled then stop pass timer.
1239 void StopPassTimer(Pass *P) {
1241 TheTimeInfo->passEnded(P);
1244 //===----------------------------------------------------------------------===//
1245 // PMStack implementation
1248 // Pop Pass Manager from the stack and clear its analysis info.
1249 void PMStack::pop() {
1251 PMDataManager *Top = this->top();
1252 Top->initializeAnalysisInfo();
1257 // Push PM on the stack and set its top level manager.
1258 void PMStack::push(Pass *P) {
1260 PMDataManager *Top = NULL;
1261 PMDataManager *PM = dynamic_cast<PMDataManager *>(P);
1262 assert (PM && "Unable to push. Pass Manager expected");
1264 if (this->empty()) {
1269 PMTopLevelManager *TPM = Top->getTopLevelManager();
1271 assert (TPM && "Unable to find top level manager");
1272 TPM->addIndirectPassManager(PM);
1273 PM->setTopLevelManager(TPM);
1276 AnalysisResolver *AR = new AnalysisResolver(*Top);
1282 // Dump content of the pass manager stack.
1283 void PMStack::dump() {
1284 for(std::deque<PMDataManager *>::iterator I = S.begin(),
1285 E = S.end(); I != E; ++I) {
1286 Pass *P = dynamic_cast<Pass *>(*I);
1287 printf ("%s ", P->getPassName());
1293 /// Find appropriate Module Pass Manager in the PM Stack and
1294 /// add self into that manager.
1295 void ModulePass::assignPassManager(PMStack &PMS,
1296 PassManagerType PreferredType) {
1298 // Find Module Pass Manager
1299 while(!PMS.empty()) {
1300 PassManagerType TopPMType = PMS.top()->getPassManagerType();
1301 if (TopPMType == PreferredType)
1302 break; // We found desired pass manager
1303 else if (TopPMType > PMT_ModulePassManager)
1304 PMS.pop(); // Pop children pass managers
1309 PMS.top()->add(this);
1312 /// Find appropriate Function Pass Manager or Call Graph Pass Manager
1313 /// in the PM Stack and add self into that manager.
1314 void FunctionPass::assignPassManager(PMStack &PMS,
1315 PassManagerType PreferredType) {
1317 // Find Module Pass Manager (TODO : Or Call Graph Pass Manager)
1318 while(!PMS.empty()) {
1319 if (PMS.top()->getPassManagerType() > PMT_FunctionPassManager)
1324 FPPassManager *FPP = dynamic_cast<FPPassManager *>(PMS.top());
1326 // Create new Function Pass Manager
1328 assert(!PMS.empty() && "Unable to create Function Pass Manager");
1329 PMDataManager *PMD = PMS.top();
1331 // [1] Create new Function Pass Manager
1332 FPP = new FPPassManager(PMD->getDepth() + 1);
1334 // [2] Set up new manager's top level manager
1335 PMTopLevelManager *TPM = PMD->getTopLevelManager();
1336 TPM->addIndirectPassManager(FPP);
1338 // [3] Assign manager to manage this new manager. This may create
1339 // and push new managers into PMS
1340 Pass *P = dynamic_cast<Pass *>(FPP);
1342 // If Call Graph Pass Manager is active then use it to manage
1343 // this new Function Pass manager.
1344 if (PMD->getPassManagerType() == PMT_CallGraphPassManager)
1345 P->assignPassManager(PMS, PMT_CallGraphPassManager);
1347 P->assignPassManager(PMS);
1349 // [4] Push new manager into PMS
1353 // Assign FPP as the manager of this pass.
1357 /// Find appropriate Basic Pass Manager or Call Graph Pass Manager
1358 /// in the PM Stack and add self into that manager.
1359 void BasicBlockPass::assignPassManager(PMStack &PMS,
1360 PassManagerType PreferredType) {
1362 BBPassManager *BBP = NULL;
1364 // Basic Pass Manager is a leaf pass manager. It does not handle
1365 // any other pass manager.
1367 BBP = dynamic_cast<BBPassManager *>(PMS.top());
1370 // If leaf manager is not Basic Block Pass manager then create new
1371 // basic Block Pass manager.
1374 assert(!PMS.empty() && "Unable to create BasicBlock Pass Manager");
1375 PMDataManager *PMD = PMS.top();
1377 // [1] Create new Basic Block Manager
1378 BBP = new BBPassManager(PMD->getDepth() + 1);
1380 // [2] Set up new manager's top level manager
1381 // Basic Block Pass Manager does not live by itself
1382 PMTopLevelManager *TPM = PMD->getTopLevelManager();
1383 TPM->addIndirectPassManager(BBP);
1385 // [3] Assign manager to manage this new manager. This may create
1386 // and push new managers into PMS
1387 Pass *P = dynamic_cast<Pass *>(BBP);
1388 P->assignPassManager(PMS);
1390 // [4] Push new manager into PMS
1394 // Assign BBP as the manager of this pass.