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) {
356 // If AP is the last user of other passes then make P last user of
358 for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
359 LUE = LastUser.end(); LUI != LUE; ++LUI) {
360 if (LUI->second == AP)
361 LastUser[LUI->first] = P;
366 /// Collect passes whose last user is P
367 void PMTopLevelManager::collectLastUses(std::vector<Pass *> &LastUses,
369 for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
370 LUE = LastUser.end(); LUI != LUE; ++LUI)
371 if (LUI->second == P)
372 LastUses.push_back(LUI->first);
375 /// Schedule pass P for execution. Make sure that passes required by
376 /// P are run before P is run. Update analysis info maintained by
377 /// the manager. Remove dead passes. This is a recursive function.
378 void PMTopLevelManager::schedulePass(Pass *P) {
380 // TODO : Allocate function manager for this pass, other wise required set
381 // may be inserted into previous function manager
383 // If this Analysis is already requested by one of the previous pass
384 // and it is still available then do not insert new pass in the queue again.
385 if (findAnalysisPass(P->getPassInfo()))
388 // Give pass a chance to prepare the stage.
389 P->preparePassManager(activeStack);
391 AnalysisUsage AnUsage;
392 P->getAnalysisUsage(AnUsage);
393 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
394 for (std::vector<AnalysisID>::const_iterator I = RequiredSet.begin(),
395 E = RequiredSet.end(); I != E; ++I) {
397 Pass *AnalysisPass = findAnalysisPass(*I);
399 // Schedule this analysis run first.
400 AnalysisPass = (*I)->createPass();
401 schedulePass(AnalysisPass);
405 // Now all required passes are available.
409 /// Find the pass that implements Analysis AID. Search immutable
410 /// passes and all pass managers. If desired pass is not found
411 /// then return NULL.
412 Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
415 // Check pass managers
416 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
417 E = PassManagers.end(); P == NULL && I != E; ++I) {
418 PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
419 assert(PMD && "This is not a PassManager");
420 P = PMD->findAnalysisPass(AID, false);
423 // Check other pass managers
424 for (std::vector<PMDataManager *>::iterator I = IndirectPassManagers.begin(),
425 E = IndirectPassManagers.end(); P == NULL && I != E; ++I)
426 P = (*I)->findAnalysisPass(AID, false);
428 for (std::vector<ImmutablePass *>::iterator I = ImmutablePasses.begin(),
429 E = ImmutablePasses.end(); P == NULL && I != E; ++I) {
430 const PassInfo *PI = (*I)->getPassInfo();
434 // If Pass not found then check the interfaces implemented by Immutable Pass
436 const std::vector<const PassInfo*> &ImmPI = PI->getInterfacesImplemented();
437 if (std::find(ImmPI.begin(), ImmPI.end(), AID) != ImmPI.end())
445 // Print passes managed by this top level manager.
446 void PMTopLevelManager::dumpPasses() const {
448 if (PassDebugging < Structure)
451 // Print out the immutable passes
452 for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
453 ImmutablePasses[i]->dumpPassStructure(0);
456 for (std::vector<Pass *>::const_iterator I = PassManagers.begin(),
457 E = PassManagers.end(); I != E; ++I)
458 (*I)->dumpPassStructure(1);
461 void PMTopLevelManager::dumpArguments() const {
463 if (PassDebugging < Arguments)
466 cerr << "Pass Arguments: ";
467 for (std::vector<Pass *>::const_iterator I = PassManagers.begin(),
468 E = PassManagers.end(); I != E; ++I) {
469 PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
470 assert(PMD && "This is not a PassManager");
471 PMD->dumpPassArguments();
476 void PMTopLevelManager::initializeAllAnalysisInfo() {
478 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
479 E = PassManagers.end(); I != E; ++I) {
480 PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
481 assert(PMD && "This is not a PassManager");
482 PMD->initializeAnalysisInfo();
485 // Initailize other pass managers
486 for (std::vector<PMDataManager *>::iterator I = IndirectPassManagers.begin(),
487 E = IndirectPassManagers.end(); I != E; ++I)
488 (*I)->initializeAnalysisInfo();
492 PMTopLevelManager::~PMTopLevelManager() {
493 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
494 E = PassManagers.end(); I != E; ++I)
497 for (std::vector<ImmutablePass *>::iterator
498 I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
501 PassManagers.clear();
504 //===----------------------------------------------------------------------===//
505 // PMDataManager implementation
507 /// Return true IFF pass P's required analysis set does not required new
509 bool PMDataManager::manageablePass(Pass *P) {
512 // If this pass is not preserving information that is required by a
513 // pass maintained by higher level pass manager then do not insert
514 // this pass into current manager. Use new manager. For example,
515 // For example, If FunctionPass F is not preserving ModulePass Info M1
516 // that is used by another ModulePass M2 then do not insert F in
517 // current function pass manager.
521 /// Augement AvailableAnalysis by adding analysis made available by pass P.
522 void PMDataManager::recordAvailableAnalysis(Pass *P) {
524 if (const PassInfo *PI = P->getPassInfo()) {
525 AvailableAnalysis[PI] = P;
527 //This pass is the current implementation of all of the interfaces it
528 //implements as well.
529 const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
530 for (unsigned i = 0, e = II.size(); i != e; ++i)
531 AvailableAnalysis[II[i]] = P;
535 /// Remove Analyss not preserved by Pass P
536 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
537 AnalysisUsage AnUsage;
538 P->getAnalysisUsage(AnUsage);
540 if (AnUsage.getPreservesAll())
543 const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
544 for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
545 E = AvailableAnalysis.end(); I != E; ) {
546 std::map<AnalysisID, Pass*>::iterator Info = I++;
547 if (std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
548 PreservedSet.end()) {
549 // Remove this analysis
550 if (!dynamic_cast<ImmutablePass*>(Info->second))
551 AvailableAnalysis.erase(Info);
555 // Check inherited analysis also. If P is not preserving analysis
556 // provided by parent manager then remove it here.
557 for (unsigned Index = 0; Index < PMT_Last; ++Index) {
559 if (!InheritedAnalysis[Index])
562 for (std::map<AnalysisID, Pass*>::iterator
563 I = InheritedAnalysis[Index]->begin(),
564 E = InheritedAnalysis[Index]->end(); I != E; ) {
565 std::map<AnalysisID, Pass *>::iterator Info = I++;
566 if (std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
567 PreservedSet.end()) {
568 // Remove this analysis
569 if (!dynamic_cast<ImmutablePass*>(Info->second))
570 InheritedAnalysis[Index]->erase(Info);
577 /// Remove analysis passes that are not used any longer
578 void PMDataManager::removeDeadPasses(Pass *P, std::string Msg,
579 enum PassDebuggingString DBG_STR) {
581 std::vector<Pass *> DeadPasses;
582 TPM->collectLastUses(DeadPasses, P);
584 for (std::vector<Pass *>::iterator I = DeadPasses.begin(),
585 E = DeadPasses.end(); I != E; ++I) {
587 dumpPassInfo(*I, FREEING_MSG, DBG_STR, Msg);
589 if (TheTimeInfo) TheTimeInfo->passStarted(*I);
590 (*I)->releaseMemory();
591 if (TheTimeInfo) TheTimeInfo->passEnded(*I);
593 std::map<AnalysisID, Pass*>::iterator Pos =
594 AvailableAnalysis.find((*I)->getPassInfo());
596 // It is possible that pass is already removed from the AvailableAnalysis
597 if (Pos != AvailableAnalysis.end())
598 AvailableAnalysis.erase(Pos);
602 /// Add pass P into the PassVector. Update
603 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
604 void PMDataManager::add(Pass *P,
605 bool ProcessAnalysis) {
607 // This manager is going to manage pass P. Set up analysis resolver
609 AnalysisResolver *AR = new AnalysisResolver(*this);
612 // If a FunctionPass F is the last user of ModulePass info M
613 // then the F's manager, not F, records itself as a last user of M.
614 std::vector<Pass *> TransferLastUses;
616 if (ProcessAnalysis) {
618 // At the moment, this pass is the last user of all required passes.
619 std::vector<Pass *> LastUses;
620 std::vector<Pass *> RequiredPasses;
621 unsigned PDepth = this->getDepth();
623 collectRequiredAnalysisPasses(RequiredPasses, P);
624 for (std::vector<Pass *>::iterator I = RequiredPasses.begin(),
625 E = RequiredPasses.end(); I != E; ++I) {
626 Pass *PRequired = *I;
629 PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
630 RDepth = DM.getDepth();
632 if (PDepth == RDepth)
633 LastUses.push_back(PRequired);
634 else if (PDepth > RDepth) {
635 // Let the parent claim responsibility of last use
636 TransferLastUses.push_back(PRequired);
638 // Note : This feature is not yet implemented
640 "Unable to handle Pass that requires lower level Analysis pass");
644 // Set P as P's last user until someone starts using P.
645 // However, if P is a Pass Manager then it does not need
646 // to record its last user.
647 if (!dynamic_cast<PMDataManager *>(P))
648 LastUses.push_back(P);
649 TPM->setLastUser(LastUses, P);
651 if (!TransferLastUses.empty()) {
652 Pass *My_PM = dynamic_cast<Pass *>(this);
653 TPM->setLastUser(TransferLastUses, My_PM);
654 TransferLastUses.clear();
657 // Take a note of analysis required and made available by this pass.
658 // Remove the analysis not preserved by this pass
659 removeNotPreservedAnalysis(P);
660 recordAvailableAnalysis(P);
664 PassVector.push_back(P);
667 /// Populate RequiredPasses with the analysis pass that are required by
669 void PMDataManager::collectRequiredAnalysisPasses(std::vector<Pass *> &RP,
671 AnalysisUsage AnUsage;
672 P->getAnalysisUsage(AnUsage);
673 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
674 for (std::vector<AnalysisID>::const_iterator
675 I = RequiredSet.begin(), E = RequiredSet.end();
677 Pass *AnalysisPass = findAnalysisPass(*I, true);
678 assert (AnalysisPass && "Analysis pass is not available");
679 RP.push_back(AnalysisPass);
682 const std::vector<AnalysisID> &IDs = AnUsage.getRequiredTransitiveSet();
683 for (std::vector<AnalysisID>::const_iterator I = IDs.begin(),
684 E = IDs.end(); I != E; ++I) {
685 Pass *AnalysisPass = findAnalysisPass(*I, true);
686 assert (AnalysisPass && "Analysis pass is not available");
687 RP.push_back(AnalysisPass);
691 // All Required analyses should be available to the pass as it runs! Here
692 // we fill in the AnalysisImpls member of the pass so that it can
693 // successfully use the getAnalysis() method to retrieve the
694 // implementations it needs.
696 void PMDataManager::initializeAnalysisImpl(Pass *P) {
697 AnalysisUsage AnUsage;
698 P->getAnalysisUsage(AnUsage);
700 for (std::vector<const PassInfo *>::const_iterator
701 I = AnUsage.getRequiredSet().begin(),
702 E = AnUsage.getRequiredSet().end(); I != E; ++I) {
703 Pass *Impl = findAnalysisPass(*I, true);
705 assert(0 && "Analysis used but not available!");
706 AnalysisResolver *AR = P->getResolver();
707 AR->addAnalysisImplsPair(*I, Impl);
711 /// Find the pass that implements Analysis AID. If desired pass is not found
712 /// then return NULL.
713 Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
715 // Check if AvailableAnalysis map has one entry.
716 std::map<AnalysisID, Pass*>::const_iterator I = AvailableAnalysis.find(AID);
718 if (I != AvailableAnalysis.end())
721 // Search Parents through TopLevelManager
723 return TPM->findAnalysisPass(AID);
728 // Print list of passes that are last used by P.
729 void PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{
731 std::vector<Pass *> LUses;
733 assert (TPM && "Top Level Manager is missing");
734 TPM->collectLastUses(LUses, P);
736 for (std::vector<Pass *>::iterator I = LUses.begin(),
737 E = LUses.end(); I != E; ++I) {
738 llvm::cerr << "--" << std::string(Offset*2, ' ');
739 (*I)->dumpPassStructure(0);
743 void PMDataManager::dumpPassArguments() const {
744 for(std::vector<Pass *>::const_iterator I = PassVector.begin(),
745 E = PassVector.end(); I != E; ++I) {
746 if (PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I))
747 PMD->dumpPassArguments();
749 if (const PassInfo *PI = (*I)->getPassInfo())
750 if (!PI->isAnalysisGroup())
751 cerr << " -" << PI->getPassArgument();
755 void PMDataManager:: dumpPassInfo(Pass *P, enum PassDebuggingString S1,
756 enum PassDebuggingString S2,
758 if (PassDebugging < Executions)
760 cerr << (void*)this << std::string(getDepth()*2+1, ' ');
763 cerr << "Executing Pass '" << P->getPassName();
765 case MODIFICATION_MSG:
766 cerr << "' Made Modification '" << P->getPassName();
769 cerr << " Freeing Pass '" << P->getPassName();
775 case ON_BASICBLOCK_MSG:
776 cerr << "' on BasicBlock '" << Msg << "...\n";
778 case ON_FUNCTION_MSG:
779 cerr << "' on Function '" << Msg << "...\n";
782 cerr << "' on Module '" << Msg << "...\n";
785 cerr << "' on Loop " << Msg << "...\n";
788 cerr << "' on Call Graph " << Msg << "...\n";
795 void PMDataManager::dumpAnalysisSetInfo(const char *Msg, Pass *P,
796 const std::vector<AnalysisID> &Set)
798 if (PassDebugging >= Details && !Set.empty()) {
799 cerr << (void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:";
800 for (unsigned i = 0; i != Set.size(); ++i) {
802 cerr << " " << Set[i]->getPassName();
809 PMDataManager::~PMDataManager() {
811 for (std::vector<Pass *>::iterator I = PassVector.begin(),
812 E = PassVector.end(); I != E; ++I)
818 //===----------------------------------------------------------------------===//
819 // NOTE: Is this the right place to define this method ?
820 // getAnalysisToUpdate - Return an analysis result or null if it doesn't exist
821 Pass *AnalysisResolver::getAnalysisToUpdate(AnalysisID ID, bool dir) const {
822 return PM.findAnalysisPass(ID, dir);
825 //===----------------------------------------------------------------------===//
826 // BBPassManager implementation
828 /// Execute all of the passes scheduled for execution by invoking
829 /// runOnBasicBlock method. Keep track of whether any of the passes modifies
830 /// the function, and if so, return true.
832 BBPassManager::runOnFunction(Function &F) {
834 if (F.isDeclaration())
837 bool Changed = doInitialization(F);
839 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
840 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
841 BasicBlockPass *BP = getContainedPass(Index);
842 AnalysisUsage AnUsage;
843 BP->getAnalysisUsage(AnUsage);
845 dumpPassInfo(BP, EXECUTION_MSG, ON_BASICBLOCK_MSG, (*I).getName());
846 dumpAnalysisSetInfo("Required", BP, AnUsage.getRequiredSet());
848 initializeAnalysisImpl(BP);
850 if (TheTimeInfo) TheTimeInfo->passStarted(BP);
851 Changed |= BP->runOnBasicBlock(*I);
852 if (TheTimeInfo) TheTimeInfo->passEnded(BP);
855 dumpPassInfo(BP, MODIFICATION_MSG, ON_BASICBLOCK_MSG, (*I).getName());
856 dumpAnalysisSetInfo("Preserved", BP, AnUsage.getPreservedSet());
858 removeNotPreservedAnalysis(BP);
859 recordAvailableAnalysis(BP);
860 removeDeadPasses(BP, (*I).getName(), ON_BASICBLOCK_MSG);
863 return Changed |= doFinalization(F);
866 // Implement doInitialization and doFinalization
867 inline bool BBPassManager::doInitialization(Module &M) {
868 bool Changed = false;
870 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
871 BasicBlockPass *BP = getContainedPass(Index);
872 Changed |= BP->doInitialization(M);
878 inline bool BBPassManager::doFinalization(Module &M) {
879 bool Changed = false;
881 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
882 BasicBlockPass *BP = getContainedPass(Index);
883 Changed |= BP->doFinalization(M);
889 inline bool BBPassManager::doInitialization(Function &F) {
890 bool Changed = false;
892 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
893 BasicBlockPass *BP = getContainedPass(Index);
894 Changed |= BP->doInitialization(F);
900 inline bool BBPassManager::doFinalization(Function &F) {
901 bool Changed = false;
903 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
904 BasicBlockPass *BP = getContainedPass(Index);
905 Changed |= BP->doFinalization(F);
912 //===----------------------------------------------------------------------===//
913 // FunctionPassManager implementation
915 /// Create new Function pass manager
916 FunctionPassManager::FunctionPassManager(ModuleProvider *P) {
917 FPM = new FunctionPassManagerImpl(0);
918 // FPM is the top level manager.
919 FPM->setTopLevelManager(FPM);
921 PMDataManager *PMD = dynamic_cast<PMDataManager *>(FPM);
922 AnalysisResolver *AR = new AnalysisResolver(*PMD);
923 FPM->setResolver(AR);
928 FunctionPassManager::~FunctionPassManager() {
932 /// add - Add a pass to the queue of passes to run. This passes
933 /// ownership of the Pass to the PassManager. When the
934 /// PassManager_X is destroyed, the pass will be destroyed as well, so
935 /// there is no need to delete the pass. (TODO delete passes.)
936 /// This implies that all passes MUST be allocated with 'new'.
937 void FunctionPassManager::add(Pass *P) {
941 /// run - Execute all of the passes scheduled for execution. Keep
942 /// track of whether any of the passes modifies the function, and if
945 bool FunctionPassManager::run(Function &F) {
947 if (MP->materializeFunction(&F, &errstr)) {
948 cerr << "Error reading bytecode file: " << errstr << "\n";
955 /// doInitialization - Run all of the initializers for the function passes.
957 bool FunctionPassManager::doInitialization() {
958 return FPM->doInitialization(*MP->getModule());
961 /// doFinalization - Run all of the initializers for the function passes.
963 bool FunctionPassManager::doFinalization() {
964 return FPM->doFinalization(*MP->getModule());
967 //===----------------------------------------------------------------------===//
968 // FunctionPassManagerImpl implementation
970 inline bool FunctionPassManagerImpl::doInitialization(Module &M) {
971 bool Changed = false;
973 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
974 FPPassManager *FP = getContainedManager(Index);
975 Changed |= FP->doInitialization(M);
981 inline bool FunctionPassManagerImpl::doFinalization(Module &M) {
982 bool Changed = false;
984 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
985 FPPassManager *FP = getContainedManager(Index);
986 Changed |= FP->doFinalization(M);
992 // Execute all the passes managed by this top level manager.
993 // Return true if any function is modified by a pass.
994 bool FunctionPassManagerImpl::run(Function &F) {
996 bool Changed = false;
998 TimingInfo::createTheTimeInfo();
1003 initializeAllAnalysisInfo();
1004 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1005 FPPassManager *FP = getContainedManager(Index);
1006 Changed |= FP->runOnFunction(F);
1011 //===----------------------------------------------------------------------===//
1012 // FPPassManager implementation
1014 /// Print passes managed by this manager
1015 void FPPassManager::dumpPassStructure(unsigned Offset) {
1016 llvm::cerr << std::string(Offset*2, ' ') << "FunctionPass Manager\n";
1017 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1018 FunctionPass *FP = getContainedPass(Index);
1019 FP->dumpPassStructure(Offset + 1);
1020 dumpLastUses(FP, Offset+1);
1025 /// Execute all of the passes scheduled for execution by invoking
1026 /// runOnFunction method. Keep track of whether any of the passes modifies
1027 /// the function, and if so, return true.
1028 bool FPPassManager::runOnFunction(Function &F) {
1030 bool Changed = false;
1032 if (F.isDeclaration())
1035 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1036 FunctionPass *FP = getContainedPass(Index);
1038 AnalysisUsage AnUsage;
1039 FP->getAnalysisUsage(AnUsage);
1041 dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getName());
1042 dumpAnalysisSetInfo("Required", FP, AnUsage.getRequiredSet());
1044 initializeAnalysisImpl(FP);
1046 if (TheTimeInfo) TheTimeInfo->passStarted(FP);
1047 Changed |= FP->runOnFunction(F);
1048 if (TheTimeInfo) TheTimeInfo->passEnded(FP);
1051 dumpPassInfo(FP, MODIFICATION_MSG, ON_FUNCTION_MSG, F.getName());
1052 dumpAnalysisSetInfo("Preserved", FP, AnUsage.getPreservedSet());
1054 removeNotPreservedAnalysis(FP);
1055 recordAvailableAnalysis(FP);
1056 removeDeadPasses(FP, F.getName(), ON_FUNCTION_MSG);
1061 bool FPPassManager::runOnModule(Module &M) {
1063 bool Changed = doInitialization(M);
1065 for(Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1066 this->runOnFunction(*I);
1068 return Changed |= doFinalization(M);
1071 inline bool FPPassManager::doInitialization(Module &M) {
1072 bool Changed = false;
1074 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1075 FunctionPass *FP = getContainedPass(Index);
1076 Changed |= FP->doInitialization(M);
1082 inline bool FPPassManager::doFinalization(Module &M) {
1083 bool Changed = false;
1085 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1086 FunctionPass *FP = getContainedPass(Index);
1087 Changed |= FP->doFinalization(M);
1093 //===----------------------------------------------------------------------===//
1094 // MPPassManager implementation
1096 /// Execute all of the passes scheduled for execution by invoking
1097 /// runOnModule method. Keep track of whether any of the passes modifies
1098 /// the module, and if so, return true.
1100 MPPassManager::runOnModule(Module &M) {
1101 bool Changed = false;
1103 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1104 ModulePass *MP = getContainedPass(Index);
1106 AnalysisUsage AnUsage;
1107 MP->getAnalysisUsage(AnUsage);
1109 dumpPassInfo(MP, EXECUTION_MSG, ON_MODULE_MSG, M.getModuleIdentifier());
1110 dumpAnalysisSetInfo("Required", MP, AnUsage.getRequiredSet());
1112 initializeAnalysisImpl(MP);
1114 if (TheTimeInfo) TheTimeInfo->passStarted(MP);
1115 Changed |= MP->runOnModule(M);
1116 if (TheTimeInfo) TheTimeInfo->passEnded(MP);
1119 dumpPassInfo(MP, MODIFICATION_MSG, ON_MODULE_MSG,
1120 M.getModuleIdentifier());
1121 dumpAnalysisSetInfo("Preserved", MP, AnUsage.getPreservedSet());
1123 removeNotPreservedAnalysis(MP);
1124 recordAvailableAnalysis(MP);
1125 removeDeadPasses(MP, M.getModuleIdentifier(), ON_MODULE_MSG);
1130 //===----------------------------------------------------------------------===//
1131 // PassManagerImpl implementation
1133 /// run - Execute all of the passes scheduled for execution. Keep track of
1134 /// whether any of the passes modifies the module, and if so, return true.
1135 bool PassManagerImpl::run(Module &M) {
1137 bool Changed = false;
1139 TimingInfo::createTheTimeInfo();
1144 initializeAllAnalysisInfo();
1145 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1146 MPPassManager *MP = getContainedManager(Index);
1147 Changed |= MP->runOnModule(M);
1152 //===----------------------------------------------------------------------===//
1153 // PassManager implementation
1155 /// Create new pass manager
1156 PassManager::PassManager() {
1157 PM = new PassManagerImpl(0);
1158 // PM is the top level manager
1159 PM->setTopLevelManager(PM);
1162 PassManager::~PassManager() {
1166 /// add - Add a pass to the queue of passes to run. This passes ownership of
1167 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
1168 /// will be destroyed as well, so there is no need to delete the pass. This
1169 /// implies that all passes MUST be allocated with 'new'.
1171 PassManager::add(Pass *P) {
1175 /// run - Execute all of the passes scheduled for execution. Keep track of
1176 /// whether any of the passes modifies the module, and if so, return true.
1178 PassManager::run(Module &M) {
1182 //===----------------------------------------------------------------------===//
1183 // TimingInfo Class - This class is used to calculate information about the
1184 // amount of time each pass takes to execute. This only happens with
1185 // -time-passes is enabled on the command line.
1187 bool llvm::TimePassesIsEnabled = false;
1188 static cl::opt<bool,true>
1189 EnableTiming("time-passes", cl::location(TimePassesIsEnabled),
1190 cl::desc("Time each pass, printing elapsed time for each on exit"));
1192 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
1193 // a non null value (if the -time-passes option is enabled) or it leaves it
1194 // null. It may be called multiple times.
1195 void TimingInfo::createTheTimeInfo() {
1196 if (!TimePassesIsEnabled || TheTimeInfo) return;
1198 // Constructed the first time this is called, iff -time-passes is enabled.
1199 // This guarantees that the object will be constructed before static globals,
1200 // thus it will be destroyed before them.
1201 static ManagedStatic<TimingInfo> TTI;
1202 TheTimeInfo = &*TTI;
1205 /// If TimingInfo is enabled then start pass timer.
1206 void StartPassTimer(Pass *P) {
1208 TheTimeInfo->passStarted(P);
1211 /// If TimingInfo is enabled then stop pass timer.
1212 void StopPassTimer(Pass *P) {
1214 TheTimeInfo->passEnded(P);
1217 //===----------------------------------------------------------------------===//
1218 // PMStack implementation
1221 // Pop Pass Manager from the stack and clear its analysis info.
1222 void PMStack::pop() {
1224 PMDataManager *Top = this->top();
1225 Top->initializeAnalysisInfo();
1230 // Push PM on the stack and set its top level manager.
1231 void PMStack::push(Pass *P) {
1233 PMDataManager *Top = NULL;
1234 PMDataManager *PM = dynamic_cast<PMDataManager *>(P);
1235 assert (PM && "Unable to push. Pass Manager expected");
1237 if (this->empty()) {
1242 PMTopLevelManager *TPM = Top->getTopLevelManager();
1244 assert (TPM && "Unable to find top level manager");
1245 TPM->addIndirectPassManager(PM);
1246 PM->setTopLevelManager(TPM);
1249 AnalysisResolver *AR = new AnalysisResolver(*Top);
1255 // Dump content of the pass manager stack.
1256 void PMStack::dump() {
1257 for(std::deque<PMDataManager *>::iterator I = S.begin(),
1258 E = S.end(); I != E; ++I) {
1259 Pass *P = dynamic_cast<Pass *>(*I);
1260 printf ("%s ", P->getPassName());
1266 /// Find appropriate Module Pass Manager in the PM Stack and
1267 /// add self into that manager.
1268 void ModulePass::assignPassManager(PMStack &PMS,
1269 PassManagerType PreferredType) {
1271 // Find Module Pass Manager
1272 while(!PMS.empty()) {
1273 PassManagerType TopPMType = PMS.top()->getPassManagerType();
1274 if (TopPMType == PreferredType)
1275 break; // We found desired pass manager
1276 else if (TopPMType > PMT_ModulePassManager)
1277 PMS.pop(); // Pop children pass managers
1282 PMS.top()->add(this);
1285 /// Find appropriate Function Pass Manager or Call Graph Pass Manager
1286 /// in the PM Stack and add self into that manager.
1287 void FunctionPass::assignPassManager(PMStack &PMS,
1288 PassManagerType PreferredType) {
1290 // Find Module Pass Manager (TODO : Or Call Graph Pass Manager)
1291 while(!PMS.empty()) {
1292 if (PMS.top()->getPassManagerType() > PMT_FunctionPassManager)
1297 FPPassManager *FPP = dynamic_cast<FPPassManager *>(PMS.top());
1299 // Create new Function Pass Manager
1301 assert(!PMS.empty() && "Unable to create Function Pass Manager");
1302 PMDataManager *PMD = PMS.top();
1304 // [1] Create new Function Pass Manager
1305 FPP = new FPPassManager(PMD->getDepth() + 1);
1307 // [2] Set up new manager's top level manager
1308 PMTopLevelManager *TPM = PMD->getTopLevelManager();
1309 TPM->addIndirectPassManager(FPP);
1311 // [3] Assign manager to manage this new manager. This may create
1312 // and push new managers into PMS
1313 Pass *P = dynamic_cast<Pass *>(FPP);
1315 // If Call Graph Pass Manager is active then use it to manage
1316 // this new Function Pass manager.
1317 if (PMD->getPassManagerType() == PMT_CallGraphPassManager)
1318 P->assignPassManager(PMS, PMT_CallGraphPassManager);
1320 P->assignPassManager(PMS);
1322 // [4] Push new manager into PMS
1326 // Assign FPP as the manager of this pass.
1330 /// Find appropriate Basic Pass Manager or Call Graph Pass Manager
1331 /// in the PM Stack and add self into that manager.
1332 void BasicBlockPass::assignPassManager(PMStack &PMS,
1333 PassManagerType PreferredType) {
1335 BBPassManager *BBP = NULL;
1337 // Basic Pass Manager is a leaf pass manager. It does not handle
1338 // any other pass manager.
1340 BBP = dynamic_cast<BBPassManager *>(PMS.top());
1343 // If leaf manager is not Basic Block Pass manager then create new
1344 // basic Block Pass manager.
1347 assert(!PMS.empty() && "Unable to create BasicBlock Pass Manager");
1348 PMDataManager *PMD = PMS.top();
1350 // [1] Create new Basic Block Manager
1351 BBP = new BBPassManager(PMD->getDepth() + 1);
1353 // [2] Set up new manager's top level manager
1354 // Basic Block Pass Manager does not live by itself
1355 PMTopLevelManager *TPM = PMD->getTopLevelManager();
1356 TPM->addIndirectPassManager(BBP);
1358 // [3] Assign manager to manage this new manager. This may create
1359 // and push new managers into PMS
1360 Pass *P = dynamic_cast<Pass *>(BBP);
1361 P->assignPassManager(PMS);
1363 // [4] Push new manager into PMS
1367 // Assign BBP as the manager of this pass.