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/Support/Timer.h"
18 #include "llvm/Module.h"
19 #include "llvm/ModuleProvider.h"
20 #include "llvm/Support/Streams.h"
21 #include "llvm/Support/ManagedStatic.h"
26 //===----------------------------------------------------------------------===//
28 // The Pass Manager Infrastructure manages passes. It's responsibilities are:
30 // o Manage optimization pass execution order
31 // o Make required Analysis information available before pass P is run
32 // o Release memory occupied by dead passes
33 // o If Analysis information is dirtied by a pass then regenerate Analysis
34 // information before it is consumed by another pass.
36 // Pass Manager Infrastructure uses multiple pass managers. They are
37 // PassManager, FunctionPassManager, ModulePassManager, BasicBlockPassManager.
38 // This class hierarcy uses multiple inheritance but pass managers do not derive
39 // from another pass manager.
41 // PassManager and FunctionPassManager are two top-level pass manager that
42 // represents the external interface of this entire pass manager infrastucture.
44 // Important classes :
46 // [o] class PMTopLevelManager;
48 // Two top level managers, PassManager and FunctionPassManager, derive from
49 // PMTopLevelManager. PMTopLevelManager manages information used by top level
50 // managers such as last user info.
52 // [o] class PMDataManager;
54 // PMDataManager manages information, e.g. list of available analysis info,
55 // used by a pass manager to manage execution order of passes. It also provides
56 // a place to implement common pass manager APIs. All pass managers derive from
59 // [o] class BasicBlockPassManager : public FunctionPass, public PMDataManager;
61 // BasicBlockPassManager manages BasicBlockPasses.
63 // [o] class FunctionPassManager;
65 // This is a external interface used by JIT to manage FunctionPasses. This
66 // interface relies on FunctionPassManagerImpl to do all the tasks.
68 // [o] class FunctionPassManagerImpl : public ModulePass, PMDataManager,
69 // public PMTopLevelManager;
71 // FunctionPassManagerImpl is a top level manager. It manages FunctionPasses
72 // and BasicBlockPassManagers.
74 // [o] class ModulePassManager : public Pass, public PMDataManager;
76 // ModulePassManager manages ModulePasses and FunctionPassManagerImpls.
78 // [o] class PassManager;
80 // This is a external interface used by various tools to manages passes. It
81 // relies on PassManagerImpl to do all the tasks.
83 // [o] class PassManagerImpl : public Pass, public PMDataManager,
84 // public PMDTopLevelManager
86 // PassManagerImpl is a top level pass manager responsible for managing
87 // ModulePassManagers.
88 //===----------------------------------------------------------------------===//
92 //===----------------------------------------------------------------------===//
93 // Pass debugging information. Often it is useful to find out what pass is
94 // running when a crash occurs in a utility. When this library is compiled with
95 // debugging on, a command line option (--debug-pass) is enabled that causes the
96 // pass name to be printed before it executes.
99 // Different debug levels that can be enabled...
100 enum PassDebugLevel {
101 None, Arguments, Structure, Executions, Details
104 static cl::opt<enum PassDebugLevel>
105 PassDebugging_New("debug-pass", cl::Hidden,
106 cl::desc("Print PassManager debugging information"),
108 clEnumVal(None , "disable debug output"),
109 clEnumVal(Arguments , "print pass arguments to pass to 'opt'"),
110 clEnumVal(Structure , "print pass structure before run()"),
111 clEnumVal(Executions, "print pass name before it is executed"),
112 clEnumVal(Details , "print pass details when it is executed"),
114 } // End of llvm namespace
116 #ifndef USE_OLD_PASSMANAGER
121 //===----------------------------------------------------------------------===//
124 /// PMTopLevelManager manages LastUser info and collects common APIs used by
125 /// top level pass managers.
126 class PMTopLevelManager {
129 inline std::vector<Pass *>::iterator passManagersBegin() {
130 return PassManagers.begin();
133 inline std::vector<Pass *>::iterator passManagersEnd() {
134 return PassManagers.end();
137 /// Schedule pass P for execution. Make sure that passes required by
138 /// P are run before P is run. Update analysis info maintained by
139 /// the manager. Remove dead passes. This is a recursive function.
140 void schedulePass(Pass *P);
142 /// This is implemented by top level pass manager and used by
143 /// schedulePass() to add analysis info passes that are not available.
144 virtual void addTopLevelPass(Pass *P) = 0;
146 /// Set pass P as the last user of the given analysis passes.
147 void setLastUser(std::vector<Pass *> &AnalysisPasses, Pass *P);
149 /// Collect passes whose last user is P
150 void collectLastUses(std::vector<Pass *> &LastUses, Pass *P);
152 /// Find the pass that implements Analysis AID. Search immutable
153 /// passes and all pass managers. If desired pass is not found
154 /// then return NULL.
155 Pass *findAnalysisPass(AnalysisID AID);
157 inline void clearManagers() {
158 PassManagers.clear();
161 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 {
221 PMDataManager(int D) : TPM(NULL), Depth(D) {
222 initializeAnalysisInfo();
225 virtual ~PMDataManager() {
227 for (std::vector<Pass *>::iterator I = PassVector.begin(),
228 E = PassVector.end(); I != E; ++I)
234 /// Return true IFF pass P's required analysis set does not required new
236 bool manageablePass(Pass *P);
238 /// Augment AvailableAnalysis by adding analysis made available by pass P.
239 void recordAvailableAnalysis(Pass *P);
241 /// Remove Analysis that is not preserved by the pass
242 void removeNotPreservedAnalysis(Pass *P);
244 /// Remove dead passes
245 void removeDeadPasses(Pass *P, std::string &Msg);
247 /// Add pass P into the PassVector. Update
248 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
249 void addPassToManager(Pass *P, bool ProcessAnalysis = true);
251 /// Initialize available analysis information.
252 void initializeAnalysisInfo() {
253 TransferLastUses.clear();
254 AvailableAnalysis.clear();
257 /// Populate RequiredPasses with the analysis pass that are required by
259 void collectRequiredAnalysisPasses(std::vector<Pass *> &RequiredPasses,
262 /// All Required analyses should be available to the pass as it runs! Here
263 /// we fill in the AnalysisImpls member of the pass so that it can
264 /// successfully use the getAnalysis() method to retrieve the
265 /// implementations it needs.
266 void initializeAnalysisImpl(Pass *P);
268 /// Find the pass that implements Analysis AID. If desired pass is not found
269 /// then return NULL.
270 Pass *findAnalysisPass(AnalysisID AID, bool Direction);
272 inline std::vector<Pass *>::iterator passVectorBegin() {
273 return PassVector.begin();
276 inline std::vector<Pass *>::iterator passVectorEnd() {
277 return PassVector.end();
280 // Access toplevel manager
281 PMTopLevelManager *getTopLevelManager() { return TPM; }
282 void setTopLevelManager(PMTopLevelManager *T) { TPM = T; }
284 unsigned getDepth() { return Depth; }
286 // Print list of passes that are last used by P.
287 void dumpLastUses(Pass *P, unsigned Offset) {
289 std::vector<Pass *> LUses;
291 assert (TPM && "Top Level Manager is missing");
292 TPM->collectLastUses(LUses, P);
294 for (std::vector<Pass *>::iterator I = LUses.begin(),
295 E = LUses.end(); I != E; ++I) {
296 llvm::cerr << "--" << std::string(Offset*2, ' ');
297 (*I)->dumpPassStructure(0);
301 void dumpPassArguments() {
302 for(std::vector<Pass *>::iterator I = PassVector.begin(),
303 E = PassVector.end(); I != E; ++I) {
304 if (PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I))
305 PMD->dumpPassArguments();
307 if (const PassInfo *PI = (*I)->getPassInfo())
308 if (!PI->isAnalysisGroup())
309 cerr << " -" << PI->getPassArgument();
313 void dumpPassInfo(Pass *P, std::string &Msg1, std::string &Msg2) {
314 if (PassDebugging_New < Executions)
316 cerr << (void*)this << std::string(getDepth()*2+1, ' ');
318 cerr << P->getPassName();
322 void dumpAnalysisSetInfo(const char *Msg, Pass *P,
323 const std::vector<AnalysisID> &Set) {
324 if (PassDebugging_New >= Details && !Set.empty()) {
325 cerr << (void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:";
326 for (unsigned i = 0; i != Set.size(); ++i) {
328 cerr << " " << Set[i]->getPassName();
334 std::vector<Pass *>& getTransferredLastUses() {
335 return TransferLastUses;
340 // If a FunctionPass F is the last user of ModulePass info M
341 // then the F's manager, not F, records itself as a last user of M.
342 // Current pass manage is requesting parent manager to record parent
343 // manager as the last user of these TrransferLastUses passes.
344 std::vector<Pass *> TransferLastUses;
346 // Top level manager.
347 PMTopLevelManager *TPM;
350 // Set of available Analysis. This information is used while scheduling
351 // pass. If a pass requires an analysis which is not not available then
352 // equired analysis pass is scheduled to run before the pass itself is
354 std::map<AnalysisID, Pass*> AvailableAnalysis;
356 // Collection of pass that are managed by this manager
357 std::vector<Pass *> PassVector;
362 //===----------------------------------------------------------------------===//
363 // BasicBlockPassManager
365 /// BasicBlockPassManager manages BasicBlockPass. It batches all the
366 /// pass together and sequence them to process one basic block before
367 /// processing next basic block.
368 class BasicBlockPassManager : public PMDataManager,
369 public FunctionPass {
372 BasicBlockPassManager(int D) : PMDataManager(D) { }
374 /// Add a pass into a passmanager queue.
375 bool addPass(Pass *p);
377 /// Execute all of the passes scheduled for execution. Keep track of
378 /// whether any of the passes modifies the function, and if so, return true.
379 bool runOnFunction(Function &F);
381 /// Pass Manager itself does not invalidate any analysis info.
382 void getAnalysisUsage(AnalysisUsage &Info) const {
383 Info.setPreservesAll();
386 bool doInitialization(Module &M);
387 bool doInitialization(Function &F);
388 bool doFinalization(Module &M);
389 bool doFinalization(Function &F);
391 // Print passes managed by this manager
392 void dumpPassStructure(unsigned Offset) {
393 llvm::cerr << std::string(Offset*2, ' ') << "BasicBLockPass Manager\n";
394 for (std::vector<Pass *>::iterator I = passVectorBegin(),
395 E = passVectorEnd(); I != E; ++I) {
396 (*I)->dumpPassStructure(Offset + 1);
397 dumpLastUses(*I, Offset+1);
402 //===----------------------------------------------------------------------===//
403 // FunctionPassManagerImpl_New
405 /// FunctionPassManagerImpl_New manages FunctionPasses and
406 /// BasicBlockPassManagers. It batches all function passes and basic block pass
407 /// managers together and sequence them to process one function at a time before
408 /// processing next function.
409 class FunctionPassManagerImpl_New : public ModulePass,
410 public PMDataManager,
411 public PMTopLevelManager {
413 FunctionPassManagerImpl_New(int D) : PMDataManager(D) {
414 activeBBPassManager = NULL;
416 ~FunctionPassManagerImpl_New() { /* TODO */ };
418 inline void addTopLevelPass(Pass *P) {
420 if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
422 // P is a immutable pass then it will be managed by this
423 // top level manager. Set up analysis resolver to connect them.
424 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
426 initializeAnalysisImpl(P);
427 addImmutablePass(IP);
428 recordAvailableAnalysis(IP);
434 /// add - Add a pass to the queue of passes to run. This passes
435 /// ownership of the Pass to the PassManager. When the
436 /// PassManager_X is destroyed, the pass will be destroyed as well, so
437 /// there is no need to delete the pass. (TODO delete passes.)
438 /// This implies that all passes MUST be allocated with 'new'.
443 /// Add pass into the pass manager queue.
444 bool addPass(Pass *P);
446 /// Execute all of the passes scheduled for execution. Keep
447 /// track of whether any of the passes modifies the function, and if
449 bool runOnModule(Module &M);
450 bool runOnFunction(Function &F);
451 bool run(Function &F);
453 /// doInitialization - Run all of the initializers for the function passes.
455 bool doInitialization(Module &M);
457 /// doFinalization - Run all of the initializers for the function passes.
459 bool doFinalization(Module &M);
461 /// Pass Manager itself does not invalidate any analysis info.
462 void getAnalysisUsage(AnalysisUsage &Info) const {
463 Info.setPreservesAll();
466 // Print passes managed by this manager
467 void dumpPassStructure(unsigned Offset) {
468 llvm::cerr << std::string(Offset*2, ' ') << "FunctionPass Manager\n";
469 for (std::vector<Pass *>::iterator I = passVectorBegin(),
470 E = passVectorEnd(); I != E; ++I) {
471 (*I)->dumpPassStructure(Offset + 1);
472 dumpLastUses(*I, Offset+1);
477 // Active Pass Managers
478 BasicBlockPassManager *activeBBPassManager;
481 //===----------------------------------------------------------------------===//
484 /// ModulePassManager manages ModulePasses and function pass managers.
485 /// It batches all Module passes passes and function pass managers together and
486 /// sequence them to process one module.
487 class ModulePassManager : public Pass, public PMDataManager {
490 ModulePassManager(int D) : PMDataManager(D) {
491 activeFunctionPassManager = NULL;
494 /// Add a pass into a passmanager queue.
495 bool addPass(Pass *p);
497 /// run - Execute all of the passes scheduled for execution. Keep track of
498 /// whether any of the passes modifies the module, and if so, return true.
499 bool runOnModule(Module &M);
501 /// Pass Manager itself does not invalidate any analysis info.
502 void getAnalysisUsage(AnalysisUsage &Info) const {
503 Info.setPreservesAll();
506 // Print passes managed by this manager
507 void dumpPassStructure(unsigned Offset) {
508 llvm::cerr << std::string(Offset*2, ' ') << "ModulePass Manager\n";
509 for (std::vector<Pass *>::iterator I = passVectorBegin(),
510 E = passVectorEnd(); I != E; ++I) {
511 (*I)->dumpPassStructure(Offset + 1);
512 dumpLastUses(*I, Offset+1);
517 // Active Pass Manager
518 FunctionPassManagerImpl_New *activeFunctionPassManager;
521 //===----------------------------------------------------------------------===//
522 // PassManagerImpl_New
524 /// PassManagerImpl_New manages ModulePassManagers
525 class PassManagerImpl_New : public Pass,
526 public PMDataManager,
527 public PMTopLevelManager {
531 PassManagerImpl_New(int D) : PMDataManager(D) {
532 activeManager = NULL;
535 /// add - Add a pass to the queue of passes to run. This passes ownership of
536 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
537 /// will be destroyed as well, so there is no need to delete the pass. This
538 /// implies that all passes MUST be allocated with 'new'.
543 /// run - Execute all of the passes scheduled for execution. Keep track of
544 /// whether any of the passes modifies the module, and if so, return true.
547 /// Pass Manager itself does not invalidate any analysis info.
548 void getAnalysisUsage(AnalysisUsage &Info) const {
549 Info.setPreservesAll();
552 inline void addTopLevelPass(Pass *P) {
554 if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
556 // P is a immutable pass and it will be managed by this
557 // top level manager. Set up analysis resolver to connect them.
558 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
560 initializeAnalysisImpl(P);
561 addImmutablePass(IP);
562 recordAvailableAnalysis(IP);
570 /// Add a pass into a passmanager queue.
571 bool addPass(Pass *p);
573 // Active Pass Manager
574 ModulePassManager *activeManager;
577 //===----------------------------------------------------------------------===//
578 // TimingInfo Class - This class is used to calculate information about the
579 // amount of time each pass takes to execute. This only happens when
580 // -time-passes is enabled on the command line.
584 std::map<Pass*, Timer> TimingData;
588 // Use 'create' member to get this.
589 TimingInfo() : TG("... Pass execution timing report ...") {}
591 // TimingDtor - Print out information about timing information
593 // Delete all of the timers...
595 // TimerGroup is deleted next, printing the report.
598 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer
599 // to a non null value (if the -time-passes option is enabled) or it leaves it
600 // null. It may be called multiple times.
601 static void createTheTimeInfo();
603 void passStarted(Pass *P) {
605 if (dynamic_cast<PMDataManager *>(P))
608 std::map<Pass*, Timer>::iterator I = TimingData.find(P);
609 if (I == TimingData.end())
610 I=TimingData.insert(std::make_pair(P, Timer(P->getPassName(), TG))).first;
611 I->second.startTimer();
613 void passEnded(Pass *P) {
615 if (dynamic_cast<PMDataManager *>(P))
618 std::map<Pass*, Timer>::iterator I = TimingData.find(P);
619 assert (I != TimingData.end() && "passStarted/passEnded not nested right!");
620 I->second.stopTimer();
624 static TimingInfo *TheTimeInfo;
626 } // End of llvm namespace
628 //===----------------------------------------------------------------------===//
629 // PMTopLevelManager implementation
631 /// Set pass P as the last user of the given analysis passes.
632 void PMTopLevelManager::setLastUser(std::vector<Pass *> &AnalysisPasses,
635 for (std::vector<Pass *>::iterator I = AnalysisPasses.begin(),
636 E = AnalysisPasses.end(); I != E; ++I) {
639 // If AP is the last user of other passes then make P last user of
641 for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
642 LUE = LastUser.end(); LUI != LUE; ++LUI) {
643 if (LUI->second == AP)
644 LastUser[LUI->first] = P;
649 /// Collect passes whose last user is P
650 void PMTopLevelManager::collectLastUses(std::vector<Pass *> &LastUses,
652 for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
653 LUE = LastUser.end(); LUI != LUE; ++LUI)
654 if (LUI->second == P)
655 LastUses.push_back(LUI->first);
658 /// Schedule pass P for execution. Make sure that passes required by
659 /// P are run before P is run. Update analysis info maintained by
660 /// the manager. Remove dead passes. This is a recursive function.
661 void PMTopLevelManager::schedulePass(Pass *P) {
663 // TODO : Allocate function manager for this pass, other wise required set
664 // may be inserted into previous function manager
666 AnalysisUsage AnUsage;
667 P->getAnalysisUsage(AnUsage);
668 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
669 for (std::vector<AnalysisID>::const_iterator I = RequiredSet.begin(),
670 E = RequiredSet.end(); I != E; ++I) {
672 Pass *AnalysisPass = findAnalysisPass(*I);
674 // Schedule this analysis run first.
675 AnalysisPass = (*I)->createPass();
676 schedulePass(AnalysisPass);
680 // Now all required passes are available.
684 /// Find the pass that implements Analysis AID. Search immutable
685 /// passes and all pass managers. If desired pass is not found
686 /// then return NULL.
687 Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
690 // Check pass managers
691 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
692 E = PassManagers.end(); P == NULL && I != E; ++I) {
693 PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
694 assert(PMD && "This is not a PassManager");
695 P = PMD->findAnalysisPass(AID, false);
698 // Check other pass managers
699 for (std::vector<PMDataManager *>::iterator I = IndirectPassManagers.begin(),
700 E = IndirectPassManagers.end(); P == NULL && I != E; ++I)
701 P = (*I)->findAnalysisPass(AID, false);
703 for (std::vector<ImmutablePass *>::iterator I = ImmutablePasses.begin(),
704 E = ImmutablePasses.end(); P == NULL && I != E; ++I) {
705 const PassInfo *PI = (*I)->getPassInfo();
709 // If Pass not found then check the interfaces implemented by Immutable Pass
711 const std::vector<const PassInfo*> &ImmPI =
712 PI->getInterfacesImplemented();
713 for (unsigned Index = 0, End = ImmPI.size();
714 P == NULL && Index != End; ++Index)
715 if (ImmPI[Index] == AID)
723 // Print passes managed by this top level manager.
724 void PMTopLevelManager::dumpPasses() {
726 // Print out the immutable passes
727 for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
728 ImmutablePasses[i]->dumpPassStructure(0);
731 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
732 E = PassManagers.end(); I != E; ++I)
733 (*I)->dumpPassStructure(1);
737 void PMTopLevelManager::dumpArguments() {
739 if (PassDebugging_New < Arguments)
742 cerr << "Pass Arguments: ";
743 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
744 E = PassManagers.end(); I != E; ++I) {
745 PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
746 assert(PMD && "This is not a PassManager");
747 PMD->dumpPassArguments();
752 //===----------------------------------------------------------------------===//
753 // PMDataManager implementation
755 /// Return true IFF pass P's required analysis set does not required new
757 bool PMDataManager::manageablePass(Pass *P) {
760 // If this pass is not preserving information that is required by a
761 // pass maintained by higher level pass manager then do not insert
762 // this pass into current manager. Use new manager. For example,
763 // For example, If FunctionPass F is not preserving ModulePass Info M1
764 // that is used by another ModulePass M2 then do not insert F in
765 // current function pass manager.
769 /// Augement AvailableAnalysis by adding analysis made available by pass P.
770 void PMDataManager::recordAvailableAnalysis(Pass *P) {
772 if (const PassInfo *PI = P->getPassInfo()) {
773 AvailableAnalysis[PI] = P;
775 //This pass is the current implementation of all of the interfaces it
776 //implements as well.
777 const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
778 for (unsigned i = 0, e = II.size(); i != e; ++i)
779 AvailableAnalysis[II[i]] = P;
783 /// Remove Analyss not preserved by Pass P
784 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
785 AnalysisUsage AnUsage;
786 P->getAnalysisUsage(AnUsage);
788 if (AnUsage.getPreservesAll())
791 const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
792 for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
793 E = AvailableAnalysis.end(); I != E; ) {
794 if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) ==
795 PreservedSet.end()) {
796 // Remove this analysis
797 if (!dynamic_cast<ImmutablePass*>(I->second)) {
798 std::map<AnalysisID, Pass*>::iterator J = I++;
799 AvailableAnalysis.erase(J);
807 /// Remove analysis passes that are not used any longer
808 void PMDataManager::removeDeadPasses(Pass *P, std::string &Msg) {
810 std::vector<Pass *> DeadPasses;
811 TPM->collectLastUses(DeadPasses, P);
813 for (std::vector<Pass *>::iterator I = DeadPasses.begin(),
814 E = DeadPasses.end(); I != E; ++I) {
816 std::string Msg1 = " Freeing Pass '";
817 dumpPassInfo(*I, Msg1, Msg);
819 if (TheTimeInfo) TheTimeInfo->passStarted(P);
820 (*I)->releaseMemory();
821 if (TheTimeInfo) TheTimeInfo->passEnded(P);
823 std::map<AnalysisID, Pass*>::iterator Pos =
824 AvailableAnalysis.find((*I)->getPassInfo());
826 // It is possible that pass is already removed from the AvailableAnalysis
827 if (Pos != AvailableAnalysis.end())
828 AvailableAnalysis.erase(Pos);
832 /// Add pass P into the PassVector. Update
833 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
834 void PMDataManager::addPassToManager(Pass *P,
835 bool ProcessAnalysis) {
837 // This manager is going to manage pass P. Set up analysis resolver
839 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
842 if (ProcessAnalysis) {
844 // At the moment, this pass is the last user of all required passes.
845 std::vector<Pass *> LastUses;
846 std::vector<Pass *> RequiredPasses;
847 unsigned PDepth = this->getDepth();
849 collectRequiredAnalysisPasses(RequiredPasses, P);
850 for (std::vector<Pass *>::iterator I = RequiredPasses.begin(),
851 E = RequiredPasses.end(); I != E; ++I) {
852 Pass *PRequired = *I;
855 PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
856 RDepth = DM.getDepth();
858 if (PDepth == RDepth)
859 LastUses.push_back(PRequired);
860 else if (PDepth > RDepth) {
861 // Let the parent claim responsibility of last use
862 TransferLastUses.push_back(PRequired);
864 // Note : This feature is not yet implemented
866 "Unable to handle Pass that requires lower level Analysis pass");
870 LastUses.push_back(P);
871 TPM->setLastUser(LastUses, P);
873 // Take a note of analysis required and made available by this pass.
874 // Remove the analysis not preserved by this pass
875 removeNotPreservedAnalysis(P);
876 recordAvailableAnalysis(P);
880 PassVector.push_back(P);
883 /// Populate RequiredPasses with the analysis pass that are required by
885 void PMDataManager::collectRequiredAnalysisPasses(std::vector<Pass *> &RP,
887 AnalysisUsage AnUsage;
888 P->getAnalysisUsage(AnUsage);
889 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
890 for (std::vector<AnalysisID>::const_iterator
891 I = RequiredSet.begin(), E = RequiredSet.end();
893 Pass *AnalysisPass = findAnalysisPass(*I, true);
894 assert (AnalysisPass && "Analysis pass is not available");
895 RP.push_back(AnalysisPass);
898 const std::vector<AnalysisID> &IDs = AnUsage.getRequiredTransitiveSet();
899 for (std::vector<AnalysisID>::const_iterator I = IDs.begin(),
900 E = IDs.end(); I != E; ++I) {
901 Pass *AnalysisPass = findAnalysisPass(*I, true);
902 assert (AnalysisPass && "Analysis pass is not available");
903 RP.push_back(AnalysisPass);
907 // All Required analyses should be available to the pass as it runs! Here
908 // we fill in the AnalysisImpls member of the pass so that it can
909 // successfully use the getAnalysis() method to retrieve the
910 // implementations it needs.
912 void PMDataManager::initializeAnalysisImpl(Pass *P) {
913 AnalysisUsage AnUsage;
914 P->getAnalysisUsage(AnUsage);
916 for (std::vector<const PassInfo *>::const_iterator
917 I = AnUsage.getRequiredSet().begin(),
918 E = AnUsage.getRequiredSet().end(); I != E; ++I) {
919 Pass *Impl = findAnalysisPass(*I, true);
921 assert(0 && "Analysis used but not available!");
922 AnalysisResolver_New *AR = P->getResolver();
923 AR->addAnalysisImplsPair(*I, Impl);
927 /// Find the pass that implements Analysis AID. If desired pass is not found
928 /// then return NULL.
929 Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
931 // Check if AvailableAnalysis map has one entry.
932 std::map<AnalysisID, Pass*>::const_iterator I = AvailableAnalysis.find(AID);
934 if (I != AvailableAnalysis.end())
937 // Search Parents through TopLevelManager
939 return TPM->findAnalysisPass(AID);
945 //===----------------------------------------------------------------------===//
946 // NOTE: Is this the right place to define this method ?
947 // getAnalysisToUpdate - Return an analysis result or null if it doesn't exist
948 Pass *AnalysisResolver_New::getAnalysisToUpdate(AnalysisID ID, bool dir) const {
949 return PM.findAnalysisPass(ID, dir);
952 //===----------------------------------------------------------------------===//
953 // BasicBlockPassManager implementation
955 /// Add pass P into PassVector and return true. If this pass is not
956 /// manageable by this manager then return false.
958 BasicBlockPassManager::addPass(Pass *P) {
960 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
964 // If this pass does not preserve anlysis that is used by other passes
965 // managed by this manager than it is not a suiable pass for this manager.
966 if (!manageablePass(P))
969 addPassToManager(BP);
974 /// Execute all of the passes scheduled for execution by invoking
975 /// runOnBasicBlock method. Keep track of whether any of the passes modifies
976 /// the function, and if so, return true.
978 BasicBlockPassManager::runOnFunction(Function &F) {
983 bool Changed = doInitialization(F);
984 initializeAnalysisInfo();
986 std::string Msg1 = "Executing Pass '";
987 std::string Msg3 = "' Made Modification '";
989 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
990 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
991 e = passVectorEnd(); itr != e; ++itr) {
993 AnalysisUsage AnUsage;
994 P->getAnalysisUsage(AnUsage);
996 std::string Msg2 = "' on BasicBlock '" + (*I).getName() + "'...\n";
997 dumpPassInfo(P, Msg1, Msg2);
998 dumpAnalysisSetInfo("Required", P, AnUsage.getRequiredSet());
1000 initializeAnalysisImpl(P);
1002 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1003 if (TheTimeInfo) TheTimeInfo->passStarted(P);
1004 Changed |= BP->runOnBasicBlock(*I);
1005 if (TheTimeInfo) TheTimeInfo->passEnded(P);
1008 dumpPassInfo(P, Msg3, Msg2);
1009 dumpAnalysisSetInfo("Preserved", P, AnUsage.getPreservedSet());
1011 removeNotPreservedAnalysis(P);
1012 recordAvailableAnalysis(P);
1013 removeDeadPasses(P, Msg2);
1015 return Changed | doFinalization(F);
1018 // Implement doInitialization and doFinalization
1019 inline bool BasicBlockPassManager::doInitialization(Module &M) {
1020 bool Changed = false;
1022 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1023 e = passVectorEnd(); itr != e; ++itr) {
1025 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1026 Changed |= BP->doInitialization(M);
1032 inline bool BasicBlockPassManager::doFinalization(Module &M) {
1033 bool Changed = false;
1035 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1036 e = passVectorEnd(); itr != e; ++itr) {
1038 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1039 Changed |= BP->doFinalization(M);
1045 inline bool BasicBlockPassManager::doInitialization(Function &F) {
1046 bool Changed = false;
1048 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1049 e = passVectorEnd(); itr != e; ++itr) {
1051 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1052 Changed |= BP->doInitialization(F);
1058 inline bool BasicBlockPassManager::doFinalization(Function &F) {
1059 bool Changed = false;
1061 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1062 e = passVectorEnd(); itr != e; ++itr) {
1064 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1065 Changed |= BP->doFinalization(F);
1072 //===----------------------------------------------------------------------===//
1073 // FunctionPassManager implementation
1075 /// Create new Function pass manager
1076 FunctionPassManager::FunctionPassManager(ModuleProvider *P) {
1077 FPM = new FunctionPassManagerImpl_New(0);
1078 // FPM is the top level manager.
1079 FPM->setTopLevelManager(FPM);
1081 PMDataManager *PMD = dynamic_cast<PMDataManager *>(FPM);
1082 AnalysisResolver_New *AR = new AnalysisResolver_New(*PMD);
1083 FPM->setResolver(AR);
1085 FPM->addPassManager(FPM);
1089 FunctionPassManager::~FunctionPassManager() {
1090 // Note : FPM maintains one entry in PassManagers vector.
1091 // This one entry is FPM itself. This is not ideal. One
1092 // alternative is have one additional layer between
1093 // FunctionPassManager and FunctionPassManagerImpl.
1094 // Meanwhile, to avoid going into infinte loop, first
1095 // remove FPM from its PassMangers vector.
1096 FPM->clearManagers();
1100 /// add - Add a pass to the queue of passes to run. This passes
1101 /// ownership of the Pass to the PassManager. When the
1102 /// PassManager_X is destroyed, the pass will be destroyed as well, so
1103 /// there is no need to delete the pass. (TODO delete passes.)
1104 /// This implies that all passes MUST be allocated with 'new'.
1105 void FunctionPassManager::add(Pass *P) {
1109 /// run - Execute all of the passes scheduled for execution. Keep
1110 /// track of whether any of the passes modifies the function, and if
1111 /// so, return true.
1113 bool FunctionPassManager::run(Function &F) {
1115 if (MP->materializeFunction(&F, &errstr)) {
1116 cerr << "Error reading bytecode file: " << errstr << "\n";
1123 /// doInitialization - Run all of the initializers for the function passes.
1125 bool FunctionPassManager::doInitialization() {
1126 return FPM->doInitialization(*MP->getModule());
1129 /// doFinalization - Run all of the initializers for the function passes.
1131 bool FunctionPassManager::doFinalization() {
1132 return FPM->doFinalization(*MP->getModule());
1135 //===----------------------------------------------------------------------===//
1136 // FunctionPassManagerImpl_New implementation
1138 /// Add pass P into the pass manager queue. If P is a BasicBlockPass then
1139 /// either use it into active basic block pass manager or create new basic
1140 /// block pass manager to handle pass P.
1142 FunctionPassManagerImpl_New::addPass(Pass *P) {
1144 // If P is a BasicBlockPass then use BasicBlockPassManager.
1145 if (BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P)) {
1147 if (!activeBBPassManager || !activeBBPassManager->addPass(BP)) {
1149 // If active manager exists then clear its analysis info.
1150 if (activeBBPassManager)
1151 activeBBPassManager->initializeAnalysisInfo();
1153 // Create and add new manager
1154 activeBBPassManager =
1155 new BasicBlockPassManager(getDepth() + 1);
1156 // Inherit top level manager
1157 activeBBPassManager->setTopLevelManager(this->getTopLevelManager());
1159 // Add new manager into current manager's list.
1160 addPassToManager(activeBBPassManager, false);
1162 // Add new manager into top level manager's indirect passes list
1163 PMDataManager *PMD = dynamic_cast<PMDataManager *>(activeBBPassManager);
1164 assert (PMD && "Manager is not Pass Manager");
1165 TPM->addIndirectPassManager(PMD);
1167 // Add pass into new manager. This time it must succeed.
1168 if (!activeBBPassManager->addPass(BP))
1169 assert(0 && "Unable to add Pass");
1171 // If activeBBPassManager transfered any Last Uses then handle them here.
1172 std::vector<Pass *> &TLU = activeBBPassManager->getTransferredLastUses();
1174 TPM->setLastUser(TLU, this);
1182 FunctionPass *FP = dynamic_cast<FunctionPass *>(P);
1186 // If this pass does not preserve anlysis that is used by other passes
1187 // managed by this manager than it is not a suiable pass for this manager.
1188 if (!manageablePass(P))
1191 addPassToManager (FP);
1193 // If active manager exists then clear its analysis info.
1194 if (activeBBPassManager) {
1195 activeBBPassManager->initializeAnalysisInfo();
1196 activeBBPassManager = NULL;
1202 /// Execute all of the passes scheduled for execution by invoking
1203 /// runOnFunction method. Keep track of whether any of the passes modifies
1204 /// the function, and if so, return true.
1205 bool FunctionPassManagerImpl_New::runOnModule(Module &M) {
1207 bool Changed = doInitialization(M);
1208 initializeAnalysisInfo();
1210 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1211 this->runOnFunction(*I);
1213 return Changed | doFinalization(M);
1216 /// Execute all of the passes scheduled for execution by invoking
1217 /// runOnFunction method. Keep track of whether any of the passes modifies
1218 /// the function, and if so, return true.
1219 bool FunctionPassManagerImpl_New::runOnFunction(Function &F) {
1221 bool Changed = false;
1226 initializeAnalysisInfo();
1228 std::string Msg1 = "Executing Pass '";
1229 std::string Msg3 = "' Made Modification '";
1231 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1232 e = passVectorEnd(); itr != e; ++itr) {
1234 AnalysisUsage AnUsage;
1235 P->getAnalysisUsage(AnUsage);
1237 std::string Msg2 = "' on Function '" + F.getName() + "'...\n";
1238 dumpPassInfo(P, Msg1, Msg2);
1239 dumpAnalysisSetInfo("Required", P, AnUsage.getRequiredSet());
1241 initializeAnalysisImpl(P);
1242 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
1244 if (TheTimeInfo) TheTimeInfo->passStarted(P);
1245 Changed |= FP->runOnFunction(F);
1246 if (TheTimeInfo) TheTimeInfo->passEnded(P);
1249 dumpPassInfo(P, Msg3, Msg2);
1250 dumpAnalysisSetInfo("Preserved", P, AnUsage.getPreservedSet());
1252 removeNotPreservedAnalysis(P);
1253 recordAvailableAnalysis(P);
1254 removeDeadPasses(P, Msg2);
1260 inline bool FunctionPassManagerImpl_New::doInitialization(Module &M) {
1261 bool Changed = false;
1263 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1264 e = passVectorEnd(); itr != e; ++itr) {
1267 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
1268 Changed |= FP->doInitialization(M);
1274 inline bool FunctionPassManagerImpl_New::doFinalization(Module &M) {
1275 bool Changed = false;
1277 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1278 e = passVectorEnd(); itr != e; ++itr) {
1281 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
1282 Changed |= FP->doFinalization(M);
1288 // Execute all the passes managed by this top level manager.
1289 // Return true if any function is modified by a pass.
1290 bool FunctionPassManagerImpl_New::run(Function &F) {
1292 bool Changed = false;
1293 for (std::vector<Pass *>::iterator I = passManagersBegin(),
1294 E = passManagersEnd(); I != E; ++I) {
1295 FunctionPassManagerImpl_New *FP =
1296 dynamic_cast<FunctionPassManagerImpl_New *>(*I);
1297 Changed |= FP->runOnFunction(F);
1302 //===----------------------------------------------------------------------===//
1303 // ModulePassManager implementation
1305 /// Add P into pass vector if it is manageble. If P is a FunctionPass
1306 /// then use FunctionPassManagerImpl_New to manage it. Return false if P
1307 /// is not manageable by this manager.
1309 ModulePassManager::addPass(Pass *P) {
1311 // If P is FunctionPass then use function pass maanager.
1312 if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P)) {
1314 if (!activeFunctionPassManager || !activeFunctionPassManager->addPass(P)) {
1316 // If active manager exists then clear its analysis info.
1317 if (activeFunctionPassManager)
1318 activeFunctionPassManager->initializeAnalysisInfo();
1320 // Create and add new manager
1321 activeFunctionPassManager =
1322 new FunctionPassManagerImpl_New(getDepth() + 1);
1324 // Add new manager into current manager's list
1325 addPassToManager(activeFunctionPassManager, false);
1327 // Inherit top level manager
1328 activeFunctionPassManager->setTopLevelManager(this->getTopLevelManager());
1330 // Add new manager into top level manager's indirect passes list
1331 PMDataManager *PMD =
1332 dynamic_cast<PMDataManager *>(activeFunctionPassManager);
1333 assert(PMD && "Manager is not Pass Manager");
1334 TPM->addIndirectPassManager(PMD);
1336 // Add pass into new manager. This time it must succeed.
1337 if (!activeFunctionPassManager->addPass(FP))
1338 assert(0 && "Unable to add pass");
1340 // If activeFunctionPassManager transfered any Last Uses then
1341 // handle them here.
1342 std::vector<Pass *> &TLU =
1343 activeFunctionPassManager->getTransferredLastUses();
1345 TPM->setLastUser(TLU, this);
1351 ModulePass *MP = dynamic_cast<ModulePass *>(P);
1355 // If this pass does not preserve anlysis that is used by other passes
1356 // managed by this manager than it is not a suiable pass for this manager.
1357 if (!manageablePass(P))
1360 addPassToManager(MP);
1361 // If active manager exists then clear its analysis info.
1362 if (activeFunctionPassManager) {
1363 activeFunctionPassManager->initializeAnalysisInfo();
1364 activeFunctionPassManager = NULL;
1371 /// Execute all of the passes scheduled for execution by invoking
1372 /// runOnModule method. Keep track of whether any of the passes modifies
1373 /// the module, and if so, return true.
1375 ModulePassManager::runOnModule(Module &M) {
1376 bool Changed = false;
1377 initializeAnalysisInfo();
1379 std::string Msg1 = "Executing Pass '";
1380 std::string Msg3 = "' Made Modification '";
1382 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1383 e = passVectorEnd(); itr != e; ++itr) {
1385 AnalysisUsage AnUsage;
1386 P->getAnalysisUsage(AnUsage);
1388 std::string Msg2 = "' on Module '" + M.getModuleIdentifier() + "'...\n";
1389 dumpPassInfo(P, Msg1, Msg2);
1390 dumpAnalysisSetInfo("Required", P, AnUsage.getRequiredSet());
1392 initializeAnalysisImpl(P);
1393 ModulePass *MP = dynamic_cast<ModulePass*>(P);
1395 if (TheTimeInfo) TheTimeInfo->passStarted(P);
1396 Changed |= MP->runOnModule(M);
1397 if (TheTimeInfo) TheTimeInfo->passEnded(P);
1400 dumpPassInfo(P, Msg3, Msg2);
1401 dumpAnalysisSetInfo("Preserved", P, AnUsage.getPreservedSet());
1403 removeNotPreservedAnalysis(P);
1404 recordAvailableAnalysis(P);
1405 removeDeadPasses(P, Msg2);
1410 //===----------------------------------------------------------------------===//
1411 // PassManagerImpl implementation
1413 /// Add P into active pass manager or use new module pass manager to
1415 bool PassManagerImpl_New::addPass(Pass *P) {
1417 if (!activeManager || !activeManager->addPass(P)) {
1418 activeManager = new ModulePassManager(getDepth() + 1);
1419 // Inherit top level manager
1420 activeManager->setTopLevelManager(this->getTopLevelManager());
1422 // This top level manager is going to manage activeManager.
1423 // Set up analysis resolver to connect them.
1424 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
1425 activeManager->setResolver(AR);
1427 addPassManager(activeManager);
1428 return activeManager->addPass(P);
1433 /// run - Execute all of the passes scheduled for execution. Keep track of
1434 /// whether any of the passes modifies the module, and if so, return true.
1435 bool PassManagerImpl_New::run(Module &M) {
1437 bool Changed = false;
1439 TimingInfo::createTheTimeInfo();
1442 if (PassDebugging_New >= Structure)
1445 for (std::vector<Pass *>::iterator I = passManagersBegin(),
1446 E = passManagersEnd(); I != E; ++I) {
1447 ModulePassManager *MP = dynamic_cast<ModulePassManager *>(*I);
1448 Changed |= MP->runOnModule(M);
1453 //===----------------------------------------------------------------------===//
1454 // PassManager implementation
1456 /// Create new pass manager
1457 PassManager::PassManager() {
1458 PM = new PassManagerImpl_New(0);
1459 // PM is the top level manager
1460 PM->setTopLevelManager(PM);
1463 PassManager::~PassManager() {
1467 /// add - Add a pass to the queue of passes to run. This passes ownership of
1468 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
1469 /// will be destroyed as well, so there is no need to delete the pass. This
1470 /// implies that all passes MUST be allocated with 'new'.
1472 PassManager::add(Pass *P) {
1476 /// run - Execute all of the passes scheduled for execution. Keep track of
1477 /// whether any of the passes modifies the module, and if so, return true.
1479 PassManager::run(Module &M) {
1483 //===----------------------------------------------------------------------===//
1484 // TimingInfo Class - This class is used to calculate information about the
1485 // amount of time each pass takes to execute. This only happens with
1486 // -time-passes is enabled on the command line.
1488 bool llvm::TimePassesIsEnabled = false;
1489 static cl::opt<bool,true>
1490 EnableTiming("time-passes", cl::location(TimePassesIsEnabled),
1491 cl::desc("Time each pass, printing elapsed time for each on exit"));
1493 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
1494 // a non null value (if the -time-passes option is enabled) or it leaves it
1495 // null. It may be called multiple times.
1496 void TimingInfo::createTheTimeInfo() {
1497 if (!TimePassesIsEnabled || TheTimeInfo) return;
1499 // Constructed the first time this is called, iff -time-passes is enabled.
1500 // This guarantees that the object will be constructed before static globals,
1501 // thus it will be destroyed before them.
1502 static ManagedStatic<TimingInfo> TTI;
1503 TheTimeInfo = &*TTI;