1 //===- PassManager.cpp - LLVM Pass Infrastructure Implementation ----------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the LLVM Pass Manager infrastructure.
12 //===----------------------------------------------------------------------===//
15 #include "llvm/PassManagers.h"
16 #include "llvm/Assembly/Writer.h"
17 #include "llvm/Support/CommandLine.h"
18 #include "llvm/Support/Timer.h"
19 #include "llvm/Module.h"
20 #include "llvm/ModuleProvider.h"
21 #include "llvm/Support/ErrorHandling.h"
22 #include "llvm/Support/ManagedStatic.h"
23 #include "llvm/Support/raw_ostream.h"
24 #include "llvm/System/Mutex.h"
25 #include "llvm/System/Threading.h"
26 #include "llvm-c/Core.h"
32 // See PassManagers.h for Pass Manager infrastructure overview.
36 //===----------------------------------------------------------------------===//
37 // Pass debugging information. Often it is useful to find out what pass is
38 // running when a crash occurs in a utility. When this library is compiled with
39 // debugging on, a command line option (--debug-pass) is enabled that causes the
40 // pass name to be printed before it executes.
43 // Different debug levels that can be enabled...
45 None, Arguments, Structure, Executions, Details
48 static cl::opt<enum PassDebugLevel>
49 PassDebugging("debug-pass", cl::Hidden,
50 cl::desc("Print PassManager debugging information"),
52 clEnumVal(None , "disable debug output"),
53 clEnumVal(Arguments , "print pass arguments to pass to 'opt'"),
54 clEnumVal(Structure , "print pass structure before run()"),
55 clEnumVal(Executions, "print pass name before it is executed"),
56 clEnumVal(Details , "print pass details when it is executed"),
58 } // End of llvm namespace
60 /// isPassDebuggingExecutionsOrMore - Return true if -debug-pass=Executions
61 /// or higher is specified.
62 bool PMDataManager::isPassDebuggingExecutionsOrMore() const {
63 return PassDebugging >= Executions;
69 void PassManagerPrettyStackEntry::print(raw_ostream &OS) const {
71 OS << "Releasing pass '";
73 OS << "Running pass '";
75 OS << P->getPassName() << "'";
78 OS << " on module '" << M->getModuleIdentifier() << "'.\n";
89 else if (isa<BasicBlock>(V))
95 WriteAsOperand(OS, V, /*PrintTy=*/false, M);
102 //===----------------------------------------------------------------------===//
105 /// BBPassManager manages BasicBlockPass. It batches all the
106 /// pass together and sequence them to process one basic block before
107 /// processing next basic block.
108 class BBPassManager : public PMDataManager, public FunctionPass {
112 explicit BBPassManager(int Depth)
113 : PMDataManager(Depth), FunctionPass(&ID) {}
115 /// Execute all of the passes scheduled for execution. Keep track of
116 /// whether any of the passes modifies the function, and if so, return true.
117 bool runOnFunction(Function &F);
119 /// Pass Manager itself does not invalidate any analysis info.
120 void getAnalysisUsage(AnalysisUsage &Info) const {
121 Info.setPreservesAll();
124 bool doInitialization(Module &M);
125 bool doInitialization(Function &F);
126 bool doFinalization(Module &M);
127 bool doFinalization(Function &F);
129 virtual const char *getPassName() const {
130 return "BasicBlock Pass Manager";
133 // Print passes managed by this manager
134 void dumpPassStructure(unsigned Offset) {
135 llvm::errs() << std::string(Offset*2, ' ') << "BasicBlockPass Manager\n";
136 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
137 BasicBlockPass *BP = getContainedPass(Index);
138 BP->dumpPassStructure(Offset + 1);
139 dumpLastUses(BP, Offset+1);
143 BasicBlockPass *getContainedPass(unsigned N) {
144 assert(N < PassVector.size() && "Pass number out of range!");
145 BasicBlockPass *BP = static_cast<BasicBlockPass *>(PassVector[N]);
149 virtual PassManagerType getPassManagerType() const {
150 return PMT_BasicBlockPassManager;
154 char BBPassManager::ID = 0;
159 //===----------------------------------------------------------------------===//
160 // FunctionPassManagerImpl
162 /// FunctionPassManagerImpl manages FPPassManagers
163 class FunctionPassManagerImpl : public Pass,
164 public PMDataManager,
165 public PMTopLevelManager {
170 explicit FunctionPassManagerImpl(int Depth) :
171 Pass(&ID), PMDataManager(Depth),
172 PMTopLevelManager(TLM_Function), wasRun(false) { }
174 /// add - Add a pass to the queue of passes to run. This passes ownership of
175 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
176 /// will be destroyed as well, so there is no need to delete the pass. This
177 /// implies that all passes MUST be allocated with 'new'.
182 // Prepare for running an on the fly pass, freeing memory if needed
183 // from a previous run.
184 void releaseMemoryOnTheFly();
186 /// run - Execute all of the passes scheduled for execution. Keep track of
187 /// whether any of the passes modifies the module, and if so, return true.
188 bool run(Function &F);
190 /// doInitialization - Run all of the initializers for the function passes.
192 bool doInitialization(Module &M);
194 /// doFinalization - Run all of the finalizers for the function passes.
196 bool doFinalization(Module &M);
198 /// Pass Manager itself does not invalidate any analysis info.
199 void getAnalysisUsage(AnalysisUsage &Info) const {
200 Info.setPreservesAll();
203 inline void addTopLevelPass(Pass *P) {
205 if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
207 // P is a immutable pass and it will be managed by this
208 // top level manager. Set up analysis resolver to connect them.
209 AnalysisResolver *AR = new AnalysisResolver(*this);
211 initializeAnalysisImpl(P);
212 addImmutablePass(IP);
213 recordAvailableAnalysis(IP);
215 P->assignPassManager(activeStack);
220 FPPassManager *getContainedManager(unsigned N) {
221 assert(N < PassManagers.size() && "Pass number out of range!");
222 FPPassManager *FP = static_cast<FPPassManager *>(PassManagers[N]);
227 char FunctionPassManagerImpl::ID = 0;
228 //===----------------------------------------------------------------------===//
231 /// MPPassManager manages ModulePasses and function pass managers.
232 /// It batches all Module passes and function pass managers together and
233 /// sequences them to process one module.
234 class MPPassManager : public Pass, public PMDataManager {
237 explicit MPPassManager(int Depth) :
238 Pass(&ID), PMDataManager(Depth) { }
240 // Delete on the fly managers.
241 virtual ~MPPassManager() {
242 for (std::map<Pass *, FunctionPassManagerImpl *>::iterator
243 I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end();
245 FunctionPassManagerImpl *FPP = I->second;
250 /// run - Execute all of the passes scheduled for execution. Keep track of
251 /// whether any of the passes modifies the module, and if so, return true.
252 bool runOnModule(Module &M);
254 /// Pass Manager itself does not invalidate any analysis info.
255 void getAnalysisUsage(AnalysisUsage &Info) const {
256 Info.setPreservesAll();
259 /// Add RequiredPass into list of lower level passes required by pass P.
260 /// RequiredPass is run on the fly by Pass Manager when P requests it
261 /// through getAnalysis interface.
262 virtual void addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass);
264 /// Return function pass corresponding to PassInfo PI, that is
265 /// required by module pass MP. Instantiate analysis pass, by using
266 /// its runOnFunction() for function F.
267 virtual Pass* getOnTheFlyPass(Pass *MP, const PassInfo *PI, Function &F);
269 virtual const char *getPassName() const {
270 return "Module Pass Manager";
273 // Print passes managed by this manager
274 void dumpPassStructure(unsigned Offset) {
275 llvm::errs() << std::string(Offset*2, ' ') << "ModulePass Manager\n";
276 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
277 ModulePass *MP = getContainedPass(Index);
278 MP->dumpPassStructure(Offset + 1);
279 std::map<Pass *, FunctionPassManagerImpl *>::const_iterator I =
280 OnTheFlyManagers.find(MP);
281 if (I != OnTheFlyManagers.end())
282 I->second->dumpPassStructure(Offset + 2);
283 dumpLastUses(MP, Offset+1);
287 ModulePass *getContainedPass(unsigned N) {
288 assert(N < PassVector.size() && "Pass number out of range!");
289 return static_cast<ModulePass *>(PassVector[N]);
292 virtual PassManagerType getPassManagerType() const {
293 return PMT_ModulePassManager;
297 /// Collection of on the fly FPPassManagers. These managers manage
298 /// function passes that are required by module passes.
299 std::map<Pass *, FunctionPassManagerImpl *> OnTheFlyManagers;
302 char MPPassManager::ID = 0;
303 //===----------------------------------------------------------------------===//
307 /// PassManagerImpl manages MPPassManagers
308 class PassManagerImpl : public Pass,
309 public PMDataManager,
310 public PMTopLevelManager {
314 explicit PassManagerImpl(int Depth) :
315 Pass(&ID), PMDataManager(Depth), PMTopLevelManager(TLM_Pass) { }
317 /// add - Add a pass to the queue of passes to run. This passes ownership of
318 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
319 /// will be destroyed as well, so there is no need to delete the pass. This
320 /// implies that all passes MUST be allocated with 'new'.
325 /// run - Execute all of the passes scheduled for execution. Keep track of
326 /// whether any of the passes modifies the module, and if so, return true.
329 /// Pass Manager itself does not invalidate any analysis info.
330 void getAnalysisUsage(AnalysisUsage &Info) const {
331 Info.setPreservesAll();
334 inline void addTopLevelPass(Pass *P) {
335 if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
337 // P is a immutable pass and it will be managed by this
338 // top level manager. Set up analysis resolver to connect them.
339 AnalysisResolver *AR = new AnalysisResolver(*this);
341 initializeAnalysisImpl(P);
342 addImmutablePass(IP);
343 recordAvailableAnalysis(IP);
345 P->assignPassManager(activeStack);
349 MPPassManager *getContainedManager(unsigned N) {
350 assert(N < PassManagers.size() && "Pass number out of range!");
351 MPPassManager *MP = static_cast<MPPassManager *>(PassManagers[N]);
356 char PassManagerImpl::ID = 0;
357 } // End of llvm namespace
361 //===----------------------------------------------------------------------===//
362 /// TimingInfo Class - This class is used to calculate information about the
363 /// amount of time each pass takes to execute. This only happens when
364 /// -time-passes is enabled on the command line.
367 static ManagedStatic<sys::SmartMutex<true> > TimingInfoMutex;
370 std::map<Pass*, Timer> TimingData;
374 // Use 'create' member to get this.
375 TimingInfo() : TG("... Pass execution timing report ...") {}
377 // TimingDtor - Print out information about timing information
379 // Delete all of the timers...
381 // TimerGroup is deleted next, printing the report.
384 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer
385 // to a non null value (if the -time-passes option is enabled) or it leaves it
386 // null. It may be called multiple times.
387 static void createTheTimeInfo();
389 /// passStarted - This method creates a timer for the given pass if it doesn't
390 /// already have one, and starts the timer.
391 Timer *passStarted(Pass *P) {
392 if (dynamic_cast<PMDataManager *>(P))
395 sys::SmartScopedLock<true> Lock(*TimingInfoMutex);
396 std::map<Pass*, Timer>::iterator I = TimingData.find(P);
397 if (I == TimingData.end())
398 I=TimingData.insert(std::make_pair(P, Timer(P->getPassName(), TG))).first;
399 Timer *T = &I->second;
405 } // End of anon namespace
407 static TimingInfo *TheTimeInfo;
409 //===----------------------------------------------------------------------===//
410 // PMTopLevelManager implementation
412 /// Initialize top level manager. Create first pass manager.
413 PMTopLevelManager::PMTopLevelManager(enum TopLevelManagerType t) {
415 MPPassManager *MPP = new MPPassManager(1);
416 MPP->setTopLevelManager(this);
418 activeStack.push(MPP);
419 } else if (t == TLM_Function) {
420 FPPassManager *FPP = new FPPassManager(1);
421 FPP->setTopLevelManager(this);
423 activeStack.push(FPP);
427 /// Set pass P as the last user of the given analysis passes.
428 void PMTopLevelManager::setLastUser(SmallVector<Pass *, 12> &AnalysisPasses,
430 for (SmallVector<Pass *, 12>::iterator I = AnalysisPasses.begin(),
431 E = AnalysisPasses.end(); I != E; ++I) {
438 // If AP is the last user of other passes then make P last user of
440 for (DenseMap<Pass *, Pass *>::iterator LUI = LastUser.begin(),
441 LUE = LastUser.end(); LUI != LUE; ++LUI) {
442 if (LUI->second == AP)
443 // DenseMap iterator is not invalidated here because
444 // this is just updating exisitng entry.
445 LastUser[LUI->first] = P;
450 /// Collect passes whose last user is P
451 void PMTopLevelManager::collectLastUses(SmallVector<Pass *, 12> &LastUses,
453 DenseMap<Pass *, SmallPtrSet<Pass *, 8> >::iterator DMI =
454 InversedLastUser.find(P);
455 if (DMI == InversedLastUser.end())
458 SmallPtrSet<Pass *, 8> &LU = DMI->second;
459 for (SmallPtrSet<Pass *, 8>::iterator I = LU.begin(),
460 E = LU.end(); I != E; ++I) {
461 LastUses.push_back(*I);
466 AnalysisUsage *PMTopLevelManager::findAnalysisUsage(Pass *P) {
467 AnalysisUsage *AnUsage = NULL;
468 DenseMap<Pass *, AnalysisUsage *>::iterator DMI = AnUsageMap.find(P);
469 if (DMI != AnUsageMap.end())
470 AnUsage = DMI->second;
472 AnUsage = new AnalysisUsage();
473 P->getAnalysisUsage(*AnUsage);
474 AnUsageMap[P] = AnUsage;
479 /// Schedule pass P for execution. Make sure that passes required by
480 /// P are run before P is run. Update analysis info maintained by
481 /// the manager. Remove dead passes. This is a recursive function.
482 void PMTopLevelManager::schedulePass(Pass *P) {
484 // TODO : Allocate function manager for this pass, other wise required set
485 // may be inserted into previous function manager
487 // Give pass a chance to prepare the stage.
488 P->preparePassManager(activeStack);
490 // If P is an analysis pass and it is available then do not
491 // generate the analysis again. Stale analysis info should not be
492 // available at this point.
493 if (P->getPassInfo() &&
494 P->getPassInfo()->isAnalysis() && findAnalysisPass(P->getPassInfo())) {
499 AnalysisUsage *AnUsage = findAnalysisUsage(P);
501 bool checkAnalysis = true;
502 while (checkAnalysis) {
503 checkAnalysis = false;
505 const AnalysisUsage::VectorType &RequiredSet = AnUsage->getRequiredSet();
506 for (AnalysisUsage::VectorType::const_iterator I = RequiredSet.begin(),
507 E = RequiredSet.end(); I != E; ++I) {
509 Pass *AnalysisPass = findAnalysisPass(*I);
511 AnalysisPass = (*I)->createPass();
512 if (P->getPotentialPassManagerType () ==
513 AnalysisPass->getPotentialPassManagerType())
514 // Schedule analysis pass that is managed by the same pass manager.
515 schedulePass(AnalysisPass);
516 else if (P->getPotentialPassManagerType () >
517 AnalysisPass->getPotentialPassManagerType()) {
518 // Schedule analysis pass that is managed by a new manager.
519 schedulePass(AnalysisPass);
520 // Recheck analysis passes to ensure that required analysises that
521 // are already checked are still available.
522 checkAnalysis = true;
525 // Do not schedule this analysis. Lower level analsyis
526 // passes are run on the fly.
532 // Now all required passes are available.
536 /// Find the pass that implements Analysis AID. Search immutable
537 /// passes and all pass managers. If desired pass is not found
538 /// then return NULL.
539 Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
542 // Check pass managers
543 for (SmallVector<PMDataManager *, 8>::iterator I = PassManagers.begin(),
544 E = PassManagers.end(); P == NULL && I != E; ++I) {
545 PMDataManager *PMD = *I;
546 P = PMD->findAnalysisPass(AID, false);
549 // Check other pass managers
550 for (SmallVector<PMDataManager *, 8>::iterator
551 I = IndirectPassManagers.begin(),
552 E = IndirectPassManagers.end(); P == NULL && I != E; ++I)
553 P = (*I)->findAnalysisPass(AID, false);
555 for (SmallVector<ImmutablePass *, 8>::iterator I = ImmutablePasses.begin(),
556 E = ImmutablePasses.end(); P == NULL && I != E; ++I) {
557 const PassInfo *PI = (*I)->getPassInfo();
561 // If Pass not found then check the interfaces implemented by Immutable Pass
563 const std::vector<const PassInfo*> &ImmPI =
564 PI->getInterfacesImplemented();
565 if (std::find(ImmPI.begin(), ImmPI.end(), AID) != ImmPI.end())
573 // Print passes managed by this top level manager.
574 void PMTopLevelManager::dumpPasses() const {
576 if (PassDebugging < Structure)
579 // Print out the immutable passes
580 for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
581 ImmutablePasses[i]->dumpPassStructure(0);
584 // Every class that derives from PMDataManager also derives from Pass
585 // (sometimes indirectly), but there's no inheritance relationship
586 // between PMDataManager and Pass, so we have to dynamic_cast to get
587 // from a PMDataManager* to a Pass*.
588 for (SmallVector<PMDataManager *, 8>::const_iterator I = PassManagers.begin(),
589 E = PassManagers.end(); I != E; ++I)
590 dynamic_cast<Pass *>(*I)->dumpPassStructure(1);
593 void PMTopLevelManager::dumpArguments() const {
595 if (PassDebugging < Arguments)
598 errs() << "Pass Arguments: ";
599 for (SmallVector<PMDataManager *, 8>::const_iterator I = PassManagers.begin(),
600 E = PassManagers.end(); I != E; ++I)
601 (*I)->dumpPassArguments();
605 void PMTopLevelManager::initializeAllAnalysisInfo() {
606 for (SmallVector<PMDataManager *, 8>::iterator I = PassManagers.begin(),
607 E = PassManagers.end(); I != E; ++I)
608 (*I)->initializeAnalysisInfo();
610 // Initailize other pass managers
611 for (SmallVector<PMDataManager *, 8>::iterator I = IndirectPassManagers.begin(),
612 E = IndirectPassManagers.end(); I != E; ++I)
613 (*I)->initializeAnalysisInfo();
615 for (DenseMap<Pass *, Pass *>::iterator DMI = LastUser.begin(),
616 DME = LastUser.end(); DMI != DME; ++DMI) {
617 DenseMap<Pass *, SmallPtrSet<Pass *, 8> >::iterator InvDMI =
618 InversedLastUser.find(DMI->second);
619 if (InvDMI != InversedLastUser.end()) {
620 SmallPtrSet<Pass *, 8> &L = InvDMI->second;
621 L.insert(DMI->first);
623 SmallPtrSet<Pass *, 8> L; L.insert(DMI->first);
624 InversedLastUser[DMI->second] = L;
630 PMTopLevelManager::~PMTopLevelManager() {
631 for (SmallVector<PMDataManager *, 8>::iterator I = PassManagers.begin(),
632 E = PassManagers.end(); I != E; ++I)
635 for (SmallVector<ImmutablePass *, 8>::iterator
636 I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
639 for (DenseMap<Pass *, AnalysisUsage *>::iterator DMI = AnUsageMap.begin(),
640 DME = AnUsageMap.end(); DMI != DME; ++DMI)
644 //===----------------------------------------------------------------------===//
645 // PMDataManager implementation
647 /// Augement AvailableAnalysis by adding analysis made available by pass P.
648 void PMDataManager::recordAvailableAnalysis(Pass *P) {
649 const PassInfo *PI = P->getPassInfo();
652 AvailableAnalysis[PI] = P;
654 //This pass is the current implementation of all of the interfaces it
655 //implements as well.
656 const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
657 for (unsigned i = 0, e = II.size(); i != e; ++i)
658 AvailableAnalysis[II[i]] = P;
661 // Return true if P preserves high level analysis used by other
662 // passes managed by this manager
663 bool PMDataManager::preserveHigherLevelAnalysis(Pass *P) {
664 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
665 if (AnUsage->getPreservesAll())
668 const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
669 for (SmallVector<Pass *, 8>::iterator I = HigherLevelAnalysis.begin(),
670 E = HigherLevelAnalysis.end(); I != E; ++I) {
672 if (!dynamic_cast<ImmutablePass*>(P1) &&
673 std::find(PreservedSet.begin(), PreservedSet.end(),
674 P1->getPassInfo()) ==
682 /// verifyPreservedAnalysis -- Verify analysis preserved by pass P.
683 void PMDataManager::verifyPreservedAnalysis(Pass *P) {
684 // Don't do this unless assertions are enabled.
688 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
689 const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
691 // Verify preserved analysis
692 for (AnalysisUsage::VectorType::const_iterator I = PreservedSet.begin(),
693 E = PreservedSet.end(); I != E; ++I) {
695 if (Pass *AP = findAnalysisPass(AID, true)) {
698 if (TheTimeInfo) T = TheTimeInfo->passStarted(AP);
699 AP->verifyAnalysis();
700 if (T) T->stopTimer();
705 /// Remove Analysis not preserved by Pass P
706 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
707 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
708 if (AnUsage->getPreservesAll())
711 const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
712 for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
713 E = AvailableAnalysis.end(); I != E; ) {
714 std::map<AnalysisID, Pass*>::iterator Info = I++;
715 if (!dynamic_cast<ImmutablePass*>(Info->second)
716 && std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
717 PreservedSet.end()) {
718 // Remove this analysis
719 if (PassDebugging >= Details) {
720 Pass *S = Info->second;
721 errs() << " -- '" << P->getPassName() << "' is not preserving '";
722 errs() << S->getPassName() << "'\n";
724 AvailableAnalysis.erase(Info);
728 // Check inherited analysis also. If P is not preserving analysis
729 // provided by parent manager then remove it here.
730 for (unsigned Index = 0; Index < PMT_Last; ++Index) {
732 if (!InheritedAnalysis[Index])
735 for (std::map<AnalysisID, Pass*>::iterator
736 I = InheritedAnalysis[Index]->begin(),
737 E = InheritedAnalysis[Index]->end(); I != E; ) {
738 std::map<AnalysisID, Pass *>::iterator Info = I++;
739 if (!dynamic_cast<ImmutablePass*>(Info->second) &&
740 std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
742 // Remove this analysis
743 InheritedAnalysis[Index]->erase(Info);
748 /// Remove analysis passes that are not used any longer
749 void PMDataManager::removeDeadPasses(Pass *P, const StringRef &Msg,
750 enum PassDebuggingString DBG_STR) {
752 SmallVector<Pass *, 12> DeadPasses;
754 // If this is a on the fly manager then it does not have TPM.
758 TPM->collectLastUses(DeadPasses, P);
760 if (PassDebugging >= Details && !DeadPasses.empty()) {
761 errs() << " -*- '" << P->getPassName();
762 errs() << "' is the last user of following pass instances.";
763 errs() << " Free these instances\n";
766 for (SmallVector<Pass *, 12>::iterator I = DeadPasses.begin(),
767 E = DeadPasses.end(); I != E; ++I)
768 freePass(*I, Msg, DBG_STR);
771 void PMDataManager::freePass(Pass *P, const StringRef &Msg,
772 enum PassDebuggingString DBG_STR) {
773 dumpPassInfo(P, FREEING_MSG, DBG_STR, Msg);
776 // If the pass crashes releasing memory, remember this.
777 PassManagerPrettyStackEntry X(P);
779 Timer *T = StartPassTimer(P);
784 if (const PassInfo *PI = P->getPassInfo()) {
785 // Remove the pass itself (if it is not already removed).
786 AvailableAnalysis.erase(PI);
788 // Remove all interfaces this pass implements, for which it is also
789 // listed as the available implementation.
790 const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
791 for (unsigned i = 0, e = II.size(); i != e; ++i) {
792 std::map<AnalysisID, Pass*>::iterator Pos =
793 AvailableAnalysis.find(II[i]);
794 if (Pos != AvailableAnalysis.end() && Pos->second == P)
795 AvailableAnalysis.erase(Pos);
800 /// Add pass P into the PassVector. Update
801 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
802 void PMDataManager::add(Pass *P, bool ProcessAnalysis) {
803 // This manager is going to manage pass P. Set up analysis resolver
805 AnalysisResolver *AR = new AnalysisResolver(*this);
808 // If a FunctionPass F is the last user of ModulePass info M
809 // then the F's manager, not F, records itself as a last user of M.
810 SmallVector<Pass *, 12> TransferLastUses;
812 if (!ProcessAnalysis) {
814 PassVector.push_back(P);
818 // At the moment, this pass is the last user of all required passes.
819 SmallVector<Pass *, 12> LastUses;
820 SmallVector<Pass *, 8> RequiredPasses;
821 SmallVector<AnalysisID, 8> ReqAnalysisNotAvailable;
823 unsigned PDepth = this->getDepth();
825 collectRequiredAnalysis(RequiredPasses,
826 ReqAnalysisNotAvailable, P);
827 for (SmallVector<Pass *, 8>::iterator I = RequiredPasses.begin(),
828 E = RequiredPasses.end(); I != E; ++I) {
829 Pass *PRequired = *I;
832 assert(PRequired->getResolver() && "Analysis Resolver is not set");
833 PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
834 RDepth = DM.getDepth();
836 if (PDepth == RDepth)
837 LastUses.push_back(PRequired);
838 else if (PDepth > RDepth) {
839 // Let the parent claim responsibility of last use
840 TransferLastUses.push_back(PRequired);
841 // Keep track of higher level analysis used by this manager.
842 HigherLevelAnalysis.push_back(PRequired);
844 llvm_unreachable("Unable to accomodate Required Pass");
847 // Set P as P's last user until someone starts using P.
848 // However, if P is a Pass Manager then it does not need
849 // to record its last user.
850 if (!dynamic_cast<PMDataManager *>(P))
851 LastUses.push_back(P);
852 TPM->setLastUser(LastUses, P);
854 if (!TransferLastUses.empty()) {
855 Pass *My_PM = dynamic_cast<Pass *>(this);
856 TPM->setLastUser(TransferLastUses, My_PM);
857 TransferLastUses.clear();
860 // Now, take care of required analysises that are not available.
861 for (SmallVector<AnalysisID, 8>::iterator
862 I = ReqAnalysisNotAvailable.begin(),
863 E = ReqAnalysisNotAvailable.end() ;I != E; ++I) {
864 Pass *AnalysisPass = (*I)->createPass();
865 this->addLowerLevelRequiredPass(P, AnalysisPass);
868 // Take a note of analysis required and made available by this pass.
869 // Remove the analysis not preserved by this pass
870 removeNotPreservedAnalysis(P);
871 recordAvailableAnalysis(P);
874 PassVector.push_back(P);
878 /// Populate RP with analysis pass that are required by
879 /// pass P and are available. Populate RP_NotAvail with analysis
880 /// pass that are required by pass P but are not available.
881 void PMDataManager::collectRequiredAnalysis(SmallVector<Pass *, 8>&RP,
882 SmallVector<AnalysisID, 8> &RP_NotAvail,
884 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
885 const AnalysisUsage::VectorType &RequiredSet = AnUsage->getRequiredSet();
886 for (AnalysisUsage::VectorType::const_iterator
887 I = RequiredSet.begin(), E = RequiredSet.end(); I != E; ++I) {
888 if (Pass *AnalysisPass = findAnalysisPass(*I, true))
889 RP.push_back(AnalysisPass);
891 RP_NotAvail.push_back(*I);
894 const AnalysisUsage::VectorType &IDs = AnUsage->getRequiredTransitiveSet();
895 for (AnalysisUsage::VectorType::const_iterator I = IDs.begin(),
896 E = IDs.end(); I != E; ++I) {
897 if (Pass *AnalysisPass = findAnalysisPass(*I, true))
898 RP.push_back(AnalysisPass);
900 RP_NotAvail.push_back(*I);
904 // All Required analyses should be available to the pass as it runs! Here
905 // we fill in the AnalysisImpls member of the pass so that it can
906 // successfully use the getAnalysis() method to retrieve the
907 // implementations it needs.
909 void PMDataManager::initializeAnalysisImpl(Pass *P) {
910 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
912 for (AnalysisUsage::VectorType::const_iterator
913 I = AnUsage->getRequiredSet().begin(),
914 E = AnUsage->getRequiredSet().end(); I != E; ++I) {
915 Pass *Impl = findAnalysisPass(*I, true);
917 // This may be analysis pass that is initialized on the fly.
918 // If that is not the case then it will raise an assert when it is used.
920 AnalysisResolver *AR = P->getResolver();
921 assert(AR && "Analysis Resolver is not set");
922 AR->addAnalysisImplsPair(*I, Impl);
926 /// Find the pass that implements Analysis AID. If desired pass is not found
927 /// then return NULL.
928 Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
930 // Check if AvailableAnalysis map has one entry.
931 std::map<AnalysisID, Pass*>::const_iterator I = AvailableAnalysis.find(AID);
933 if (I != AvailableAnalysis.end())
936 // Search Parents through TopLevelManager
938 return TPM->findAnalysisPass(AID);
943 // Print list of passes that are last used by P.
944 void PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{
946 SmallVector<Pass *, 12> LUses;
948 // If this is a on the fly manager then it does not have TPM.
952 TPM->collectLastUses(LUses, P);
954 for (SmallVector<Pass *, 12>::iterator I = LUses.begin(),
955 E = LUses.end(); I != E; ++I) {
956 llvm::errs() << "--" << std::string(Offset*2, ' ');
957 (*I)->dumpPassStructure(0);
961 void PMDataManager::dumpPassArguments() const {
962 for (SmallVector<Pass *, 8>::const_iterator I = PassVector.begin(),
963 E = PassVector.end(); I != E; ++I) {
964 if (PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I))
965 PMD->dumpPassArguments();
967 if (const PassInfo *PI = (*I)->getPassInfo())
968 if (!PI->isAnalysisGroup())
969 errs() << " -" << PI->getPassArgument();
973 void PMDataManager::dumpPassInfo(Pass *P, enum PassDebuggingString S1,
974 enum PassDebuggingString S2,
975 const StringRef &Msg) {
976 if (PassDebugging < Executions)
978 errs() << (void*)this << std::string(getDepth()*2+1, ' ');
981 errs() << "Executing Pass '" << P->getPassName();
983 case MODIFICATION_MSG:
984 errs() << "Made Modification '" << P->getPassName();
987 errs() << " Freeing Pass '" << P->getPassName();
993 case ON_BASICBLOCK_MSG:
994 errs() << "' on BasicBlock '" << Msg << "'...\n";
996 case ON_FUNCTION_MSG:
997 errs() << "' on Function '" << Msg << "'...\n";
1000 errs() << "' on Module '" << Msg << "'...\n";
1003 errs() << "' on Loop '" << Msg << "'...\n";
1006 errs() << "' on Call Graph Nodes '" << Msg << "'...\n";
1013 void PMDataManager::dumpRequiredSet(const Pass *P) const {
1014 if (PassDebugging < Details)
1017 AnalysisUsage analysisUsage;
1018 P->getAnalysisUsage(analysisUsage);
1019 dumpAnalysisUsage("Required", P, analysisUsage.getRequiredSet());
1022 void PMDataManager::dumpPreservedSet(const Pass *P) const {
1023 if (PassDebugging < Details)
1026 AnalysisUsage analysisUsage;
1027 P->getAnalysisUsage(analysisUsage);
1028 dumpAnalysisUsage("Preserved", P, analysisUsage.getPreservedSet());
1031 void PMDataManager::dumpAnalysisUsage(const StringRef &Msg, const Pass *P,
1032 const AnalysisUsage::VectorType &Set) const {
1033 assert(PassDebugging >= Details);
1036 errs() << (void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:";
1037 for (unsigned i = 0; i != Set.size(); ++i) {
1038 if (i) errs() << ',';
1039 errs() << ' ' << Set[i]->getPassName();
1044 /// Add RequiredPass into list of lower level passes required by pass P.
1045 /// RequiredPass is run on the fly by Pass Manager when P requests it
1046 /// through getAnalysis interface.
1047 /// This should be handled by specific pass manager.
1048 void PMDataManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
1050 TPM->dumpArguments();
1054 // Module Level pass may required Function Level analysis info
1055 // (e.g. dominator info). Pass manager uses on the fly function pass manager
1056 // to provide this on demand. In that case, in Pass manager terminology,
1057 // module level pass is requiring lower level analysis info managed by
1058 // lower level pass manager.
1060 // When Pass manager is not able to order required analysis info, Pass manager
1061 // checks whether any lower level manager will be able to provide this
1062 // analysis info on demand or not.
1064 errs() << "Unable to schedule '" << RequiredPass->getPassName();
1065 errs() << "' required by '" << P->getPassName() << "'\n";
1067 llvm_unreachable("Unable to schedule pass");
1071 PMDataManager::~PMDataManager() {
1072 for (SmallVector<Pass *, 8>::iterator I = PassVector.begin(),
1073 E = PassVector.end(); I != E; ++I)
1077 //===----------------------------------------------------------------------===//
1078 // NOTE: Is this the right place to define this method ?
1079 // getAnalysisIfAvailable - Return analysis result or null if it doesn't exist.
1080 Pass *AnalysisResolver::getAnalysisIfAvailable(AnalysisID ID, bool dir) const {
1081 return PM.findAnalysisPass(ID, dir);
1084 Pass *AnalysisResolver::findImplPass(Pass *P, const PassInfo *AnalysisPI,
1086 return PM.getOnTheFlyPass(P, AnalysisPI, F);
1089 //===----------------------------------------------------------------------===//
1090 // BBPassManager implementation
1092 /// Execute all of the passes scheduled for execution by invoking
1093 /// runOnBasicBlock method. Keep track of whether any of the passes modifies
1094 /// the function, and if so, return true.
1095 bool BBPassManager::runOnFunction(Function &F) {
1096 if (F.isDeclaration())
1099 bool Changed = doInitialization(F);
1101 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
1102 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1103 BasicBlockPass *BP = getContainedPass(Index);
1105 dumpPassInfo(BP, EXECUTION_MSG, ON_BASICBLOCK_MSG, I->getName());
1106 dumpRequiredSet(BP);
1108 initializeAnalysisImpl(BP);
1111 // If the pass crashes, remember this.
1112 PassManagerPrettyStackEntry X(BP, *I);
1114 Timer *T = StartPassTimer(BP);
1115 Changed |= BP->runOnBasicBlock(*I);
1116 StopPassTimer(BP, T);
1120 dumpPassInfo(BP, MODIFICATION_MSG, ON_BASICBLOCK_MSG,
1122 dumpPreservedSet(BP);
1124 verifyPreservedAnalysis(BP);
1125 removeNotPreservedAnalysis(BP);
1126 recordAvailableAnalysis(BP);
1127 removeDeadPasses(BP, I->getName(), ON_BASICBLOCK_MSG);
1130 return Changed |= doFinalization(F);
1133 // Implement doInitialization and doFinalization
1134 bool BBPassManager::doInitialization(Module &M) {
1135 bool Changed = false;
1137 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1138 Changed |= getContainedPass(Index)->doInitialization(M);
1143 bool BBPassManager::doFinalization(Module &M) {
1144 bool Changed = false;
1146 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1147 Changed |= getContainedPass(Index)->doFinalization(M);
1152 bool BBPassManager::doInitialization(Function &F) {
1153 bool Changed = false;
1155 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1156 BasicBlockPass *BP = getContainedPass(Index);
1157 Changed |= BP->doInitialization(F);
1163 bool BBPassManager::doFinalization(Function &F) {
1164 bool Changed = false;
1166 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1167 BasicBlockPass *BP = getContainedPass(Index);
1168 Changed |= BP->doFinalization(F);
1175 //===----------------------------------------------------------------------===//
1176 // FunctionPassManager implementation
1178 /// Create new Function pass manager
1179 FunctionPassManager::FunctionPassManager(ModuleProvider *P) {
1180 FPM = new FunctionPassManagerImpl(0);
1181 // FPM is the top level manager.
1182 FPM->setTopLevelManager(FPM);
1184 AnalysisResolver *AR = new AnalysisResolver(*FPM);
1185 FPM->setResolver(AR);
1190 FunctionPassManager::~FunctionPassManager() {
1194 /// add - Add a pass to the queue of passes to run. This passes
1195 /// ownership of the Pass to the PassManager. When the
1196 /// PassManager_X is destroyed, the pass will be destroyed as well, so
1197 /// there is no need to delete the pass. (TODO delete passes.)
1198 /// This implies that all passes MUST be allocated with 'new'.
1199 void FunctionPassManager::add(Pass *P) {
1203 /// run - Execute all of the passes scheduled for execution. Keep
1204 /// track of whether any of the passes modifies the function, and if
1205 /// so, return true.
1207 bool FunctionPassManager::run(Function &F) {
1209 if (MP->materializeFunction(&F, &errstr)) {
1210 llvm_report_error("Error reading bitcode file: " + errstr);
1216 /// doInitialization - Run all of the initializers for the function passes.
1218 bool FunctionPassManager::doInitialization() {
1219 return FPM->doInitialization(*MP->getModule());
1222 /// doFinalization - Run all of the finalizers for the function passes.
1224 bool FunctionPassManager::doFinalization() {
1225 return FPM->doFinalization(*MP->getModule());
1228 //===----------------------------------------------------------------------===//
1229 // FunctionPassManagerImpl implementation
1231 bool FunctionPassManagerImpl::doInitialization(Module &M) {
1232 bool Changed = false;
1234 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1235 Changed |= getContainedManager(Index)->doInitialization(M);
1240 bool FunctionPassManagerImpl::doFinalization(Module &M) {
1241 bool Changed = false;
1243 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1244 Changed |= getContainedManager(Index)->doFinalization(M);
1249 /// cleanup - After running all passes, clean up pass manager cache.
1250 void FPPassManager::cleanup() {
1251 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1252 FunctionPass *FP = getContainedPass(Index);
1253 AnalysisResolver *AR = FP->getResolver();
1254 assert(AR && "Analysis Resolver is not set");
1255 AR->clearAnalysisImpls();
1259 void FunctionPassManagerImpl::releaseMemoryOnTheFly() {
1262 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1263 FPPassManager *FPPM = getContainedManager(Index);
1264 for (unsigned Index = 0; Index < FPPM->getNumContainedPasses(); ++Index) {
1265 FPPM->getContainedPass(Index)->releaseMemory();
1271 // Execute all the passes managed by this top level manager.
1272 // Return true if any function is modified by a pass.
1273 bool FunctionPassManagerImpl::run(Function &F) {
1274 bool Changed = false;
1275 TimingInfo::createTheTimeInfo();
1280 initializeAllAnalysisInfo();
1281 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1282 Changed |= getContainedManager(Index)->runOnFunction(F);
1284 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1285 getContainedManager(Index)->cleanup();
1291 //===----------------------------------------------------------------------===//
1292 // FPPassManager implementation
1294 char FPPassManager::ID = 0;
1295 /// Print passes managed by this manager
1296 void FPPassManager::dumpPassStructure(unsigned Offset) {
1297 llvm::errs() << std::string(Offset*2, ' ') << "FunctionPass Manager\n";
1298 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1299 FunctionPass *FP = getContainedPass(Index);
1300 FP->dumpPassStructure(Offset + 1);
1301 dumpLastUses(FP, Offset+1);
1306 /// Execute all of the passes scheduled for execution by invoking
1307 /// runOnFunction method. Keep track of whether any of the passes modifies
1308 /// the function, and if so, return true.
1309 bool FPPassManager::runOnFunction(Function &F) {
1310 if (F.isDeclaration())
1313 bool Changed = false;
1315 // Collect inherited analysis from Module level pass manager.
1316 populateInheritedAnalysis(TPM->activeStack);
1318 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1319 FunctionPass *FP = getContainedPass(Index);
1321 dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getName());
1322 dumpRequiredSet(FP);
1324 initializeAnalysisImpl(FP);
1327 PassManagerPrettyStackEntry X(FP, F);
1329 Timer *T = StartPassTimer(FP);
1330 Changed |= FP->runOnFunction(F);
1331 StopPassTimer(FP, T);
1335 dumpPassInfo(FP, MODIFICATION_MSG, ON_FUNCTION_MSG, F.getName());
1336 dumpPreservedSet(FP);
1338 verifyPreservedAnalysis(FP);
1339 removeNotPreservedAnalysis(FP);
1340 recordAvailableAnalysis(FP);
1341 removeDeadPasses(FP, F.getName(), ON_FUNCTION_MSG);
1346 bool FPPassManager::runOnModule(Module &M) {
1347 bool Changed = doInitialization(M);
1349 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1352 return Changed |= doFinalization(M);
1355 bool FPPassManager::doInitialization(Module &M) {
1356 bool Changed = false;
1358 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1359 Changed |= getContainedPass(Index)->doInitialization(M);
1364 bool FPPassManager::doFinalization(Module &M) {
1365 bool Changed = false;
1367 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1368 Changed |= getContainedPass(Index)->doFinalization(M);
1373 //===----------------------------------------------------------------------===//
1374 // MPPassManager implementation
1376 /// Execute all of the passes scheduled for execution by invoking
1377 /// runOnModule method. Keep track of whether any of the passes modifies
1378 /// the module, and if so, return true.
1380 MPPassManager::runOnModule(Module &M) {
1381 bool Changed = false;
1383 // Initialize on-the-fly passes
1384 for (std::map<Pass *, FunctionPassManagerImpl *>::iterator
1385 I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end();
1387 FunctionPassManagerImpl *FPP = I->second;
1388 Changed |= FPP->doInitialization(M);
1391 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1392 ModulePass *MP = getContainedPass(Index);
1394 dumpPassInfo(MP, EXECUTION_MSG, ON_MODULE_MSG,
1395 M.getModuleIdentifier().c_str());
1396 dumpRequiredSet(MP);
1398 initializeAnalysisImpl(MP);
1401 PassManagerPrettyStackEntry X(MP, M);
1402 Timer *T = StartPassTimer(MP);
1403 Changed |= MP->runOnModule(M);
1404 StopPassTimer(MP, T);
1408 dumpPassInfo(MP, MODIFICATION_MSG, ON_MODULE_MSG,
1409 M.getModuleIdentifier().c_str());
1410 dumpPreservedSet(MP);
1412 verifyPreservedAnalysis(MP);
1413 removeNotPreservedAnalysis(MP);
1414 recordAvailableAnalysis(MP);
1415 removeDeadPasses(MP, M.getModuleIdentifier().c_str(), ON_MODULE_MSG);
1418 // Finalize on-the-fly passes
1419 for (std::map<Pass *, FunctionPassManagerImpl *>::iterator
1420 I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end();
1422 FunctionPassManagerImpl *FPP = I->second;
1423 // We don't know when is the last time an on-the-fly pass is run,
1424 // so we need to releaseMemory / finalize here
1425 FPP->releaseMemoryOnTheFly();
1426 Changed |= FPP->doFinalization(M);
1431 /// Add RequiredPass into list of lower level passes required by pass P.
1432 /// RequiredPass is run on the fly by Pass Manager when P requests it
1433 /// through getAnalysis interface.
1434 void MPPassManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
1435 assert(P->getPotentialPassManagerType() == PMT_ModulePassManager &&
1436 "Unable to handle Pass that requires lower level Analysis pass");
1437 assert((P->getPotentialPassManagerType() <
1438 RequiredPass->getPotentialPassManagerType()) &&
1439 "Unable to handle Pass that requires lower level Analysis pass");
1441 FunctionPassManagerImpl *FPP = OnTheFlyManagers[P];
1443 FPP = new FunctionPassManagerImpl(0);
1444 // FPP is the top level manager.
1445 FPP->setTopLevelManager(FPP);
1447 OnTheFlyManagers[P] = FPP;
1449 FPP->add(RequiredPass);
1451 // Register P as the last user of RequiredPass.
1452 SmallVector<Pass *, 12> LU;
1453 LU.push_back(RequiredPass);
1454 FPP->setLastUser(LU, P);
1457 /// Return function pass corresponding to PassInfo PI, that is
1458 /// required by module pass MP. Instantiate analysis pass, by using
1459 /// its runOnFunction() for function F.
1460 Pass* MPPassManager::getOnTheFlyPass(Pass *MP, const PassInfo *PI, Function &F){
1461 FunctionPassManagerImpl *FPP = OnTheFlyManagers[MP];
1462 assert(FPP && "Unable to find on the fly pass");
1464 FPP->releaseMemoryOnTheFly();
1466 return (dynamic_cast<PMTopLevelManager *>(FPP))->findAnalysisPass(PI);
1470 //===----------------------------------------------------------------------===//
1471 // PassManagerImpl implementation
1473 /// run - Execute all of the passes scheduled for execution. Keep track of
1474 /// whether any of the passes modifies the module, and if so, return true.
1475 bool PassManagerImpl::run(Module &M) {
1476 bool Changed = false;
1477 TimingInfo::createTheTimeInfo();
1482 initializeAllAnalysisInfo();
1483 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1484 Changed |= getContainedManager(Index)->runOnModule(M);
1488 //===----------------------------------------------------------------------===//
1489 // PassManager implementation
1491 /// Create new pass manager
1492 PassManager::PassManager() {
1493 PM = new PassManagerImpl(0);
1494 // PM is the top level manager
1495 PM->setTopLevelManager(PM);
1498 PassManager::~PassManager() {
1502 /// add - Add a pass to the queue of passes to run. This passes ownership of
1503 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
1504 /// will be destroyed as well, so there is no need to delete the pass. This
1505 /// implies that all passes MUST be allocated with 'new'.
1506 void PassManager::add(Pass *P) {
1510 /// run - Execute all of the passes scheduled for execution. Keep track of
1511 /// whether any of the passes modifies the module, and if so, return true.
1512 bool PassManager::run(Module &M) {
1516 //===----------------------------------------------------------------------===//
1517 // TimingInfo Class - This class is used to calculate information about the
1518 // amount of time each pass takes to execute. This only happens with
1519 // -time-passes is enabled on the command line.
1521 bool llvm::TimePassesIsEnabled = false;
1522 static cl::opt<bool,true>
1523 EnableTiming("time-passes", cl::location(TimePassesIsEnabled),
1524 cl::desc("Time each pass, printing elapsed time for each on exit"));
1526 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
1527 // a non null value (if the -time-passes option is enabled) or it leaves it
1528 // null. It may be called multiple times.
1529 void TimingInfo::createTheTimeInfo() {
1530 if (!TimePassesIsEnabled || TheTimeInfo) return;
1532 // Constructed the first time this is called, iff -time-passes is enabled.
1533 // This guarantees that the object will be constructed before static globals,
1534 // thus it will be destroyed before them.
1535 static ManagedStatic<TimingInfo> TTI;
1536 TheTimeInfo = &*TTI;
1539 /// If TimingInfo is enabled then start pass timer.
1540 Timer *llvm::StartPassTimer(Pass *P) {
1542 return TheTimeInfo->passStarted(P);
1546 /// If TimingInfo is enabled then stop pass timer.
1547 void llvm::StopPassTimer(Pass *P, Timer *T) {
1548 if (T) T->stopTimer();
1551 //===----------------------------------------------------------------------===//
1552 // PMStack implementation
1555 // Pop Pass Manager from the stack and clear its analysis info.
1556 void PMStack::pop() {
1558 PMDataManager *Top = this->top();
1559 Top->initializeAnalysisInfo();
1564 // Push PM on the stack and set its top level manager.
1565 void PMStack::push(PMDataManager *PM) {
1566 assert(PM && "Unable to push. Pass Manager expected");
1568 if (!this->empty()) {
1569 PMTopLevelManager *TPM = this->top()->getTopLevelManager();
1571 assert(TPM && "Unable to find top level manager");
1572 TPM->addIndirectPassManager(PM);
1573 PM->setTopLevelManager(TPM);
1579 // Dump content of the pass manager stack.
1580 void PMStack::dump() {
1581 for (std::deque<PMDataManager *>::iterator I = S.begin(),
1582 E = S.end(); I != E; ++I)
1583 printf("%s ", dynamic_cast<Pass *>(*I)->getPassName());
1589 /// Find appropriate Module Pass Manager in the PM Stack and
1590 /// add self into that manager.
1591 void ModulePass::assignPassManager(PMStack &PMS,
1592 PassManagerType PreferredType) {
1593 // Find Module Pass Manager
1594 while(!PMS.empty()) {
1595 PassManagerType TopPMType = PMS.top()->getPassManagerType();
1596 if (TopPMType == PreferredType)
1597 break; // We found desired pass manager
1598 else if (TopPMType > PMT_ModulePassManager)
1599 PMS.pop(); // Pop children pass managers
1603 assert(!PMS.empty() && "Unable to find appropriate Pass Manager");
1604 PMS.top()->add(this);
1607 /// Find appropriate Function Pass Manager or Call Graph Pass Manager
1608 /// in the PM Stack and add self into that manager.
1609 void FunctionPass::assignPassManager(PMStack &PMS,
1610 PassManagerType PreferredType) {
1612 // Find Module Pass Manager
1613 while(!PMS.empty()) {
1614 if (PMS.top()->getPassManagerType() > PMT_FunctionPassManager)
1619 FPPassManager *FPP = dynamic_cast<FPPassManager *>(PMS.top());
1621 // Create new Function Pass Manager
1623 assert(!PMS.empty() && "Unable to create Function Pass Manager");
1624 PMDataManager *PMD = PMS.top();
1626 // [1] Create new Function Pass Manager
1627 FPP = new FPPassManager(PMD->getDepth() + 1);
1628 FPP->populateInheritedAnalysis(PMS);
1630 // [2] Set up new manager's top level manager
1631 PMTopLevelManager *TPM = PMD->getTopLevelManager();
1632 TPM->addIndirectPassManager(FPP);
1634 // [3] Assign manager to manage this new manager. This may create
1635 // and push new managers into PMS
1636 FPP->assignPassManager(PMS, PMD->getPassManagerType());
1638 // [4] Push new manager into PMS
1642 // Assign FPP as the manager of this pass.
1646 /// Find appropriate Basic Pass Manager or Call Graph Pass Manager
1647 /// in the PM Stack and add self into that manager.
1648 void BasicBlockPass::assignPassManager(PMStack &PMS,
1649 PassManagerType PreferredType) {
1650 BBPassManager *BBP = NULL;
1652 // Basic Pass Manager is a leaf pass manager. It does not handle
1653 // any other pass manager.
1655 BBP = dynamic_cast<BBPassManager *>(PMS.top());
1657 // If leaf manager is not Basic Block Pass manager then create new
1658 // basic Block Pass manager.
1661 assert(!PMS.empty() && "Unable to create BasicBlock Pass Manager");
1662 PMDataManager *PMD = PMS.top();
1664 // [1] Create new Basic Block Manager
1665 BBP = new BBPassManager(PMD->getDepth() + 1);
1667 // [2] Set up new manager's top level manager
1668 // Basic Block Pass Manager does not live by itself
1669 PMTopLevelManager *TPM = PMD->getTopLevelManager();
1670 TPM->addIndirectPassManager(BBP);
1672 // [3] Assign manager to manage this new manager. This may create
1673 // and push new managers into PMS
1674 BBP->assignPassManager(PMS);
1676 // [4] Push new manager into PMS
1680 // Assign BBP as the manager of this pass.
1684 PassManagerBase::~PassManagerBase() {}
1686 /*===-- C Bindings --------------------------------------------------------===*/
1688 LLVMPassManagerRef LLVMCreatePassManager() {
1689 return wrap(new PassManager());
1692 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef P) {
1693 return wrap(new FunctionPassManager(unwrap(P)));
1696 int LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M) {
1697 return unwrap<PassManager>(PM)->run(*unwrap(M));
1700 int LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM) {
1701 return unwrap<FunctionPassManager>(FPM)->doInitialization();
1704 int LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F) {
1705 return unwrap<FunctionPassManager>(FPM)->run(*unwrap<Function>(F));
1708 int LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM) {
1709 return unwrap<FunctionPassManager>(FPM)->doFinalization();
1712 void LLVMDisposePassManager(LLVMPassManagerRef PM) {