1 //===- PassManager.cpp - LLVM Pass Infrastructure Implementation ----------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Devang Patel and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the LLVM Pass Manager infrastructure.
12 //===----------------------------------------------------------------------===//
15 #include "llvm/PassManager.h"
16 #include "llvm/Support/CommandLine.h"
17 #include "llvm/Module.h"
18 #include "llvm/ModuleProvider.h"
19 #include "llvm/Support/Streams.h"
24 //===----------------------------------------------------------------------===//
26 // The Pass Manager Infrastructure manages passes. It's responsibilities are:
28 // o Manage optimization pass execution order
29 // o Make required Analysis information available before pass P is run
30 // o Release memory occupied by dead passes
31 // o If Analysis information is dirtied by a pass then regenerate Analysis
32 // information before it is consumed by another pass.
34 // Pass Manager Infrastructure uses multipe pass managers. They are PassManager,
35 // FunctionPassManager, ModulePassManager, BasicBlockPassManager. This class
36 // hierarcy uses multiple inheritance but pass managers do not derive from
37 // another pass manager.
39 // PassManager and FunctionPassManager are two top level pass manager that
40 // represents the external interface of this entire pass manager infrastucture.
42 // Important classes :
44 // [o] class PMTopLevelManager;
46 // Two top level managers, PassManager and FunctionPassManager, derive from
47 // PMTopLevelManager. PMTopLevelManager manages information used by top level
48 // managers such as last user info.
50 // [o] class PMDataManager;
52 // PMDataManager manages information, e.g. list of available analysis info,
53 // used by a pass manager to manage execution order of passes. It also provides
54 // a place to implement common pass manager APIs. All pass managers derive from
57 // [o] class BasicBlockPassManager : public FunctionPass, public PMDataManager;
59 // BasicBlockPassManager manages BasicBlockPasses.
61 // [o] class FunctionPassManager;
63 // This is a external interface used by JIT to manage FunctionPasses. This
64 // interface relies on FunctionPassManagerImpl to do all the tasks.
66 // [o] class FunctionPassManagerImpl : public ModulePass, PMDataManager,
67 // public PMTopLevelManager;
69 // FunctionPassManagerImpl is a top level manager. It manages FunctionPasses
70 // and BasicBlockPassManagers.
72 // [o] class ModulePassManager : public Pass, public PMDataManager;
74 // ModulePassManager manages ModulePasses and FunctionPassManagerImpls.
76 // [o] class PassManager;
78 // This is a external interface used by various tools to manages passes. It
79 // relies on PassManagerImpl to do all the tasks.
81 // [o] class PassManagerImpl : public Pass, public PMDataManager,
82 // public PMDTopLevelManager
84 // PassManagerImpl is a top level pass manager responsible for managing
85 // ModulePassManagers.
86 //===----------------------------------------------------------------------===//
90 //===----------------------------------------------------------------------===//
91 // Pass debugging information. Often it is useful to find out what pass is
92 // running when a crash occurs in a utility. When this library is compiled with
93 // debugging on, a command line option (--debug-pass) is enabled that causes the
94 // pass name to be printed before it executes.
97 // Different debug levels that can be enabled...
99 None, Arguments, Structure, Executions, Details
102 static cl::opt<enum PassDebugLevel>
103 PassDebugging_New("debug-pass", cl::Hidden,
104 cl::desc("Print PassManager debugging information"),
106 clEnumVal(None , "disable debug output"),
107 clEnumVal(Arguments , "print pass arguments to pass to 'opt'"),
108 clEnumVal(Structure , "print pass structure before run()"),
109 clEnumVal(Executions, "print pass name before it is executed"),
110 clEnumVal(Details , "print pass details when it is executed"),
112 } // End of llvm namespace
114 #ifndef USE_OLD_PASSMANAGER
119 //===----------------------------------------------------------------------===//
122 /// PMTopLevelManager manages LastUser info and collects common APIs used by
123 /// top level pass managers.
124 class PMTopLevelManager {
128 inline std::vector<Pass *>::iterator passManagersBegin() {
129 return PassManagers.begin();
132 inline std::vector<Pass *>::iterator passManagersEnd() {
133 return PassManagers.end();
136 /// Schedule pass P for execution. Make sure that passes required by
137 /// P are run before P is run. Update analysis info maintained by
138 /// the manager. Remove dead passes. This is a recursive function.
139 void schedulePass(Pass *P);
141 /// This is implemented by top level pass manager and used by
142 /// schedulePass() to add analysis info passes that are not available.
143 virtual void addTopLevelPass(Pass *P) = 0;
145 /// Set pass P as the last user of the given analysis passes.
146 void setLastUser(std::vector<Pass *> &AnalysisPasses, Pass *P);
148 /// Collect passes whose last user is P
149 void collectLastUses(std::vector<Pass *> &LastUses, Pass *P);
151 /// Find the pass that implements Analysis AID. Search immutable
152 /// passes and all pass managers. If desired pass is not found
153 /// then return NULL.
154 Pass *findAnalysisPass(AnalysisID AID);
156 inline void clearManagers() {
157 PassManagers.clear();
160 virtual ~PMTopLevelManager() {
162 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
163 E = PassManagers.end(); I != E; ++I)
166 for (std::vector<ImmutablePass *>::iterator
167 I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
170 PassManagers.clear();
173 /// Add immutable pass and initialize it.
174 inline void addImmutablePass(ImmutablePass *P) {
176 ImmutablePasses.push_back(P);
179 inline std::vector<ImmutablePass *>& getImmutablePasses() {
180 return ImmutablePasses;
183 void addPassManager(Pass *Manager) {
184 PassManagers.push_back(Manager);
187 // Add Manager into the list of managers that are not directly
188 // maintained by this top level pass manager
189 inline void addIndirectPassManager(PMDataManager *Manager) {
190 IndirectPassManagers.push_back(Manager);
193 // Print passes managed by this top level manager.
195 void dumpArguments();
199 /// Collection of pass managers
200 std::vector<Pass *> PassManagers;
202 /// Collection of pass managers that are not directly maintained
203 /// by this pass manager
204 std::vector<PMDataManager *> IndirectPassManagers;
206 // Map to keep track of last user of the analysis pass.
207 // LastUser->second is the last user of Lastuser->first.
208 std::map<Pass *, Pass *> LastUser;
210 /// Immutable passes are managed by top level manager.
211 std::vector<ImmutablePass *> ImmutablePasses;
214 //===----------------------------------------------------------------------===//
217 /// PMDataManager provides the common place to manage the analysis data
218 /// used by pass managers.
219 class PMDataManager {
223 PMDataManager(int D) : TPM(NULL), Depth(D) {
224 initializeAnalysisInfo();
227 virtual ~PMDataManager() {
229 for (std::vector<Pass *>::iterator I = PassVector.begin(),
230 E = PassVector.end(); I != E; ++I)
236 /// Return true IFF pass P's required analysis set does not required new
238 bool manageablePass(Pass *P);
240 /// Augment AvailableAnalysis by adding analysis made available by pass P.
241 void recordAvailableAnalysis(Pass *P);
243 /// Remove Analysis that is not preserved by the pass
244 void removeNotPreservedAnalysis(Pass *P);
246 /// Remove dead passes
247 void removeDeadPasses(Pass *P);
249 /// Add pass P into the PassVector. Update
250 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
251 void addPassToManager (Pass *P, bool ProcessAnalysis = true);
253 /// Initialize available analysis information.
254 void initializeAnalysisInfo() {
255 ForcedLastUses.clear();
256 AvailableAnalysis.clear();
259 /// Populate RequiredPasses with the analysis pass that are required by
261 void collectRequiredAnalysisPasses(std::vector<Pass *> &RequiredPasses,
264 /// All Required analyses should be available to the pass as it runs! Here
265 /// we fill in the AnalysisImpls member of the pass so that it can
266 /// successfully use the getAnalysis() method to retrieve the
267 /// implementations it needs.
268 void initializeAnalysisImpl(Pass *P);
270 /// Find the pass that implements Analysis AID. If desired pass is not found
271 /// then return NULL.
272 Pass *findAnalysisPass(AnalysisID AID, bool Direction);
274 inline std::vector<Pass *>::iterator passVectorBegin() {
275 return PassVector.begin();
278 inline std::vector<Pass *>::iterator passVectorEnd() {
279 return PassVector.end();
282 // Access toplevel manager
283 PMTopLevelManager *getTopLevelManager() { return TPM; }
284 void setTopLevelManager(PMTopLevelManager *T) { TPM = T; }
286 unsigned getDepth() { return Depth; }
288 // Print list of passes that are last used by P.
289 void dumpLastUses(Pass *P, unsigned Offset) {
291 std::vector<Pass *> LUses;
293 assert (TPM && "Top Level Manager is missing");
294 TPM->collectLastUses(LUses, P);
296 for (std::vector<Pass *>::iterator I = LUses.begin(),
297 E = LUses.end(); I != E; ++I) {
298 llvm::cerr << "--" << std::string(Offset*2, ' ');
299 (*I)->dumpPassStructure(0);
303 void dumpPassArguments() {
304 for(std::vector<Pass *>::iterator I = PassVector.begin(),
305 E = PassVector.end(); I != E; ++I) {
306 if (PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I))
307 PMD->dumpPassArguments();
309 if (const PassInfo *PI = (*I)->getPassInfo())
310 if (!PI->isAnalysisGroup())
311 cerr << " -" << PI->getPassArgument();
317 // Collection of pass whose last user asked this manager to claim
318 // last use. If a FunctionPass F is the last user of ModulePass info M
319 // then the F's manager, not F, records itself as a last user of M.
320 std::vector<Pass *> ForcedLastUses;
322 // Top level manager.
323 PMTopLevelManager *TPM;
326 // Set of available Analysis. This information is used while scheduling
327 // pass. If a pass requires an analysis which is not not available then
328 // equired analysis pass is scheduled to run before the pass itself is
330 std::map<AnalysisID, Pass*> AvailableAnalysis;
332 // Collection of pass that are managed by this manager
333 std::vector<Pass *> PassVector;
338 //===----------------------------------------------------------------------===//
339 // BasicBlockPassManager
341 /// BasicBlockPassManager manages BasicBlockPass. It batches all the
342 /// pass together and sequence them to process one basic block before
343 /// processing next basic block.
344 class BasicBlockPassManager : public PMDataManager,
345 public FunctionPass {
348 BasicBlockPassManager(int D) : PMDataManager(D) { }
350 /// Add a pass into a passmanager queue.
351 bool addPass(Pass *p);
353 /// Execute all of the passes scheduled for execution. Keep track of
354 /// whether any of the passes modifies the function, and if so, return true.
355 bool runOnFunction(Function &F);
357 /// Pass Manager itself does not invalidate any analysis info.
358 void getAnalysisUsage(AnalysisUsage &Info) const {
359 Info.setPreservesAll();
362 bool doInitialization(Module &M);
363 bool doInitialization(Function &F);
364 bool doFinalization(Module &M);
365 bool doFinalization(Function &F);
367 // Print passes managed by this manager
368 void dumpPassStructure(unsigned Offset) {
369 llvm::cerr << std::string(Offset*2, ' ') << "BasicBLockPass Manager\n";
370 for (std::vector<Pass *>::iterator I = passVectorBegin(),
371 E = passVectorEnd(); I != E; ++I) {
372 (*I)->dumpPassStructure(Offset + 1);
373 dumpLastUses(*I, Offset+1);
378 //===----------------------------------------------------------------------===//
379 // FunctionPassManagerImpl_New
381 /// FunctionPassManagerImpl_New manages FunctionPasses and
382 /// BasicBlockPassManagers. It batches all function passes and basic block pass
383 /// managers together and sequence them to process one function at a time before
384 /// processing next function.
385 class FunctionPassManagerImpl_New : public ModulePass,
386 public PMDataManager,
387 public PMTopLevelManager {
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();
442 // Print passes managed by this manager
443 void dumpPassStructure(unsigned Offset) {
444 llvm::cerr << std::string(Offset*2, ' ') << "FunctionPass Manager\n";
445 for (std::vector<Pass *>::iterator I = passVectorBegin(),
446 E = passVectorEnd(); I != E; ++I) {
447 (*I)->dumpPassStructure(Offset + 1);
448 dumpLastUses(*I, Offset+1);
453 // Active Pass Managers
454 BasicBlockPassManager *activeBBPassManager;
457 //===----------------------------------------------------------------------===//
460 /// ModulePassManager manages ModulePasses and function pass managers.
461 /// It batches all Module passes passes and function pass managers together and
462 /// sequence them to process one module.
463 class ModulePassManager : public Pass,
464 public PMDataManager {
467 ModulePassManager(int D) : PMDataManager(D) {
468 activeFunctionPassManager = NULL;
471 /// Add a pass into a passmanager queue.
472 bool addPass(Pass *p);
474 /// run - Execute all of the passes scheduled for execution. Keep track of
475 /// whether any of the passes modifies the module, and if so, return true.
476 bool runOnModule(Module &M);
478 /// Pass Manager itself does not invalidate any analysis info.
479 void getAnalysisUsage(AnalysisUsage &Info) const {
480 Info.setPreservesAll();
483 // Print passes managed by this manager
484 void dumpPassStructure(unsigned Offset) {
485 llvm::cerr << std::string(Offset*2, ' ') << "ModulePass Manager\n";
486 for (std::vector<Pass *>::iterator I = passVectorBegin(),
487 E = passVectorEnd(); I != E; ++I) {
488 (*I)->dumpPassStructure(Offset + 1);
489 dumpLastUses(*I, Offset+1);
494 // Active Pass Manager
495 FunctionPassManagerImpl_New *activeFunctionPassManager;
498 //===----------------------------------------------------------------------===//
499 // PassManagerImpl_New
501 /// PassManagerImpl_New manages ModulePassManagers
502 class PassManagerImpl_New : public Pass,
503 public PMDataManager,
504 public PMTopLevelManager {
508 PassManagerImpl_New(int D) : PMDataManager(D) {
509 activeManager = NULL;
512 /// add - Add a pass to the queue of passes to run. This passes ownership of
513 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
514 /// will be destroyed as well, so there is no need to delete the pass. This
515 /// implies that all passes MUST be allocated with 'new'.
520 /// run - Execute all of the passes scheduled for execution. Keep track of
521 /// whether any of the passes modifies the module, and if so, return true.
524 /// Pass Manager itself does not invalidate any analysis info.
525 void getAnalysisUsage(AnalysisUsage &Info) const {
526 Info.setPreservesAll();
529 inline void addTopLevelPass(Pass *P) {
531 if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
533 // P is a immutable pass and it will be managed by this
534 // top level manager. Set up analysis resolver to connect them.
535 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
537 initializeAnalysisImpl(P);
538 addImmutablePass(IP);
539 recordAvailableAnalysis(IP);
547 /// Add a pass into a passmanager queue.
548 bool addPass(Pass *p);
550 // Active Pass Manager
551 ModulePassManager *activeManager;
554 } // End of llvm namespace
556 //===----------------------------------------------------------------------===//
557 // PMTopLevelManager implementation
559 /// Set pass P as the last user of the given analysis passes.
560 void PMTopLevelManager::setLastUser(std::vector<Pass *> &AnalysisPasses,
563 for (std::vector<Pass *>::iterator I = AnalysisPasses.begin(),
564 E = AnalysisPasses.end(); I != E; ++I) {
567 // If AP is the last user of other passes then make P last user of
569 for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
570 LUE = LastUser.end(); LUI != LUE; ++LUI) {
571 if (LUI->second == AP)
572 LastUser[LUI->first] = P;
578 /// Collect passes whose last user is P
579 void PMTopLevelManager::collectLastUses(std::vector<Pass *> &LastUses,
581 for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
582 LUE = LastUser.end(); LUI != LUE; ++LUI)
583 if (LUI->second == P)
584 LastUses.push_back(LUI->first);
587 /// Schedule pass P for execution. Make sure that passes required by
588 /// P are run before P is run. Update analysis info maintained by
589 /// the manager. Remove dead passes. This is a recursive function.
590 void PMTopLevelManager::schedulePass(Pass *P) {
592 // TODO : Allocate function manager for this pass, other wise required set
593 // may be inserted into previous function manager
595 AnalysisUsage AnUsage;
596 P->getAnalysisUsage(AnUsage);
597 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
598 for (std::vector<AnalysisID>::const_iterator I = RequiredSet.begin(),
599 E = RequiredSet.end(); I != E; ++I) {
601 Pass *AnalysisPass = findAnalysisPass(*I);
603 // Schedule this analysis run first.
604 AnalysisPass = (*I)->createPass();
605 schedulePass(AnalysisPass);
609 // Now all required passes are available.
613 /// Find the pass that implements Analysis AID. Search immutable
614 /// passes and all pass managers. If desired pass is not found
615 /// then return NULL.
616 Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
619 // Check pass managers
620 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
621 E = PassManagers.end(); P == NULL && I != E; ++I) {
622 PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
623 assert(PMD && "This is not a PassManager");
624 P = PMD->findAnalysisPass(AID, false);
627 // Check other pass managers
628 for (std::vector<PMDataManager *>::iterator I = IndirectPassManagers.begin(),
629 E = IndirectPassManagers.end(); P == NULL && I != E; ++I)
630 P = (*I)->findAnalysisPass(AID, false);
632 for (std::vector<ImmutablePass *>::iterator I = ImmutablePasses.begin(),
633 E = ImmutablePasses.end(); P == NULL && I != E; ++I) {
634 const PassInfo *PI = (*I)->getPassInfo();
638 // If Pass not found then check the interfaces implemented by Immutable Pass
640 const std::vector<const PassInfo*> &ImmPI =
641 PI->getInterfacesImplemented();
642 for (unsigned Index = 0, End = ImmPI.size();
643 P == NULL && Index != End; ++Index)
644 if (ImmPI[Index] == AID)
652 // Print passes managed by this top level manager.
653 void PMTopLevelManager::dumpPasses() {
655 // Print out the immutable passes
656 for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
657 ImmutablePasses[i]->dumpPassStructure(0);
660 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
661 E = PassManagers.end(); I != E; ++I)
662 (*I)->dumpPassStructure(1);
666 void PMTopLevelManager::dumpArguments() {
668 if (PassDebugging_New < Arguments)
671 cerr << "Pass Arguments: ";
672 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
673 E = PassManagers.end(); I != E; ++I) {
674 PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
675 assert(PMD && "This is not a PassManager");
676 PMD->dumpPassArguments();
681 //===----------------------------------------------------------------------===//
682 // PMDataManager implementation
684 /// Return true IFF pass P's required analysis set does not required new
686 bool PMDataManager::manageablePass(Pass *P) {
689 // If this pass is not preserving information that is required by a
690 // pass maintained by higher level pass manager then do not insert
691 // this pass into current manager. Use new manager. For example,
692 // For example, If FunctionPass F is not preserving ModulePass Info M1
693 // that is used by another ModulePass M2 then do not insert F in
694 // current function pass manager.
698 /// Augement AvailableAnalysis by adding analysis made available by pass P.
699 void PMDataManager::recordAvailableAnalysis(Pass *P) {
701 if (const PassInfo *PI = P->getPassInfo()) {
702 AvailableAnalysis[PI] = P;
704 //This pass is the current implementation of all of the interfaces it
705 //implements as well.
706 const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
707 for (unsigned i = 0, e = II.size(); i != e; ++i)
708 AvailableAnalysis[II[i]] = P;
712 /// Remove Analyss not preserved by Pass P
713 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
714 AnalysisUsage AnUsage;
715 P->getAnalysisUsage(AnUsage);
717 if (AnUsage.getPreservesAll())
720 const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
721 for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
722 E = AvailableAnalysis.end(); I != E; ) {
723 if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) ==
724 PreservedSet.end()) {
725 // Remove this analysis
726 if (!dynamic_cast<ImmutablePass*>(I->second)) {
727 std::map<AnalysisID, Pass*>::iterator J = I++;
728 AvailableAnalysis.erase(J);
736 /// Remove analysis passes that are not used any longer
737 void PMDataManager::removeDeadPasses(Pass *P) {
739 std::vector<Pass *> DeadPasses;
740 TPM->collectLastUses(DeadPasses, P);
742 for (std::vector<Pass *>::iterator I = DeadPasses.begin(),
743 E = DeadPasses.end(); I != E; ++I) {
744 (*I)->releaseMemory();
746 std::map<AnalysisID, Pass*>::iterator Pos =
747 AvailableAnalysis.find((*I)->getPassInfo());
749 // It is possible that pass is already removed from the AvailableAnalysis
750 if (Pos != AvailableAnalysis.end())
751 AvailableAnalysis.erase(Pos);
755 /// Add pass P into the PassVector. Update
756 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
757 void PMDataManager::addPassToManager(Pass *P,
758 bool ProcessAnalysis) {
760 // This manager is going to manage pass P. Set up analysis resolver
762 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
765 if (ProcessAnalysis) {
767 // At the moment, this pass is the last user of all required passes.
768 std::vector<Pass *> LastUses;
769 std::vector<Pass *> RequiredPasses;
770 unsigned PDepth = this->getDepth();
772 collectRequiredAnalysisPasses(RequiredPasses, P);
773 for (std::vector<Pass *>::iterator I = RequiredPasses.begin(),
774 E = RequiredPasses.end(); I != E; ++I) {
775 Pass *PRequired = *I;
778 PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
779 RDepth = DM.getDepth();
781 if (PDepth == RDepth)
782 LastUses.push_back(PRequired);
783 else if (PDepth > RDepth) {
784 // Let the parent claim responsibility of last use
785 ForcedLastUses.push_back(PRequired);
787 // Note : This feature is not yet implemented
789 "Unable to handle Pass that requires lower level Analysis pass");
793 if (!LastUses.empty())
794 TPM->setLastUser(LastUses, P);
796 // Take a note of analysis required and made available by this pass.
797 // Remove the analysis not preserved by this pass
798 removeNotPreservedAnalysis(P);
799 recordAvailableAnalysis(P);
803 PassVector.push_back(P);
806 /// Populate RequiredPasses with the analysis pass that are required by
808 void PMDataManager::collectRequiredAnalysisPasses(std::vector<Pass *> &RP,
810 AnalysisUsage AnUsage;
811 P->getAnalysisUsage(AnUsage);
812 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
813 for (std::vector<AnalysisID>::const_iterator
814 I = RequiredSet.begin(), E = RequiredSet.end();
816 Pass *AnalysisPass = findAnalysisPass(*I, true);
817 assert (AnalysisPass && "Analysis pass is not available");
818 RP.push_back(AnalysisPass);
821 const std::vector<AnalysisID> &IDs = AnUsage.getRequiredTransitiveSet();
822 for (std::vector<AnalysisID>::const_iterator I = IDs.begin(),
823 E = IDs.end(); I != E; ++I) {
824 Pass *AnalysisPass = findAnalysisPass(*I, true);
825 assert (AnalysisPass && "Analysis pass is not available");
826 RP.push_back(AnalysisPass);
830 // All Required analyses should be available to the pass as it runs! Here
831 // we fill in the AnalysisImpls member of the pass so that it can
832 // successfully use the getAnalysis() method to retrieve the
833 // implementations it needs.
835 void PMDataManager::initializeAnalysisImpl(Pass *P) {
836 AnalysisUsage AnUsage;
837 P->getAnalysisUsage(AnUsage);
839 for (std::vector<const PassInfo *>::const_iterator
840 I = AnUsage.getRequiredSet().begin(),
841 E = AnUsage.getRequiredSet().end(); I != E; ++I) {
842 Pass *Impl = findAnalysisPass(*I, true);
844 assert(0 && "Analysis used but not available!");
845 AnalysisResolver_New *AR = P->getResolver();
846 AR->addAnalysisImplsPair(*I, Impl);
850 /// Find the pass that implements Analysis AID. If desired pass is not found
851 /// then return NULL.
852 Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
854 // Check if AvailableAnalysis map has one entry.
855 std::map<AnalysisID, Pass*>::const_iterator I = AvailableAnalysis.find(AID);
857 if (I != AvailableAnalysis.end())
860 // Search Parents through TopLevelManager
862 return TPM->findAnalysisPass(AID);
868 //===----------------------------------------------------------------------===//
869 // NOTE: Is this the right place to define this method ?
870 // getAnalysisToUpdate - Return an analysis result or null if it doesn't exist
871 Pass *AnalysisResolver_New::getAnalysisToUpdate(AnalysisID ID, bool dir) const {
872 return PM.findAnalysisPass(ID, dir);
875 //===----------------------------------------------------------------------===//
876 // BasicBlockPassManager implementation
878 /// Add pass P into PassVector and return true. If this pass is not
879 /// manageable by this manager then return false.
881 BasicBlockPassManager::addPass(Pass *P) {
883 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
887 // If this pass does not preserve anlysis that is used by other passes
888 // managed by this manager than it is not a suiable pass for this manager.
889 if (!manageablePass(P))
892 addPassToManager (BP);
897 /// Execute all of the passes scheduled for execution by invoking
898 /// runOnBasicBlock method. Keep track of whether any of the passes modifies
899 /// the function, and if so, return true.
901 BasicBlockPassManager::runOnFunction(Function &F) {
906 bool Changed = doInitialization(F);
907 initializeAnalysisInfo();
909 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
910 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
911 e = passVectorEnd(); itr != e; ++itr) {
913 initializeAnalysisImpl(P);
914 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
915 Changed |= BP->runOnBasicBlock(*I);
916 removeNotPreservedAnalysis(P);
917 recordAvailableAnalysis(P);
920 return Changed | doFinalization(F);
923 // Implement doInitialization and doFinalization
924 inline bool BasicBlockPassManager::doInitialization(Module &M) {
925 bool Changed = false;
927 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
928 e = passVectorEnd(); itr != e; ++itr) {
930 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
931 Changed |= BP->doInitialization(M);
937 inline bool BasicBlockPassManager::doFinalization(Module &M) {
938 bool Changed = false;
940 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
941 e = passVectorEnd(); itr != e; ++itr) {
943 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
944 Changed |= BP->doFinalization(M);
950 inline bool BasicBlockPassManager::doInitialization(Function &F) {
951 bool Changed = false;
953 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
954 e = passVectorEnd(); itr != e; ++itr) {
956 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
957 Changed |= BP->doInitialization(F);
963 inline bool BasicBlockPassManager::doFinalization(Function &F) {
964 bool Changed = false;
966 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
967 e = passVectorEnd(); itr != e; ++itr) {
969 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
970 Changed |= BP->doFinalization(F);
977 //===----------------------------------------------------------------------===//
978 // FunctionPassManager implementation
980 /// Create new Function pass manager
981 FunctionPassManager::FunctionPassManager(ModuleProvider *P) {
982 FPM = new FunctionPassManagerImpl_New(0);
983 // FPM is the top level manager.
984 FPM->setTopLevelManager(FPM);
986 PMDataManager *PMD = dynamic_cast<PMDataManager *>(FPM);
987 AnalysisResolver_New *AR = new AnalysisResolver_New(*PMD);
988 FPM->setResolver(AR);
990 FPM->addPassManager(FPM);
994 FunctionPassManager::~FunctionPassManager() {
995 // Note : FPM maintains one entry in PassManagers vector.
996 // This one entry is FPM itself. This is not ideal. One
997 // alternative is have one additional layer between
998 // FunctionPassManager and FunctionPassManagerImpl.
999 // Meanwhile, to avoid going into infinte loop, first
1000 // remove FPM from its PassMangers vector.
1001 FPM->clearManagers();
1005 /// add - Add a pass to the queue of passes to run. This passes
1006 /// ownership of the Pass to the PassManager. When the
1007 /// PassManager_X is destroyed, the pass will be destroyed as well, so
1008 /// there is no need to delete the pass. (TODO delete passes.)
1009 /// This implies that all passes MUST be allocated with 'new'.
1010 void FunctionPassManager::add(Pass *P) {
1014 /// run - Execute all of the passes scheduled for execution. Keep
1015 /// track of whether any of the passes modifies the function, and if
1016 /// so, return true.
1018 bool FunctionPassManager::run(Function &F) {
1020 if (MP->materializeFunction(&F, &errstr)) {
1021 cerr << "Error reading bytecode file: " << errstr << "\n";
1028 /// doInitialization - Run all of the initializers for the function passes.
1030 bool FunctionPassManager::doInitialization() {
1031 return FPM->doInitialization(*MP->getModule());
1034 /// doFinalization - Run all of the initializers for the function passes.
1036 bool FunctionPassManager::doFinalization() {
1037 return FPM->doFinalization(*MP->getModule());
1040 //===----------------------------------------------------------------------===//
1041 // FunctionPassManagerImpl_New implementation
1043 /// Add pass P into the pass manager queue. If P is a BasicBlockPass then
1044 /// either use it into active basic block pass manager or create new basic
1045 /// block pass manager to handle pass P.
1047 FunctionPassManagerImpl_New::addPass(Pass *P) {
1049 // If P is a BasicBlockPass then use BasicBlockPassManager.
1050 if (BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P)) {
1052 if (!activeBBPassManager || !activeBBPassManager->addPass(BP)) {
1054 // If active manager exists then clear its analysis info.
1055 if (activeBBPassManager)
1056 activeBBPassManager->initializeAnalysisInfo();
1058 // Create and add new manager
1059 activeBBPassManager =
1060 new BasicBlockPassManager(getDepth() + 1);
1061 // Inherit top level manager
1062 activeBBPassManager->setTopLevelManager(this->getTopLevelManager());
1064 // Add new manager into current manager's list.
1065 addPassToManager(activeBBPassManager, false);
1067 // Add new manager into top level manager's indirect passes list
1068 PMDataManager *PMD = dynamic_cast<PMDataManager *>(activeBBPassManager);
1069 assert (PMD && "Manager is not Pass Manager");
1070 TPM->addIndirectPassManager(PMD);
1072 // Add pass into new manager. This time it must succeed.
1073 if (!activeBBPassManager->addPass(BP))
1074 assert(0 && "Unable to add Pass");
1077 if (!ForcedLastUses.empty())
1078 TPM->setLastUser(ForcedLastUses, this);
1083 FunctionPass *FP = dynamic_cast<FunctionPass *>(P);
1087 // If this pass does not preserve anlysis that is used by other passes
1088 // managed by this manager than it is not a suiable pass for this manager.
1089 if (!manageablePass(P))
1092 addPassToManager (FP);
1094 // If active manager exists then clear its analysis info.
1095 if (activeBBPassManager) {
1096 activeBBPassManager->initializeAnalysisInfo();
1097 activeBBPassManager = NULL;
1103 /// Execute all of the passes scheduled for execution by invoking
1104 /// runOnFunction method. Keep track of whether any of the passes modifies
1105 /// the function, and if so, return true.
1106 bool FunctionPassManagerImpl_New::runOnModule(Module &M) {
1108 bool Changed = doInitialization(M);
1109 initializeAnalysisInfo();
1111 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1112 this->runOnFunction(*I);
1114 return Changed | doFinalization(M);
1117 /// Execute all of the passes scheduled for execution by invoking
1118 /// runOnFunction method. Keep track of whether any of the passes modifies
1119 /// the function, and if so, return true.
1120 bool FunctionPassManagerImpl_New::runOnFunction(Function &F) {
1122 bool Changed = false;
1127 initializeAnalysisInfo();
1129 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1130 e = passVectorEnd(); itr != e; ++itr) {
1132 initializeAnalysisImpl(P);
1133 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
1134 Changed |= FP->runOnFunction(F);
1135 removeNotPreservedAnalysis(P);
1136 recordAvailableAnalysis(P);
1137 removeDeadPasses(P);
1143 inline bool FunctionPassManagerImpl_New::doInitialization(Module &M) {
1144 bool Changed = false;
1146 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1147 e = passVectorEnd(); itr != e; ++itr) {
1150 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
1151 Changed |= FP->doInitialization(M);
1157 inline bool FunctionPassManagerImpl_New::doFinalization(Module &M) {
1158 bool Changed = false;
1160 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1161 e = passVectorEnd(); itr != e; ++itr) {
1164 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
1165 Changed |= FP->doFinalization(M);
1171 // Execute all the passes managed by this top level manager.
1172 // Return true if any function is modified by a pass.
1173 bool FunctionPassManagerImpl_New::run(Function &F) {
1175 bool Changed = false;
1176 for (std::vector<Pass *>::iterator I = passManagersBegin(),
1177 E = passManagersEnd(); I != E; ++I) {
1178 FunctionPassManagerImpl_New *FP =
1179 dynamic_cast<FunctionPassManagerImpl_New *>(*I);
1180 Changed |= FP->runOnFunction(F);
1185 //===----------------------------------------------------------------------===//
1186 // ModulePassManager implementation
1188 /// Add P into pass vector if it is manageble. If P is a FunctionPass
1189 /// then use FunctionPassManagerImpl_New to manage it. Return false if P
1190 /// is not manageable by this manager.
1192 ModulePassManager::addPass(Pass *P) {
1194 // If P is FunctionPass then use function pass maanager.
1195 if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P)) {
1197 if (!activeFunctionPassManager || !activeFunctionPassManager->addPass(P)) {
1199 // If active manager exists then clear its analysis info.
1200 if (activeFunctionPassManager)
1201 activeFunctionPassManager->initializeAnalysisInfo();
1203 // Create and add new manager
1204 activeFunctionPassManager =
1205 new FunctionPassManagerImpl_New(getDepth() + 1);
1207 // Add new manager into current manager's list
1208 addPassToManager(activeFunctionPassManager, false);
1210 // Inherit top level manager
1211 activeFunctionPassManager->setTopLevelManager(this->getTopLevelManager());
1213 // Add new manager into top level manager's indirect passes list
1214 PMDataManager *PMD =
1215 dynamic_cast<PMDataManager *>(activeFunctionPassManager);
1216 assert(PMD && "Manager is not Pass Manager");
1217 TPM->addIndirectPassManager(PMD);
1219 // Add pass into new manager. This time it must succeed.
1220 if (!activeFunctionPassManager->addPass(FP))
1221 assert(0 && "Unable to add pass");
1224 if (!ForcedLastUses.empty())
1225 TPM->setLastUser(ForcedLastUses, this);
1230 ModulePass *MP = dynamic_cast<ModulePass *>(P);
1234 // If this pass does not preserve anlysis that is used by other passes
1235 // managed by this manager than it is not a suiable pass for this manager.
1236 if (!manageablePass(P))
1239 addPassToManager(MP);
1240 // If active manager exists then clear its analysis info.
1241 if (activeFunctionPassManager) {
1242 activeFunctionPassManager->initializeAnalysisInfo();
1243 activeFunctionPassManager = NULL;
1250 /// Execute all of the passes scheduled for execution by invoking
1251 /// runOnModule method. Keep track of whether any of the passes modifies
1252 /// the module, and if so, return true.
1254 ModulePassManager::runOnModule(Module &M) {
1255 bool Changed = false;
1256 initializeAnalysisInfo();
1258 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1259 e = passVectorEnd(); itr != e; ++itr) {
1261 initializeAnalysisImpl(P);
1262 ModulePass *MP = dynamic_cast<ModulePass*>(P);
1263 Changed |= MP->runOnModule(M);
1264 removeNotPreservedAnalysis(P);
1265 recordAvailableAnalysis(P);
1266 removeDeadPasses(P);
1271 //===----------------------------------------------------------------------===//
1272 // PassManagerImpl implementation
1274 /// Add P into active pass manager or use new module pass manager to
1276 bool PassManagerImpl_New::addPass(Pass *P) {
1278 if (!activeManager || !activeManager->addPass(P)) {
1279 activeManager = new ModulePassManager(getDepth() + 1);
1280 // Inherit top level manager
1281 activeManager->setTopLevelManager(this->getTopLevelManager());
1283 // This top level manager is going to manage activeManager.
1284 // Set up analysis resolver to connect them.
1285 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
1286 activeManager->setResolver(AR);
1288 addPassManager(activeManager);
1289 return activeManager->addPass(P);
1294 /// run - Execute all of the passes scheduled for execution. Keep track of
1295 /// whether any of the passes modifies the module, and if so, return true.
1296 bool PassManagerImpl_New::run(Module &M) {
1298 bool Changed = false;
1301 if (PassDebugging_New >= Structure)
1304 for (std::vector<Pass *>::iterator I = passManagersBegin(),
1305 E = passManagersEnd(); I != E; ++I) {
1306 ModulePassManager *MP = dynamic_cast<ModulePassManager *>(*I);
1307 Changed |= MP->runOnModule(M);
1312 //===----------------------------------------------------------------------===//
1313 // PassManager implementation
1315 /// Create new pass manager
1316 PassManager::PassManager() {
1317 PM = new PassManagerImpl_New(0);
1318 // PM is the top level manager
1319 PM->setTopLevelManager(PM);
1322 PassManager::~PassManager() {
1326 /// add - Add a pass to the queue of passes to run. This passes ownership of
1327 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
1328 /// will be destroyed as well, so there is no need to delete the pass. This
1329 /// implies that all passes MUST be allocated with 'new'.
1331 PassManager::add(Pass *P) {
1335 /// run - Execute all of the passes scheduled for execution. Keep track of
1336 /// whether any of the passes modifies the module, and if so, return true.
1338 PassManager::run(Module &M) {