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 = NULL; // FIXME: (*I)->findAnalysisPass(AID, false /* Search downward */);
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 = NULL; // FIXME: (*I)->findAnalysisPass(AID, false /* Search downward */);
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 // TODO : Make it a reference.
337 PMTopLevelManager *TPM;
340 // Set of available Analysis. This information is used while scheduling
341 // pass. If a pass requires an analysis which is not not available then
342 // equired analysis pass is scheduled to run before the pass itself is
344 std::map<AnalysisID, Pass*> AvailableAnalysis;
346 // Collection of pass that are managed by this manager
347 std::vector<Pass *> PassVector;
352 /// BasicBlockPassManager_New manages BasicBlockPass. It batches all the
353 /// pass together and sequence them to process one basic block before
354 /// processing next basic block.
355 class BasicBlockPassManager_New : public PMDataManager,
356 public FunctionPass {
359 BasicBlockPassManager_New(int D) : PMDataManager(D) { }
361 /// Add a pass into a passmanager queue.
362 bool addPass(Pass *p);
364 /// Execute all of the passes scheduled for execution. Keep track of
365 /// whether any of the passes modifies the function, and if so, return true.
366 bool runOnFunction(Function &F);
368 /// Pass Manager itself does not invalidate any analysis info.
369 void getAnalysisUsage(AnalysisUsage &Info) const {
370 Info.setPreservesAll();
373 bool doInitialization(Module &M);
374 bool doInitialization(Function &F);
375 bool doFinalization(Module &M);
376 bool doFinalization(Function &F);
380 /// FunctionPassManagerImpl_New manages FunctionPasses and BasicBlockPassManagers.
381 /// It batches all function passes and basic block pass managers together and
382 /// sequence them to process one function at a time before processing next
384 class FunctionPassManagerImpl_New : public ModulePass,
385 public PMDataManager,
386 public PMTopLevelManager {
388 FunctionPassManagerImpl_New(ModuleProvider *P, int D) :
389 PMDataManager(D) { /* TODO */ }
390 FunctionPassManagerImpl_New(int D) : PMDataManager(D) {
391 activeBBPassManager = NULL;
393 ~FunctionPassManagerImpl_New() { /* TODO */ };
395 inline void addTopLevelPass(Pass *P) {
397 if (dynamic_cast<ImmutablePass *> (P)) {
399 // P is a immutable pass then it will be managed by this
400 // top level manager. Set up analysis resolver to connect them.
401 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
408 /// add - Add a pass to the queue of passes to run. This passes
409 /// ownership of the Pass to the PassManager. When the
410 /// PassManager_X is destroyed, the pass will be destroyed as well, so
411 /// there is no need to delete the pass. (TODO delete passes.)
412 /// This implies that all passes MUST be allocated with 'new'.
417 /// Add pass into the pass manager queue.
418 bool addPass(Pass *P);
420 /// Execute all of the passes scheduled for execution. Keep
421 /// track of whether any of the passes modifies the function, and if
423 bool runOnModule(Module &M);
424 bool runOnFunction(Function &F);
425 bool run(Function &F);
427 /// doInitialization - Run all of the initializers for the function passes.
429 bool doInitialization(Module &M);
431 /// doFinalization - Run all of the initializers for the function passes.
433 bool doFinalization(Module &M);
435 /// Pass Manager itself does not invalidate any analysis info.
436 void getAnalysisUsage(AnalysisUsage &Info) const {
437 Info.setPreservesAll();
441 // Active Pass Managers
442 BasicBlockPassManager_New *activeBBPassManager;
445 /// ModulePassManager_New manages ModulePasses and function pass managers.
446 /// It batches all Module passes passes and function pass managers together and
447 /// sequence them to process one module.
448 class ModulePassManager_New : public Pass,
449 public PMDataManager {
452 ModulePassManager_New(int D) : PMDataManager(D) {
453 activeFunctionPassManager = NULL;
456 /// Add a pass into a passmanager queue.
457 bool addPass(Pass *p);
459 /// run - Execute all of the passes scheduled for execution. Keep track of
460 /// whether any of the passes modifies the module, and if so, return true.
461 bool runOnModule(Module &M);
463 /// Pass Manager itself does not invalidate any analysis info.
464 void getAnalysisUsage(AnalysisUsage &Info) const {
465 Info.setPreservesAll();
469 // Active Pass Manager
470 FunctionPassManagerImpl_New *activeFunctionPassManager;
473 /// PassManager_New manages ModulePassManagers
474 class PassManagerImpl_New : public Pass,
475 public PMDataManager,
476 public PMTopLevelManager {
480 PassManagerImpl_New(int D) : PMDataManager(D) {}
482 /// add - Add a pass to the queue of passes to run. This passes ownership of
483 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
484 /// will be destroyed as well, so there is no need to delete the pass. This
485 /// implies that all passes MUST be allocated with 'new'.
490 /// run - Execute all of the passes scheduled for execution. Keep track of
491 /// whether any of the passes modifies the module, and if so, return true.
494 /// Pass Manager itself does not invalidate any analysis info.
495 void getAnalysisUsage(AnalysisUsage &Info) const {
496 Info.setPreservesAll();
499 inline void addTopLevelPass(Pass *P) {
501 if (dynamic_cast<ImmutablePass *> (P)) {
503 // P is a immutable pass and it will be managed by this
504 // top level manager. Set up analysis resolver to connect them.
505 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
514 /// Add a pass into a passmanager queue.
515 bool addPass(Pass *p);
517 // Active Pass Manager
518 ModulePassManager_New *activeManager;
521 } // End of llvm namespace
523 //===----------------------------------------------------------------------===//
524 // PMDataManager implementation
526 /// Return true IFF pass P's required analysis set does not required new
528 bool PMDataManager::manageablePass(Pass *P) {
531 // If this pass is not preserving information that is required by a
532 // pass maintained by higher level pass manager then do not insert
533 // this pass into current manager. Use new manager. For example,
534 // For example, If FunctionPass F is not preserving ModulePass Info M1
535 // that is used by another ModulePass M2 then do not insert F in
536 // current function pass manager.
540 /// Augement AvailableAnalysis by adding analysis made available by pass P.
541 void PMDataManager::recordAvailableAnalysis(Pass *P) {
543 if (const PassInfo *PI = P->getPassInfo()) {
544 AvailableAnalysis[PI] = P;
546 //This pass is the current implementation of all of the interfaces it
547 //implements as well.
548 const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
549 for (unsigned i = 0, e = II.size(); i != e; ++i)
550 AvailableAnalysis[II[i]] = P;
554 /// Remove Analyss not preserved by Pass P
555 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
556 AnalysisUsage AnUsage;
557 P->getAnalysisUsage(AnUsage);
559 if (AnUsage.getPreservesAll())
562 const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
563 for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
564 E = AvailableAnalysis.end(); I != E; ++I ) {
565 if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) ==
566 PreservedSet.end()) {
567 // Remove this analysis
568 std::map<AnalysisID, Pass*>::iterator J = I++;
569 AvailableAnalysis.erase(J);
574 /// Remove analysis passes that are not used any longer
575 void PMDataManager::removeDeadPasses(Pass *P) {
577 std::vector<Pass *> DeadPasses;
578 TPM->collectLastUses(DeadPasses, P);
580 for (std::vector<Pass *>::iterator I = DeadPasses.begin(),
581 E = DeadPasses.end(); I != E; ++I) {
582 (*I)->releaseMemory();
584 std::map<AnalysisID, Pass*>::iterator Pos =
585 AvailableAnalysis.find((*I)->getPassInfo());
587 // It is possible that pass is already removed from the AvailableAnalysis
588 if (Pos != AvailableAnalysis.end())
589 AvailableAnalysis.erase(Pos);
593 /// Add pass P into the PassVector. Update
594 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
595 void PMDataManager::addPassToManager(Pass *P,
596 bool ProcessAnalysis) {
598 // This manager is going to manage pass P. Set up analysis resolver
600 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
603 if (ProcessAnalysis) {
605 // At the moment, this pass is the last user of all required passes.
606 std::vector<Pass *> LastUses;
607 std::vector<Pass *> RequiredPasses;
608 unsigned PDepth = this->getDepth();
610 collectRequiredAnalysisPasses(RequiredPasses, P);
611 for (std::vector<Pass *>::iterator I = RequiredPasses.begin(),
612 E = RequiredPasses.end(); I != E; ++I) {
613 Pass *PRequired = *I;
615 //FIXME: RDepth = PRequired->getResolver()->getDepth();
616 if (PDepth == RDepth)
617 LastUses.push_back(PRequired);
618 else if (PDepth > RDepth) {
619 // Let the parent claim responsibility of last use
620 ForcedLastUses.push_back(PRequired);
622 // Note : This feature is not yet implemented
624 "Unable to handle Pass that requires lower level Analysis pass");
628 if (!LastUses.empty())
629 TPM->setLastUser(LastUses, P);
631 // Take a note of analysis required and made available by this pass.
632 // Remove the analysis not preserved by this pass
633 initializeAnalysisImpl(P);
634 removeNotPreservedAnalysis(P);
635 recordAvailableAnalysis(P);
639 PassVector.push_back(P);
642 /// Populate RequiredPasses with the analysis pass that are required by
644 void PMDataManager::collectRequiredAnalysisPasses(std::vector<Pass *> &RP,
646 AnalysisUsage AnUsage;
647 P->getAnalysisUsage(AnUsage);
648 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
649 for (std::vector<AnalysisID>::const_iterator
650 I = RequiredSet.begin(), E = RequiredSet.end();
652 Pass *AnalysisPass = findAnalysisPass(*I, true);
653 assert (AnalysisPass && "Analysis pass is not available");
654 RP.push_back(AnalysisPass);
658 // All Required analyses should be available to the pass as it runs! Here
659 // we fill in the AnalysisImpls member of the pass so that it can
660 // successfully use the getAnalysis() method to retrieve the
661 // implementations it needs.
663 void PMDataManager::initializeAnalysisImpl(Pass *P) {
664 AnalysisUsage AnUsage;
665 P->getAnalysisUsage(AnUsage);
667 for (std::vector<const PassInfo *>::const_iterator
668 I = AnUsage.getRequiredSet().begin(),
669 E = AnUsage.getRequiredSet().end(); I != E; ++I) {
670 Pass *Impl = findAnalysisPass(*I, true);
672 assert(0 && "Analysis used but not available!");
673 // TODO: P->AnalysisImpls.push_back(std::make_pair(*I, Impl));
677 /// Find the pass that implements Analysis AID. If desired pass is not found
678 /// then return NULL.
679 Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
681 // Check if AvailableAnalysis map has one entry.
682 std::map<AnalysisID, Pass*>::const_iterator I = AvailableAnalysis.find(AID);
684 if (I != AvailableAnalysis.end())
687 // Search Parents through TopLevelManager
689 return TPM->findAnalysisPass(AID);
691 // FIXME : This is expensive and requires. Need to check only managers not all passes.
692 // One solution is to collect managers in advance at TPM level.
694 for(std::vector<Pass *>::iterator I = passVectorBegin(),
695 E = passVectorEnd(); P == NULL && I!= E; ++I )
696 P = NULL; // FIXME : P = (*I)->getResolver()->getAnalysisToUpdate(AID, false /* Do not search parents again */);
702 //===----------------------------------------------------------------------===//
703 // NOTE: Is this the right place to define this method ?
704 // getAnalysisToUpdate - Return an analysis result or null if it doesn't exist
705 Pass *AnalysisResolver_New::getAnalysisToUpdate(AnalysisID ID, bool dir) const {
706 return PM.findAnalysisPass(ID, dir);
709 //===----------------------------------------------------------------------===//
710 // BasicBlockPassManager_New implementation
712 /// Add pass P into PassVector and return true. If this pass is not
713 /// manageable by this manager then return false.
715 BasicBlockPassManager_New::addPass(Pass *P) {
717 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
721 // If this pass does not preserve anlysis that is used by other passes
722 // managed by this manager than it is not a suiable pass for this manager.
723 if (!manageablePass(P))
726 addPassToManager (BP);
731 /// Execute all of the passes scheduled for execution by invoking
732 /// runOnBasicBlock method. Keep track of whether any of the passes modifies
733 /// the function, and if so, return true.
735 BasicBlockPassManager_New::runOnFunction(Function &F) {
737 bool Changed = doInitialization(F);
738 initializeAnalysisInfo();
740 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
741 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
742 e = passVectorEnd(); itr != e; ++itr) {
745 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
746 Changed |= BP->runOnBasicBlock(*I);
747 removeNotPreservedAnalysis(P);
748 recordAvailableAnalysis(P);
751 return Changed | doFinalization(F);
754 // Implement doInitialization and doFinalization
755 inline bool BasicBlockPassManager_New::doInitialization(Module &M) {
756 bool Changed = false;
758 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
759 e = passVectorEnd(); itr != e; ++itr) {
761 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
762 Changed |= BP->doInitialization(M);
768 inline bool BasicBlockPassManager_New::doFinalization(Module &M) {
769 bool Changed = false;
771 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
772 e = passVectorEnd(); itr != e; ++itr) {
774 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
775 Changed |= BP->doFinalization(M);
781 inline bool BasicBlockPassManager_New::doInitialization(Function &F) {
782 bool Changed = false;
784 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
785 e = passVectorEnd(); itr != e; ++itr) {
787 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
788 Changed |= BP->doInitialization(F);
794 inline bool BasicBlockPassManager_New::doFinalization(Function &F) {
795 bool Changed = false;
797 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
798 e = passVectorEnd(); itr != e; ++itr) {
800 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
801 Changed |= BP->doFinalization(F);
808 //===----------------------------------------------------------------------===//
809 // FunctionPassManager_New implementation
811 /// Create new Function pass manager
812 FunctionPassManager_New::FunctionPassManager_New() {
813 FPM = new FunctionPassManagerImpl_New(0);
816 FunctionPassManager_New::FunctionPassManager_New(ModuleProvider *P) {
817 FPM = new FunctionPassManagerImpl_New(0);
821 /// add - Add a pass to the queue of passes to run. This passes
822 /// ownership of the Pass to the PassManager. When the
823 /// PassManager_X is destroyed, the pass will be destroyed as well, so
824 /// there is no need to delete the pass. (TODO delete passes.)
825 /// This implies that all passes MUST be allocated with 'new'.
826 void FunctionPassManager_New::add(Pass *P) {
830 /// Execute all of the passes scheduled for execution. Keep
831 /// track of whether any of the passes modifies the function, and if
833 bool FunctionPassManager_New::runOnModule(Module &M) {
834 return FPM->runOnModule(M);
837 /// run - Execute all of the passes scheduled for execution. Keep
838 /// track of whether any of the passes modifies the function, and if
841 bool FunctionPassManager_New::run(Function &F) {
843 if (MP->materializeFunction(&F, &errstr)) {
844 cerr << "Error reading bytecode file: " << errstr << "\n";
851 /// doInitialization - Run all of the initializers for the function passes.
853 bool FunctionPassManager_New::doInitialization() {
854 return FPM->doInitialization(*MP->getModule());
857 /// doFinalization - Run all of the initializers for the function passes.
859 bool FunctionPassManager_New::doFinalization() {
860 return FPM->doFinalization(*MP->getModule());
863 //===----------------------------------------------------------------------===//
864 // FunctionPassManagerImpl_New implementation
866 /// Add pass P into the pass manager queue. If P is a BasicBlockPass then
867 /// either use it into active basic block pass manager or create new basic
868 /// block pass manager to handle pass P.
870 FunctionPassManagerImpl_New::addPass(Pass *P) {
872 // If P is a BasicBlockPass then use BasicBlockPassManager_New.
873 if (BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P)) {
875 if (!activeBBPassManager || !activeBBPassManager->addPass(BP)) {
877 // If active manager exists then clear its analysis info.
878 if (activeBBPassManager)
879 activeBBPassManager->initializeAnalysisInfo();
881 // Create and add new manager
882 activeBBPassManager =
883 new BasicBlockPassManager_New(getDepth() + 1);
884 addPassToManager(activeBBPassManager, false);
885 TPM->addOtherPassManager(activeBBPassManager);
887 // Add pass into new manager. This time it must succeed.
888 if (!activeBBPassManager->addPass(BP))
889 assert(0 && "Unable to add Pass");
892 if (!ForcedLastUses.empty())
893 TPM->setLastUser(ForcedLastUses, this);
898 FunctionPass *FP = dynamic_cast<FunctionPass *>(P);
902 // If this pass does not preserve anlysis that is used by other passes
903 // managed by this manager than it is not a suiable pass for this manager.
904 if (!manageablePass(P))
907 addPassToManager (FP);
909 // If active manager exists then clear its analysis info.
910 if (activeBBPassManager) {
911 activeBBPassManager->initializeAnalysisInfo();
912 activeBBPassManager = NULL;
918 /// Execute all of the passes scheduled for execution by invoking
919 /// runOnFunction method. Keep track of whether any of the passes modifies
920 /// the function, and if so, return true.
921 bool FunctionPassManagerImpl_New::runOnModule(Module &M) {
923 bool Changed = doInitialization(M);
924 initializeAnalysisInfo();
926 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
927 this->runOnFunction(*I);
929 return Changed | doFinalization(M);
932 /// Execute all of the passes scheduled for execution by invoking
933 /// runOnFunction method. Keep track of whether any of the passes modifies
934 /// the function, and if so, return true.
935 bool FunctionPassManagerImpl_New::runOnFunction(Function &F) {
937 bool Changed = false;
938 initializeAnalysisInfo();
940 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
941 e = passVectorEnd(); itr != e; ++itr) {
944 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
945 Changed |= FP->runOnFunction(F);
946 removeNotPreservedAnalysis(P);
947 recordAvailableAnalysis(P);
954 inline bool FunctionPassManagerImpl_New::doInitialization(Module &M) {
955 bool Changed = false;
957 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
958 e = passVectorEnd(); itr != e; ++itr) {
961 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
962 Changed |= FP->doInitialization(M);
968 inline bool FunctionPassManagerImpl_New::doFinalization(Module &M) {
969 bool Changed = false;
971 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
972 e = passVectorEnd(); itr != e; ++itr) {
975 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
976 Changed |= FP->doFinalization(M);
982 // Execute all the passes managed by this top level manager.
983 // Return true if any function is modified by a pass.
984 bool FunctionPassManagerImpl_New::run(Function &F) {
986 bool Changed = false;
987 for (std::vector<Pass *>::iterator I = passManagersBegin(),
988 E = passManagersEnd(); I != E; ++I) {
989 FunctionPass *FP = dynamic_cast<FunctionPass *>(*I);
990 Changed |= FP->runOnFunction(F);
995 //===----------------------------------------------------------------------===//
996 // ModulePassManager implementation
998 /// Add P into pass vector if it is manageble. If P is a FunctionPass
999 /// then use FunctionPassManagerImpl_New to manage it. Return false if P
1000 /// is not manageable by this manager.
1002 ModulePassManager_New::addPass(Pass *P) {
1004 // If P is FunctionPass then use function pass maanager.
1005 if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P)) {
1007 if (!activeFunctionPassManager || !activeFunctionPassManager->addPass(P)) {
1009 // If active manager exists then clear its analysis info.
1010 if (activeFunctionPassManager)
1011 activeFunctionPassManager->initializeAnalysisInfo();
1013 // Create and add new manager
1014 activeFunctionPassManager =
1015 new FunctionPassManagerImpl_New(getDepth() + 1);
1016 addPassToManager(activeFunctionPassManager, false);
1017 TPM->addOtherPassManager(activeFunctionPassManager);
1019 // Add pass into new manager. This time it must succeed.
1020 if (!activeFunctionPassManager->addPass(FP))
1021 assert(0 && "Unable to add pass");
1024 if (!ForcedLastUses.empty())
1025 TPM->setLastUser(ForcedLastUses, this);
1030 ModulePass *MP = dynamic_cast<ModulePass *>(P);
1034 // If this pass does not preserve anlysis that is used by other passes
1035 // managed by this manager than it is not a suiable pass for this manager.
1036 if (!manageablePass(P))
1039 addPassToManager(MP);
1040 // If active manager exists then clear its analysis info.
1041 if (activeFunctionPassManager) {
1042 activeFunctionPassManager->initializeAnalysisInfo();
1043 activeFunctionPassManager = NULL;
1050 /// Execute all of the passes scheduled for execution by invoking
1051 /// runOnModule method. Keep track of whether any of the passes modifies
1052 /// the module, and if so, return true.
1054 ModulePassManager_New::runOnModule(Module &M) {
1055 bool Changed = false;
1056 initializeAnalysisInfo();
1058 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1059 e = passVectorEnd(); itr != e; ++itr) {
1062 ModulePass *MP = dynamic_cast<ModulePass*>(P);
1063 Changed |= MP->runOnModule(M);
1064 removeNotPreservedAnalysis(P);
1065 recordAvailableAnalysis(P);
1066 removeDeadPasses(P);
1071 //===----------------------------------------------------------------------===//
1072 // PassManagerImpl implementation
1074 // PassManager_New implementation
1075 /// Add P into active pass manager or use new module pass manager to
1077 bool PassManagerImpl_New::addPass(Pass *P) {
1079 if (!activeManager || !activeManager->addPass(P)) {
1080 activeManager = new ModulePassManager_New(getDepth() + 1);
1082 // This top level manager is going to manage activeManager.
1083 // Set up analysis resolver to connect them.
1084 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
1085 activeManager->setResolver(AR);
1087 addPassManager(activeManager);
1088 return activeManager->addPass(P);
1093 /// run - Execute all of the passes scheduled for execution. Keep track of
1094 /// whether any of the passes modifies the module, and if so, return true.
1095 bool PassManagerImpl_New::run(Module &M) {
1097 bool Changed = false;
1098 for (std::vector<Pass *>::iterator I = passManagersBegin(),
1099 E = passManagersEnd(); I != E; ++I) {
1100 ModulePassManager_New *MP = dynamic_cast<ModulePassManager_New *>(*I);
1101 Changed |= MP->runOnModule(M);
1106 //===----------------------------------------------------------------------===//
1107 // PassManager implementation
1109 /// Create new pass manager
1110 PassManager_New::PassManager_New() {
1111 PM = new PassManagerImpl_New(0);
1114 /// add - Add a pass to the queue of passes to run. This passes ownership of
1115 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
1116 /// will be destroyed as well, so there is no need to delete the pass. This
1117 /// implies that all passes MUST be allocated with 'new'.
1119 PassManager_New::add(Pass *P) {
1123 /// run - Execute all of the passes scheduled for execution. Keep track of
1124 /// whether any of the passes modifies the module, and if so, return true.
1126 PassManager_New::run(Module &M) {