1 //===- LegacyPassManager.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 legacy LLVM Pass Manager infrastructure.
12 //===----------------------------------------------------------------------===//
15 #include "llvm/IR/LLVMContext.h"
16 #include "llvm/IR/IRPrintingPasses.h"
17 #include "llvm/IR/LegacyPassManager.h"
18 #include "llvm/IR/LegacyPassManagers.h"
19 #include "llvm/IR/LegacyPassNameParser.h"
20 #include "llvm/IR/Module.h"
21 #include "llvm/Support/CommandLine.h"
22 #include "llvm/Support/Debug.h"
23 #include "llvm/Support/ErrorHandling.h"
24 #include "llvm/Support/ManagedStatic.h"
25 #include "llvm/Support/Mutex.h"
26 #include "llvm/Support/TimeValue.h"
27 #include "llvm/Support/Timer.h"
28 #include "llvm/Support/raw_ostream.h"
32 using namespace llvm::legacy;
34 // 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.
44 // Different debug levels that can be enabled...
46 Disabled, Arguments, Structure, Executions, Details
50 static cl::opt<enum PassDebugLevel>
51 PassDebugging("debug-pass", cl::Hidden,
52 cl::desc("Print PassManager debugging information"),
54 clEnumVal(Disabled , "disable debug output"),
55 clEnumVal(Arguments , "print pass arguments to pass to 'opt'"),
56 clEnumVal(Structure , "print pass structure before run()"),
57 clEnumVal(Executions, "print pass name before it is executed"),
58 clEnumVal(Details , "print pass details when it is executed"),
62 typedef llvm::cl::list<const llvm::PassInfo *, bool, PassNameParser>
66 // Print IR out before/after specified passes.
68 PrintBefore("print-before",
69 llvm::cl::desc("Print IR before specified passes"),
73 PrintAfter("print-after",
74 llvm::cl::desc("Print IR after specified passes"),
78 PrintBeforeAll("print-before-all",
79 llvm::cl::desc("Print IR before each pass"),
82 PrintAfterAll("print-after-all",
83 llvm::cl::desc("Print IR after each pass"),
86 /// This is a helper to determine whether to print IR before or
89 static bool ShouldPrintBeforeOrAfterPass(const PassInfo *PI,
90 PassOptionList &PassesToPrint) {
91 for (unsigned i = 0, ie = PassesToPrint.size(); i < ie; ++i) {
92 const llvm::PassInfo *PassInf = PassesToPrint[i];
94 if (PassInf->getPassArgument() == PI->getPassArgument()) {
101 /// This is a utility to check whether a pass should have IR dumped
103 static bool ShouldPrintBeforePass(const PassInfo *PI) {
104 return PrintBeforeAll || ShouldPrintBeforeOrAfterPass(PI, PrintBefore);
107 /// This is a utility to check whether a pass should have IR dumped
109 static bool ShouldPrintAfterPass(const PassInfo *PI) {
110 return PrintAfterAll || ShouldPrintBeforeOrAfterPass(PI, PrintAfter);
113 /// isPassDebuggingExecutionsOrMore - Return true if -debug-pass=Executions
114 /// or higher is specified.
115 bool PMDataManager::isPassDebuggingExecutionsOrMore() const {
116 return PassDebugging >= Executions;
122 void PassManagerPrettyStackEntry::print(raw_ostream &OS) const {
124 OS << "Releasing pass '";
126 OS << "Running pass '";
128 OS << P->getPassName() << "'";
131 OS << " on module '" << M->getModuleIdentifier() << "'.\n";
140 if (isa<Function>(V))
142 else if (isa<BasicBlock>(V))
148 V->printAsOperand(OS, /*PrintTy=*/false, M);
154 //===----------------------------------------------------------------------===//
157 /// BBPassManager manages BasicBlockPass. It batches all the
158 /// pass together and sequence them to process one basic block before
159 /// processing next basic block.
160 class BBPassManager : public PMDataManager, public FunctionPass {
164 explicit BBPassManager()
165 : PMDataManager(), FunctionPass(ID) {}
167 /// Execute all of the passes scheduled for execution. Keep track of
168 /// whether any of the passes modifies the function, and if so, return true.
169 bool runOnFunction(Function &F) override;
171 /// Pass Manager itself does not invalidate any analysis info.
172 void getAnalysisUsage(AnalysisUsage &Info) const override {
173 Info.setPreservesAll();
176 bool doInitialization(Module &M) override;
177 bool doInitialization(Function &F);
178 bool doFinalization(Module &M) override;
179 bool doFinalization(Function &F);
181 PMDataManager *getAsPMDataManager() override { return this; }
182 Pass *getAsPass() override { return this; }
184 const char *getPassName() const override {
185 return "BasicBlock Pass Manager";
188 // Print passes managed by this manager
189 void dumpPassStructure(unsigned Offset) override {
190 dbgs().indent(Offset*2) << "BasicBlockPass Manager\n";
191 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
192 BasicBlockPass *BP = getContainedPass(Index);
193 BP->dumpPassStructure(Offset + 1);
194 dumpLastUses(BP, Offset+1);
198 BasicBlockPass *getContainedPass(unsigned N) {
199 assert(N < PassVector.size() && "Pass number out of range!");
200 BasicBlockPass *BP = static_cast<BasicBlockPass *>(PassVector[N]);
204 PassManagerType getPassManagerType() const override {
205 return PMT_BasicBlockPassManager;
209 char BBPassManager::ID = 0;
210 } // End anonymous namespace
214 //===----------------------------------------------------------------------===//
215 // FunctionPassManagerImpl
217 /// FunctionPassManagerImpl manages FPPassManagers
218 class FunctionPassManagerImpl : public Pass,
219 public PMDataManager,
220 public PMTopLevelManager {
221 virtual void anchor();
226 explicit FunctionPassManagerImpl() :
227 Pass(PT_PassManager, ID), PMDataManager(),
228 PMTopLevelManager(new FPPassManager()), wasRun(false) {}
230 /// add - Add a pass to the queue of passes to run. This passes ownership of
231 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
232 /// will be destroyed as well, so there is no need to delete the pass. This
233 /// implies that all passes MUST be allocated with 'new'.
238 /// createPrinterPass - Get a function printer pass.
239 Pass *createPrinterPass(raw_ostream &O,
240 const std::string &Banner) const override {
241 return createPrintFunctionPass(O, Banner);
244 // Prepare for running an on the fly pass, freeing memory if needed
245 // from a previous run.
246 void releaseMemoryOnTheFly();
248 /// run - Execute all of the passes scheduled for execution. Keep track of
249 /// whether any of the passes modifies the module, and if so, return true.
250 bool run(Function &F);
252 /// doInitialization - Run all of the initializers for the function passes.
254 bool doInitialization(Module &M) override;
256 /// doFinalization - Run all of the finalizers for the function passes.
258 bool doFinalization(Module &M) override;
261 PMDataManager *getAsPMDataManager() override { return this; }
262 Pass *getAsPass() override { return this; }
263 PassManagerType getTopLevelPassManagerType() override {
264 return PMT_FunctionPassManager;
267 /// Pass Manager itself does not invalidate any analysis info.
268 void getAnalysisUsage(AnalysisUsage &Info) const override {
269 Info.setPreservesAll();
272 FPPassManager *getContainedManager(unsigned N) {
273 assert(N < PassManagers.size() && "Pass number out of range!");
274 FPPassManager *FP = static_cast<FPPassManager *>(PassManagers[N]);
279 void FunctionPassManagerImpl::anchor() {}
281 char FunctionPassManagerImpl::ID = 0;
282 } // End of legacy namespace
283 } // End of llvm namespace
286 //===----------------------------------------------------------------------===//
289 /// MPPassManager manages ModulePasses and function pass managers.
290 /// It batches all Module passes and function pass managers together and
291 /// sequences them to process one module.
292 class MPPassManager : public Pass, public PMDataManager {
295 explicit MPPassManager() :
296 Pass(PT_PassManager, ID), PMDataManager() { }
298 // Delete on the fly managers.
299 virtual ~MPPassManager() {
300 for (std::map<Pass *, FunctionPassManagerImpl *>::iterator
301 I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end();
303 FunctionPassManagerImpl *FPP = I->second;
308 /// createPrinterPass - Get a module printer pass.
309 Pass *createPrinterPass(raw_ostream &O,
310 const std::string &Banner) const override {
311 return createPrintModulePass(O, Banner);
314 /// run - Execute all of the passes scheduled for execution. Keep track of
315 /// whether any of the passes modifies the module, and if so, return true.
316 bool runOnModule(Module &M);
318 using llvm::Pass::doInitialization;
319 using llvm::Pass::doFinalization;
321 /// doInitialization - Run all of the initializers for the module passes.
323 bool doInitialization();
325 /// doFinalization - Run all of the finalizers for the module passes.
327 bool doFinalization();
329 /// Pass Manager itself does not invalidate any analysis info.
330 void getAnalysisUsage(AnalysisUsage &Info) const override {
331 Info.setPreservesAll();
334 /// Add RequiredPass into list of lower level passes required by pass P.
335 /// RequiredPass is run on the fly by Pass Manager when P requests it
336 /// through getAnalysis interface.
337 void addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) override;
339 /// Return function pass corresponding to PassInfo PI, that is
340 /// required by module pass MP. Instantiate analysis pass, by using
341 /// its runOnFunction() for function F.
342 Pass* getOnTheFlyPass(Pass *MP, AnalysisID PI, Function &F) override;
344 const char *getPassName() const override {
345 return "Module Pass Manager";
348 PMDataManager *getAsPMDataManager() override { return this; }
349 Pass *getAsPass() override { return this; }
351 // Print passes managed by this manager
352 void dumpPassStructure(unsigned Offset) override {
353 dbgs().indent(Offset*2) << "ModulePass Manager\n";
354 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
355 ModulePass *MP = getContainedPass(Index);
356 MP->dumpPassStructure(Offset + 1);
357 std::map<Pass *, FunctionPassManagerImpl *>::const_iterator I =
358 OnTheFlyManagers.find(MP);
359 if (I != OnTheFlyManagers.end())
360 I->second->dumpPassStructure(Offset + 2);
361 dumpLastUses(MP, Offset+1);
365 ModulePass *getContainedPass(unsigned N) {
366 assert(N < PassVector.size() && "Pass number out of range!");
367 return static_cast<ModulePass *>(PassVector[N]);
370 PassManagerType getPassManagerType() const override {
371 return PMT_ModulePassManager;
375 /// Collection of on the fly FPPassManagers. These managers manage
376 /// function passes that are required by module passes.
377 std::map<Pass *, FunctionPassManagerImpl *> OnTheFlyManagers;
380 char MPPassManager::ID = 0;
381 } // End anonymous namespace
385 //===----------------------------------------------------------------------===//
389 /// PassManagerImpl manages MPPassManagers
390 class PassManagerImpl : public Pass,
391 public PMDataManager,
392 public PMTopLevelManager {
393 virtual void anchor();
397 explicit PassManagerImpl() :
398 Pass(PT_PassManager, ID), PMDataManager(),
399 PMTopLevelManager(new MPPassManager()) {}
401 /// add - Add a pass to the queue of passes to run. This passes ownership of
402 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
403 /// will be destroyed as well, so there is no need to delete the pass. This
404 /// implies that all passes MUST be allocated with 'new'.
409 /// createPrinterPass - Get a module printer pass.
410 Pass *createPrinterPass(raw_ostream &O,
411 const std::string &Banner) const override {
412 return createPrintModulePass(O, Banner);
415 /// run - Execute all of the passes scheduled for execution. Keep track of
416 /// whether any of the passes modifies the module, and if so, return true.
419 using llvm::Pass::doInitialization;
420 using llvm::Pass::doFinalization;
422 /// doInitialization - Run all of the initializers for the module passes.
424 bool doInitialization();
426 /// doFinalization - Run all of the finalizers for the module passes.
428 bool doFinalization();
430 /// Pass Manager itself does not invalidate any analysis info.
431 void getAnalysisUsage(AnalysisUsage &Info) const override {
432 Info.setPreservesAll();
435 PMDataManager *getAsPMDataManager() override { return this; }
436 Pass *getAsPass() override { return this; }
437 PassManagerType getTopLevelPassManagerType() override {
438 return PMT_ModulePassManager;
441 MPPassManager *getContainedManager(unsigned N) {
442 assert(N < PassManagers.size() && "Pass number out of range!");
443 MPPassManager *MP = static_cast<MPPassManager *>(PassManagers[N]);
448 void PassManagerImpl::anchor() {}
450 char PassManagerImpl::ID = 0;
451 } // End of legacy namespace
452 } // End of llvm namespace
456 //===----------------------------------------------------------------------===//
457 /// TimingInfo Class - This class is used to calculate information about the
458 /// amount of time each pass takes to execute. This only happens when
459 /// -time-passes is enabled on the command line.
462 static ManagedStatic<sys::SmartMutex<true> > TimingInfoMutex;
465 DenseMap<Pass*, Timer*> TimingData;
468 // Use 'create' member to get this.
469 TimingInfo() : TG("... Pass execution timing report ...") {}
471 // TimingDtor - Print out information about timing information
473 // Delete all of the timers, which accumulate their info into the
475 for (DenseMap<Pass*, Timer*>::iterator I = TimingData.begin(),
476 E = TimingData.end(); I != E; ++I)
478 // TimerGroup is deleted next, printing the report.
481 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer
482 // to a non-null value (if the -time-passes option is enabled) or it leaves it
483 // null. It may be called multiple times.
484 static void createTheTimeInfo();
486 /// getPassTimer - Return the timer for the specified pass if it exists.
487 Timer *getPassTimer(Pass *P) {
488 if (P->getAsPMDataManager())
491 sys::SmartScopedLock<true> Lock(*TimingInfoMutex);
492 Timer *&T = TimingData[P];
494 T = new Timer(P->getPassName(), TG);
499 } // End of anon namespace
501 static TimingInfo *TheTimeInfo;
503 //===----------------------------------------------------------------------===//
504 // PMTopLevelManager implementation
506 /// Initialize top level manager. Create first pass manager.
507 PMTopLevelManager::PMTopLevelManager(PMDataManager *PMDM) {
508 PMDM->setTopLevelManager(this);
509 addPassManager(PMDM);
510 activeStack.push(PMDM);
513 /// Set pass P as the last user of the given analysis passes.
515 PMTopLevelManager::setLastUser(ArrayRef<Pass*> AnalysisPasses, Pass *P) {
517 if (P->getResolver())
518 PDepth = P->getResolver()->getPMDataManager().getDepth();
520 for (SmallVectorImpl<Pass *>::const_iterator I = AnalysisPasses.begin(),
521 E = AnalysisPasses.end(); I != E; ++I) {
528 // Update the last users of passes that are required transitive by AP.
529 AnalysisUsage *AnUsage = findAnalysisUsage(AP);
530 const AnalysisUsage::VectorType &IDs = AnUsage->getRequiredTransitiveSet();
531 SmallVector<Pass *, 12> LastUses;
532 SmallVector<Pass *, 12> LastPMUses;
533 for (AnalysisUsage::VectorType::const_iterator I = IDs.begin(),
534 E = IDs.end(); I != E; ++I) {
535 Pass *AnalysisPass = findAnalysisPass(*I);
536 assert(AnalysisPass && "Expected analysis pass to exist.");
537 AnalysisResolver *AR = AnalysisPass->getResolver();
538 assert(AR && "Expected analysis resolver to exist.");
539 unsigned APDepth = AR->getPMDataManager().getDepth();
541 if (PDepth == APDepth)
542 LastUses.push_back(AnalysisPass);
543 else if (PDepth > APDepth)
544 LastPMUses.push_back(AnalysisPass);
547 setLastUser(LastUses, P);
549 // If this pass has a corresponding pass manager, push higher level
550 // analysis to this pass manager.
551 if (P->getResolver())
552 setLastUser(LastPMUses, P->getResolver()->getPMDataManager().getAsPass());
555 // If AP is the last user of other passes then make P last user of
557 for (DenseMap<Pass *, Pass *>::iterator LUI = LastUser.begin(),
558 LUE = LastUser.end(); LUI != LUE; ++LUI) {
559 if (LUI->second == AP)
560 // DenseMap iterator is not invalidated here because
561 // this is just updating existing entries.
562 LastUser[LUI->first] = P;
567 /// Collect passes whose last user is P
568 void PMTopLevelManager::collectLastUses(SmallVectorImpl<Pass *> &LastUses,
570 DenseMap<Pass *, SmallPtrSet<Pass *, 8> >::iterator DMI =
571 InversedLastUser.find(P);
572 if (DMI == InversedLastUser.end())
575 SmallPtrSet<Pass *, 8> &LU = DMI->second;
576 for (SmallPtrSet<Pass *, 8>::iterator I = LU.begin(),
577 E = LU.end(); I != E; ++I) {
578 LastUses.push_back(*I);
583 AnalysisUsage *PMTopLevelManager::findAnalysisUsage(Pass *P) {
584 AnalysisUsage *AnUsage = nullptr;
585 DenseMap<Pass *, AnalysisUsage *>::iterator DMI = AnUsageMap.find(P);
586 if (DMI != AnUsageMap.end())
587 AnUsage = DMI->second;
589 AnUsage = new AnalysisUsage();
590 P->getAnalysisUsage(*AnUsage);
591 AnUsageMap[P] = AnUsage;
596 /// Schedule pass P for execution. Make sure that passes required by
597 /// P are run before P is run. Update analysis info maintained by
598 /// the manager. Remove dead passes. This is a recursive function.
599 void PMTopLevelManager::schedulePass(Pass *P) {
601 // TODO : Allocate function manager for this pass, other wise required set
602 // may be inserted into previous function manager
604 // Give pass a chance to prepare the stage.
605 P->preparePassManager(activeStack);
607 // If P is an analysis pass and it is available then do not
608 // generate the analysis again. Stale analysis info should not be
609 // available at this point.
611 PassRegistry::getPassRegistry()->getPassInfo(P->getPassID());
612 if (PI && PI->isAnalysis() && findAnalysisPass(P->getPassID())) {
617 AnalysisUsage *AnUsage = findAnalysisUsage(P);
619 bool checkAnalysis = true;
620 while (checkAnalysis) {
621 checkAnalysis = false;
623 const AnalysisUsage::VectorType &RequiredSet = AnUsage->getRequiredSet();
624 for (AnalysisUsage::VectorType::const_iterator I = RequiredSet.begin(),
625 E = RequiredSet.end(); I != E; ++I) {
627 Pass *AnalysisPass = findAnalysisPass(*I);
629 const PassInfo *PI = PassRegistry::getPassRegistry()->getPassInfo(*I);
632 // Pass P is not in the global PassRegistry
633 dbgs() << "Pass '" << P->getPassName() << "' is not initialized." << "\n";
634 dbgs() << "Verify if there is a pass dependency cycle." << "\n";
635 dbgs() << "Required Passes:" << "\n";
636 for (AnalysisUsage::VectorType::const_iterator I2 = RequiredSet.begin(),
637 E = RequiredSet.end(); I2 != E && I2 != I; ++I2) {
638 Pass *AnalysisPass2 = findAnalysisPass(*I2);
640 dbgs() << "\t" << AnalysisPass2->getPassName() << "\n";
642 dbgs() << "\t" << "Error: Required pass not found! Possible causes:" << "\n";
643 dbgs() << "\t\t" << "- Pass misconfiguration (e.g.: missing macros)" << "\n";
644 dbgs() << "\t\t" << "- Corruption of the global PassRegistry" << "\n";
649 assert(PI && "Expected required passes to be initialized");
650 AnalysisPass = PI->createPass();
651 if (P->getPotentialPassManagerType () ==
652 AnalysisPass->getPotentialPassManagerType())
653 // Schedule analysis pass that is managed by the same pass manager.
654 schedulePass(AnalysisPass);
655 else if (P->getPotentialPassManagerType () >
656 AnalysisPass->getPotentialPassManagerType()) {
657 // Schedule analysis pass that is managed by a new manager.
658 schedulePass(AnalysisPass);
659 // Recheck analysis passes to ensure that required analyses that
660 // are already checked are still available.
661 checkAnalysis = true;
663 // Do not schedule this analysis. Lower level analsyis
664 // passes are run on the fly.
670 // Now all required passes are available.
671 if (ImmutablePass *IP = P->getAsImmutablePass()) {
672 // P is a immutable pass and it will be managed by this
673 // top level manager. Set up analysis resolver to connect them.
674 PMDataManager *DM = getAsPMDataManager();
675 AnalysisResolver *AR = new AnalysisResolver(*DM);
677 DM->initializeAnalysisImpl(P);
678 addImmutablePass(IP);
679 DM->recordAvailableAnalysis(IP);
683 if (PI && !PI->isAnalysis() && ShouldPrintBeforePass(PI)) {
684 Pass *PP = P->createPrinterPass(
685 dbgs(), std::string("*** IR Dump Before ") + P->getPassName() + " ***");
686 PP->assignPassManager(activeStack, getTopLevelPassManagerType());
689 // Add the requested pass to the best available pass manager.
690 P->assignPassManager(activeStack, getTopLevelPassManagerType());
692 if (PI && !PI->isAnalysis() && ShouldPrintAfterPass(PI)) {
693 Pass *PP = P->createPrinterPass(
694 dbgs(), std::string("*** IR Dump After ") + P->getPassName() + " ***");
695 PP->assignPassManager(activeStack, getTopLevelPassManagerType());
699 /// Find the pass that implements Analysis AID. Search immutable
700 /// passes and all pass managers. If desired pass is not found
701 /// then return NULL.
702 Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
704 // Check pass managers
705 for (SmallVectorImpl<PMDataManager *>::iterator I = PassManagers.begin(),
706 E = PassManagers.end(); I != E; ++I)
707 if (Pass *P = (*I)->findAnalysisPass(AID, false))
710 // Check other pass managers
711 for (SmallVectorImpl<PMDataManager *>::iterator
712 I = IndirectPassManagers.begin(),
713 E = IndirectPassManagers.end(); I != E; ++I)
714 if (Pass *P = (*I)->findAnalysisPass(AID, false))
717 // Check the immutable passes. Iterate in reverse order so that we find
718 // the most recently registered passes first.
719 for (SmallVectorImpl<ImmutablePass *>::reverse_iterator I =
720 ImmutablePasses.rbegin(), E = ImmutablePasses.rend(); I != E; ++I) {
721 AnalysisID PI = (*I)->getPassID();
725 // If Pass not found then check the interfaces implemented by Immutable Pass
726 const PassInfo *PassInf =
727 PassRegistry::getPassRegistry()->getPassInfo(PI);
728 assert(PassInf && "Expected all immutable passes to be initialized");
729 const std::vector<const PassInfo*> &ImmPI =
730 PassInf->getInterfacesImplemented();
731 for (std::vector<const PassInfo*>::const_iterator II = ImmPI.begin(),
732 EE = ImmPI.end(); II != EE; ++II) {
733 if ((*II)->getTypeInfo() == AID)
741 // Print passes managed by this top level manager.
742 void PMTopLevelManager::dumpPasses() const {
744 if (PassDebugging < Structure)
747 // Print out the immutable passes
748 for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
749 ImmutablePasses[i]->dumpPassStructure(0);
752 // Every class that derives from PMDataManager also derives from Pass
753 // (sometimes indirectly), but there's no inheritance relationship
754 // between PMDataManager and Pass, so we have to getAsPass to get
755 // from a PMDataManager* to a Pass*.
756 for (SmallVectorImpl<PMDataManager *>::const_iterator I =
757 PassManagers.begin(), E = PassManagers.end(); I != E; ++I)
758 (*I)->getAsPass()->dumpPassStructure(1);
761 void PMTopLevelManager::dumpArguments() const {
763 if (PassDebugging < Arguments)
766 dbgs() << "Pass Arguments: ";
767 for (SmallVectorImpl<ImmutablePass *>::const_iterator I =
768 ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
769 if (const PassInfo *PI =
770 PassRegistry::getPassRegistry()->getPassInfo((*I)->getPassID())) {
771 assert(PI && "Expected all immutable passes to be initialized");
772 if (!PI->isAnalysisGroup())
773 dbgs() << " -" << PI->getPassArgument();
775 for (SmallVectorImpl<PMDataManager *>::const_iterator I =
776 PassManagers.begin(), E = PassManagers.end(); I != E; ++I)
777 (*I)->dumpPassArguments();
781 void PMTopLevelManager::initializeAllAnalysisInfo() {
782 for (SmallVectorImpl<PMDataManager *>::iterator I = PassManagers.begin(),
783 E = PassManagers.end(); I != E; ++I)
784 (*I)->initializeAnalysisInfo();
786 // Initailize other pass managers
787 for (SmallVectorImpl<PMDataManager *>::iterator
788 I = IndirectPassManagers.begin(), E = IndirectPassManagers.end();
790 (*I)->initializeAnalysisInfo();
792 for (DenseMap<Pass *, Pass *>::iterator DMI = LastUser.begin(),
793 DME = LastUser.end(); DMI != DME; ++DMI) {
794 DenseMap<Pass *, SmallPtrSet<Pass *, 8> >::iterator InvDMI =
795 InversedLastUser.find(DMI->second);
796 if (InvDMI != InversedLastUser.end()) {
797 SmallPtrSet<Pass *, 8> &L = InvDMI->second;
798 L.insert(DMI->first);
800 SmallPtrSet<Pass *, 8> L; L.insert(DMI->first);
801 InversedLastUser[DMI->second] = L;
807 PMTopLevelManager::~PMTopLevelManager() {
808 for (SmallVectorImpl<PMDataManager *>::iterator I = PassManagers.begin(),
809 E = PassManagers.end(); I != E; ++I)
812 for (SmallVectorImpl<ImmutablePass *>::iterator
813 I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
816 for (DenseMap<Pass *, AnalysisUsage *>::iterator DMI = AnUsageMap.begin(),
817 DME = AnUsageMap.end(); DMI != DME; ++DMI)
821 //===----------------------------------------------------------------------===//
822 // PMDataManager implementation
824 /// Augement AvailableAnalysis by adding analysis made available by pass P.
825 void PMDataManager::recordAvailableAnalysis(Pass *P) {
826 AnalysisID PI = P->getPassID();
828 AvailableAnalysis[PI] = P;
830 assert(!AvailableAnalysis.empty());
832 // This pass is the current implementation of all of the interfaces it
833 // implements as well.
834 const PassInfo *PInf = PassRegistry::getPassRegistry()->getPassInfo(PI);
836 const std::vector<const PassInfo*> &II = PInf->getInterfacesImplemented();
837 for (unsigned i = 0, e = II.size(); i != e; ++i)
838 AvailableAnalysis[II[i]->getTypeInfo()] = P;
841 // Return true if P preserves high level analysis used by other
842 // passes managed by this manager
843 bool PMDataManager::preserveHigherLevelAnalysis(Pass *P) {
844 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
845 if (AnUsage->getPreservesAll())
848 const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
849 for (SmallVectorImpl<Pass *>::iterator I = HigherLevelAnalysis.begin(),
850 E = HigherLevelAnalysis.end(); I != E; ++I) {
852 if (P1->getAsImmutablePass() == nullptr &&
853 std::find(PreservedSet.begin(), PreservedSet.end(),
862 /// verifyPreservedAnalysis -- Verify analysis preserved by pass P.
863 void PMDataManager::verifyPreservedAnalysis(Pass *P) {
864 // Don't do this unless assertions are enabled.
868 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
869 const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
871 // Verify preserved analysis
872 for (AnalysisUsage::VectorType::const_iterator I = PreservedSet.begin(),
873 E = PreservedSet.end(); I != E; ++I) {
875 if (Pass *AP = findAnalysisPass(AID, true)) {
876 TimeRegion PassTimer(getPassTimer(AP));
877 AP->verifyAnalysis();
882 /// Remove Analysis not preserved by Pass P
883 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
884 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
885 if (AnUsage->getPreservesAll())
888 const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
889 for (DenseMap<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
890 E = AvailableAnalysis.end(); I != E; ) {
891 DenseMap<AnalysisID, Pass*>::iterator Info = I++;
892 if (Info->second->getAsImmutablePass() == nullptr &&
893 std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
894 PreservedSet.end()) {
895 // Remove this analysis
896 if (PassDebugging >= Details) {
897 Pass *S = Info->second;
898 dbgs() << " -- '" << P->getPassName() << "' is not preserving '";
899 dbgs() << S->getPassName() << "'\n";
901 AvailableAnalysis.erase(Info);
905 // Check inherited analysis also. If P is not preserving analysis
906 // provided by parent manager then remove it here.
907 for (unsigned Index = 0; Index < PMT_Last; ++Index) {
909 if (!InheritedAnalysis[Index])
912 for (DenseMap<AnalysisID, Pass*>::iterator
913 I = InheritedAnalysis[Index]->begin(),
914 E = InheritedAnalysis[Index]->end(); I != E; ) {
915 DenseMap<AnalysisID, Pass *>::iterator Info = I++;
916 if (Info->second->getAsImmutablePass() == nullptr &&
917 std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
918 PreservedSet.end()) {
919 // Remove this analysis
920 if (PassDebugging >= Details) {
921 Pass *S = Info->second;
922 dbgs() << " -- '" << P->getPassName() << "' is not preserving '";
923 dbgs() << S->getPassName() << "'\n";
925 InheritedAnalysis[Index]->erase(Info);
931 /// Remove analysis passes that are not used any longer
932 void PMDataManager::removeDeadPasses(Pass *P, StringRef Msg,
933 enum PassDebuggingString DBG_STR) {
935 SmallVector<Pass *, 12> DeadPasses;
937 // If this is a on the fly manager then it does not have TPM.
941 TPM->collectLastUses(DeadPasses, P);
943 if (PassDebugging >= Details && !DeadPasses.empty()) {
944 dbgs() << " -*- '" << P->getPassName();
945 dbgs() << "' is the last user of following pass instances.";
946 dbgs() << " Free these instances\n";
949 for (SmallVectorImpl<Pass *>::iterator I = DeadPasses.begin(),
950 E = DeadPasses.end(); I != E; ++I)
951 freePass(*I, Msg, DBG_STR);
954 void PMDataManager::freePass(Pass *P, StringRef Msg,
955 enum PassDebuggingString DBG_STR) {
956 dumpPassInfo(P, FREEING_MSG, DBG_STR, Msg);
959 // If the pass crashes releasing memory, remember this.
960 PassManagerPrettyStackEntry X(P);
961 TimeRegion PassTimer(getPassTimer(P));
966 AnalysisID PI = P->getPassID();
967 if (const PassInfo *PInf = PassRegistry::getPassRegistry()->getPassInfo(PI)) {
968 // Remove the pass itself (if it is not already removed).
969 AvailableAnalysis.erase(PI);
971 // Remove all interfaces this pass implements, for which it is also
972 // listed as the available implementation.
973 const std::vector<const PassInfo*> &II = PInf->getInterfacesImplemented();
974 for (unsigned i = 0, e = II.size(); i != e; ++i) {
975 DenseMap<AnalysisID, Pass*>::iterator Pos =
976 AvailableAnalysis.find(II[i]->getTypeInfo());
977 if (Pos != AvailableAnalysis.end() && Pos->second == P)
978 AvailableAnalysis.erase(Pos);
983 /// Add pass P into the PassVector. Update
984 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
985 void PMDataManager::add(Pass *P, bool ProcessAnalysis) {
986 // This manager is going to manage pass P. Set up analysis resolver
988 AnalysisResolver *AR = new AnalysisResolver(*this);
991 // If a FunctionPass F is the last user of ModulePass info M
992 // then the F's manager, not F, records itself as a last user of M.
993 SmallVector<Pass *, 12> TransferLastUses;
995 if (!ProcessAnalysis) {
997 PassVector.push_back(P);
1001 // At the moment, this pass is the last user of all required passes.
1002 SmallVector<Pass *, 12> LastUses;
1003 SmallVector<Pass *, 8> RequiredPasses;
1004 SmallVector<AnalysisID, 8> ReqAnalysisNotAvailable;
1006 unsigned PDepth = this->getDepth();
1008 collectRequiredAnalysis(RequiredPasses,
1009 ReqAnalysisNotAvailable, P);
1010 for (SmallVectorImpl<Pass *>::iterator I = RequiredPasses.begin(),
1011 E = RequiredPasses.end(); I != E; ++I) {
1012 Pass *PRequired = *I;
1013 unsigned RDepth = 0;
1015 assert(PRequired->getResolver() && "Analysis Resolver is not set");
1016 PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
1017 RDepth = DM.getDepth();
1019 if (PDepth == RDepth)
1020 LastUses.push_back(PRequired);
1021 else if (PDepth > RDepth) {
1022 // Let the parent claim responsibility of last use
1023 TransferLastUses.push_back(PRequired);
1024 // Keep track of higher level analysis used by this manager.
1025 HigherLevelAnalysis.push_back(PRequired);
1027 llvm_unreachable("Unable to accommodate Required Pass");
1030 // Set P as P's last user until someone starts using P.
1031 // However, if P is a Pass Manager then it does not need
1032 // to record its last user.
1033 if (!P->getAsPMDataManager())
1034 LastUses.push_back(P);
1035 TPM->setLastUser(LastUses, P);
1037 if (!TransferLastUses.empty()) {
1038 Pass *My_PM = getAsPass();
1039 TPM->setLastUser(TransferLastUses, My_PM);
1040 TransferLastUses.clear();
1043 // Now, take care of required analyses that are not available.
1044 for (SmallVectorImpl<AnalysisID>::iterator
1045 I = ReqAnalysisNotAvailable.begin(),
1046 E = ReqAnalysisNotAvailable.end() ;I != E; ++I) {
1047 const PassInfo *PI = PassRegistry::getPassRegistry()->getPassInfo(*I);
1048 Pass *AnalysisPass = PI->createPass();
1049 this->addLowerLevelRequiredPass(P, AnalysisPass);
1052 // Take a note of analysis required and made available by this pass.
1053 // Remove the analysis not preserved by this pass
1054 removeNotPreservedAnalysis(P);
1055 recordAvailableAnalysis(P);
1058 PassVector.push_back(P);
1062 /// Populate RP with analysis pass that are required by
1063 /// pass P and are available. Populate RP_NotAvail with analysis
1064 /// pass that are required by pass P but are not available.
1065 void PMDataManager::collectRequiredAnalysis(SmallVectorImpl<Pass *> &RP,
1066 SmallVectorImpl<AnalysisID> &RP_NotAvail,
1068 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
1069 const AnalysisUsage::VectorType &RequiredSet = AnUsage->getRequiredSet();
1070 for (AnalysisUsage::VectorType::const_iterator
1071 I = RequiredSet.begin(), E = RequiredSet.end(); I != E; ++I) {
1072 if (Pass *AnalysisPass = findAnalysisPass(*I, true))
1073 RP.push_back(AnalysisPass);
1075 RP_NotAvail.push_back(*I);
1078 const AnalysisUsage::VectorType &IDs = AnUsage->getRequiredTransitiveSet();
1079 for (AnalysisUsage::VectorType::const_iterator I = IDs.begin(),
1080 E = IDs.end(); I != E; ++I) {
1081 if (Pass *AnalysisPass = findAnalysisPass(*I, true))
1082 RP.push_back(AnalysisPass);
1084 RP_NotAvail.push_back(*I);
1088 // All Required analyses should be available to the pass as it runs! Here
1089 // we fill in the AnalysisImpls member of the pass so that it can
1090 // successfully use the getAnalysis() method to retrieve the
1091 // implementations it needs.
1093 void PMDataManager::initializeAnalysisImpl(Pass *P) {
1094 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
1096 for (AnalysisUsage::VectorType::const_iterator
1097 I = AnUsage->getRequiredSet().begin(),
1098 E = AnUsage->getRequiredSet().end(); I != E; ++I) {
1099 Pass *Impl = findAnalysisPass(*I, true);
1101 // This may be analysis pass that is initialized on the fly.
1102 // If that is not the case then it will raise an assert when it is used.
1104 AnalysisResolver *AR = P->getResolver();
1105 assert(AR && "Analysis Resolver is not set");
1106 AR->addAnalysisImplsPair(*I, Impl);
1110 /// Find the pass that implements Analysis AID. If desired pass is not found
1111 /// then return NULL.
1112 Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
1114 // Check if AvailableAnalysis map has one entry.
1115 DenseMap<AnalysisID, Pass*>::const_iterator I = AvailableAnalysis.find(AID);
1117 if (I != AvailableAnalysis.end())
1120 // Search Parents through TopLevelManager
1122 return TPM->findAnalysisPass(AID);
1127 // Print list of passes that are last used by P.
1128 void PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{
1130 SmallVector<Pass *, 12> LUses;
1132 // If this is a on the fly manager then it does not have TPM.
1136 TPM->collectLastUses(LUses, P);
1138 for (SmallVectorImpl<Pass *>::iterator I = LUses.begin(),
1139 E = LUses.end(); I != E; ++I) {
1140 dbgs() << "--" << std::string(Offset*2, ' ');
1141 (*I)->dumpPassStructure(0);
1145 void PMDataManager::dumpPassArguments() const {
1146 for (SmallVectorImpl<Pass *>::const_iterator I = PassVector.begin(),
1147 E = PassVector.end(); I != E; ++I) {
1148 if (PMDataManager *PMD = (*I)->getAsPMDataManager())
1149 PMD->dumpPassArguments();
1151 if (const PassInfo *PI =
1152 PassRegistry::getPassRegistry()->getPassInfo((*I)->getPassID()))
1153 if (!PI->isAnalysisGroup())
1154 dbgs() << " -" << PI->getPassArgument();
1158 void PMDataManager::dumpPassInfo(Pass *P, enum PassDebuggingString S1,
1159 enum PassDebuggingString S2,
1161 if (PassDebugging < Executions)
1163 dbgs() << "[" << sys::TimeValue::now().str() << "] " << (void *)this
1164 << std::string(getDepth() * 2 + 1, ' ');
1167 dbgs() << "Executing Pass '" << P->getPassName();
1169 case MODIFICATION_MSG:
1170 dbgs() << "Made Modification '" << P->getPassName();
1173 dbgs() << " Freeing Pass '" << P->getPassName();
1179 case ON_BASICBLOCK_MSG:
1180 dbgs() << "' on BasicBlock '" << Msg << "'...\n";
1182 case ON_FUNCTION_MSG:
1183 dbgs() << "' on Function '" << Msg << "'...\n";
1186 dbgs() << "' on Module '" << Msg << "'...\n";
1189 dbgs() << "' on Region '" << Msg << "'...\n";
1192 dbgs() << "' on Loop '" << Msg << "'...\n";
1195 dbgs() << "' on Call Graph Nodes '" << Msg << "'...\n";
1202 void PMDataManager::dumpRequiredSet(const Pass *P) const {
1203 if (PassDebugging < Details)
1206 AnalysisUsage analysisUsage;
1207 P->getAnalysisUsage(analysisUsage);
1208 dumpAnalysisUsage("Required", P, analysisUsage.getRequiredSet());
1211 void PMDataManager::dumpPreservedSet(const Pass *P) const {
1212 if (PassDebugging < Details)
1215 AnalysisUsage analysisUsage;
1216 P->getAnalysisUsage(analysisUsage);
1217 dumpAnalysisUsage("Preserved", P, analysisUsage.getPreservedSet());
1220 void PMDataManager::dumpAnalysisUsage(StringRef Msg, const Pass *P,
1221 const AnalysisUsage::VectorType &Set) const {
1222 assert(PassDebugging >= Details);
1225 dbgs() << (const void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:";
1226 for (unsigned i = 0; i != Set.size(); ++i) {
1227 if (i) dbgs() << ',';
1228 const PassInfo *PInf = PassRegistry::getPassRegistry()->getPassInfo(Set[i]);
1230 // Some preserved passes, such as AliasAnalysis, may not be initialized by
1232 dbgs() << " Uninitialized Pass";
1235 dbgs() << ' ' << PInf->getPassName();
1240 /// Add RequiredPass into list of lower level passes required by pass P.
1241 /// RequiredPass is run on the fly by Pass Manager when P requests it
1242 /// through getAnalysis interface.
1243 /// This should be handled by specific pass manager.
1244 void PMDataManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
1246 TPM->dumpArguments();
1250 // Module Level pass may required Function Level analysis info
1251 // (e.g. dominator info). Pass manager uses on the fly function pass manager
1252 // to provide this on demand. In that case, in Pass manager terminology,
1253 // module level pass is requiring lower level analysis info managed by
1254 // lower level pass manager.
1256 // When Pass manager is not able to order required analysis info, Pass manager
1257 // checks whether any lower level manager will be able to provide this
1258 // analysis info on demand or not.
1260 dbgs() << "Unable to schedule '" << RequiredPass->getPassName();
1261 dbgs() << "' required by '" << P->getPassName() << "'\n";
1263 llvm_unreachable("Unable to schedule pass");
1266 Pass *PMDataManager::getOnTheFlyPass(Pass *P, AnalysisID PI, Function &F) {
1267 llvm_unreachable("Unable to find on the fly pass");
1271 PMDataManager::~PMDataManager() {
1272 for (SmallVectorImpl<Pass *>::iterator I = PassVector.begin(),
1273 E = PassVector.end(); I != E; ++I)
1277 //===----------------------------------------------------------------------===//
1278 // NOTE: Is this the right place to define this method ?
1279 // getAnalysisIfAvailable - Return analysis result or null if it doesn't exist.
1280 Pass *AnalysisResolver::getAnalysisIfAvailable(AnalysisID ID, bool dir) const {
1281 return PM.findAnalysisPass(ID, dir);
1284 Pass *AnalysisResolver::findImplPass(Pass *P, AnalysisID AnalysisPI,
1286 return PM.getOnTheFlyPass(P, AnalysisPI, F);
1289 //===----------------------------------------------------------------------===//
1290 // BBPassManager implementation
1292 /// Execute all of the passes scheduled for execution by invoking
1293 /// runOnBasicBlock method. Keep track of whether any of the passes modifies
1294 /// the function, and if so, return true.
1295 bool BBPassManager::runOnFunction(Function &F) {
1296 if (F.isDeclaration())
1299 bool Changed = doInitialization(F);
1301 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
1302 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1303 BasicBlockPass *BP = getContainedPass(Index);
1304 bool LocalChanged = false;
1306 dumpPassInfo(BP, EXECUTION_MSG, ON_BASICBLOCK_MSG, I->getName());
1307 dumpRequiredSet(BP);
1309 initializeAnalysisImpl(BP);
1312 // If the pass crashes, remember this.
1313 PassManagerPrettyStackEntry X(BP, *I);
1314 TimeRegion PassTimer(getPassTimer(BP));
1316 LocalChanged |= BP->runOnBasicBlock(*I);
1319 Changed |= LocalChanged;
1321 dumpPassInfo(BP, MODIFICATION_MSG, ON_BASICBLOCK_MSG,
1323 dumpPreservedSet(BP);
1325 verifyPreservedAnalysis(BP);
1326 removeNotPreservedAnalysis(BP);
1327 recordAvailableAnalysis(BP);
1328 removeDeadPasses(BP, I->getName(), ON_BASICBLOCK_MSG);
1331 return doFinalization(F) || Changed;
1334 // Implement doInitialization and doFinalization
1335 bool BBPassManager::doInitialization(Module &M) {
1336 bool Changed = false;
1338 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1339 Changed |= getContainedPass(Index)->doInitialization(M);
1344 bool BBPassManager::doFinalization(Module &M) {
1345 bool Changed = false;
1347 for (int Index = getNumContainedPasses() - 1; Index >= 0; --Index)
1348 Changed |= getContainedPass(Index)->doFinalization(M);
1353 bool BBPassManager::doInitialization(Function &F) {
1354 bool Changed = false;
1356 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1357 BasicBlockPass *BP = getContainedPass(Index);
1358 Changed |= BP->doInitialization(F);
1364 bool BBPassManager::doFinalization(Function &F) {
1365 bool Changed = false;
1367 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1368 BasicBlockPass *BP = getContainedPass(Index);
1369 Changed |= BP->doFinalization(F);
1376 //===----------------------------------------------------------------------===//
1377 // FunctionPassManager implementation
1379 /// Create new Function pass manager
1380 FunctionPassManager::FunctionPassManager(Module *m) : M(m) {
1381 FPM = new FunctionPassManagerImpl();
1382 // FPM is the top level manager.
1383 FPM->setTopLevelManager(FPM);
1385 AnalysisResolver *AR = new AnalysisResolver(*FPM);
1386 FPM->setResolver(AR);
1389 FunctionPassManager::~FunctionPassManager() {
1393 /// add - Add a pass to the queue of passes to run. This passes
1394 /// ownership of the Pass to the PassManager. When the
1395 /// PassManager_X is destroyed, the pass will be destroyed as well, so
1396 /// there is no need to delete the pass. (TODO delete passes.)
1397 /// This implies that all passes MUST be allocated with 'new'.
1398 void FunctionPassManager::add(Pass *P) {
1402 /// run - Execute all of the passes scheduled for execution. Keep
1403 /// track of whether any of the passes modifies the function, and if
1404 /// so, return true.
1406 bool FunctionPassManager::run(Function &F) {
1407 if (F.isMaterializable()) {
1409 if (F.Materialize(&errstr))
1410 report_fatal_error("Error reading bitcode file: " + Twine(errstr));
1416 /// doInitialization - Run all of the initializers for the function passes.
1418 bool FunctionPassManager::doInitialization() {
1419 return FPM->doInitialization(*M);
1422 /// doFinalization - Run all of the finalizers for the function passes.
1424 bool FunctionPassManager::doFinalization() {
1425 return FPM->doFinalization(*M);
1428 //===----------------------------------------------------------------------===//
1429 // FunctionPassManagerImpl implementation
1431 bool FunctionPassManagerImpl::doInitialization(Module &M) {
1432 bool Changed = false;
1437 SmallVectorImpl<ImmutablePass *>& IPV = getImmutablePasses();
1438 for (SmallVectorImpl<ImmutablePass *>::const_iterator I = IPV.begin(),
1439 E = IPV.end(); I != E; ++I) {
1440 Changed |= (*I)->doInitialization(M);
1443 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1444 Changed |= getContainedManager(Index)->doInitialization(M);
1449 bool FunctionPassManagerImpl::doFinalization(Module &M) {
1450 bool Changed = false;
1452 for (int Index = getNumContainedManagers() - 1; Index >= 0; --Index)
1453 Changed |= getContainedManager(Index)->doFinalization(M);
1455 SmallVectorImpl<ImmutablePass *>& IPV = getImmutablePasses();
1456 for (SmallVectorImpl<ImmutablePass *>::const_iterator I = IPV.begin(),
1457 E = IPV.end(); I != E; ++I) {
1458 Changed |= (*I)->doFinalization(M);
1464 /// cleanup - After running all passes, clean up pass manager cache.
1465 void FPPassManager::cleanup() {
1466 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1467 FunctionPass *FP = getContainedPass(Index);
1468 AnalysisResolver *AR = FP->getResolver();
1469 assert(AR && "Analysis Resolver is not set");
1470 AR->clearAnalysisImpls();
1474 void FunctionPassManagerImpl::releaseMemoryOnTheFly() {
1477 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1478 FPPassManager *FPPM = getContainedManager(Index);
1479 for (unsigned Index = 0; Index < FPPM->getNumContainedPasses(); ++Index) {
1480 FPPM->getContainedPass(Index)->releaseMemory();
1486 // Execute all the passes managed by this top level manager.
1487 // Return true if any function is modified by a pass.
1488 bool FunctionPassManagerImpl::run(Function &F) {
1489 bool Changed = false;
1490 TimingInfo::createTheTimeInfo();
1492 initializeAllAnalysisInfo();
1493 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1494 Changed |= getContainedManager(Index)->runOnFunction(F);
1495 F.getContext().yield();
1498 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1499 getContainedManager(Index)->cleanup();
1505 //===----------------------------------------------------------------------===//
1506 // FPPassManager implementation
1508 char FPPassManager::ID = 0;
1509 /// Print passes managed by this manager
1510 void FPPassManager::dumpPassStructure(unsigned Offset) {
1511 dbgs().indent(Offset*2) << "FunctionPass Manager\n";
1512 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1513 FunctionPass *FP = getContainedPass(Index);
1514 FP->dumpPassStructure(Offset + 1);
1515 dumpLastUses(FP, Offset+1);
1520 /// Execute all of the passes scheduled for execution by invoking
1521 /// runOnFunction method. Keep track of whether any of the passes modifies
1522 /// the function, and if so, return true.
1523 bool FPPassManager::runOnFunction(Function &F) {
1524 if (F.isDeclaration())
1527 bool Changed = false;
1529 // Collect inherited analysis from Module level pass manager.
1530 populateInheritedAnalysis(TPM->activeStack);
1532 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1533 FunctionPass *FP = getContainedPass(Index);
1534 bool LocalChanged = false;
1536 dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getName());
1537 dumpRequiredSet(FP);
1539 initializeAnalysisImpl(FP);
1542 PassManagerPrettyStackEntry X(FP, F);
1543 TimeRegion PassTimer(getPassTimer(FP));
1545 LocalChanged |= FP->runOnFunction(F);
1548 Changed |= LocalChanged;
1550 dumpPassInfo(FP, MODIFICATION_MSG, ON_FUNCTION_MSG, F.getName());
1551 dumpPreservedSet(FP);
1553 verifyPreservedAnalysis(FP);
1554 removeNotPreservedAnalysis(FP);
1555 recordAvailableAnalysis(FP);
1556 removeDeadPasses(FP, F.getName(), ON_FUNCTION_MSG);
1561 bool FPPassManager::runOnModule(Module &M) {
1562 bool Changed = false;
1564 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1565 Changed |= runOnFunction(*I);
1570 bool FPPassManager::doInitialization(Module &M) {
1571 bool Changed = false;
1573 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1574 Changed |= getContainedPass(Index)->doInitialization(M);
1579 bool FPPassManager::doFinalization(Module &M) {
1580 bool Changed = false;
1582 for (int Index = getNumContainedPasses() - 1; Index >= 0; --Index)
1583 Changed |= getContainedPass(Index)->doFinalization(M);
1588 //===----------------------------------------------------------------------===//
1589 // MPPassManager implementation
1591 /// Execute all of the passes scheduled for execution by invoking
1592 /// runOnModule method. Keep track of whether any of the passes modifies
1593 /// the module, and if so, return true.
1595 MPPassManager::runOnModule(Module &M) {
1596 bool Changed = false;
1598 // Initialize on-the-fly passes
1599 for (std::map<Pass *, FunctionPassManagerImpl *>::iterator
1600 I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end();
1602 FunctionPassManagerImpl *FPP = I->second;
1603 Changed |= FPP->doInitialization(M);
1606 // Initialize module passes
1607 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1608 Changed |= getContainedPass(Index)->doInitialization(M);
1610 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1611 ModulePass *MP = getContainedPass(Index);
1612 bool LocalChanged = false;
1614 dumpPassInfo(MP, EXECUTION_MSG, ON_MODULE_MSG, M.getModuleIdentifier());
1615 dumpRequiredSet(MP);
1617 initializeAnalysisImpl(MP);
1620 PassManagerPrettyStackEntry X(MP, M);
1621 TimeRegion PassTimer(getPassTimer(MP));
1623 LocalChanged |= MP->runOnModule(M);
1626 Changed |= LocalChanged;
1628 dumpPassInfo(MP, MODIFICATION_MSG, ON_MODULE_MSG,
1629 M.getModuleIdentifier());
1630 dumpPreservedSet(MP);
1632 verifyPreservedAnalysis(MP);
1633 removeNotPreservedAnalysis(MP);
1634 recordAvailableAnalysis(MP);
1635 removeDeadPasses(MP, M.getModuleIdentifier(), ON_MODULE_MSG);
1638 // Finalize module passes
1639 for (int Index = getNumContainedPasses() - 1; Index >= 0; --Index)
1640 Changed |= getContainedPass(Index)->doFinalization(M);
1642 // Finalize on-the-fly passes
1643 for (std::map<Pass *, FunctionPassManagerImpl *>::iterator
1644 I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end();
1646 FunctionPassManagerImpl *FPP = I->second;
1647 // We don't know when is the last time an on-the-fly pass is run,
1648 // so we need to releaseMemory / finalize here
1649 FPP->releaseMemoryOnTheFly();
1650 Changed |= FPP->doFinalization(M);
1656 /// Add RequiredPass into list of lower level passes required by pass P.
1657 /// RequiredPass is run on the fly by Pass Manager when P requests it
1658 /// through getAnalysis interface.
1659 void MPPassManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
1660 assert(P->getPotentialPassManagerType() == PMT_ModulePassManager &&
1661 "Unable to handle Pass that requires lower level Analysis pass");
1662 assert((P->getPotentialPassManagerType() <
1663 RequiredPass->getPotentialPassManagerType()) &&
1664 "Unable to handle Pass that requires lower level Analysis pass");
1668 FunctionPassManagerImpl *FPP = OnTheFlyManagers[P];
1670 FPP = new FunctionPassManagerImpl();
1671 // FPP is the top level manager.
1672 FPP->setTopLevelManager(FPP);
1674 OnTheFlyManagers[P] = FPP;
1676 const PassInfo * RequiredPassPI =
1677 PassRegistry::getPassRegistry()->getPassInfo(RequiredPass->getPassID());
1679 Pass *FoundPass = nullptr;
1680 if (RequiredPassPI && RequiredPassPI->isAnalysis()) {
1682 ((PMTopLevelManager*)FPP)->findAnalysisPass(RequiredPass->getPassID());
1685 FoundPass = RequiredPass;
1686 // This should be guaranteed to add RequiredPass to the passmanager given
1687 // that we checked for an avaiable analysis above.
1688 FPP->add(RequiredPass);
1690 // Register P as the last user of FoundPass or RequiredPass.
1691 SmallVector<Pass *, 1> LU;
1692 LU.push_back(FoundPass);
1693 FPP->setLastUser(LU, P);
1696 /// Return function pass corresponding to PassInfo PI, that is
1697 /// required by module pass MP. Instantiate analysis pass, by using
1698 /// its runOnFunction() for function F.
1699 Pass* MPPassManager::getOnTheFlyPass(Pass *MP, AnalysisID PI, Function &F){
1700 FunctionPassManagerImpl *FPP = OnTheFlyManagers[MP];
1701 assert(FPP && "Unable to find on the fly pass");
1703 FPP->releaseMemoryOnTheFly();
1705 return ((PMTopLevelManager*)FPP)->findAnalysisPass(PI);
1709 //===----------------------------------------------------------------------===//
1710 // PassManagerImpl implementation
1713 /// run - Execute all of the passes scheduled for execution. Keep track of
1714 /// whether any of the passes modifies the module, and if so, return true.
1715 bool PassManagerImpl::run(Module &M) {
1716 bool Changed = false;
1717 TimingInfo::createTheTimeInfo();
1722 SmallVectorImpl<ImmutablePass *>& IPV = getImmutablePasses();
1723 for (SmallVectorImpl<ImmutablePass *>::const_iterator I = IPV.begin(),
1724 E = IPV.end(); I != E; ++I) {
1725 Changed |= (*I)->doInitialization(M);
1728 initializeAllAnalysisInfo();
1729 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1730 Changed |= getContainedManager(Index)->runOnModule(M);
1731 M.getContext().yield();
1734 for (SmallVectorImpl<ImmutablePass *>::const_iterator I = IPV.begin(),
1735 E = IPV.end(); I != E; ++I) {
1736 Changed |= (*I)->doFinalization(M);
1742 //===----------------------------------------------------------------------===//
1743 // PassManager implementation
1745 /// Create new pass manager
1746 PassManager::PassManager() {
1747 PM = new PassManagerImpl();
1748 // PM is the top level manager
1749 PM->setTopLevelManager(PM);
1752 PassManager::~PassManager() {
1756 /// add - Add a pass to the queue of passes to run. This passes ownership of
1757 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
1758 /// will be destroyed as well, so there is no need to delete the pass. This
1759 /// implies that all passes MUST be allocated with 'new'.
1760 void PassManager::add(Pass *P) {
1764 /// run - Execute all of the passes scheduled for execution. Keep track of
1765 /// whether any of the passes modifies the module, and if so, return true.
1766 bool PassManager::run(Module &M) {
1770 //===----------------------------------------------------------------------===//
1771 // TimingInfo implementation
1773 bool llvm::TimePassesIsEnabled = false;
1774 static cl::opt<bool,true>
1775 EnableTiming("time-passes", cl::location(TimePassesIsEnabled),
1776 cl::desc("Time each pass, printing elapsed time for each on exit"));
1778 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
1779 // a non-null value (if the -time-passes option is enabled) or it leaves it
1780 // null. It may be called multiple times.
1781 void TimingInfo::createTheTimeInfo() {
1782 if (!TimePassesIsEnabled || TheTimeInfo) return;
1784 // Constructed the first time this is called, iff -time-passes is enabled.
1785 // This guarantees that the object will be constructed before static globals,
1786 // thus it will be destroyed before them.
1787 static ManagedStatic<TimingInfo> TTI;
1788 TheTimeInfo = &*TTI;
1791 /// If TimingInfo is enabled then start pass timer.
1792 Timer *llvm::getPassTimer(Pass *P) {
1794 return TheTimeInfo->getPassTimer(P);
1798 //===----------------------------------------------------------------------===//
1799 // PMStack implementation
1802 // Pop Pass Manager from the stack and clear its analysis info.
1803 void PMStack::pop() {
1805 PMDataManager *Top = this->top();
1806 Top->initializeAnalysisInfo();
1811 // Push PM on the stack and set its top level manager.
1812 void PMStack::push(PMDataManager *PM) {
1813 assert(PM && "Unable to push. Pass Manager expected");
1814 assert(PM->getDepth()==0 && "Pass Manager depth set too early");
1816 if (!this->empty()) {
1817 assert(PM->getPassManagerType() > this->top()->getPassManagerType()
1818 && "pushing bad pass manager to PMStack");
1819 PMTopLevelManager *TPM = this->top()->getTopLevelManager();
1821 assert(TPM && "Unable to find top level manager");
1822 TPM->addIndirectPassManager(PM);
1823 PM->setTopLevelManager(TPM);
1824 PM->setDepth(this->top()->getDepth()+1);
1826 assert((PM->getPassManagerType() == PMT_ModulePassManager
1827 || PM->getPassManagerType() == PMT_FunctionPassManager)
1828 && "pushing bad pass manager to PMStack");
1835 // Dump content of the pass manager stack.
1836 void PMStack::dump() const {
1837 for (std::vector<PMDataManager *>::const_iterator I = S.begin(),
1838 E = S.end(); I != E; ++I)
1839 dbgs() << (*I)->getAsPass()->getPassName() << ' ';
1845 /// Find appropriate Module Pass Manager in the PM Stack and
1846 /// add self into that manager.
1847 void ModulePass::assignPassManager(PMStack &PMS,
1848 PassManagerType PreferredType) {
1849 // Find Module Pass Manager
1850 while (!PMS.empty()) {
1851 PassManagerType TopPMType = PMS.top()->getPassManagerType();
1852 if (TopPMType == PreferredType)
1853 break; // We found desired pass manager
1854 else if (TopPMType > PMT_ModulePassManager)
1855 PMS.pop(); // Pop children pass managers
1859 assert(!PMS.empty() && "Unable to find appropriate Pass Manager");
1860 PMS.top()->add(this);
1863 /// Find appropriate Function Pass Manager or Call Graph Pass Manager
1864 /// in the PM Stack and add self into that manager.
1865 void FunctionPass::assignPassManager(PMStack &PMS,
1866 PassManagerType PreferredType) {
1868 // Find Function Pass Manager
1869 while (!PMS.empty()) {
1870 if (PMS.top()->getPassManagerType() > PMT_FunctionPassManager)
1876 // Create new Function Pass Manager if needed.
1878 if (PMS.top()->getPassManagerType() == PMT_FunctionPassManager) {
1879 FPP = (FPPassManager *)PMS.top();
1881 assert(!PMS.empty() && "Unable to create Function Pass Manager");
1882 PMDataManager *PMD = PMS.top();
1884 // [1] Create new Function Pass Manager
1885 FPP = new FPPassManager();
1886 FPP->populateInheritedAnalysis(PMS);
1888 // [2] Set up new manager's top level manager
1889 PMTopLevelManager *TPM = PMD->getTopLevelManager();
1890 TPM->addIndirectPassManager(FPP);
1892 // [3] Assign manager to manage this new manager. This may create
1893 // and push new managers into PMS
1894 FPP->assignPassManager(PMS, PMD->getPassManagerType());
1896 // [4] Push new manager into PMS
1900 // Assign FPP as the manager of this pass.
1904 /// Find appropriate Basic Pass Manager or Call Graph Pass Manager
1905 /// in the PM Stack and add self into that manager.
1906 void BasicBlockPass::assignPassManager(PMStack &PMS,
1907 PassManagerType PreferredType) {
1910 // Basic Pass Manager is a leaf pass manager. It does not handle
1911 // any other pass manager.
1913 PMS.top()->getPassManagerType() == PMT_BasicBlockPassManager) {
1914 BBP = (BBPassManager *)PMS.top();
1916 // If leaf manager is not Basic Block Pass manager then create new
1917 // basic Block Pass manager.
1918 assert(!PMS.empty() && "Unable to create BasicBlock Pass Manager");
1919 PMDataManager *PMD = PMS.top();
1921 // [1] Create new Basic Block Manager
1922 BBP = new BBPassManager();
1924 // [2] Set up new manager's top level manager
1925 // Basic Block Pass Manager does not live by itself
1926 PMTopLevelManager *TPM = PMD->getTopLevelManager();
1927 TPM->addIndirectPassManager(BBP);
1929 // [3] Assign manager to manage this new manager. This may create
1930 // and push new managers into PMS
1931 BBP->assignPassManager(PMS, PreferredType);
1933 // [4] Push new manager into PMS
1937 // Assign BBP as the manager of this pass.
1941 PassManagerBase::~PassManagerBase() {}