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/Module.h"
17 #include "llvm/ModuleProvider.h"
18 #include "llvm/Support/Streams.h"
23 //===----------------------------------------------------------------------===//
25 // The Pass Manager Infrastructure manages passes. It's responsibilities are:
27 // o Manage optimization pass execution order
28 // o Make required Analysis information available before pass P is run
29 // o Release memory occupied by dead passes
30 // o If Analysis information is dirtied by a pass then regenerate Analysis
31 // information before it is consumed by another pass.
33 // Pass Manager Infrastructure uses multipe pass managers. They are PassManager,
34 // FunctionPassManager, ModulePassManager, BasicBlockPassManager. This class
35 // hierarcy uses multiple inheritance but pass managers do not derive from
36 // another pass manager.
38 // PassManager and FunctionPassManager are two top level pass manager that
39 // represents the external interface of this entire pass manager infrastucture.
41 // Important classes :
43 // [o] class PMTopLevelManager;
45 // Two top level managers, PassManager and FunctionPassManager, derive from
46 // PMTopLevelManager. PMTopLevelManager manages information used by top level
47 // managers such as last user info.
49 // [o] class PMDataManager;
51 // PMDataManager manages information, e.g. list of available analysis info,
52 // used by a pass manager to manage execution order of passes. It also provides
53 // a place to implement common pass manager APIs. All pass managers derive from
56 // [o] class BasicBlockPassManager : public FunctionPass, public PMDataManager;
58 // BasicBlockPassManager manages BasicBlockPasses.
60 // [o] class FunctionPassManager;
62 // This is a external interface used by JIT to manage FunctionPasses. This
63 // interface relies on FunctionPassManagerImpl to do all the tasks.
65 // [o] class FunctionPassManagerImpl : public ModulePass, PMDataManager,
66 // public PMTopLevelManager;
68 // FunctionPassManagerImpl is a top level manager. It manages FunctionPasses
69 // and BasicBlockPassManagers.
71 // [o] class ModulePassManager : public Pass, public PMDataManager;
73 // ModulePassManager manages ModulePasses and FunctionPassManagerImpls.
75 // [o] class PassManager;
77 // This is a external interface used by various tools to manages passes. It
78 // relies on PassManagerImpl to do all the tasks.
80 // [o] class PassManagerImpl : public Pass, public PMDataManager,
81 // public PMDTopLevelManager
83 // PassManagerImpl is a top level pass manager responsible for managing
84 // ModulePassManagers.
85 //===----------------------------------------------------------------------===//
89 //===----------------------------------------------------------------------===//
92 /// PMTopLevelManager manages LastUser info and collects common APIs used by
93 /// top level pass managers.
94 class PMTopLevelManager {
98 inline std::vector<Pass *>::iterator passManagersBegin() {
99 return PassManagers.begin();
102 inline std::vector<Pass *>::iterator passManagersEnd() {
103 return PassManagers.end();
106 /// Schedule pass P for execution. Make sure that passes required by
107 /// P are run before P is run. Update analysis info maintained by
108 /// the manager. Remove dead passes. This is a recursive function.
109 void schedulePass(Pass *P);
111 /// This is implemented by top level pass manager and used by
112 /// schedulePass() to add analysis info passes that are not available.
113 virtual void addTopLevelPass(Pass *P) = 0;
115 /// Set pass P as the last user of the given analysis passes.
116 void setLastUser(std::vector<Pass *> &AnalysisPasses, Pass *P);
118 /// Collect passes whose last user is P
119 void collectLastUses(std::vector<Pass *> &LastUses, Pass *P);
121 /// Find the pass that implements Analysis AID. Search immutable
122 /// passes and all pass managers. If desired pass is not found
123 /// then return NULL.
124 Pass *findAnalysisPass(AnalysisID AID);
126 virtual ~PMTopLevelManager() {
127 PassManagers.clear();
130 /// Add immutable pass and initialize it.
131 inline void addImmutablePass(ImmutablePass *P) {
133 ImmutablePasses.push_back(P);
136 inline std::vector<ImmutablePass *>& getImmutablePasses() {
137 return ImmutablePasses;
140 void addPassManager(Pass *Manager) {
141 PassManagers.push_back(Manager);
144 // Add Manager into the list of managers that are not directly
145 // maintained by this top level pass manager
146 void addOtherPassManager(Pass *Manager) {
147 OtherPassManagers.push_back(Manager);
152 /// Collection of pass managers
153 std::vector<Pass *> PassManagers;
155 /// Collection of pass managers that are not directly maintained
156 /// by this pass manager
157 std::vector<Pass *> OtherPassManagers;
159 // Map to keep track of last user of the analysis pass.
160 // LastUser->second is the last user of Lastuser->first.
161 std::map<Pass *, Pass *> LastUser;
163 /// Immutable passes are managed by top level manager.
164 std::vector<ImmutablePass *> ImmutablePasses;
167 /// Set pass P as the last user of the given analysis passes.
168 void PMTopLevelManager::setLastUser(std::vector<Pass *> &AnalysisPasses,
171 for (std::vector<Pass *>::iterator I = AnalysisPasses.begin(),
172 E = AnalysisPasses.end(); I != E; ++I) {
175 // If AP is the last user of other passes then make P last user of
177 for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
178 LUE = LastUser.end(); LUI != LUE; ++LUI) {
179 if (LUI->second == AP)
180 LastUser[LUI->first] = P;
186 /// Collect passes whose last user is P
187 void PMTopLevelManager::collectLastUses(std::vector<Pass *> &LastUses,
189 for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
190 LUE = LastUser.end(); LUI != LUE; ++LUI)
191 if (LUI->second == P)
192 LastUses.push_back(LUI->first);
195 /// Schedule pass P for execution. Make sure that passes required by
196 /// P are run before P is run. Update analysis info maintained by
197 /// the manager. Remove dead passes. This is a recursive function.
198 void PMTopLevelManager::schedulePass(Pass *P) {
200 // TODO : Allocate function manager for this pass, other wise required set
201 // may be inserted into previous function manager
203 AnalysisUsage AnUsage;
204 P->getAnalysisUsage(AnUsage);
205 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
206 for (std::vector<AnalysisID>::const_iterator I = RequiredSet.begin(),
207 E = RequiredSet.end(); I != E; ++I) {
209 Pass *AnalysisPass = findAnalysisPass(*I);
211 // Schedule this analysis run first.
212 AnalysisPass = (*I)->createPass();
213 schedulePass(AnalysisPass);
217 // Now all required passes are available.
221 /// Find the pass that implements Analysis AID. Search immutable
222 /// passes and all pass managers. If desired pass is not found
223 /// then return NULL.
224 Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
227 for (std::vector<ImmutablePass *>::iterator I = ImmutablePasses.begin(),
228 E = ImmutablePasses.end(); P == NULL && I != E; ++I) {
229 const PassInfo *PI = (*I)->getPassInfo();
233 // If Pass not found then check the interfaces implemented by Immutable Pass
235 const std::vector<const PassInfo*> &ImmPI =
236 PI->getInterfacesImplemented();
237 for (unsigned Index = 0, End = ImmPI.size();
238 P == NULL && Index != End; ++Index)
239 if (ImmPI[Index] == AID)
244 // Check pass managers
245 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
246 E = PassManagers.end(); P == NULL && I != E; ++I)
247 P = (*I)->getResolver()->getAnalysisToUpdate(AID, false);
249 // Check other pass managers
250 for (std::vector<Pass *>::iterator I = OtherPassManagers.begin(),
251 E = OtherPassManagers.end(); P == NULL && I != E; ++I)
252 P = (*I)->getResolver()->getAnalysisToUpdate(AID, false);
257 //===----------------------------------------------------------------------===//
260 /// PMDataManager provides the common place to manage the analysis data
261 /// used by pass managers.
262 class PMDataManager {
266 PMDataManager(int D) : TPM(NULL), Depth(D) {
267 initializeAnalysisInfo();
270 /// Return true IFF pass P's required analysis set does not required new
272 bool manageablePass(Pass *P);
274 /// Augment AvailableAnalysis by adding analysis made available by pass P.
275 void recordAvailableAnalysis(Pass *P);
277 /// Remove Analysis that is not preserved by the pass
278 void removeNotPreservedAnalysis(Pass *P);
280 /// Remove dead passes
281 void removeDeadPasses(Pass *P);
283 /// Add pass P into the PassVector. Update
284 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
285 void addPassToManager (Pass *P, bool ProcessAnalysis = true);
287 /// Initialize available analysis information.
288 void initializeAnalysisInfo() {
289 ForcedLastUses.clear();
290 AvailableAnalysis.clear();
292 // Include immutable passes into AvailableAnalysis vector.
293 std::vector<ImmutablePass *> &ImmutablePasses = TPM->getImmutablePasses();
294 for (std::vector<ImmutablePass *>::iterator I = ImmutablePasses.begin(),
295 E = ImmutablePasses.end(); I != E; ++I)
296 recordAvailableAnalysis(*I);
299 /// Populate RequiredPasses with the analysis pass that are required by
301 void collectRequiredAnalysisPasses(std::vector<Pass *> &RequiredPasses,
304 /// All Required analyses should be available to the pass as it runs! Here
305 /// we fill in the AnalysisImpls member of the pass so that it can
306 /// successfully use the getAnalysis() method to retrieve the
307 /// implementations it needs.
308 void initializeAnalysisImpl(Pass *P);
310 /// Find the pass that implements Analysis AID. If desired pass is not found
311 /// then return NULL.
312 Pass *findAnalysisPass(AnalysisID AID, bool Direction);
314 inline std::vector<Pass *>::iterator passVectorBegin() {
315 return PassVector.begin();
318 inline std::vector<Pass *>::iterator passVectorEnd() {
319 return PassVector.end();
322 // Access toplevel manager
323 PMTopLevelManager *getTopLevelManager() { return TPM; }
324 void setTopLevelManager(PMTopLevelManager *T) { TPM = T; }
326 unsigned getDepth() { return Depth; }
330 // Collection of pass whose last user asked this manager to claim
331 // last use. If a FunctionPass F is the last user of ModulePass info M
332 // then the F's manager, not F, records itself as a last user of M.
333 std::vector<Pass *> ForcedLastUses;
335 // Top level manager.
336 PMTopLevelManager *TPM;
339 // Set of available Analysis. This information is used while scheduling
340 // pass. If a pass requires an analysis which is not not available then
341 // equired analysis pass is scheduled to run before the pass itself is
343 std::map<AnalysisID, Pass*> AvailableAnalysis;
345 // Collection of pass that are managed by this manager
346 std::vector<Pass *> PassVector;
351 /// BasicBlockPassManager_New manages BasicBlockPass. It batches all the
352 /// pass together and sequence them to process one basic block before
353 /// processing next basic block.
354 class BasicBlockPassManager_New : public PMDataManager,
355 public FunctionPass {
358 BasicBlockPassManager_New(int D) : PMDataManager(D) { }
360 /// Add a pass into a passmanager queue.
361 bool addPass(Pass *p);
363 /// Execute all of the passes scheduled for execution. Keep track of
364 /// whether any of the passes modifies the function, and if so, return true.
365 bool runOnFunction(Function &F);
367 /// Pass Manager itself does not invalidate any analysis info.
368 void getAnalysisUsage(AnalysisUsage &Info) const {
369 Info.setPreservesAll();
372 bool doInitialization(Module &M);
373 bool doInitialization(Function &F);
374 bool doFinalization(Module &M);
375 bool doFinalization(Function &F);
379 /// FunctionPassManagerImpl_New manages FunctionPasses and BasicBlockPassManagers.
380 /// It batches all function passes and basic block pass managers together and
381 /// sequence them to process one function at a time before processing next
383 class FunctionPassManagerImpl_New : public ModulePass,
384 public PMDataManager,
385 public PMTopLevelManager {
387 FunctionPassManagerImpl_New(ModuleProvider *P, int D) :
388 PMDataManager(D) { /* TODO */ }
389 FunctionPassManagerImpl_New(int D) : PMDataManager(D) {
390 activeBBPassManager = NULL;
392 ~FunctionPassManagerImpl_New() { /* TODO */ };
394 inline void addTopLevelPass(Pass *P) {
396 if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
398 // P is a immutable pass then it will be managed by this
399 // top level manager. Set up analysis resolver to connect them.
400 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
402 initializeAnalysisImpl(P);
403 addImmutablePass(IP);
404 recordAvailableAnalysis(IP);
410 /// add - Add a pass to the queue of passes to run. This passes
411 /// ownership of the Pass to the PassManager. When the
412 /// PassManager_X is destroyed, the pass will be destroyed as well, so
413 /// there is no need to delete the pass. (TODO delete passes.)
414 /// This implies that all passes MUST be allocated with 'new'.
419 /// Add pass into the pass manager queue.
420 bool addPass(Pass *P);
422 /// Execute all of the passes scheduled for execution. Keep
423 /// track of whether any of the passes modifies the function, and if
425 bool runOnModule(Module &M);
426 bool runOnFunction(Function &F);
427 bool run(Function &F);
429 /// doInitialization - Run all of the initializers for the function passes.
431 bool doInitialization(Module &M);
433 /// doFinalization - Run all of the initializers for the function passes.
435 bool doFinalization(Module &M);
437 /// Pass Manager itself does not invalidate any analysis info.
438 void getAnalysisUsage(AnalysisUsage &Info) const {
439 Info.setPreservesAll();
443 // Active Pass Managers
444 BasicBlockPassManager_New *activeBBPassManager;
447 /// ModulePassManager_New manages ModulePasses and function pass managers.
448 /// It batches all Module passes passes and function pass managers together and
449 /// sequence them to process one module.
450 class ModulePassManager_New : public Pass,
451 public PMDataManager {
454 ModulePassManager_New(int D) : PMDataManager(D) {
455 activeFunctionPassManager = NULL;
458 /// Add a pass into a passmanager queue.
459 bool addPass(Pass *p);
461 /// run - Execute all of the passes scheduled for execution. Keep track of
462 /// whether any of the passes modifies the module, and if so, return true.
463 bool runOnModule(Module &M);
465 /// Pass Manager itself does not invalidate any analysis info.
466 void getAnalysisUsage(AnalysisUsage &Info) const {
467 Info.setPreservesAll();
471 // Active Pass Manager
472 FunctionPassManagerImpl_New *activeFunctionPassManager;
475 /// PassManager_New manages ModulePassManagers
476 class PassManagerImpl_New : public Pass,
477 public PMDataManager,
478 public PMTopLevelManager {
482 PassManagerImpl_New(int D) : PMDataManager(D) {}
484 /// add - Add a pass to the queue of passes to run. This passes ownership of
485 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
486 /// will be destroyed as well, so there is no need to delete the pass. This
487 /// implies that all passes MUST be allocated with 'new'.
492 /// run - Execute all of the passes scheduled for execution. Keep track of
493 /// whether any of the passes modifies the module, and if so, return true.
496 /// Pass Manager itself does not invalidate any analysis info.
497 void getAnalysisUsage(AnalysisUsage &Info) const {
498 Info.setPreservesAll();
501 inline void addTopLevelPass(Pass *P) {
503 if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
505 // P is a immutable pass and it will be managed by this
506 // top level manager. Set up analysis resolver to connect them.
507 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
509 initializeAnalysisImpl(P);
510 addImmutablePass(IP);
511 recordAvailableAnalysis(IP);
519 /// Add a pass into a passmanager queue.
520 bool addPass(Pass *p);
522 // Active Pass Manager
523 ModulePassManager_New *activeManager;
526 } // End of llvm namespace
528 //===----------------------------------------------------------------------===//
529 // PMDataManager implementation
531 /// Return true IFF pass P's required analysis set does not required new
533 bool PMDataManager::manageablePass(Pass *P) {
536 // If this pass is not preserving information that is required by a
537 // pass maintained by higher level pass manager then do not insert
538 // this pass into current manager. Use new manager. For example,
539 // For example, If FunctionPass F is not preserving ModulePass Info M1
540 // that is used by another ModulePass M2 then do not insert F in
541 // current function pass manager.
545 /// Augement AvailableAnalysis by adding analysis made available by pass P.
546 void PMDataManager::recordAvailableAnalysis(Pass *P) {
548 if (const PassInfo *PI = P->getPassInfo()) {
549 AvailableAnalysis[PI] = P;
551 //This pass is the current implementation of all of the interfaces it
552 //implements as well.
553 const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
554 for (unsigned i = 0, e = II.size(); i != e; ++i)
555 AvailableAnalysis[II[i]] = P;
559 /// Remove Analyss not preserved by Pass P
560 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
561 AnalysisUsage AnUsage;
562 P->getAnalysisUsage(AnUsage);
564 if (AnUsage.getPreservesAll())
567 const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
568 for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
569 E = AvailableAnalysis.end(); I != E; ++I ) {
570 if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) ==
571 PreservedSet.end()) {
572 // Remove this analysis
573 std::map<AnalysisID, Pass*>::iterator J = I++;
574 AvailableAnalysis.erase(J);
579 /// Remove analysis passes that are not used any longer
580 void PMDataManager::removeDeadPasses(Pass *P) {
582 std::vector<Pass *> DeadPasses;
583 TPM->collectLastUses(DeadPasses, P);
585 for (std::vector<Pass *>::iterator I = DeadPasses.begin(),
586 E = DeadPasses.end(); I != E; ++I) {
587 (*I)->releaseMemory();
589 std::map<AnalysisID, Pass*>::iterator Pos =
590 AvailableAnalysis.find((*I)->getPassInfo());
592 // It is possible that pass is already removed from the AvailableAnalysis
593 if (Pos != AvailableAnalysis.end())
594 AvailableAnalysis.erase(Pos);
598 /// Add pass P into the PassVector. Update
599 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
600 void PMDataManager::addPassToManager(Pass *P,
601 bool ProcessAnalysis) {
603 // This manager is going to manage pass P. Set up analysis resolver
605 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
608 if (ProcessAnalysis) {
610 // At the moment, this pass is the last user of all required passes.
611 std::vector<Pass *> LastUses;
612 std::vector<Pass *> RequiredPasses;
613 unsigned PDepth = this->getDepth();
615 collectRequiredAnalysisPasses(RequiredPasses, P);
616 for (std::vector<Pass *>::iterator I = RequiredPasses.begin(),
617 E = RequiredPasses.end(); I != E; ++I) {
618 Pass *PRequired = *I;
621 PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
622 RDepth = DM.getDepth();
624 if (PDepth == RDepth)
625 LastUses.push_back(PRequired);
626 else if (PDepth > RDepth) {
627 // Let the parent claim responsibility of last use
628 ForcedLastUses.push_back(PRequired);
630 // Note : This feature is not yet implemented
632 "Unable to handle Pass that requires lower level Analysis pass");
636 if (!LastUses.empty())
637 TPM->setLastUser(LastUses, P);
639 // Take a note of analysis required and made available by this pass.
640 // Remove the analysis not preserved by this pass
641 removeNotPreservedAnalysis(P);
642 recordAvailableAnalysis(P);
646 PassVector.push_back(P);
649 /// Populate RequiredPasses with the analysis pass that are required by
651 void PMDataManager::collectRequiredAnalysisPasses(std::vector<Pass *> &RP,
653 AnalysisUsage AnUsage;
654 P->getAnalysisUsage(AnUsage);
655 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
656 for (std::vector<AnalysisID>::const_iterator
657 I = RequiredSet.begin(), E = RequiredSet.end();
659 Pass *AnalysisPass = findAnalysisPass(*I, true);
660 assert (AnalysisPass && "Analysis pass is not available");
661 RP.push_back(AnalysisPass);
665 // All Required analyses should be available to the pass as it runs! Here
666 // we fill in the AnalysisImpls member of the pass so that it can
667 // successfully use the getAnalysis() method to retrieve the
668 // implementations it needs.
670 void PMDataManager::initializeAnalysisImpl(Pass *P) {
671 AnalysisUsage AnUsage;
672 P->getAnalysisUsage(AnUsage);
674 for (std::vector<const PassInfo *>::const_iterator
675 I = AnUsage.getRequiredSet().begin(),
676 E = AnUsage.getRequiredSet().end(); I != E; ++I) {
677 Pass *Impl = findAnalysisPass(*I, true);
679 assert(0 && "Analysis used but not available!");
680 AnalysisResolver_New *AR = P->getResolver();
681 AR->addAnalysisImplsPair(*I, Impl);
685 /// Find the pass that implements Analysis AID. If desired pass is not found
686 /// then return NULL.
687 Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
689 // Check if AvailableAnalysis map has one entry.
690 std::map<AnalysisID, Pass*>::const_iterator I = AvailableAnalysis.find(AID);
692 if (I != AvailableAnalysis.end())
695 // Search Parents through TopLevelManager
697 return TPM->findAnalysisPass(AID);
703 //===----------------------------------------------------------------------===//
704 // NOTE: Is this the right place to define this method ?
705 // getAnalysisToUpdate - Return an analysis result or null if it doesn't exist
706 Pass *AnalysisResolver_New::getAnalysisToUpdate(AnalysisID ID, bool dir) const {
707 return PM.findAnalysisPass(ID, dir);
710 //===----------------------------------------------------------------------===//
711 // BasicBlockPassManager_New implementation
713 /// Add pass P into PassVector and return true. If this pass is not
714 /// manageable by this manager then return false.
716 BasicBlockPassManager_New::addPass(Pass *P) {
718 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
722 // If this pass does not preserve anlysis that is used by other passes
723 // managed by this manager than it is not a suiable pass for this manager.
724 if (!manageablePass(P))
727 addPassToManager (BP);
732 /// Execute all of the passes scheduled for execution by invoking
733 /// runOnBasicBlock method. Keep track of whether any of the passes modifies
734 /// the function, and if so, return true.
736 BasicBlockPassManager_New::runOnFunction(Function &F) {
738 bool Changed = doInitialization(F);
739 initializeAnalysisInfo();
741 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
742 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
743 e = passVectorEnd(); itr != e; ++itr) {
746 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
747 Changed |= BP->runOnBasicBlock(*I);
748 removeNotPreservedAnalysis(P);
749 recordAvailableAnalysis(P);
752 return Changed | doFinalization(F);
755 // Implement doInitialization and doFinalization
756 inline bool BasicBlockPassManager_New::doInitialization(Module &M) {
757 bool Changed = false;
759 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
760 e = passVectorEnd(); itr != e; ++itr) {
762 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
763 Changed |= BP->doInitialization(M);
769 inline bool BasicBlockPassManager_New::doFinalization(Module &M) {
770 bool Changed = false;
772 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
773 e = passVectorEnd(); itr != e; ++itr) {
775 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
776 Changed |= BP->doFinalization(M);
782 inline bool BasicBlockPassManager_New::doInitialization(Function &F) {
783 bool Changed = false;
785 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
786 e = passVectorEnd(); itr != e; ++itr) {
788 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
789 Changed |= BP->doInitialization(F);
795 inline bool BasicBlockPassManager_New::doFinalization(Function &F) {
796 bool Changed = false;
798 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
799 e = passVectorEnd(); itr != e; ++itr) {
801 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
802 Changed |= BP->doFinalization(F);
809 //===----------------------------------------------------------------------===//
810 // FunctionPassManager_New implementation
812 /// Create new Function pass manager
813 FunctionPassManager_New::FunctionPassManager_New() {
814 FPM = new FunctionPassManagerImpl_New(0);
817 FunctionPassManager_New::FunctionPassManager_New(ModuleProvider *P) {
818 FPM = new FunctionPassManagerImpl_New(0);
819 // FPM is the top level manager.
820 FPM->setTopLevelManager(FPM);
824 /// add - Add a pass to the queue of passes to run. This passes
825 /// ownership of the Pass to the PassManager. When the
826 /// PassManager_X is destroyed, the pass will be destroyed as well, so
827 /// there is no need to delete the pass. (TODO delete passes.)
828 /// This implies that all passes MUST be allocated with 'new'.
829 void FunctionPassManager_New::add(Pass *P) {
833 /// Execute all of the passes scheduled for execution. Keep
834 /// track of whether any of the passes modifies the function, and if
836 bool FunctionPassManager_New::runOnModule(Module &M) {
837 return FPM->runOnModule(M);
840 /// run - Execute all of the passes scheduled for execution. Keep
841 /// track of whether any of the passes modifies the function, and if
844 bool FunctionPassManager_New::run(Function &F) {
846 if (MP->materializeFunction(&F, &errstr)) {
847 cerr << "Error reading bytecode file: " << errstr << "\n";
854 /// doInitialization - Run all of the initializers for the function passes.
856 bool FunctionPassManager_New::doInitialization() {
857 return FPM->doInitialization(*MP->getModule());
860 /// doFinalization - Run all of the initializers for the function passes.
862 bool FunctionPassManager_New::doFinalization() {
863 return FPM->doFinalization(*MP->getModule());
866 //===----------------------------------------------------------------------===//
867 // FunctionPassManagerImpl_New implementation
869 /// Add pass P into the pass manager queue. If P is a BasicBlockPass then
870 /// either use it into active basic block pass manager or create new basic
871 /// block pass manager to handle pass P.
873 FunctionPassManagerImpl_New::addPass(Pass *P) {
875 // If P is a BasicBlockPass then use BasicBlockPassManager_New.
876 if (BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P)) {
878 if (!activeBBPassManager || !activeBBPassManager->addPass(BP)) {
880 // If active manager exists then clear its analysis info.
881 if (activeBBPassManager)
882 activeBBPassManager->initializeAnalysisInfo();
884 // Create and add new manager
885 activeBBPassManager =
886 new BasicBlockPassManager_New(getDepth() + 1);
887 // Inherit top level manager
888 activeBBPassManager->setTopLevelManager(this->getTopLevelManager());
889 addPassToManager(activeBBPassManager, false);
890 TPM->addOtherPassManager(activeBBPassManager);
892 // Add pass into new manager. This time it must succeed.
893 if (!activeBBPassManager->addPass(BP))
894 assert(0 && "Unable to add Pass");
897 if (!ForcedLastUses.empty())
898 TPM->setLastUser(ForcedLastUses, this);
903 FunctionPass *FP = dynamic_cast<FunctionPass *>(P);
907 // If this pass does not preserve anlysis that is used by other passes
908 // managed by this manager than it is not a suiable pass for this manager.
909 if (!manageablePass(P))
912 addPassToManager (FP);
914 // If active manager exists then clear its analysis info.
915 if (activeBBPassManager) {
916 activeBBPassManager->initializeAnalysisInfo();
917 activeBBPassManager = NULL;
923 /// Execute all of the passes scheduled for execution by invoking
924 /// runOnFunction method. Keep track of whether any of the passes modifies
925 /// the function, and if so, return true.
926 bool FunctionPassManagerImpl_New::runOnModule(Module &M) {
928 bool Changed = doInitialization(M);
929 initializeAnalysisInfo();
931 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
932 this->runOnFunction(*I);
934 return Changed | doFinalization(M);
937 /// Execute all of the passes scheduled for execution by invoking
938 /// runOnFunction method. Keep track of whether any of the passes modifies
939 /// the function, and if so, return true.
940 bool FunctionPassManagerImpl_New::runOnFunction(Function &F) {
942 bool Changed = false;
943 initializeAnalysisInfo();
945 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
946 e = passVectorEnd(); itr != e; ++itr) {
949 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
950 Changed |= FP->runOnFunction(F);
951 removeNotPreservedAnalysis(P);
952 recordAvailableAnalysis(P);
959 inline bool FunctionPassManagerImpl_New::doInitialization(Module &M) {
960 bool Changed = false;
962 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
963 e = passVectorEnd(); itr != e; ++itr) {
966 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
967 Changed |= FP->doInitialization(M);
973 inline bool FunctionPassManagerImpl_New::doFinalization(Module &M) {
974 bool Changed = false;
976 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
977 e = passVectorEnd(); itr != e; ++itr) {
980 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
981 Changed |= FP->doFinalization(M);
987 // Execute all the passes managed by this top level manager.
988 // Return true if any function is modified by a pass.
989 bool FunctionPassManagerImpl_New::run(Function &F) {
991 bool Changed = false;
992 for (std::vector<Pass *>::iterator I = passManagersBegin(),
993 E = passManagersEnd(); I != E; ++I) {
994 FunctionPass *FP = dynamic_cast<FunctionPass *>(*I);
995 Changed |= FP->runOnFunction(F);
1000 //===----------------------------------------------------------------------===//
1001 // ModulePassManager implementation
1003 /// Add P into pass vector if it is manageble. If P is a FunctionPass
1004 /// then use FunctionPassManagerImpl_New to manage it. Return false if P
1005 /// is not manageable by this manager.
1007 ModulePassManager_New::addPass(Pass *P) {
1009 // If P is FunctionPass then use function pass maanager.
1010 if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P)) {
1012 if (!activeFunctionPassManager || !activeFunctionPassManager->addPass(P)) {
1014 // If active manager exists then clear its analysis info.
1015 if (activeFunctionPassManager)
1016 activeFunctionPassManager->initializeAnalysisInfo();
1018 // Create and add new manager
1019 activeFunctionPassManager =
1020 new FunctionPassManagerImpl_New(getDepth() + 1);
1021 addPassToManager(activeFunctionPassManager, false);
1022 // Inherit top level manager
1023 activeFunctionPassManager->setTopLevelManager(this->getTopLevelManager());
1024 TPM->addOtherPassManager(activeFunctionPassManager);
1026 // Add pass into new manager. This time it must succeed.
1027 if (!activeFunctionPassManager->addPass(FP))
1028 assert(0 && "Unable to add pass");
1031 if (!ForcedLastUses.empty())
1032 TPM->setLastUser(ForcedLastUses, this);
1037 ModulePass *MP = dynamic_cast<ModulePass *>(P);
1041 // If this pass does not preserve anlysis that is used by other passes
1042 // managed by this manager than it is not a suiable pass for this manager.
1043 if (!manageablePass(P))
1046 addPassToManager(MP);
1047 // If active manager exists then clear its analysis info.
1048 if (activeFunctionPassManager) {
1049 activeFunctionPassManager->initializeAnalysisInfo();
1050 activeFunctionPassManager = NULL;
1057 /// Execute all of the passes scheduled for execution by invoking
1058 /// runOnModule method. Keep track of whether any of the passes modifies
1059 /// the module, and if so, return true.
1061 ModulePassManager_New::runOnModule(Module &M) {
1062 bool Changed = false;
1063 initializeAnalysisInfo();
1065 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1066 e = passVectorEnd(); itr != e; ++itr) {
1069 ModulePass *MP = dynamic_cast<ModulePass*>(P);
1070 Changed |= MP->runOnModule(M);
1071 removeNotPreservedAnalysis(P);
1072 recordAvailableAnalysis(P);
1073 removeDeadPasses(P);
1078 //===----------------------------------------------------------------------===//
1079 // PassManagerImpl implementation
1081 // PassManager_New implementation
1082 /// Add P into active pass manager or use new module pass manager to
1084 bool PassManagerImpl_New::addPass(Pass *P) {
1086 if (!activeManager || !activeManager->addPass(P)) {
1087 activeManager = new ModulePassManager_New(getDepth() + 1);
1088 // Inherit top level manager
1089 activeManager->setTopLevelManager(this->getTopLevelManager());
1091 // This top level manager is going to manage activeManager.
1092 // Set up analysis resolver to connect them.
1093 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
1094 activeManager->setResolver(AR);
1096 addPassManager(activeManager);
1097 return activeManager->addPass(P);
1102 /// run - Execute all of the passes scheduled for execution. Keep track of
1103 /// whether any of the passes modifies the module, and if so, return true.
1104 bool PassManagerImpl_New::run(Module &M) {
1106 bool Changed = false;
1107 for (std::vector<Pass *>::iterator I = passManagersBegin(),
1108 E = passManagersEnd(); I != E; ++I) {
1109 ModulePassManager_New *MP = dynamic_cast<ModulePassManager_New *>(*I);
1110 Changed |= MP->runOnModule(M);
1115 //===----------------------------------------------------------------------===//
1116 // PassManager implementation
1118 /// Create new pass manager
1119 PassManager_New::PassManager_New() {
1120 PM = new PassManagerImpl_New(0);
1121 // PM is the top level manager
1122 PM->setTopLevelManager(PM);
1125 /// add - Add a pass to the queue of passes to run. This passes ownership of
1126 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
1127 /// will be destroyed as well, so there is no need to delete the pass. This
1128 /// implies that all passes MUST be allocated with 'new'.
1130 PassManager_New::add(Pass *P) {
1134 /// run - Execute all of the passes scheduled for execution. Keep track of
1135 /// whether any of the passes modifies the module, and if so, return true.
1137 PassManager_New::run(Module &M) {