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/PassManager.h"
16 #include "llvm/Support/CommandLine.h"
17 #include "llvm/Module.h"
18 #include "llvm/ModuleProvider.h"
19 #include "llvm/Support/Streams.h"
24 //===----------------------------------------------------------------------===//
26 // The Pass Manager Infrastructure manages passes. It's responsibilities are:
28 // o Manage optimization pass execution order
29 // o Make required Analysis information available before pass P is run
30 // o Release memory occupied by dead passes
31 // o If Analysis information is dirtied by a pass then regenerate Analysis
32 // information before it is consumed by another pass.
34 // Pass Manager Infrastructure uses multipe pass managers. They are PassManager,
35 // FunctionPassManager, ModulePassManager, BasicBlockPassManager. This class
36 // hierarcy uses multiple inheritance but pass managers do not derive from
37 // another pass manager.
39 // PassManager and FunctionPassManager are two top level pass manager that
40 // represents the external interface of this entire pass manager infrastucture.
42 // Important classes :
44 // [o] class PMTopLevelManager;
46 // Two top level managers, PassManager and FunctionPassManager, derive from
47 // PMTopLevelManager. PMTopLevelManager manages information used by top level
48 // managers such as last user info.
50 // [o] class PMDataManager;
52 // PMDataManager manages information, e.g. list of available analysis info,
53 // used by a pass manager to manage execution order of passes. It also provides
54 // a place to implement common pass manager APIs. All pass managers derive from
57 // [o] class BasicBlockPassManager : public FunctionPass, public PMDataManager;
59 // BasicBlockPassManager manages BasicBlockPasses.
61 // [o] class FunctionPassManager;
63 // This is a external interface used by JIT to manage FunctionPasses. This
64 // interface relies on FunctionPassManagerImpl to do all the tasks.
66 // [o] class FunctionPassManagerImpl : public ModulePass, PMDataManager,
67 // public PMTopLevelManager;
69 // FunctionPassManagerImpl is a top level manager. It manages FunctionPasses
70 // and BasicBlockPassManagers.
72 // [o] class ModulePassManager : public Pass, public PMDataManager;
74 // ModulePassManager manages ModulePasses and FunctionPassManagerImpls.
76 // [o] class PassManager;
78 // This is a external interface used by various tools to manages passes. It
79 // relies on PassManagerImpl to do all the tasks.
81 // [o] class PassManagerImpl : public Pass, public PMDataManager,
82 // public PMDTopLevelManager
84 // PassManagerImpl is a top level pass manager responsible for managing
85 // ModulePassManagers.
86 //===----------------------------------------------------------------------===//
90 //===----------------------------------------------------------------------===//
91 // Pass debugging information. Often it is useful to find out what pass is
92 // running when a crash occurs in a utility. When this library is compiled with
93 // debugging on, a command line option (--debug-pass) is enabled that causes the
94 // pass name to be printed before it executes.
97 // Different debug levels that can be enabled...
99 None, Arguments, Structure, Executions, Details
102 static cl::opt<enum PassDebugLevel>
103 PassDebugging_New("debug-pass", cl::Hidden,
104 cl::desc("Print PassManager debugging information"),
106 clEnumVal(None , "disable debug output"),
107 clEnumVal(Arguments , "print pass arguments to pass to 'opt'"),
108 clEnumVal(Structure , "print pass structure before run()"),
109 clEnumVal(Executions, "print pass name before it is executed"),
110 clEnumVal(Details , "print pass details when it is executed"),
112 } // End of llvm namespace
114 #ifndef USE_OLD_PASSMANAGER
119 //===----------------------------------------------------------------------===//
122 /// PMTopLevelManager manages LastUser info and collects common APIs used by
123 /// top level pass managers.
124 class PMTopLevelManager {
128 inline std::vector<Pass *>::iterator passManagersBegin() {
129 return PassManagers.begin();
132 inline std::vector<Pass *>::iterator passManagersEnd() {
133 return PassManagers.end();
136 /// Schedule pass P for execution. Make sure that passes required by
137 /// P are run before P is run. Update analysis info maintained by
138 /// the manager. Remove dead passes. This is a recursive function.
139 void schedulePass(Pass *P);
141 /// This is implemented by top level pass manager and used by
142 /// schedulePass() to add analysis info passes that are not available.
143 virtual void addTopLevelPass(Pass *P) = 0;
145 /// Set pass P as the last user of the given analysis passes.
146 void setLastUser(std::vector<Pass *> &AnalysisPasses, Pass *P);
148 /// Collect passes whose last user is P
149 void collectLastUses(std::vector<Pass *> &LastUses, Pass *P);
151 /// Find the pass that implements Analysis AID. Search immutable
152 /// passes and all pass managers. If desired pass is not found
153 /// then return NULL.
154 Pass *findAnalysisPass(AnalysisID AID);
156 inline void clearManagers() {
157 PassManagers.clear();
160 virtual ~PMTopLevelManager() {
162 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
163 E = PassManagers.end(); I != E; ++I)
166 for (std::vector<ImmutablePass *>::iterator
167 I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
170 PassManagers.clear();
173 /// Add immutable pass and initialize it.
174 inline void addImmutablePass(ImmutablePass *P) {
176 ImmutablePasses.push_back(P);
179 inline std::vector<ImmutablePass *>& getImmutablePasses() {
180 return ImmutablePasses;
183 void addPassManager(Pass *Manager) {
184 PassManagers.push_back(Manager);
187 // Add Manager into the list of managers that are not directly
188 // maintained by this top level pass manager
189 inline void addIndirectPassManager(PMDataManager *Manager) {
190 IndirectPassManagers.push_back(Manager);
193 // Print passes managed by this top level manager.
198 /// Collection of pass managers
199 std::vector<Pass *> PassManagers;
201 /// Collection of pass managers that are not directly maintained
202 /// by this pass manager
203 std::vector<PMDataManager *> IndirectPassManagers;
205 // Map to keep track of last user of the analysis pass.
206 // LastUser->second is the last user of Lastuser->first.
207 std::map<Pass *, Pass *> LastUser;
209 /// Immutable passes are managed by top level manager.
210 std::vector<ImmutablePass *> ImmutablePasses;
213 //===----------------------------------------------------------------------===//
216 /// PMDataManager provides the common place to manage the analysis data
217 /// used by pass managers.
218 class PMDataManager {
222 PMDataManager(int D) : TPM(NULL), Depth(D) {
223 initializeAnalysisInfo();
226 virtual ~PMDataManager() {
228 for (std::vector<Pass *>::iterator I = PassVector.begin(),
229 E = PassVector.end(); I != E; ++I)
235 /// Return true IFF pass P's required analysis set does not required new
237 bool manageablePass(Pass *P);
239 /// Augment AvailableAnalysis by adding analysis made available by pass P.
240 void recordAvailableAnalysis(Pass *P);
242 /// Remove Analysis that is not preserved by the pass
243 void removeNotPreservedAnalysis(Pass *P);
245 /// Remove dead passes
246 void removeDeadPasses(Pass *P);
248 /// Add pass P into the PassVector. Update
249 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
250 void addPassToManager (Pass *P, bool ProcessAnalysis = true);
252 /// Initialize available analysis information.
253 void initializeAnalysisInfo() {
254 ForcedLastUses.clear();
255 AvailableAnalysis.clear();
258 /// Populate RequiredPasses with the analysis pass that are required by
260 void collectRequiredAnalysisPasses(std::vector<Pass *> &RequiredPasses,
263 /// All Required analyses should be available to the pass as it runs! Here
264 /// we fill in the AnalysisImpls member of the pass so that it can
265 /// successfully use the getAnalysis() method to retrieve the
266 /// implementations it needs.
267 void initializeAnalysisImpl(Pass *P);
269 /// Find the pass that implements Analysis AID. If desired pass is not found
270 /// then return NULL.
271 Pass *findAnalysisPass(AnalysisID AID, bool Direction);
273 inline std::vector<Pass *>::iterator passVectorBegin() {
274 return PassVector.begin();
277 inline std::vector<Pass *>::iterator passVectorEnd() {
278 return PassVector.end();
281 // Access toplevel manager
282 PMTopLevelManager *getTopLevelManager() { return TPM; }
283 void setTopLevelManager(PMTopLevelManager *T) { TPM = T; }
285 unsigned getDepth() { return Depth; }
287 // Print list of passes that are last used by P.
288 void dumpLastUses(Pass *P, unsigned Offset) {
290 std::vector<Pass *> LUses;
292 assert (TPM && "Top Level Manager is missing");
293 TPM->collectLastUses(LUses, P);
295 for (std::vector<Pass *>::iterator I = LUses.begin(),
296 E = LUses.end(); I != E; ++I) {
297 llvm::cerr << "--" << std::string(Offset*2, ' ');
298 (*I)->dumpPassStructure(0);
304 // Collection of pass whose last user asked this manager to claim
305 // last use. If a FunctionPass F is the last user of ModulePass info M
306 // then the F's manager, not F, records itself as a last user of M.
307 std::vector<Pass *> ForcedLastUses;
309 // Top level manager.
310 PMTopLevelManager *TPM;
313 // Set of available Analysis. This information is used while scheduling
314 // pass. If a pass requires an analysis which is not not available then
315 // equired analysis pass is scheduled to run before the pass itself is
317 std::map<AnalysisID, Pass*> AvailableAnalysis;
319 // Collection of pass that are managed by this manager
320 std::vector<Pass *> PassVector;
325 //===----------------------------------------------------------------------===//
326 // BasicBlockPassManager
328 /// BasicBlockPassManager manages BasicBlockPass. It batches all the
329 /// pass together and sequence them to process one basic block before
330 /// processing next basic block.
331 class BasicBlockPassManager : public PMDataManager,
332 public FunctionPass {
335 BasicBlockPassManager(int D) : PMDataManager(D) { }
337 /// Add a pass into a passmanager queue.
338 bool addPass(Pass *p);
340 /// Execute all of the passes scheduled for execution. Keep track of
341 /// whether any of the passes modifies the function, and if so, return true.
342 bool runOnFunction(Function &F);
344 /// Pass Manager itself does not invalidate any analysis info.
345 void getAnalysisUsage(AnalysisUsage &Info) const {
346 Info.setPreservesAll();
349 bool doInitialization(Module &M);
350 bool doInitialization(Function &F);
351 bool doFinalization(Module &M);
352 bool doFinalization(Function &F);
354 // Print passes managed by this manager
355 void dumpPassStructure(unsigned Offset) {
356 llvm::cerr << std::string(Offset*2, ' ') << "BasicBLockPass Manager\n";
357 for (std::vector<Pass *>::iterator I = passVectorBegin(),
358 E = passVectorEnd(); I != E; ++I) {
359 (*I)->dumpPassStructure(Offset + 1);
360 dumpLastUses(*I, Offset+1);
366 //===----------------------------------------------------------------------===//
367 // FunctionPassManagerImpl_New
369 /// FunctionPassManagerImpl_New manages FunctionPasses and BasicBlockPassManagers.
370 /// It batches all function passes and basic block pass managers together and
371 /// sequence them to process one function at a time before processing next
373 class FunctionPassManagerImpl_New : public ModulePass,
374 public PMDataManager,
375 public PMTopLevelManager {
377 FunctionPassManagerImpl_New(int D) : PMDataManager(D) {
378 activeBBPassManager = NULL;
380 ~FunctionPassManagerImpl_New() { /* TODO */ };
382 inline void addTopLevelPass(Pass *P) {
384 if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
386 // P is a immutable pass then it will be managed by this
387 // top level manager. Set up analysis resolver to connect them.
388 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
390 initializeAnalysisImpl(P);
391 addImmutablePass(IP);
392 recordAvailableAnalysis(IP);
398 /// add - Add a pass to the queue of passes to run. This passes
399 /// ownership of the Pass to the PassManager. When the
400 /// PassManager_X is destroyed, the pass will be destroyed as well, so
401 /// there is no need to delete the pass. (TODO delete passes.)
402 /// This implies that all passes MUST be allocated with 'new'.
407 /// Add pass into the pass manager queue.
408 bool addPass(Pass *P);
410 /// Execute all of the passes scheduled for execution. Keep
411 /// track of whether any of the passes modifies the function, and if
413 bool runOnModule(Module &M);
414 bool runOnFunction(Function &F);
415 bool run(Function &F);
417 /// doInitialization - Run all of the initializers for the function passes.
419 bool doInitialization(Module &M);
421 /// doFinalization - Run all of the initializers for the function passes.
423 bool doFinalization(Module &M);
425 /// Pass Manager itself does not invalidate any analysis info.
426 void getAnalysisUsage(AnalysisUsage &Info) const {
427 Info.setPreservesAll();
430 // Print passes managed by this manager
431 void dumpPassStructure(unsigned Offset) {
432 llvm::cerr << std::string(Offset*2, ' ') << "FunctionPass Manager\n";
433 for (std::vector<Pass *>::iterator I = passVectorBegin(),
434 E = passVectorEnd(); I != E; ++I) {
435 (*I)->dumpPassStructure(Offset + 1);
436 dumpLastUses(*I, Offset+1);
441 // Active Pass Managers
442 BasicBlockPassManager *activeBBPassManager;
445 //===----------------------------------------------------------------------===//
448 /// ModulePassManager manages ModulePasses and function pass managers.
449 /// It batches all Module passes passes and function pass managers together and
450 /// sequence them to process one module.
451 class ModulePassManager : public Pass,
452 public PMDataManager {
455 ModulePassManager(int D) : PMDataManager(D) {
456 activeFunctionPassManager = NULL;
459 /// Add a pass into a passmanager queue.
460 bool addPass(Pass *p);
462 /// run - Execute all of the passes scheduled for execution. Keep track of
463 /// whether any of the passes modifies the module, and if so, return true.
464 bool runOnModule(Module &M);
466 /// Pass Manager itself does not invalidate any analysis info.
467 void getAnalysisUsage(AnalysisUsage &Info) const {
468 Info.setPreservesAll();
471 // Print passes managed by this manager
472 void dumpPassStructure(unsigned Offset) {
473 llvm::cerr << std::string(Offset*2, ' ') << "ModulePass Manager\n";
474 for (std::vector<Pass *>::iterator I = passVectorBegin(),
475 E = passVectorEnd(); I != E; ++I) {
476 (*I)->dumpPassStructure(Offset + 1);
477 dumpLastUses(*I, Offset+1);
482 // Active Pass Manager
483 FunctionPassManagerImpl_New *activeFunctionPassManager;
486 //===----------------------------------------------------------------------===//
487 // PassManagerImpl_New
489 /// PassManagerImpl_New manages ModulePassManagers
490 class PassManagerImpl_New : public Pass,
491 public PMDataManager,
492 public PMTopLevelManager {
496 PassManagerImpl_New(int D) : PMDataManager(D) {
497 activeManager = NULL;
500 /// add - Add a pass to the queue of passes to run. This passes ownership of
501 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
502 /// will be destroyed as well, so there is no need to delete the pass. This
503 /// implies that all passes MUST be allocated with 'new'.
508 /// run - Execute all of the passes scheduled for execution. Keep track of
509 /// whether any of the passes modifies the module, and if so, return true.
512 /// Pass Manager itself does not invalidate any analysis info.
513 void getAnalysisUsage(AnalysisUsage &Info) const {
514 Info.setPreservesAll();
517 inline void addTopLevelPass(Pass *P) {
519 if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
521 // P is a immutable pass and it will be managed by this
522 // top level manager. Set up analysis resolver to connect them.
523 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
525 initializeAnalysisImpl(P);
526 addImmutablePass(IP);
527 recordAvailableAnalysis(IP);
535 /// Add a pass into a passmanager queue.
536 bool addPass(Pass *p);
538 // Active Pass Manager
539 ModulePassManager *activeManager;
542 } // End of llvm namespace
544 //===----------------------------------------------------------------------===//
545 // PMTopLevelManager implementation
547 /// Set pass P as the last user of the given analysis passes.
548 void PMTopLevelManager::setLastUser(std::vector<Pass *> &AnalysisPasses,
551 for (std::vector<Pass *>::iterator I = AnalysisPasses.begin(),
552 E = AnalysisPasses.end(); I != E; ++I) {
555 // If AP is the last user of other passes then make P last user of
557 for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
558 LUE = LastUser.end(); LUI != LUE; ++LUI) {
559 if (LUI->second == AP)
560 LastUser[LUI->first] = P;
566 /// Collect passes whose last user is P
567 void PMTopLevelManager::collectLastUses(std::vector<Pass *> &LastUses,
569 for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
570 LUE = LastUser.end(); LUI != LUE; ++LUI)
571 if (LUI->second == P)
572 LastUses.push_back(LUI->first);
575 /// Schedule pass P for execution. Make sure that passes required by
576 /// P are run before P is run. Update analysis info maintained by
577 /// the manager. Remove dead passes. This is a recursive function.
578 void PMTopLevelManager::schedulePass(Pass *P) {
580 // TODO : Allocate function manager for this pass, other wise required set
581 // may be inserted into previous function manager
583 AnalysisUsage AnUsage;
584 P->getAnalysisUsage(AnUsage);
585 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
586 for (std::vector<AnalysisID>::const_iterator I = RequiredSet.begin(),
587 E = RequiredSet.end(); I != E; ++I) {
589 Pass *AnalysisPass = findAnalysisPass(*I);
591 // Schedule this analysis run first.
592 AnalysisPass = (*I)->createPass();
593 schedulePass(AnalysisPass);
597 // Now all required passes are available.
601 /// Find the pass that implements Analysis AID. Search immutable
602 /// passes and all pass managers. If desired pass is not found
603 /// then return NULL.
604 Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
607 // Check pass managers
608 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
609 E = PassManagers.end(); P == NULL && I != E; ++I) {
610 PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
611 assert(PMD && "This is not a PassManager");
612 P = PMD->findAnalysisPass(AID, false);
615 // Check other pass managers
616 for (std::vector<PMDataManager *>::iterator I = IndirectPassManagers.begin(),
617 E = IndirectPassManagers.end(); P == NULL && I != E; ++I)
618 P = (*I)->findAnalysisPass(AID, false);
620 for (std::vector<ImmutablePass *>::iterator I = ImmutablePasses.begin(),
621 E = ImmutablePasses.end(); P == NULL && I != E; ++I) {
622 const PassInfo *PI = (*I)->getPassInfo();
626 // If Pass not found then check the interfaces implemented by Immutable Pass
628 const std::vector<const PassInfo*> &ImmPI =
629 PI->getInterfacesImplemented();
630 for (unsigned Index = 0, End = ImmPI.size();
631 P == NULL && Index != End; ++Index)
632 if (ImmPI[Index] == AID)
640 // Print passes managed by this top level manager.
641 void PMTopLevelManager::dumpPasses() {
643 // Print out the immutable passes
644 for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
645 ImmutablePasses[i]->dumpPassStructure(0);
648 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
649 E = PassManagers.end(); I != E; ++I)
650 (*I)->dumpPassStructure(1);
654 //===----------------------------------------------------------------------===//
655 // PMDataManager implementation
657 /// Return true IFF pass P's required analysis set does not required new
659 bool PMDataManager::manageablePass(Pass *P) {
662 // If this pass is not preserving information that is required by a
663 // pass maintained by higher level pass manager then do not insert
664 // this pass into current manager. Use new manager. For example,
665 // For example, If FunctionPass F is not preserving ModulePass Info M1
666 // that is used by another ModulePass M2 then do not insert F in
667 // current function pass manager.
671 /// Augement AvailableAnalysis by adding analysis made available by pass P.
672 void PMDataManager::recordAvailableAnalysis(Pass *P) {
674 if (const PassInfo *PI = P->getPassInfo()) {
675 AvailableAnalysis[PI] = P;
677 //This pass is the current implementation of all of the interfaces it
678 //implements as well.
679 const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
680 for (unsigned i = 0, e = II.size(); i != e; ++i)
681 AvailableAnalysis[II[i]] = P;
685 /// Remove Analyss not preserved by Pass P
686 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
687 AnalysisUsage AnUsage;
688 P->getAnalysisUsage(AnUsage);
690 if (AnUsage.getPreservesAll())
693 const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
694 for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
695 E = AvailableAnalysis.end(); I != E; ) {
696 if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) ==
697 PreservedSet.end()) {
698 // Remove this analysis
699 if (!dynamic_cast<ImmutablePass*>(I->second)) {
700 std::map<AnalysisID, Pass*>::iterator J = I++;
701 AvailableAnalysis.erase(J);
709 /// Remove analysis passes that are not used any longer
710 void PMDataManager::removeDeadPasses(Pass *P) {
712 std::vector<Pass *> DeadPasses;
713 TPM->collectLastUses(DeadPasses, P);
715 for (std::vector<Pass *>::iterator I = DeadPasses.begin(),
716 E = DeadPasses.end(); I != E; ++I) {
717 (*I)->releaseMemory();
719 std::map<AnalysisID, Pass*>::iterator Pos =
720 AvailableAnalysis.find((*I)->getPassInfo());
722 // It is possible that pass is already removed from the AvailableAnalysis
723 if (Pos != AvailableAnalysis.end())
724 AvailableAnalysis.erase(Pos);
728 /// Add pass P into the PassVector. Update
729 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
730 void PMDataManager::addPassToManager(Pass *P,
731 bool ProcessAnalysis) {
733 // This manager is going to manage pass P. Set up analysis resolver
735 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
738 if (ProcessAnalysis) {
740 // At the moment, this pass is the last user of all required passes.
741 std::vector<Pass *> LastUses;
742 std::vector<Pass *> RequiredPasses;
743 unsigned PDepth = this->getDepth();
745 collectRequiredAnalysisPasses(RequiredPasses, P);
746 for (std::vector<Pass *>::iterator I = RequiredPasses.begin(),
747 E = RequiredPasses.end(); I != E; ++I) {
748 Pass *PRequired = *I;
751 PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
752 RDepth = DM.getDepth();
754 if (PDepth == RDepth)
755 LastUses.push_back(PRequired);
756 else if (PDepth > RDepth) {
757 // Let the parent claim responsibility of last use
758 ForcedLastUses.push_back(PRequired);
760 // Note : This feature is not yet implemented
762 "Unable to handle Pass that requires lower level Analysis pass");
766 if (!LastUses.empty())
767 TPM->setLastUser(LastUses, P);
769 // Take a note of analysis required and made available by this pass.
770 // Remove the analysis not preserved by this pass
771 removeNotPreservedAnalysis(P);
772 recordAvailableAnalysis(P);
776 PassVector.push_back(P);
779 /// Populate RequiredPasses with the analysis pass that are required by
781 void PMDataManager::collectRequiredAnalysisPasses(std::vector<Pass *> &RP,
783 AnalysisUsage AnUsage;
784 P->getAnalysisUsage(AnUsage);
785 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
786 for (std::vector<AnalysisID>::const_iterator
787 I = RequiredSet.begin(), E = RequiredSet.end();
789 Pass *AnalysisPass = findAnalysisPass(*I, true);
790 assert (AnalysisPass && "Analysis pass is not available");
791 RP.push_back(AnalysisPass);
794 const std::vector<AnalysisID> &IDs = AnUsage.getRequiredTransitiveSet();
795 for (std::vector<AnalysisID>::const_iterator I = IDs.begin(),
796 E = IDs.end(); I != E; ++I) {
797 Pass *AnalysisPass = findAnalysisPass(*I, true);
798 assert (AnalysisPass && "Analysis pass is not available");
799 RP.push_back(AnalysisPass);
803 // All Required analyses should be available to the pass as it runs! Here
804 // we fill in the AnalysisImpls member of the pass so that it can
805 // successfully use the getAnalysis() method to retrieve the
806 // implementations it needs.
808 void PMDataManager::initializeAnalysisImpl(Pass *P) {
809 AnalysisUsage AnUsage;
810 P->getAnalysisUsage(AnUsage);
812 for (std::vector<const PassInfo *>::const_iterator
813 I = AnUsage.getRequiredSet().begin(),
814 E = AnUsage.getRequiredSet().end(); I != E; ++I) {
815 Pass *Impl = findAnalysisPass(*I, true);
817 assert(0 && "Analysis used but not available!");
818 AnalysisResolver_New *AR = P->getResolver();
819 AR->addAnalysisImplsPair(*I, Impl);
823 /// Find the pass that implements Analysis AID. If desired pass is not found
824 /// then return NULL.
825 Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
827 // Check if AvailableAnalysis map has one entry.
828 std::map<AnalysisID, Pass*>::const_iterator I = AvailableAnalysis.find(AID);
830 if (I != AvailableAnalysis.end())
833 // Search Parents through TopLevelManager
835 return TPM->findAnalysisPass(AID);
841 //===----------------------------------------------------------------------===//
842 // NOTE: Is this the right place to define this method ?
843 // getAnalysisToUpdate - Return an analysis result or null if it doesn't exist
844 Pass *AnalysisResolver_New::getAnalysisToUpdate(AnalysisID ID, bool dir) const {
845 return PM.findAnalysisPass(ID, dir);
848 //===----------------------------------------------------------------------===//
849 // BasicBlockPassManager implementation
851 /// Add pass P into PassVector and return true. If this pass is not
852 /// manageable by this manager then return false.
854 BasicBlockPassManager::addPass(Pass *P) {
856 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
860 // If this pass does not preserve anlysis that is used by other passes
861 // managed by this manager than it is not a suiable pass for this manager.
862 if (!manageablePass(P))
865 addPassToManager (BP);
870 /// Execute all of the passes scheduled for execution by invoking
871 /// runOnBasicBlock method. Keep track of whether any of the passes modifies
872 /// the function, and if so, return true.
874 BasicBlockPassManager::runOnFunction(Function &F) {
879 bool Changed = doInitialization(F);
880 initializeAnalysisInfo();
882 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
883 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
884 e = passVectorEnd(); itr != e; ++itr) {
886 initializeAnalysisImpl(P);
887 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
888 Changed |= BP->runOnBasicBlock(*I);
889 removeNotPreservedAnalysis(P);
890 recordAvailableAnalysis(P);
893 return Changed | doFinalization(F);
896 // Implement doInitialization and doFinalization
897 inline bool BasicBlockPassManager::doInitialization(Module &M) {
898 bool Changed = false;
900 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
901 e = passVectorEnd(); itr != e; ++itr) {
903 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
904 Changed |= BP->doInitialization(M);
910 inline bool BasicBlockPassManager::doFinalization(Module &M) {
911 bool Changed = false;
913 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
914 e = passVectorEnd(); itr != e; ++itr) {
916 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
917 Changed |= BP->doFinalization(M);
923 inline bool BasicBlockPassManager::doInitialization(Function &F) {
924 bool Changed = false;
926 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
927 e = passVectorEnd(); itr != e; ++itr) {
929 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
930 Changed |= BP->doInitialization(F);
936 inline bool BasicBlockPassManager::doFinalization(Function &F) {
937 bool Changed = false;
939 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
940 e = passVectorEnd(); itr != e; ++itr) {
942 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
943 Changed |= BP->doFinalization(F);
950 //===----------------------------------------------------------------------===//
951 // FunctionPassManager implementation
953 /// Create new Function pass manager
954 FunctionPassManager::FunctionPassManager(ModuleProvider *P) {
955 FPM = new FunctionPassManagerImpl_New(0);
956 // FPM is the top level manager.
957 FPM->setTopLevelManager(FPM);
959 PMDataManager *PMD = dynamic_cast<PMDataManager *>(FPM);
960 AnalysisResolver_New *AR = new AnalysisResolver_New(*PMD);
961 FPM->setResolver(AR);
963 FPM->addPassManager(FPM);
967 FunctionPassManager::~FunctionPassManager() {
968 // Note : FPM maintains one entry in PassManagers vector.
969 // This one entry is FPM itself. This is not ideal. One
970 // alternative is have one additional layer between
971 // FunctionPassManager and FunctionPassManagerImpl.
972 // Meanwhile, to avoid going into infinte loop, first
973 // remove FPM from its PassMangers vector.
974 FPM->clearManagers();
978 /// add - Add a pass to the queue of passes to run. This passes
979 /// ownership of the Pass to the PassManager. When the
980 /// PassManager_X is destroyed, the pass will be destroyed as well, so
981 /// there is no need to delete the pass. (TODO delete passes.)
982 /// This implies that all passes MUST be allocated with 'new'.
983 void FunctionPassManager::add(Pass *P) {
987 /// run - Execute all of the passes scheduled for execution. Keep
988 /// track of whether any of the passes modifies the function, and if
991 bool FunctionPassManager::run(Function &F) {
993 if (MP->materializeFunction(&F, &errstr)) {
994 cerr << "Error reading bytecode file: " << errstr << "\n";
1001 /// doInitialization - Run all of the initializers for the function passes.
1003 bool FunctionPassManager::doInitialization() {
1004 return FPM->doInitialization(*MP->getModule());
1007 /// doFinalization - Run all of the initializers for the function passes.
1009 bool FunctionPassManager::doFinalization() {
1010 return FPM->doFinalization(*MP->getModule());
1013 //===----------------------------------------------------------------------===//
1014 // FunctionPassManagerImpl_New implementation
1016 /// Add pass P into the pass manager queue. If P is a BasicBlockPass then
1017 /// either use it into active basic block pass manager or create new basic
1018 /// block pass manager to handle pass P.
1020 FunctionPassManagerImpl_New::addPass(Pass *P) {
1022 // If P is a BasicBlockPass then use BasicBlockPassManager.
1023 if (BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P)) {
1025 if (!activeBBPassManager || !activeBBPassManager->addPass(BP)) {
1027 // If active manager exists then clear its analysis info.
1028 if (activeBBPassManager)
1029 activeBBPassManager->initializeAnalysisInfo();
1031 // Create and add new manager
1032 activeBBPassManager =
1033 new BasicBlockPassManager(getDepth() + 1);
1034 // Inherit top level manager
1035 activeBBPassManager->setTopLevelManager(this->getTopLevelManager());
1037 // Add new manager into current manager's list.
1038 addPassToManager(activeBBPassManager, false);
1040 // Add new manager into top level manager's indirect passes list
1041 PMDataManager *PMD = dynamic_cast<PMDataManager *>(activeBBPassManager);
1042 assert (PMD && "Manager is not Pass Manager");
1043 TPM->addIndirectPassManager(PMD);
1045 // Add pass into new manager. This time it must succeed.
1046 if (!activeBBPassManager->addPass(BP))
1047 assert(0 && "Unable to add Pass");
1050 if (!ForcedLastUses.empty())
1051 TPM->setLastUser(ForcedLastUses, this);
1056 FunctionPass *FP = dynamic_cast<FunctionPass *>(P);
1060 // If this pass does not preserve anlysis that is used by other passes
1061 // managed by this manager than it is not a suiable pass for this manager.
1062 if (!manageablePass(P))
1065 addPassToManager (FP);
1067 // If active manager exists then clear its analysis info.
1068 if (activeBBPassManager) {
1069 activeBBPassManager->initializeAnalysisInfo();
1070 activeBBPassManager = NULL;
1076 /// Execute all of the passes scheduled for execution by invoking
1077 /// runOnFunction method. Keep track of whether any of the passes modifies
1078 /// the function, and if so, return true.
1079 bool FunctionPassManagerImpl_New::runOnModule(Module &M) {
1081 bool Changed = doInitialization(M);
1082 initializeAnalysisInfo();
1084 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1085 this->runOnFunction(*I);
1087 return Changed | doFinalization(M);
1090 /// Execute all of the passes scheduled for execution by invoking
1091 /// runOnFunction method. Keep track of whether any of the passes modifies
1092 /// the function, and if so, return true.
1093 bool FunctionPassManagerImpl_New::runOnFunction(Function &F) {
1095 bool Changed = false;
1100 initializeAnalysisInfo();
1102 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1103 e = passVectorEnd(); itr != e; ++itr) {
1105 initializeAnalysisImpl(P);
1106 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
1107 Changed |= FP->runOnFunction(F);
1108 removeNotPreservedAnalysis(P);
1109 recordAvailableAnalysis(P);
1110 removeDeadPasses(P);
1116 inline bool FunctionPassManagerImpl_New::doInitialization(Module &M) {
1117 bool Changed = false;
1119 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1120 e = passVectorEnd(); itr != e; ++itr) {
1123 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
1124 Changed |= FP->doInitialization(M);
1130 inline bool FunctionPassManagerImpl_New::doFinalization(Module &M) {
1131 bool Changed = false;
1133 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1134 e = passVectorEnd(); itr != e; ++itr) {
1137 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
1138 Changed |= FP->doFinalization(M);
1144 // Execute all the passes managed by this top level manager.
1145 // Return true if any function is modified by a pass.
1146 bool FunctionPassManagerImpl_New::run(Function &F) {
1148 bool Changed = false;
1149 for (std::vector<Pass *>::iterator I = passManagersBegin(),
1150 E = passManagersEnd(); I != E; ++I) {
1151 FunctionPassManagerImpl_New *FP =
1152 dynamic_cast<FunctionPassManagerImpl_New *>(*I);
1153 Changed |= FP->runOnFunction(F);
1158 //===----------------------------------------------------------------------===//
1159 // ModulePassManager implementation
1161 /// Add P into pass vector if it is manageble. If P is a FunctionPass
1162 /// then use FunctionPassManagerImpl_New to manage it. Return false if P
1163 /// is not manageable by this manager.
1165 ModulePassManager::addPass(Pass *P) {
1167 // If P is FunctionPass then use function pass maanager.
1168 if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P)) {
1170 if (!activeFunctionPassManager || !activeFunctionPassManager->addPass(P)) {
1172 // If active manager exists then clear its analysis info.
1173 if (activeFunctionPassManager)
1174 activeFunctionPassManager->initializeAnalysisInfo();
1176 // Create and add new manager
1177 activeFunctionPassManager =
1178 new FunctionPassManagerImpl_New(getDepth() + 1);
1180 // Add new manager into current manager's list
1181 addPassToManager(activeFunctionPassManager, false);
1183 // Inherit top level manager
1184 activeFunctionPassManager->setTopLevelManager(this->getTopLevelManager());
1186 // Add new manager into top level manager's indirect passes list
1187 PMDataManager *PMD = dynamic_cast<PMDataManager *>(activeFunctionPassManager);
1188 assert (PMD && "Manager is not Pass Manager");
1189 TPM->addIndirectPassManager(PMD);
1191 // Add pass into new manager. This time it must succeed.
1192 if (!activeFunctionPassManager->addPass(FP))
1193 assert(0 && "Unable to add pass");
1196 if (!ForcedLastUses.empty())
1197 TPM->setLastUser(ForcedLastUses, this);
1202 ModulePass *MP = dynamic_cast<ModulePass *>(P);
1206 // If this pass does not preserve anlysis that is used by other passes
1207 // managed by this manager than it is not a suiable pass for this manager.
1208 if (!manageablePass(P))
1211 addPassToManager(MP);
1212 // If active manager exists then clear its analysis info.
1213 if (activeFunctionPassManager) {
1214 activeFunctionPassManager->initializeAnalysisInfo();
1215 activeFunctionPassManager = NULL;
1222 /// Execute all of the passes scheduled for execution by invoking
1223 /// runOnModule method. Keep track of whether any of the passes modifies
1224 /// the module, and if so, return true.
1226 ModulePassManager::runOnModule(Module &M) {
1227 bool Changed = false;
1228 initializeAnalysisInfo();
1230 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1231 e = passVectorEnd(); itr != e; ++itr) {
1233 initializeAnalysisImpl(P);
1234 ModulePass *MP = dynamic_cast<ModulePass*>(P);
1235 Changed |= MP->runOnModule(M);
1236 removeNotPreservedAnalysis(P);
1237 recordAvailableAnalysis(P);
1238 removeDeadPasses(P);
1243 //===----------------------------------------------------------------------===//
1244 // PassManagerImpl implementation
1246 /// Add P into active pass manager or use new module pass manager to
1248 bool PassManagerImpl_New::addPass(Pass *P) {
1250 if (!activeManager || !activeManager->addPass(P)) {
1251 activeManager = new ModulePassManager(getDepth() + 1);
1252 // Inherit top level manager
1253 activeManager->setTopLevelManager(this->getTopLevelManager());
1255 // This top level manager is going to manage activeManager.
1256 // Set up analysis resolver to connect them.
1257 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
1258 activeManager->setResolver(AR);
1260 addPassManager(activeManager);
1261 return activeManager->addPass(P);
1266 /// run - Execute all of the passes scheduled for execution. Keep track of
1267 /// whether any of the passes modifies the module, and if so, return true.
1268 bool PassManagerImpl_New::run(Module &M) {
1270 bool Changed = false;
1272 if (PassDebugging_New >= Structure)
1275 for (std::vector<Pass *>::iterator I = passManagersBegin(),
1276 E = passManagersEnd(); I != E; ++I) {
1277 ModulePassManager *MP = dynamic_cast<ModulePassManager *>(*I);
1278 Changed |= MP->runOnModule(M);
1283 //===----------------------------------------------------------------------===//
1284 // PassManager implementation
1286 /// Create new pass manager
1287 PassManager::PassManager() {
1288 PM = new PassManagerImpl_New(0);
1289 // PM is the top level manager
1290 PM->setTopLevelManager(PM);
1293 PassManager::~PassManager() {
1297 /// add - Add a pass to the queue of passes to run. This passes ownership of
1298 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
1299 /// will be destroyed as well, so there is no need to delete the pass. This
1300 /// implies that all passes MUST be allocated with 'new'.
1302 PassManager::add(Pass *P) {
1306 /// run - Execute all of the passes scheduled for execution. Keep track of
1307 /// whether any of the passes modifies the module, and if so, return true.
1309 PassManager::run(Module &M) {