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, Pass *PM);
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 virtual ~PMTopLevelManager() {
122 PassManagers.clear();
125 /// Add immutable pass and initialize it.
126 inline void addImmutablePass(ImmutablePass *P) {
128 ImmutablePasses.push_back(P);
131 inline std::vector<ImmutablePass *>& getImmutablePasses() {
132 return ImmutablePasses;
137 /// Collection of pass managers
138 std::vector<Pass *> PassManagers;
140 // Map to keep track of last user of the analysis pass.
141 // LastUser->second is the last user of Lastuser->first.
142 std::map<Pass *, Pass *> LastUser;
144 /// Immutable passes are managed by top level manager.
145 std::vector<ImmutablePass *> ImmutablePasses;
148 /// Set pass P as the last user of the given analysis passes.
149 void PMTopLevelManager::setLastUser(std::vector<Pass *> &AnalysisPasses,
152 for (std::vector<Pass *>::iterator I = AnalysisPasses.begin(),
153 E = AnalysisPasses.end(); I != E; ++I) {
156 // If AP is the last user of other passes then make P last user of
158 for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
159 LUE = LastUser.end(); LUI != LUE; ++LUI) {
160 if (LUI->second == AP)
161 LastUser[LUI->first] = P;
167 /// Collect passes whose last user is P
168 void PMTopLevelManager::collectLastUses(std::vector<Pass *> &LastUses,
170 for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
171 LUE = LastUser.end(); LUI != LUE; ++LUI)
172 if (LUI->second == P)
173 LastUses.push_back(LUI->first);
176 /// Schedule pass P for execution. Make sure that passes required by
177 /// P are run before P is run. Update analysis info maintained by
178 /// the manager. Remove dead passes. This is a recursive function.
179 void PMTopLevelManager::schedulePass(Pass *P, Pass *PM) {
181 // TODO : Allocate function manager for this pass, other wise required set
182 // may be inserted into previous function manager
184 AnalysisUsage AnUsage;
185 P->getAnalysisUsage(AnUsage);
186 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
187 for (std::vector<AnalysisID>::const_iterator I = RequiredSet.begin(),
188 E = RequiredSet.end(); I != E; ++I) {
190 Pass *AnalysisPass = NULL; // FIXME PM->getAnalysisPass(*I, true);
192 // Schedule this analysis run first.
193 AnalysisPass = (*I)->createPass();
194 schedulePass(AnalysisPass, PM);
198 // Now all required passes are available.
202 //===----------------------------------------------------------------------===//
205 /// PMDataManager provides the common place to manage the analysis data
206 /// used by pass managers.
207 class PMDataManager {
211 PMDataManager(int D) : TPM(NULL), Depth(D) {
212 initializeAnalysisInfo();
215 /// Return true IFF pass P's required analysis set does not required new
217 bool manageablePass(Pass *P);
219 Pass *getAnalysisPass(AnalysisID AID) const {
221 std::map<AnalysisID, Pass*>::const_iterator I =
222 AvailableAnalysis.find(AID);
224 if (I != AvailableAnalysis.end())
230 /// Augment AvailableAnalysis by adding analysis made available by pass P.
231 void recordAvailableAnalysis(Pass *P);
233 /// Remove Analysis that is not preserved by the pass
234 void removeNotPreservedAnalysis(Pass *P);
236 /// Remove dead passes
237 void removeDeadPasses(Pass *P);
239 /// Add pass P into the PassVector. Update
240 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
241 void addPassToManager (Pass *P, bool ProcessAnalysis = true);
243 /// Initialize available analysis information.
244 void initializeAnalysisInfo() {
245 ForcedLastUses.clear();
246 AvailableAnalysis.clear();
248 // Include immutable passes into AvailableAnalysis vector.
249 std::vector<ImmutablePass *> &ImmutablePasses = TPM->getImmutablePasses();
250 for (std::vector<ImmutablePass *>::iterator I = ImmutablePasses.begin(),
251 E = ImmutablePasses.end(); I != E; ++I)
252 recordAvailableAnalysis(*I);
255 /// Populate RequiredPasses with the analysis pass that are required by
257 void collectRequiredAnalysisPasses(std::vector<Pass *> &RequiredPasses,
260 /// All Required analyses should be available to the pass as it runs! Here
261 /// we fill in the AnalysisImpls member of the pass so that it can
262 /// successfully use the getAnalysis() method to retrieve the
263 /// implementations it needs.
264 void initializeAnalysisImpl(Pass *P);
266 inline std::vector<Pass *>::iterator passVectorBegin() {
267 return PassVector.begin();
270 inline std::vector<Pass *>::iterator passVectorEnd() {
271 return PassVector.end();
274 // Access toplevel manager
275 PMTopLevelManager *getTopLevelManager() { return TPM; }
276 void setTopLevelManager(PMTopLevelManager *T) { TPM = T; }
278 unsigned getDepth() { return Depth; }
282 // Collection of pass whose last user asked this manager to claim
283 // last use. If a FunctionPass F is the last user of ModulePass info M
284 // then the F's manager, not F, records itself as a last user of M.
285 std::vector<Pass *> ForcedLastUses;
287 // Top level manager.
288 // TODO : Make it a reference.
289 PMTopLevelManager *TPM;
292 // Set of available Analysis. This information is used while scheduling
293 // pass. If a pass requires an analysis which is not not available then
294 // equired analysis pass is scheduled to run before the pass itself is
296 std::map<AnalysisID, Pass*> AvailableAnalysis;
298 // Collection of pass that are managed by this manager
299 std::vector<Pass *> PassVector;
304 /// BasicBlockPassManager_New manages BasicBlockPass. It batches all the
305 /// pass together and sequence them to process one basic block before
306 /// processing next basic block.
307 class BasicBlockPassManager_New : public PMDataManager,
308 public FunctionPass {
311 BasicBlockPassManager_New(int D) : PMDataManager(D) { }
313 /// Add a pass into a passmanager queue.
314 bool addPass(Pass *p);
316 /// Execute all of the passes scheduled for execution. Keep track of
317 /// whether any of the passes modifies the function, and if so, return true.
318 bool runOnFunction(Function &F);
320 /// Return true IFF AnalysisID AID is currently available.
321 /// TODO : Replace this method with getAnalysisPass()
322 Pass *getAnalysisPassFromManager(AnalysisID AID);
324 /// Pass Manager itself does not invalidate any analysis info.
325 void getAnalysisUsage(AnalysisUsage &Info) const {
326 Info.setPreservesAll();
329 bool doInitialization(Module &M);
330 bool doInitialization(Function &F);
331 bool doFinalization(Module &M);
332 bool doFinalization(Function &F);
336 /// FunctionPassManagerImpl_New manages FunctionPasses and BasicBlockPassManagers.
337 /// It batches all function passes and basic block pass managers together and
338 /// sequence them to process one function at a time before processing next
340 class FunctionPassManagerImpl_New : public ModulePass,
341 public PMDataManager,
342 public PMTopLevelManager {
344 FunctionPassManagerImpl_New(ModuleProvider *P, int D) :
345 PMDataManager(D) { /* TODO */ }
346 FunctionPassManagerImpl_New(int D) : PMDataManager(D) {
347 activeBBPassManager = NULL;
349 ~FunctionPassManagerImpl_New() { /* TODO */ };
351 inline void addTopLevelPass(Pass *P) {
355 /// add - Add a pass to the queue of passes to run. This passes
356 /// ownership of the Pass to the PassManager. When the
357 /// PassManager_X is destroyed, the pass will be destroyed as well, so
358 /// there is no need to delete the pass. (TODO delete passes.)
359 /// This implies that all passes MUST be allocated with 'new'.
361 schedulePass(P, this);
364 /// Add pass into the pass manager queue.
365 bool addPass(Pass *P);
367 /// Execute all of the passes scheduled for execution. Keep
368 /// track of whether any of the passes modifies the function, and if
370 bool runOnModule(Module &M);
371 bool runOnFunction(Function &F);
373 /// Return true IFF AnalysisID AID is currently available.
374 /// TODO : Replace this method with getAnalysisPass()
375 Pass *getAnalysisPassFromManager(AnalysisID AID);
377 /// doInitialization - Run all of the initializers for the function passes.
379 bool doInitialization(Module &M);
381 /// doFinalization - Run all of the initializers for the function passes.
383 bool doFinalization(Module &M);
385 /// Pass Manager itself does not invalidate any analysis info.
386 void getAnalysisUsage(AnalysisUsage &Info) const {
387 Info.setPreservesAll();
391 // Active Pass Managers
392 BasicBlockPassManager_New *activeBBPassManager;
395 /// ModulePassManager_New manages ModulePasses and function pass managers.
396 /// It batches all Module passes passes and function pass managers together and
397 /// sequence them to process one module.
398 class ModulePassManager_New : public Pass,
399 public PMDataManager {
402 ModulePassManager_New(int D) : PMDataManager(D) {
403 activeFunctionPassManager = NULL;
406 /// Add a pass into a passmanager queue.
407 bool addPass(Pass *p);
409 /// run - Execute all of the passes scheduled for execution. Keep track of
410 /// whether any of the passes modifies the module, and if so, return true.
411 bool runOnModule(Module &M);
413 /// Return true IFF AnalysisID AID is currently available.
414 /// TODO : Replace this method with getAnalysisPass()
415 Pass *getAnalysisPassFromManager(AnalysisID AID);
417 /// Pass Manager itself does not invalidate any analysis info.
418 void getAnalysisUsage(AnalysisUsage &Info) const {
419 Info.setPreservesAll();
423 // Active Pass Manager
424 FunctionPassManagerImpl_New *activeFunctionPassManager;
427 /// PassManager_New manages ModulePassManagers
428 class PassManagerImpl_New : public Pass,
429 public PMDataManager,
430 public PMTopLevelManager {
434 PassManagerImpl_New(int D) : PMDataManager(D) {}
436 /// add - Add a pass to the queue of passes to run. This passes ownership of
437 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
438 /// will be destroyed as well, so there is no need to delete the pass. This
439 /// implies that all passes MUST be allocated with 'new'.
441 schedulePass(P, this);
444 /// run - Execute all of the passes scheduled for execution. Keep track of
445 /// whether any of the passes modifies the module, and if so, return true.
448 /// Return true IFF AnalysisID AID is currently available.
449 /// TODO : Replace this method with getAnalysisPass()
450 Pass *getAnalysisPassFromManager(AnalysisID AID);
452 /// Pass Manager itself does not invalidate any analysis info.
453 void getAnalysisUsage(AnalysisUsage &Info) const {
454 Info.setPreservesAll();
457 inline void addTopLevelPass(Pass *P) {
463 /// Add a pass into a passmanager queue.
464 bool addPass(Pass *p);
466 // Collection of pass managers
467 std::vector<ModulePassManager_New *> PassManagers;
469 // Active Pass Manager
470 ModulePassManager_New *activeManager;
473 } // End of llvm namespace
475 //===----------------------------------------------------------------------===//
476 // PMDataManager implementation
478 /// Return true IFF pass P's required analysis set does not required new
480 bool PMDataManager::manageablePass(Pass *P) {
483 // If this pass is not preserving information that is required by a
484 // pass maintained by higher level pass manager then do not insert
485 // this pass into current manager. Use new manager. For example,
486 // For example, If FunctionPass F is not preserving ModulePass Info M1
487 // that is used by another ModulePass M2 then do not insert F in
488 // current function pass manager.
492 /// Augement AvailableAnalysis by adding analysis made available by pass P.
493 void PMDataManager::recordAvailableAnalysis(Pass *P) {
495 if (const PassInfo *PI = P->getPassInfo()) {
496 AvailableAnalysis[PI] = P;
498 //This pass is the current implementation of all of the interfaces it
499 //implements as well.
500 const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
501 for (unsigned i = 0, e = II.size(); i != e; ++i)
502 AvailableAnalysis[II[i]] = P;
506 /// Remove Analyss not preserved by Pass P
507 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
508 AnalysisUsage AnUsage;
509 P->getAnalysisUsage(AnUsage);
511 if (AnUsage.getPreservesAll())
514 const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
515 for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
516 E = AvailableAnalysis.end(); I != E; ++I ) {
517 if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) ==
518 PreservedSet.end()) {
519 // Remove this analysis
520 std::map<AnalysisID, Pass*>::iterator J = I++;
521 AvailableAnalysis.erase(J);
526 /// Remove analysis passes that are not used any longer
527 void PMDataManager::removeDeadPasses(Pass *P) {
529 std::vector<Pass *> DeadPasses;
530 TPM->collectLastUses(DeadPasses, P);
532 for (std::vector<Pass *>::iterator I = DeadPasses.begin(),
533 E = DeadPasses.end(); I != E; ++I) {
534 (*I)->releaseMemory();
536 std::map<AnalysisID, Pass*>::iterator Pos =
537 AvailableAnalysis.find((*I)->getPassInfo());
539 // It is possible that pass is already removed from the AvailableAnalysis
540 if (Pos != AvailableAnalysis.end())
541 AvailableAnalysis.erase(Pos);
545 /// Add pass P into the PassVector. Update
546 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
547 void PMDataManager::addPassToManager(Pass *P,
548 bool ProcessAnalysis) {
550 if (ProcessAnalysis) {
552 // At the moment, this pass is the last user of all required passes.
553 std::vector<Pass *> LastUses;
554 std::vector<Pass *> RequiredPasses;
555 unsigned PDepth = this->getDepth();
557 collectRequiredAnalysisPasses(RequiredPasses, P);
558 for (std::vector<Pass *>::iterator I = RequiredPasses.begin(),
559 E = RequiredPasses.end(); I != E; ++I) {
560 Pass *PRequired = *I;
562 //FIXME: RDepth = PRequired->getResolver()->getDepth();
563 if (PDepth == RDepth)
564 LastUses.push_back(PRequired);
565 else if (PDepth > RDepth) {
566 // Let the parent claim responsibility of last use
567 ForcedLastUses.push_back(PRequired);
569 // Note : This feature is not yet implemented
571 "Unable to handle Pass that requires lower level Analysis pass");
575 if (!LastUses.empty())
576 TPM->setLastUser(LastUses, P);
578 // Take a note of analysis required and made available by this pass.
579 // Remove the analysis not preserved by this pass
580 initializeAnalysisImpl(P);
581 removeNotPreservedAnalysis(P);
582 recordAvailableAnalysis(P);
586 PassVector.push_back(P);
589 /// Populate RequiredPasses with the analysis pass that are required by
591 void PMDataManager::collectRequiredAnalysisPasses(std::vector<Pass *> &RP,
593 AnalysisUsage AnUsage;
594 P->getAnalysisUsage(AnUsage);
595 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
596 for (std::vector<AnalysisID>::const_iterator
597 I = RequiredSet.begin(), E = RequiredSet.end();
599 Pass *AnalysisPass = NULL; //FIXME findAnalysisPass(*I,true);
600 assert (AnalysisPass && "Analysis pass is not available");
601 RP.push_back(AnalysisPass);
605 // All Required analyses should be available to the pass as it runs! Here
606 // we fill in the AnalysisImpls member of the pass so that it can
607 // successfully use the getAnalysis() method to retrieve the
608 // implementations it needs.
610 void PMDataManager::initializeAnalysisImpl(Pass *P) {
611 AnalysisUsage AnUsage;
612 P->getAnalysisUsage(AnUsage);
614 for (std::vector<const PassInfo *>::const_iterator
615 I = AnUsage.getRequiredSet().begin(),
616 E = AnUsage.getRequiredSet().end(); I != E; ++I) {
617 Pass *Impl = getAnalysisPass(*I);
619 assert(0 && "Analysis used but not available!");
620 // TODO: P->AnalysisImpls.push_back(std::make_pair(*I, Impl));
624 //===----------------------------------------------------------------------===//
625 // BasicBlockPassManager_New implementation
627 /// Add pass P into PassVector and return true. If this pass is not
628 /// manageable by this manager then return false.
630 BasicBlockPassManager_New::addPass(Pass *P) {
632 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
636 // If this pass does not preserve anlysis that is used by other passes
637 // managed by this manager than it is not a suiable pass for this manager.
638 if (!manageablePass(P))
641 addPassToManager (BP);
646 /// Execute all of the passes scheduled for execution by invoking
647 /// runOnBasicBlock method. Keep track of whether any of the passes modifies
648 /// the function, and if so, return true.
650 BasicBlockPassManager_New::runOnFunction(Function &F) {
652 bool Changed = doInitialization(F);
653 initializeAnalysisInfo();
655 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
656 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
657 e = passVectorEnd(); itr != e; ++itr) {
660 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
661 Changed |= BP->runOnBasicBlock(*I);
662 removeNotPreservedAnalysis(P);
663 recordAvailableAnalysis(P);
666 return Changed | doFinalization(F);
669 /// Return true IFF AnalysisID AID is currently available.
670 /// TODO : Replace this method with getAnalysisPass()
671 Pass * BasicBlockPassManager_New::getAnalysisPassFromManager(AnalysisID AID) {
672 return getAnalysisPass(AID);
675 // Implement doInitialization and doFinalization
676 inline bool BasicBlockPassManager_New::doInitialization(Module &M) {
677 bool Changed = false;
679 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
680 e = passVectorEnd(); itr != e; ++itr) {
682 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
683 Changed |= BP->doInitialization(M);
689 inline bool BasicBlockPassManager_New::doFinalization(Module &M) {
690 bool Changed = false;
692 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
693 e = passVectorEnd(); itr != e; ++itr) {
695 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
696 Changed |= BP->doFinalization(M);
702 inline bool BasicBlockPassManager_New::doInitialization(Function &F) {
703 bool Changed = false;
705 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
706 e = passVectorEnd(); itr != e; ++itr) {
708 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
709 Changed |= BP->doInitialization(F);
715 inline bool BasicBlockPassManager_New::doFinalization(Function &F) {
716 bool Changed = false;
718 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
719 e = passVectorEnd(); itr != e; ++itr) {
721 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
722 Changed |= BP->doFinalization(F);
729 //===----------------------------------------------------------------------===//
730 // FunctionPassManager_New implementation
732 /// Create new Function pass manager
733 FunctionPassManager_New::FunctionPassManager_New() {
734 FPM = new FunctionPassManagerImpl_New(0);
737 /// add - Add a pass to the queue of passes to run. This passes
738 /// ownership of the Pass to the PassManager. When the
739 /// PassManager_X is destroyed, the pass will be destroyed as well, so
740 /// there is no need to delete the pass. (TODO delete passes.)
741 /// This implies that all passes MUST be allocated with 'new'.
742 void FunctionPassManager_New::add(Pass *P) {
746 /// Execute all of the passes scheduled for execution. Keep
747 /// track of whether any of the passes modifies the function, and if
749 bool FunctionPassManager_New::runOnModule(Module &M) {
750 return FPM->runOnModule(M);
753 /// run - Execute all of the passes scheduled for execution. Keep
754 /// track of whether any of the passes modifies the function, and if
757 bool FunctionPassManager_New::run(Function &F) {
759 if (MP->materializeFunction(&F, &errstr)) {
760 cerr << "Error reading bytecode file: " << errstr << "\n";
763 return FPM->runOnFunction(F);
767 /// doInitialization - Run all of the initializers for the function passes.
769 bool FunctionPassManager_New::doInitialization() {
770 return FPM->doInitialization(*MP->getModule());
773 /// doFinalization - Run all of the initializers for the function passes.
775 bool FunctionPassManager_New::doFinalization() {
776 return FPM->doFinalization(*MP->getModule());
779 //===----------------------------------------------------------------------===//
780 // FunctionPassManagerImpl_New implementation
782 /// Add pass P into the pass manager queue. If P is a BasicBlockPass then
783 /// either use it into active basic block pass manager or create new basic
784 /// block pass manager to handle pass P.
786 FunctionPassManagerImpl_New::addPass(Pass *P) {
788 // If P is a BasicBlockPass then use BasicBlockPassManager_New.
789 if (BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P)) {
791 if (!activeBBPassManager || !activeBBPassManager->addPass(BP)) {
793 // If active manager exists then clear its analysis info.
794 if (activeBBPassManager)
795 activeBBPassManager->initializeAnalysisInfo();
797 // Create and add new manager
798 activeBBPassManager =
799 new BasicBlockPassManager_New(getDepth() + 1);
800 addPassToManager(activeBBPassManager, false);
802 // Add pass into new manager. This time it must succeed.
803 if (!activeBBPassManager->addPass(BP))
804 assert(0 && "Unable to add Pass");
807 if (!ForcedLastUses.empty())
808 TPM->setLastUser(ForcedLastUses, this);
813 FunctionPass *FP = dynamic_cast<FunctionPass *>(P);
817 // If this pass does not preserve anlysis that is used by other passes
818 // managed by this manager than it is not a suiable pass for this manager.
819 if (!manageablePass(P))
822 addPassToManager (FP);
824 // If active manager exists then clear its analysis info.
825 if (activeBBPassManager) {
826 activeBBPassManager->initializeAnalysisInfo();
827 activeBBPassManager = NULL;
833 /// Execute all of the passes scheduled for execution by invoking
834 /// runOnFunction method. Keep track of whether any of the passes modifies
835 /// the function, and if so, return true.
836 bool FunctionPassManagerImpl_New::runOnModule(Module &M) {
838 bool Changed = false;
839 initializeAnalysisInfo();
841 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
842 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
843 e = passVectorEnd(); itr != e; ++itr) {
846 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
847 Changed |= FP->runOnFunction(*I);
848 removeNotPreservedAnalysis(P);
849 recordAvailableAnalysis(P);
855 /// Execute all of the passes scheduled for execution by invoking
856 /// runOnFunction method. Keep track of whether any of the passes modifies
857 /// the function, and if so, return true.
858 bool FunctionPassManagerImpl_New::runOnFunction(Function &F) {
860 bool Changed = false;
861 initializeAnalysisInfo();
863 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
864 e = passVectorEnd(); itr != e; ++itr) {
867 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
868 Changed |= FP->runOnFunction(F);
869 removeNotPreservedAnalysis(P);
870 recordAvailableAnalysis(P);
877 /// Return true IFF AnalysisID AID is currently available.
878 /// TODO : Replace this method with getAnalysisPass()
879 Pass *FunctionPassManagerImpl_New::getAnalysisPassFromManager(AnalysisID AID) {
881 Pass *P = getAnalysisPass(AID);
885 if (activeBBPassManager &&
886 activeBBPassManager->getAnalysisPass(AID) != 0)
887 return activeBBPassManager->getAnalysisPass(AID);
889 // TODO : Check inactive managers
893 inline bool FunctionPassManagerImpl_New::doInitialization(Module &M) {
894 bool Changed = false;
896 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
897 e = passVectorEnd(); itr != e; ++itr) {
900 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
901 Changed |= FP->doInitialization(M);
907 inline bool FunctionPassManagerImpl_New::doFinalization(Module &M) {
908 bool Changed = false;
910 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
911 e = passVectorEnd(); itr != e; ++itr) {
914 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
915 Changed |= FP->doFinalization(M);
922 //===----------------------------------------------------------------------===//
923 // ModulePassManager implementation
925 /// Add P into pass vector if it is manageble. If P is a FunctionPass
926 /// then use FunctionPassManagerImpl_New to manage it. Return false if P
927 /// is not manageable by this manager.
929 ModulePassManager_New::addPass(Pass *P) {
931 // If P is FunctionPass then use function pass maanager.
932 if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P)) {
934 if (!activeFunctionPassManager
935 || !activeFunctionPassManager->addPass(P)) {
937 // If active manager exists then clear its analysis info.
938 if (activeFunctionPassManager)
939 activeFunctionPassManager->initializeAnalysisInfo();
941 // Create and add new manager
942 activeFunctionPassManager =
943 new FunctionPassManagerImpl_New(getDepth() + 1);
944 addPassToManager(activeFunctionPassManager, false);
946 // Add pass into new manager. This time it must succeed.
947 if (!activeFunctionPassManager->addPass(FP))
948 assert(0 && "Unable to add pass");
951 if (!ForcedLastUses.empty())
952 TPM->setLastUser(ForcedLastUses, this);
957 ModulePass *MP = dynamic_cast<ModulePass *>(P);
961 // If this pass does not preserve anlysis that is used by other passes
962 // managed by this manager than it is not a suiable pass for this manager.
963 if (!manageablePass(P))
966 addPassToManager(MP);
967 // If active manager exists then clear its analysis info.
968 if (activeFunctionPassManager) {
969 activeFunctionPassManager->initializeAnalysisInfo();
970 activeFunctionPassManager = NULL;
977 /// Execute all of the passes scheduled for execution by invoking
978 /// runOnModule method. Keep track of whether any of the passes modifies
979 /// the module, and if so, return true.
981 ModulePassManager_New::runOnModule(Module &M) {
982 bool Changed = false;
983 initializeAnalysisInfo();
985 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
986 e = passVectorEnd(); itr != e; ++itr) {
989 ModulePass *MP = dynamic_cast<ModulePass*>(P);
990 Changed |= MP->runOnModule(M);
991 removeNotPreservedAnalysis(P);
992 recordAvailableAnalysis(P);
998 /// Return true IFF AnalysisID AID is currently available.
999 /// TODO : Replace this method with getAnalysisPass()
1000 Pass *ModulePassManager_New::getAnalysisPassFromManager(AnalysisID AID) {
1002 Pass *P = getAnalysisPass(AID);
1006 if (activeFunctionPassManager &&
1007 activeFunctionPassManager->getAnalysisPass(AID) != 0)
1008 return activeFunctionPassManager->getAnalysisPass(AID);
1010 // TODO : Check inactive managers
1014 //===----------------------------------------------------------------------===//
1015 // PassManagerImpl implementation
1017 /// Return true IFF AnalysisID AID is currently available.
1018 /// TODO : Replace this method with getAnalysisPass()
1019 Pass *PassManagerImpl_New::getAnalysisPassFromManager(AnalysisID AID) {
1022 for (std::vector<ModulePassManager_New *>::iterator itr = PassManagers.begin(),
1023 e = PassManagers.end(); !P && itr != e; ++itr)
1024 P = (*itr)->getAnalysisPassFromManager(AID);
1028 // PassManager_New implementation
1029 /// Add P into active pass manager or use new module pass manager to
1031 bool PassManagerImpl_New::addPass(Pass *P) {
1033 if (!activeManager || !activeManager->addPass(P)) {
1034 activeManager = new ModulePassManager_New(getDepth() + 1);
1035 PassManagers.push_back(activeManager);
1036 return activeManager->addPass(P);
1041 /// run - Execute all of the passes scheduled for execution. Keep track of
1042 /// whether any of the passes modifies the module, and if so, return true.
1043 bool PassManagerImpl_New::run(Module &M) {
1045 bool Changed = false;
1046 for (std::vector<ModulePassManager_New *>::iterator itr = PassManagers.begin(),
1047 e = PassManagers.end(); itr != e; ++itr) {
1048 ModulePassManager_New *pm = *itr;
1049 Changed |= pm->runOnModule(M);
1054 //===----------------------------------------------------------------------===//
1055 // PassManager implementation
1057 /// Create new pass manager
1058 PassManager_New::PassManager_New() {
1059 PM = new PassManagerImpl_New(0);
1062 /// add - Add a pass to the queue of passes to run. This passes ownership of
1063 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
1064 /// will be destroyed as well, so there is no need to delete the pass. This
1065 /// implies that all passes MUST be allocated with 'new'.
1067 PassManager_New::add(Pass *P) {
1071 /// run - Execute all of the passes scheduled for execution. Keep track of
1072 /// whether any of the passes modifies the module, and if so, return true.
1074 PassManager_New::run(Module &M) {