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 (auto *PassInf : PassesToPrint) {
93 if (PassInf->getPassArgument() == PI->getPassArgument()) {
100 /// This is a utility to check whether a pass should have IR dumped
102 static bool ShouldPrintBeforePass(const PassInfo *PI) {
103 return PrintBeforeAll || ShouldPrintBeforeOrAfterPass(PI, PrintBefore);
106 /// This is a utility to check whether a pass should have IR dumped
108 static bool ShouldPrintAfterPass(const PassInfo *PI) {
109 return PrintAfterAll || ShouldPrintBeforeOrAfterPass(PI, PrintAfter);
112 /// isPassDebuggingExecutionsOrMore - Return true if -debug-pass=Executions
113 /// or higher is specified.
114 bool PMDataManager::isPassDebuggingExecutionsOrMore() const {
115 return PassDebugging >= Executions;
121 void PassManagerPrettyStackEntry::print(raw_ostream &OS) const {
123 OS << "Releasing pass '";
125 OS << "Running pass '";
127 OS << P->getPassName() << "'";
130 OS << " on module '" << M->getModuleIdentifier() << "'.\n";
139 if (isa<Function>(V))
141 else if (isa<BasicBlock>(V))
147 V->printAsOperand(OS, /*PrintTy=*/false, M);
153 //===----------------------------------------------------------------------===//
156 /// BBPassManager manages BasicBlockPass. It batches all the
157 /// pass together and sequence them to process one basic block before
158 /// processing next basic block.
159 class BBPassManager : public PMDataManager, public FunctionPass {
163 explicit BBPassManager()
164 : PMDataManager(), FunctionPass(ID) {}
166 /// Execute all of the passes scheduled for execution. Keep track of
167 /// whether any of the passes modifies the function, and if so, return true.
168 bool runOnFunction(Function &F) override;
170 /// Pass Manager itself does not invalidate any analysis info.
171 void getAnalysisUsage(AnalysisUsage &Info) const override {
172 Info.setPreservesAll();
175 bool doInitialization(Module &M) override;
176 bool doInitialization(Function &F);
177 bool doFinalization(Module &M) override;
178 bool doFinalization(Function &F);
180 PMDataManager *getAsPMDataManager() override { return this; }
181 Pass *getAsPass() override { return this; }
183 const char *getPassName() const override {
184 return "BasicBlock Pass Manager";
187 // Print passes managed by this manager
188 void dumpPassStructure(unsigned Offset) override {
189 dbgs().indent(Offset*2) << "BasicBlockPass Manager\n";
190 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
191 BasicBlockPass *BP = getContainedPass(Index);
192 BP->dumpPassStructure(Offset + 1);
193 dumpLastUses(BP, Offset+1);
197 BasicBlockPass *getContainedPass(unsigned N) {
198 assert(N < PassVector.size() && "Pass number out of range!");
199 BasicBlockPass *BP = static_cast<BasicBlockPass *>(PassVector[N]);
203 PassManagerType getPassManagerType() const override {
204 return PMT_BasicBlockPassManager;
208 char BBPassManager::ID = 0;
209 } // End anonymous namespace
213 //===----------------------------------------------------------------------===//
214 // FunctionPassManagerImpl
216 /// FunctionPassManagerImpl manages FPPassManagers
217 class FunctionPassManagerImpl : public Pass,
218 public PMDataManager,
219 public PMTopLevelManager {
220 virtual void anchor();
225 explicit FunctionPassManagerImpl() :
226 Pass(PT_PassManager, ID), PMDataManager(),
227 PMTopLevelManager(new FPPassManager()), wasRun(false) {}
229 /// \copydoc FunctionPassManager::add()
234 /// createPrinterPass - Get a function printer pass.
235 Pass *createPrinterPass(raw_ostream &O,
236 const std::string &Banner) const override {
237 return createPrintFunctionPass(O, Banner);
240 // Prepare for running an on the fly pass, freeing memory if needed
241 // from a previous run.
242 void releaseMemoryOnTheFly();
244 /// run - Execute all of the passes scheduled for execution. Keep track of
245 /// whether any of the passes modifies the module, and if so, return true.
246 bool run(Function &F);
248 /// doInitialization - Run all of the initializers for the function passes.
250 bool doInitialization(Module &M) override;
252 /// doFinalization - Run all of the finalizers for the function passes.
254 bool doFinalization(Module &M) override;
257 PMDataManager *getAsPMDataManager() override { return this; }
258 Pass *getAsPass() override { return this; }
259 PassManagerType getTopLevelPassManagerType() override {
260 return PMT_FunctionPassManager;
263 /// Pass Manager itself does not invalidate any analysis info.
264 void getAnalysisUsage(AnalysisUsage &Info) const override {
265 Info.setPreservesAll();
268 FPPassManager *getContainedManager(unsigned N) {
269 assert(N < PassManagers.size() && "Pass number out of range!");
270 FPPassManager *FP = static_cast<FPPassManager *>(PassManagers[N]);
275 void FunctionPassManagerImpl::anchor() {}
277 char FunctionPassManagerImpl::ID = 0;
278 } // End of legacy namespace
279 } // End of llvm namespace
282 //===----------------------------------------------------------------------===//
285 /// MPPassManager manages ModulePasses and function pass managers.
286 /// It batches all Module passes and function pass managers together and
287 /// sequences them to process one module.
288 class MPPassManager : public Pass, public PMDataManager {
291 explicit MPPassManager() :
292 Pass(PT_PassManager, ID), PMDataManager() { }
294 // Delete on the fly managers.
295 ~MPPassManager() override {
296 for (auto &OnTheFlyManager : OnTheFlyManagers) {
297 FunctionPassManagerImpl *FPP = OnTheFlyManager.second;
302 /// createPrinterPass - Get a module printer pass.
303 Pass *createPrinterPass(raw_ostream &O,
304 const std::string &Banner) const override {
305 return createPrintModulePass(O, Banner);
308 /// run - Execute all of the passes scheduled for execution. Keep track of
309 /// whether any of the passes modifies the module, and if so, return true.
310 bool runOnModule(Module &M);
312 using llvm::Pass::doInitialization;
313 using llvm::Pass::doFinalization;
315 /// doInitialization - Run all of the initializers for the module passes.
317 bool doInitialization();
319 /// doFinalization - Run all of the finalizers for the module passes.
321 bool doFinalization();
323 /// Pass Manager itself does not invalidate any analysis info.
324 void getAnalysisUsage(AnalysisUsage &Info) const override {
325 Info.setPreservesAll();
328 /// Add RequiredPass into list of lower level passes required by pass P.
329 /// RequiredPass is run on the fly by Pass Manager when P requests it
330 /// through getAnalysis interface.
331 void addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) override;
333 /// Return function pass corresponding to PassInfo PI, that is
334 /// required by module pass MP. Instantiate analysis pass, by using
335 /// its runOnFunction() for function F.
336 Pass* getOnTheFlyPass(Pass *MP, AnalysisID PI, Function &F) override;
338 const char *getPassName() const override {
339 return "Module Pass Manager";
342 PMDataManager *getAsPMDataManager() override { return this; }
343 Pass *getAsPass() override { return this; }
345 // Print passes managed by this manager
346 void dumpPassStructure(unsigned Offset) override {
347 dbgs().indent(Offset*2) << "ModulePass Manager\n";
348 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
349 ModulePass *MP = getContainedPass(Index);
350 MP->dumpPassStructure(Offset + 1);
351 std::map<Pass *, FunctionPassManagerImpl *>::const_iterator I =
352 OnTheFlyManagers.find(MP);
353 if (I != OnTheFlyManagers.end())
354 I->second->dumpPassStructure(Offset + 2);
355 dumpLastUses(MP, Offset+1);
359 ModulePass *getContainedPass(unsigned N) {
360 assert(N < PassVector.size() && "Pass number out of range!");
361 return static_cast<ModulePass *>(PassVector[N]);
364 PassManagerType getPassManagerType() const override {
365 return PMT_ModulePassManager;
369 /// Collection of on the fly FPPassManagers. These managers manage
370 /// function passes that are required by module passes.
371 std::map<Pass *, FunctionPassManagerImpl *> OnTheFlyManagers;
374 char MPPassManager::ID = 0;
375 } // End anonymous namespace
379 //===----------------------------------------------------------------------===//
383 /// PassManagerImpl manages MPPassManagers
384 class PassManagerImpl : public Pass,
385 public PMDataManager,
386 public PMTopLevelManager {
387 virtual void anchor();
391 explicit PassManagerImpl() :
392 Pass(PT_PassManager, ID), PMDataManager(),
393 PMTopLevelManager(new MPPassManager()) {}
395 /// \copydoc PassManager::add()
400 /// createPrinterPass - Get a module printer pass.
401 Pass *createPrinterPass(raw_ostream &O,
402 const std::string &Banner) const override {
403 return createPrintModulePass(O, Banner);
406 /// run - Execute all of the passes scheduled for execution. Keep track of
407 /// whether any of the passes modifies the module, and if so, return true.
410 using llvm::Pass::doInitialization;
411 using llvm::Pass::doFinalization;
413 /// doInitialization - Run all of the initializers for the module passes.
415 bool doInitialization();
417 /// doFinalization - Run all of the finalizers for the module passes.
419 bool doFinalization();
421 /// Pass Manager itself does not invalidate any analysis info.
422 void getAnalysisUsage(AnalysisUsage &Info) const override {
423 Info.setPreservesAll();
426 PMDataManager *getAsPMDataManager() override { return this; }
427 Pass *getAsPass() override { return this; }
428 PassManagerType getTopLevelPassManagerType() override {
429 return PMT_ModulePassManager;
432 MPPassManager *getContainedManager(unsigned N) {
433 assert(N < PassManagers.size() && "Pass number out of range!");
434 MPPassManager *MP = static_cast<MPPassManager *>(PassManagers[N]);
439 void PassManagerImpl::anchor() {}
441 char PassManagerImpl::ID = 0;
442 } // End of legacy namespace
443 } // End of llvm namespace
447 //===----------------------------------------------------------------------===//
448 /// TimingInfo Class - This class is used to calculate information about the
449 /// amount of time each pass takes to execute. This only happens when
450 /// -time-passes is enabled on the command line.
453 static ManagedStatic<sys::SmartMutex<true> > TimingInfoMutex;
456 DenseMap<Pass*, Timer*> TimingData;
459 // Use 'create' member to get this.
460 TimingInfo() : TG("... Pass execution timing report ...") {}
462 // TimingDtor - Print out information about timing information
464 // Delete all of the timers, which accumulate their info into the
466 for (auto &I : TimingData)
468 // TimerGroup is deleted next, printing the report.
471 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer
472 // to a non-null value (if the -time-passes option is enabled) or it leaves it
473 // null. It may be called multiple times.
474 static void createTheTimeInfo();
476 /// getPassTimer - Return the timer for the specified pass if it exists.
477 Timer *getPassTimer(Pass *P) {
478 if (P->getAsPMDataManager())
481 sys::SmartScopedLock<true> Lock(*TimingInfoMutex);
482 Timer *&T = TimingData[P];
484 T = new Timer(P->getPassName(), TG);
489 } // End of anon namespace
491 static TimingInfo *TheTimeInfo;
493 //===----------------------------------------------------------------------===//
494 // PMTopLevelManager implementation
496 /// Initialize top level manager. Create first pass manager.
497 PMTopLevelManager::PMTopLevelManager(PMDataManager *PMDM) {
498 PMDM->setTopLevelManager(this);
499 addPassManager(PMDM);
500 activeStack.push(PMDM);
503 /// Set pass P as the last user of the given analysis passes.
505 PMTopLevelManager::setLastUser(ArrayRef<Pass*> AnalysisPasses, Pass *P) {
507 if (P->getResolver())
508 PDepth = P->getResolver()->getPMDataManager().getDepth();
510 for (Pass *AP : AnalysisPasses) {
516 // Update the last users of passes that are required transitive by AP.
517 AnalysisUsage *AnUsage = findAnalysisUsage(AP);
518 const AnalysisUsage::VectorType &IDs = AnUsage->getRequiredTransitiveSet();
519 SmallVector<Pass *, 12> LastUses;
520 SmallVector<Pass *, 12> LastPMUses;
521 for (AnalysisUsage::VectorType::const_iterator I = IDs.begin(),
522 E = IDs.end(); I != E; ++I) {
523 Pass *AnalysisPass = findAnalysisPass(*I);
524 assert(AnalysisPass && "Expected analysis pass to exist.");
525 AnalysisResolver *AR = AnalysisPass->getResolver();
526 assert(AR && "Expected analysis resolver to exist.");
527 unsigned APDepth = AR->getPMDataManager().getDepth();
529 if (PDepth == APDepth)
530 LastUses.push_back(AnalysisPass);
531 else if (PDepth > APDepth)
532 LastPMUses.push_back(AnalysisPass);
535 setLastUser(LastUses, P);
537 // If this pass has a corresponding pass manager, push higher level
538 // analysis to this pass manager.
539 if (P->getResolver())
540 setLastUser(LastPMUses, P->getResolver()->getPMDataManager().getAsPass());
543 // If AP is the last user of other passes then make P last user of
545 for (DenseMap<Pass *, Pass *>::iterator LUI = LastUser.begin(),
546 LUE = LastUser.end(); LUI != LUE; ++LUI) {
547 if (LUI->second == AP)
548 // DenseMap iterator is not invalidated here because
549 // this is just updating existing entries.
550 LastUser[LUI->first] = P;
555 /// Collect passes whose last user is P
556 void PMTopLevelManager::collectLastUses(SmallVectorImpl<Pass *> &LastUses,
558 DenseMap<Pass *, SmallPtrSet<Pass *, 8> >::iterator DMI =
559 InversedLastUser.find(P);
560 if (DMI == InversedLastUser.end())
563 SmallPtrSet<Pass *, 8> &LU = DMI->second;
564 for (Pass *LUP : LU) {
565 LastUses.push_back(LUP);
570 AnalysisUsage *PMTopLevelManager::findAnalysisUsage(Pass *P) {
571 AnalysisUsage *AnUsage = nullptr;
572 DenseMap<Pass *, AnalysisUsage *>::iterator DMI = AnUsageMap.find(P);
573 if (DMI != AnUsageMap.end())
574 AnUsage = DMI->second;
576 AnUsage = new AnalysisUsage();
577 P->getAnalysisUsage(*AnUsage);
578 AnUsageMap[P] = AnUsage;
583 /// Schedule pass P for execution. Make sure that passes required by
584 /// P are run before P is run. Update analysis info maintained by
585 /// the manager. Remove dead passes. This is a recursive function.
586 void PMTopLevelManager::schedulePass(Pass *P) {
588 // TODO : Allocate function manager for this pass, other wise required set
589 // may be inserted into previous function manager
591 // Give pass a chance to prepare the stage.
592 P->preparePassManager(activeStack);
594 // If P is an analysis pass and it is available then do not
595 // generate the analysis again. Stale analysis info should not be
596 // available at this point.
597 const PassInfo *PI = findAnalysisPassInfo(P->getPassID());
598 if (PI && PI->isAnalysis() && findAnalysisPass(P->getPassID())) {
603 AnalysisUsage *AnUsage = findAnalysisUsage(P);
605 bool checkAnalysis = true;
606 while (checkAnalysis) {
607 checkAnalysis = false;
609 const AnalysisUsage::VectorType &RequiredSet = AnUsage->getRequiredSet();
610 for (AnalysisUsage::VectorType::const_iterator I = RequiredSet.begin(),
611 E = RequiredSet.end(); I != E; ++I) {
613 Pass *AnalysisPass = findAnalysisPass(*I);
615 const PassInfo *PI = findAnalysisPassInfo(*I);
618 // Pass P is not in the global PassRegistry
619 dbgs() << "Pass '" << P->getPassName() << "' is not initialized." << "\n";
620 dbgs() << "Verify if there is a pass dependency cycle." << "\n";
621 dbgs() << "Required Passes:" << "\n";
622 for (AnalysisUsage::VectorType::const_iterator I2 = RequiredSet.begin(),
623 E = RequiredSet.end(); I2 != E && I2 != I; ++I2) {
624 Pass *AnalysisPass2 = findAnalysisPass(*I2);
626 dbgs() << "\t" << AnalysisPass2->getPassName() << "\n";
628 dbgs() << "\t" << "Error: Required pass not found! Possible causes:" << "\n";
629 dbgs() << "\t\t" << "- Pass misconfiguration (e.g.: missing macros)" << "\n";
630 dbgs() << "\t\t" << "- Corruption of the global PassRegistry" << "\n";
635 assert(PI && "Expected required passes to be initialized");
636 AnalysisPass = PI->createPass();
637 if (P->getPotentialPassManagerType () ==
638 AnalysisPass->getPotentialPassManagerType())
639 // Schedule analysis pass that is managed by the same pass manager.
640 schedulePass(AnalysisPass);
641 else if (P->getPotentialPassManagerType () >
642 AnalysisPass->getPotentialPassManagerType()) {
643 // Schedule analysis pass that is managed by a new manager.
644 schedulePass(AnalysisPass);
645 // Recheck analysis passes to ensure that required analyses that
646 // are already checked are still available.
647 checkAnalysis = true;
649 // Do not schedule this analysis. Lower level analysis
650 // passes are run on the fly.
656 // Now all required passes are available.
657 if (ImmutablePass *IP = P->getAsImmutablePass()) {
658 // P is a immutable pass and it will be managed by this
659 // top level manager. Set up analysis resolver to connect them.
660 PMDataManager *DM = getAsPMDataManager();
661 AnalysisResolver *AR = new AnalysisResolver(*DM);
663 DM->initializeAnalysisImpl(P);
664 addImmutablePass(IP);
665 DM->recordAvailableAnalysis(IP);
669 if (PI && !PI->isAnalysis() && ShouldPrintBeforePass(PI)) {
670 Pass *PP = P->createPrinterPass(
671 dbgs(), std::string("*** IR Dump Before ") + P->getPassName() + " ***");
672 PP->assignPassManager(activeStack, getTopLevelPassManagerType());
675 // Add the requested pass to the best available pass manager.
676 P->assignPassManager(activeStack, getTopLevelPassManagerType());
678 if (PI && !PI->isAnalysis() && ShouldPrintAfterPass(PI)) {
679 Pass *PP = P->createPrinterPass(
680 dbgs(), std::string("*** IR Dump After ") + P->getPassName() + " ***");
681 PP->assignPassManager(activeStack, getTopLevelPassManagerType());
685 /// Find the pass that implements Analysis AID. Search immutable
686 /// passes and all pass managers. If desired pass is not found
687 /// then return NULL.
688 Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
690 // Check pass managers
691 for (PMDataManager *PassManager : PassManagers)
692 if (Pass *P = PassManager->findAnalysisPass(AID, false))
695 // Check other pass managers
696 for (PMDataManager *IndirectPassManager : IndirectPassManagers)
697 if (Pass *P = IndirectPassManager->findAnalysisPass(AID, false))
700 // Check the immutable passes. Iterate in reverse order so that we find
701 // the most recently registered passes first.
702 for (auto I = ImmutablePasses.rbegin(), E = ImmutablePasses.rend(); I != E;
704 AnalysisID PI = (*I)->getPassID();
708 // If Pass not found then check the interfaces implemented by Immutable Pass
709 const PassInfo *PassInf = findAnalysisPassInfo(PI);
710 assert(PassInf && "Expected all immutable passes to be initialized");
711 const std::vector<const PassInfo*> &ImmPI =
712 PassInf->getInterfacesImplemented();
713 for (const PassInfo *PI : ImmPI)
714 if (PI->getTypeInfo() == AID)
721 const PassInfo *PMTopLevelManager::findAnalysisPassInfo(AnalysisID AID) const {
722 const PassInfo *&PI = AnalysisPassInfos[AID];
724 PI = PassRegistry::getPassRegistry()->getPassInfo(AID);
726 assert(PI == PassRegistry::getPassRegistry()->getPassInfo(AID) &&
727 "The pass info pointer changed for an analysis ID!");
732 // Print passes managed by this top level manager.
733 void PMTopLevelManager::dumpPasses() const {
735 if (PassDebugging < Structure)
738 // Print out the immutable passes
739 for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
740 ImmutablePasses[i]->dumpPassStructure(0);
743 // Every class that derives from PMDataManager also derives from Pass
744 // (sometimes indirectly), but there's no inheritance relationship
745 // between PMDataManager and Pass, so we have to getAsPass to get
746 // from a PMDataManager* to a Pass*.
747 for (PMDataManager *Manager : PassManagers)
748 Manager->getAsPass()->dumpPassStructure(1);
751 void PMTopLevelManager::dumpArguments() const {
753 if (PassDebugging < Arguments)
756 dbgs() << "Pass Arguments: ";
757 for (SmallVectorImpl<ImmutablePass *>::const_iterator I =
758 ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
759 if (const PassInfo *PI = findAnalysisPassInfo((*I)->getPassID())) {
760 assert(PI && "Expected all immutable passes to be initialized");
761 if (!PI->isAnalysisGroup())
762 dbgs() << " -" << PI->getPassArgument();
764 for (SmallVectorImpl<PMDataManager *>::const_iterator I =
765 PassManagers.begin(), E = PassManagers.end(); I != E; ++I)
766 (*I)->dumpPassArguments();
770 void PMTopLevelManager::initializeAllAnalysisInfo() {
771 for (SmallVectorImpl<PMDataManager *>::iterator I = PassManagers.begin(),
772 E = PassManagers.end(); I != E; ++I)
773 (*I)->initializeAnalysisInfo();
775 // Initailize other pass managers
776 for (SmallVectorImpl<PMDataManager *>::iterator
777 I = IndirectPassManagers.begin(), E = IndirectPassManagers.end();
779 (*I)->initializeAnalysisInfo();
781 for (DenseMap<Pass *, Pass *>::iterator DMI = LastUser.begin(),
782 DME = LastUser.end(); DMI != DME; ++DMI) {
783 DenseMap<Pass *, SmallPtrSet<Pass *, 8> >::iterator InvDMI =
784 InversedLastUser.find(DMI->second);
785 if (InvDMI != InversedLastUser.end()) {
786 SmallPtrSet<Pass *, 8> &L = InvDMI->second;
787 L.insert(DMI->first);
789 SmallPtrSet<Pass *, 8> L; L.insert(DMI->first);
790 InversedLastUser[DMI->second] = L;
796 PMTopLevelManager::~PMTopLevelManager() {
797 for (SmallVectorImpl<PMDataManager *>::iterator I = PassManagers.begin(),
798 E = PassManagers.end(); I != E; ++I)
801 for (SmallVectorImpl<ImmutablePass *>::iterator
802 I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
805 for (DenseMap<Pass *, AnalysisUsage *>::iterator DMI = AnUsageMap.begin(),
806 DME = AnUsageMap.end(); DMI != DME; ++DMI)
810 //===----------------------------------------------------------------------===//
811 // PMDataManager implementation
813 /// Augement AvailableAnalysis by adding analysis made available by pass P.
814 void PMDataManager::recordAvailableAnalysis(Pass *P) {
815 AnalysisID PI = P->getPassID();
817 AvailableAnalysis[PI] = P;
819 assert(!AvailableAnalysis.empty());
821 // This pass is the current implementation of all of the interfaces it
822 // implements as well.
823 const PassInfo *PInf = TPM->findAnalysisPassInfo(PI);
825 const std::vector<const PassInfo*> &II = PInf->getInterfacesImplemented();
826 for (unsigned i = 0, e = II.size(); i != e; ++i)
827 AvailableAnalysis[II[i]->getTypeInfo()] = P;
830 // Return true if P preserves high level analysis used by other
831 // passes managed by this manager
832 bool PMDataManager::preserveHigherLevelAnalysis(Pass *P) {
833 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
834 if (AnUsage->getPreservesAll())
837 const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
838 for (SmallVectorImpl<Pass *>::iterator I = HigherLevelAnalysis.begin(),
839 E = HigherLevelAnalysis.end(); I != E; ++I) {
841 if (P1->getAsImmutablePass() == nullptr &&
842 std::find(PreservedSet.begin(), PreservedSet.end(),
851 /// verifyPreservedAnalysis -- Verify analysis preserved by pass P.
852 void PMDataManager::verifyPreservedAnalysis(Pass *P) {
853 // Don't do this unless assertions are enabled.
857 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
858 const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
860 // Verify preserved analysis
861 for (AnalysisUsage::VectorType::const_iterator I = PreservedSet.begin(),
862 E = PreservedSet.end(); I != E; ++I) {
864 if (Pass *AP = findAnalysisPass(AID, true)) {
865 TimeRegion PassTimer(getPassTimer(AP));
866 AP->verifyAnalysis();
871 /// Remove Analysis not preserved by Pass P
872 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
873 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
874 if (AnUsage->getPreservesAll())
877 const AnalysisUsage::VectorType &PreservedSet = AnUsage->getPreservedSet();
878 for (DenseMap<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
879 E = AvailableAnalysis.end(); I != E; ) {
880 DenseMap<AnalysisID, Pass*>::iterator Info = I++;
881 if (Info->second->getAsImmutablePass() == nullptr &&
882 std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
883 PreservedSet.end()) {
884 // Remove this analysis
885 if (PassDebugging >= Details) {
886 Pass *S = Info->second;
887 dbgs() << " -- '" << P->getPassName() << "' is not preserving '";
888 dbgs() << S->getPassName() << "'\n";
890 AvailableAnalysis.erase(Info);
894 // Check inherited analysis also. If P is not preserving analysis
895 // provided by parent manager then remove it here.
896 for (unsigned Index = 0; Index < PMT_Last; ++Index) {
898 if (!InheritedAnalysis[Index])
901 for (DenseMap<AnalysisID, Pass*>::iterator
902 I = InheritedAnalysis[Index]->begin(),
903 E = InheritedAnalysis[Index]->end(); I != E; ) {
904 DenseMap<AnalysisID, Pass *>::iterator Info = I++;
905 if (Info->second->getAsImmutablePass() == nullptr &&
906 std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
907 PreservedSet.end()) {
908 // Remove this analysis
909 if (PassDebugging >= Details) {
910 Pass *S = Info->second;
911 dbgs() << " -- '" << P->getPassName() << "' is not preserving '";
912 dbgs() << S->getPassName() << "'\n";
914 InheritedAnalysis[Index]->erase(Info);
920 /// Remove analysis passes that are not used any longer
921 void PMDataManager::removeDeadPasses(Pass *P, StringRef Msg,
922 enum PassDebuggingString DBG_STR) {
924 SmallVector<Pass *, 12> DeadPasses;
926 // If this is a on the fly manager then it does not have TPM.
930 TPM->collectLastUses(DeadPasses, P);
932 if (PassDebugging >= Details && !DeadPasses.empty()) {
933 dbgs() << " -*- '" << P->getPassName();
934 dbgs() << "' is the last user of following pass instances.";
935 dbgs() << " Free these instances\n";
938 for (SmallVectorImpl<Pass *>::iterator I = DeadPasses.begin(),
939 E = DeadPasses.end(); I != E; ++I)
940 freePass(*I, Msg, DBG_STR);
943 void PMDataManager::freePass(Pass *P, StringRef Msg,
944 enum PassDebuggingString DBG_STR) {
945 dumpPassInfo(P, FREEING_MSG, DBG_STR, Msg);
948 // If the pass crashes releasing memory, remember this.
949 PassManagerPrettyStackEntry X(P);
950 TimeRegion PassTimer(getPassTimer(P));
955 AnalysisID PI = P->getPassID();
956 if (const PassInfo *PInf = TPM->findAnalysisPassInfo(PI)) {
957 // Remove the pass itself (if it is not already removed).
958 AvailableAnalysis.erase(PI);
960 // Remove all interfaces this pass implements, for which it is also
961 // listed as the available implementation.
962 const std::vector<const PassInfo*> &II = PInf->getInterfacesImplemented();
963 for (unsigned i = 0, e = II.size(); i != e; ++i) {
964 DenseMap<AnalysisID, Pass*>::iterator Pos =
965 AvailableAnalysis.find(II[i]->getTypeInfo());
966 if (Pos != AvailableAnalysis.end() && Pos->second == P)
967 AvailableAnalysis.erase(Pos);
972 /// Add pass P into the PassVector. Update
973 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
974 void PMDataManager::add(Pass *P, bool ProcessAnalysis) {
975 // This manager is going to manage pass P. Set up analysis resolver
977 AnalysisResolver *AR = new AnalysisResolver(*this);
980 // If a FunctionPass F is the last user of ModulePass info M
981 // then the F's manager, not F, records itself as a last user of M.
982 SmallVector<Pass *, 12> TransferLastUses;
984 if (!ProcessAnalysis) {
986 PassVector.push_back(P);
990 // At the moment, this pass is the last user of all required passes.
991 SmallVector<Pass *, 12> LastUses;
992 SmallVector<Pass *, 8> UsedPasses;
993 SmallVector<AnalysisID, 8> ReqAnalysisNotAvailable;
995 unsigned PDepth = this->getDepth();
997 collectRequiredAndUsedAnalyses(UsedPasses, ReqAnalysisNotAvailable, P);
998 for (Pass *PUsed : UsedPasses) {
1001 assert(PUsed->getResolver() && "Analysis Resolver is not set");
1002 PMDataManager &DM = PUsed->getResolver()->getPMDataManager();
1003 RDepth = DM.getDepth();
1005 if (PDepth == RDepth)
1006 LastUses.push_back(PUsed);
1007 else if (PDepth > RDepth) {
1008 // Let the parent claim responsibility of last use
1009 TransferLastUses.push_back(PUsed);
1010 // Keep track of higher level analysis used by this manager.
1011 HigherLevelAnalysis.push_back(PUsed);
1013 llvm_unreachable("Unable to accommodate Used Pass");
1016 // Set P as P's last user until someone starts using P.
1017 // However, if P is a Pass Manager then it does not need
1018 // to record its last user.
1019 if (!P->getAsPMDataManager())
1020 LastUses.push_back(P);
1021 TPM->setLastUser(LastUses, P);
1023 if (!TransferLastUses.empty()) {
1024 Pass *My_PM = getAsPass();
1025 TPM->setLastUser(TransferLastUses, My_PM);
1026 TransferLastUses.clear();
1029 // Now, take care of required analyses that are not available.
1030 for (AnalysisID ID : ReqAnalysisNotAvailable) {
1031 const PassInfo *PI = TPM->findAnalysisPassInfo(ID);
1032 Pass *AnalysisPass = PI->createPass();
1033 this->addLowerLevelRequiredPass(P, AnalysisPass);
1036 // Take a note of analysis required and made available by this pass.
1037 // Remove the analysis not preserved by this pass
1038 removeNotPreservedAnalysis(P);
1039 recordAvailableAnalysis(P);
1042 PassVector.push_back(P);
1046 /// Populate UP with analysis pass that are used or required by
1047 /// pass P and are available. Populate RP_NotAvail with analysis
1048 /// pass that are required by pass P but are not available.
1049 void PMDataManager::collectRequiredAndUsedAnalyses(
1050 SmallVectorImpl<Pass *> &UP, SmallVectorImpl<AnalysisID> &RP_NotAvail,
1052 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
1054 for (const auto &UsedID : AnUsage->getUsedSet())
1055 if (Pass *AnalysisPass = findAnalysisPass(UsedID, true))
1056 UP.push_back(AnalysisPass);
1058 for (const auto &RequiredID : AnUsage->getRequiredSet())
1059 if (Pass *AnalysisPass = findAnalysisPass(RequiredID, true))
1060 UP.push_back(AnalysisPass);
1062 RP_NotAvail.push_back(RequiredID);
1064 for (const auto &RequiredID : AnUsage->getRequiredTransitiveSet())
1065 if (Pass *AnalysisPass = findAnalysisPass(RequiredID, true))
1066 UP.push_back(AnalysisPass);
1068 RP_NotAvail.push_back(RequiredID);
1071 // All Required analyses should be available to the pass as it runs! Here
1072 // we fill in the AnalysisImpls member of the pass so that it can
1073 // successfully use the getAnalysis() method to retrieve the
1074 // implementations it needs.
1076 void PMDataManager::initializeAnalysisImpl(Pass *P) {
1077 AnalysisUsage *AnUsage = TPM->findAnalysisUsage(P);
1079 for (AnalysisUsage::VectorType::const_iterator
1080 I = AnUsage->getRequiredSet().begin(),
1081 E = AnUsage->getRequiredSet().end(); I != E; ++I) {
1082 Pass *Impl = findAnalysisPass(*I, true);
1084 // This may be analysis pass that is initialized on the fly.
1085 // If that is not the case then it will raise an assert when it is used.
1087 AnalysisResolver *AR = P->getResolver();
1088 assert(AR && "Analysis Resolver is not set");
1089 AR->addAnalysisImplsPair(*I, Impl);
1093 /// Find the pass that implements Analysis AID. If desired pass is not found
1094 /// then return NULL.
1095 Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
1097 // Check if AvailableAnalysis map has one entry.
1098 DenseMap<AnalysisID, Pass*>::const_iterator I = AvailableAnalysis.find(AID);
1100 if (I != AvailableAnalysis.end())
1103 // Search Parents through TopLevelManager
1105 return TPM->findAnalysisPass(AID);
1110 // Print list of passes that are last used by P.
1111 void PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{
1113 SmallVector<Pass *, 12> LUses;
1115 // If this is a on the fly manager then it does not have TPM.
1119 TPM->collectLastUses(LUses, P);
1121 for (SmallVectorImpl<Pass *>::iterator I = LUses.begin(),
1122 E = LUses.end(); I != E; ++I) {
1123 dbgs() << "--" << std::string(Offset*2, ' ');
1124 (*I)->dumpPassStructure(0);
1128 void PMDataManager::dumpPassArguments() const {
1129 for (SmallVectorImpl<Pass *>::const_iterator I = PassVector.begin(),
1130 E = PassVector.end(); I != E; ++I) {
1131 if (PMDataManager *PMD = (*I)->getAsPMDataManager())
1132 PMD->dumpPassArguments();
1134 if (const PassInfo *PI =
1135 TPM->findAnalysisPassInfo((*I)->getPassID()))
1136 if (!PI->isAnalysisGroup())
1137 dbgs() << " -" << PI->getPassArgument();
1141 void PMDataManager::dumpPassInfo(Pass *P, enum PassDebuggingString S1,
1142 enum PassDebuggingString S2,
1144 if (PassDebugging < Executions)
1146 dbgs() << "[" << sys::TimeValue::now().str() << "] " << (void *)this
1147 << std::string(getDepth() * 2 + 1, ' ');
1150 dbgs() << "Executing Pass '" << P->getPassName();
1152 case MODIFICATION_MSG:
1153 dbgs() << "Made Modification '" << P->getPassName();
1156 dbgs() << " Freeing Pass '" << P->getPassName();
1162 case ON_BASICBLOCK_MSG:
1163 dbgs() << "' on BasicBlock '" << Msg << "'...\n";
1165 case ON_FUNCTION_MSG:
1166 dbgs() << "' on Function '" << Msg << "'...\n";
1169 dbgs() << "' on Module '" << Msg << "'...\n";
1172 dbgs() << "' on Region '" << Msg << "'...\n";
1175 dbgs() << "' on Loop '" << Msg << "'...\n";
1178 dbgs() << "' on Call Graph Nodes '" << Msg << "'...\n";
1185 void PMDataManager::dumpRequiredSet(const Pass *P) const {
1186 if (PassDebugging < Details)
1189 AnalysisUsage analysisUsage;
1190 P->getAnalysisUsage(analysisUsage);
1191 dumpAnalysisUsage("Required", P, analysisUsage.getRequiredSet());
1194 void PMDataManager::dumpPreservedSet(const Pass *P) const {
1195 if (PassDebugging < Details)
1198 AnalysisUsage analysisUsage;
1199 P->getAnalysisUsage(analysisUsage);
1200 dumpAnalysisUsage("Preserved", P, analysisUsage.getPreservedSet());
1203 void PMDataManager::dumpUsedSet(const Pass *P) const {
1204 if (PassDebugging < Details)
1207 AnalysisUsage analysisUsage;
1208 P->getAnalysisUsage(analysisUsage);
1209 dumpAnalysisUsage("Used", P, analysisUsage.getUsedSet());
1212 void PMDataManager::dumpAnalysisUsage(StringRef Msg, const Pass *P,
1213 const AnalysisUsage::VectorType &Set) const {
1214 assert(PassDebugging >= Details);
1217 dbgs() << (const void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:";
1218 for (unsigned i = 0; i != Set.size(); ++i) {
1219 if (i) dbgs() << ',';
1220 const PassInfo *PInf = TPM->findAnalysisPassInfo(Set[i]);
1222 // Some preserved passes, such as AliasAnalysis, may not be initialized by
1224 dbgs() << " Uninitialized Pass";
1227 dbgs() << ' ' << PInf->getPassName();
1232 /// Add RequiredPass into list of lower level passes required by pass P.
1233 /// RequiredPass is run on the fly by Pass Manager when P requests it
1234 /// through getAnalysis interface.
1235 /// This should be handled by specific pass manager.
1236 void PMDataManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
1238 TPM->dumpArguments();
1242 // Module Level pass may required Function Level analysis info
1243 // (e.g. dominator info). Pass manager uses on the fly function pass manager
1244 // to provide this on demand. In that case, in Pass manager terminology,
1245 // module level pass is requiring lower level analysis info managed by
1246 // lower level pass manager.
1248 // When Pass manager is not able to order required analysis info, Pass manager
1249 // checks whether any lower level manager will be able to provide this
1250 // analysis info on demand or not.
1252 dbgs() << "Unable to schedule '" << RequiredPass->getPassName();
1253 dbgs() << "' required by '" << P->getPassName() << "'\n";
1255 llvm_unreachable("Unable to schedule pass");
1258 Pass *PMDataManager::getOnTheFlyPass(Pass *P, AnalysisID PI, Function &F) {
1259 llvm_unreachable("Unable to find on the fly pass");
1263 PMDataManager::~PMDataManager() {
1264 for (SmallVectorImpl<Pass *>::iterator I = PassVector.begin(),
1265 E = PassVector.end(); I != E; ++I)
1269 //===----------------------------------------------------------------------===//
1270 // NOTE: Is this the right place to define this method ?
1271 // getAnalysisIfAvailable - Return analysis result or null if it doesn't exist.
1272 Pass *AnalysisResolver::getAnalysisIfAvailable(AnalysisID ID, bool dir) const {
1273 return PM.findAnalysisPass(ID, dir);
1276 Pass *AnalysisResolver::findImplPass(Pass *P, AnalysisID AnalysisPI,
1278 return PM.getOnTheFlyPass(P, AnalysisPI, F);
1281 //===----------------------------------------------------------------------===//
1282 // BBPassManager implementation
1284 /// Execute all of the passes scheduled for execution by invoking
1285 /// runOnBasicBlock method. Keep track of whether any of the passes modifies
1286 /// the function, and if so, return true.
1287 bool BBPassManager::runOnFunction(Function &F) {
1288 if (F.isDeclaration())
1291 bool Changed = doInitialization(F);
1293 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
1294 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1295 BasicBlockPass *BP = getContainedPass(Index);
1296 bool LocalChanged = false;
1298 dumpPassInfo(BP, EXECUTION_MSG, ON_BASICBLOCK_MSG, I->getName());
1299 dumpRequiredSet(BP);
1301 initializeAnalysisImpl(BP);
1304 // If the pass crashes, remember this.
1305 PassManagerPrettyStackEntry X(BP, *I);
1306 TimeRegion PassTimer(getPassTimer(BP));
1308 LocalChanged |= BP->runOnBasicBlock(*I);
1311 Changed |= LocalChanged;
1313 dumpPassInfo(BP, MODIFICATION_MSG, ON_BASICBLOCK_MSG,
1315 dumpPreservedSet(BP);
1318 verifyPreservedAnalysis(BP);
1319 removeNotPreservedAnalysis(BP);
1320 recordAvailableAnalysis(BP);
1321 removeDeadPasses(BP, I->getName(), ON_BASICBLOCK_MSG);
1324 return doFinalization(F) || Changed;
1327 // Implement doInitialization and doFinalization
1328 bool BBPassManager::doInitialization(Module &M) {
1329 bool Changed = false;
1331 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1332 Changed |= getContainedPass(Index)->doInitialization(M);
1337 bool BBPassManager::doFinalization(Module &M) {
1338 bool Changed = false;
1340 for (int Index = getNumContainedPasses() - 1; Index >= 0; --Index)
1341 Changed |= getContainedPass(Index)->doFinalization(M);
1346 bool BBPassManager::doInitialization(Function &F) {
1347 bool Changed = false;
1349 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1350 BasicBlockPass *BP = getContainedPass(Index);
1351 Changed |= BP->doInitialization(F);
1357 bool BBPassManager::doFinalization(Function &F) {
1358 bool Changed = false;
1360 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1361 BasicBlockPass *BP = getContainedPass(Index);
1362 Changed |= BP->doFinalization(F);
1369 //===----------------------------------------------------------------------===//
1370 // FunctionPassManager implementation
1372 /// Create new Function pass manager
1373 FunctionPassManager::FunctionPassManager(Module *m) : M(m) {
1374 FPM = new FunctionPassManagerImpl();
1375 // FPM is the top level manager.
1376 FPM->setTopLevelManager(FPM);
1378 AnalysisResolver *AR = new AnalysisResolver(*FPM);
1379 FPM->setResolver(AR);
1382 FunctionPassManager::~FunctionPassManager() {
1386 void FunctionPassManager::add(Pass *P) {
1390 /// run - Execute all of the passes scheduled for execution. Keep
1391 /// track of whether any of the passes modifies the function, and if
1392 /// so, return true.
1394 bool FunctionPassManager::run(Function &F) {
1395 if (std::error_code EC = F.materialize())
1396 report_fatal_error("Error reading bitcode file: " + EC.message());
1401 /// doInitialization - Run all of the initializers for the function passes.
1403 bool FunctionPassManager::doInitialization() {
1404 return FPM->doInitialization(*M);
1407 /// doFinalization - Run all of the finalizers for the function passes.
1409 bool FunctionPassManager::doFinalization() {
1410 return FPM->doFinalization(*M);
1413 //===----------------------------------------------------------------------===//
1414 // FunctionPassManagerImpl implementation
1416 bool FunctionPassManagerImpl::doInitialization(Module &M) {
1417 bool Changed = false;
1422 for (ImmutablePass *ImPass : getImmutablePasses())
1423 Changed |= ImPass->doInitialization(M);
1425 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1426 Changed |= getContainedManager(Index)->doInitialization(M);
1431 bool FunctionPassManagerImpl::doFinalization(Module &M) {
1432 bool Changed = false;
1434 for (int Index = getNumContainedManagers() - 1; Index >= 0; --Index)
1435 Changed |= getContainedManager(Index)->doFinalization(M);
1437 for (ImmutablePass *ImPass : getImmutablePasses())
1438 Changed |= ImPass->doFinalization(M);
1443 /// cleanup - After running all passes, clean up pass manager cache.
1444 void FPPassManager::cleanup() {
1445 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1446 FunctionPass *FP = getContainedPass(Index);
1447 AnalysisResolver *AR = FP->getResolver();
1448 assert(AR && "Analysis Resolver is not set");
1449 AR->clearAnalysisImpls();
1453 void FunctionPassManagerImpl::releaseMemoryOnTheFly() {
1456 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1457 FPPassManager *FPPM = getContainedManager(Index);
1458 for (unsigned Index = 0; Index < FPPM->getNumContainedPasses(); ++Index) {
1459 FPPM->getContainedPass(Index)->releaseMemory();
1465 // Execute all the passes managed by this top level manager.
1466 // Return true if any function is modified by a pass.
1467 bool FunctionPassManagerImpl::run(Function &F) {
1468 bool Changed = false;
1469 TimingInfo::createTheTimeInfo();
1471 initializeAllAnalysisInfo();
1472 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1473 Changed |= getContainedManager(Index)->runOnFunction(F);
1474 F.getContext().yield();
1477 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index)
1478 getContainedManager(Index)->cleanup();
1484 //===----------------------------------------------------------------------===//
1485 // FPPassManager implementation
1487 char FPPassManager::ID = 0;
1488 /// Print passes managed by this manager
1489 void FPPassManager::dumpPassStructure(unsigned Offset) {
1490 dbgs().indent(Offset*2) << "FunctionPass Manager\n";
1491 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1492 FunctionPass *FP = getContainedPass(Index);
1493 FP->dumpPassStructure(Offset + 1);
1494 dumpLastUses(FP, Offset+1);
1499 /// Execute all of the passes scheduled for execution by invoking
1500 /// runOnFunction method. Keep track of whether any of the passes modifies
1501 /// the function, and if so, return true.
1502 bool FPPassManager::runOnFunction(Function &F) {
1503 if (F.isDeclaration())
1506 bool Changed = false;
1508 // Collect inherited analysis from Module level pass manager.
1509 populateInheritedAnalysis(TPM->activeStack);
1511 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1512 FunctionPass *FP = getContainedPass(Index);
1513 bool LocalChanged = false;
1515 dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getName());
1516 dumpRequiredSet(FP);
1518 initializeAnalysisImpl(FP);
1521 PassManagerPrettyStackEntry X(FP, F);
1522 TimeRegion PassTimer(getPassTimer(FP));
1524 LocalChanged |= FP->runOnFunction(F);
1527 Changed |= LocalChanged;
1529 dumpPassInfo(FP, MODIFICATION_MSG, ON_FUNCTION_MSG, F.getName());
1530 dumpPreservedSet(FP);
1533 verifyPreservedAnalysis(FP);
1534 removeNotPreservedAnalysis(FP);
1535 recordAvailableAnalysis(FP);
1536 removeDeadPasses(FP, F.getName(), ON_FUNCTION_MSG);
1541 bool FPPassManager::runOnModule(Module &M) {
1542 bool Changed = false;
1544 for (Function &F : M)
1545 Changed |= runOnFunction(F);
1550 bool FPPassManager::doInitialization(Module &M) {
1551 bool Changed = false;
1553 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1554 Changed |= getContainedPass(Index)->doInitialization(M);
1559 bool FPPassManager::doFinalization(Module &M) {
1560 bool Changed = false;
1562 for (int Index = getNumContainedPasses() - 1; Index >= 0; --Index)
1563 Changed |= getContainedPass(Index)->doFinalization(M);
1568 //===----------------------------------------------------------------------===//
1569 // MPPassManager implementation
1571 /// Execute all of the passes scheduled for execution by invoking
1572 /// runOnModule method. Keep track of whether any of the passes modifies
1573 /// the module, and if so, return true.
1575 MPPassManager::runOnModule(Module &M) {
1576 bool Changed = false;
1578 // Initialize on-the-fly passes
1579 for (auto &OnTheFlyManager : OnTheFlyManagers) {
1580 FunctionPassManagerImpl *FPP = OnTheFlyManager.second;
1581 Changed |= FPP->doInitialization(M);
1584 // Initialize module passes
1585 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index)
1586 Changed |= getContainedPass(Index)->doInitialization(M);
1588 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
1589 ModulePass *MP = getContainedPass(Index);
1590 bool LocalChanged = false;
1592 dumpPassInfo(MP, EXECUTION_MSG, ON_MODULE_MSG, M.getModuleIdentifier());
1593 dumpRequiredSet(MP);
1595 initializeAnalysisImpl(MP);
1598 PassManagerPrettyStackEntry X(MP, M);
1599 TimeRegion PassTimer(getPassTimer(MP));
1601 LocalChanged |= MP->runOnModule(M);
1604 Changed |= LocalChanged;
1606 dumpPassInfo(MP, MODIFICATION_MSG, ON_MODULE_MSG,
1607 M.getModuleIdentifier());
1608 dumpPreservedSet(MP);
1611 verifyPreservedAnalysis(MP);
1612 removeNotPreservedAnalysis(MP);
1613 recordAvailableAnalysis(MP);
1614 removeDeadPasses(MP, M.getModuleIdentifier(), ON_MODULE_MSG);
1617 // Finalize module passes
1618 for (int Index = getNumContainedPasses() - 1; Index >= 0; --Index)
1619 Changed |= getContainedPass(Index)->doFinalization(M);
1621 // Finalize on-the-fly passes
1622 for (auto &OnTheFlyManager : OnTheFlyManagers) {
1623 FunctionPassManagerImpl *FPP = OnTheFlyManager.second;
1624 // We don't know when is the last time an on-the-fly pass is run,
1625 // so we need to releaseMemory / finalize here
1626 FPP->releaseMemoryOnTheFly();
1627 Changed |= FPP->doFinalization(M);
1633 /// Add RequiredPass into list of lower level passes required by pass P.
1634 /// RequiredPass is run on the fly by Pass Manager when P requests it
1635 /// through getAnalysis interface.
1636 void MPPassManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
1637 assert(P->getPotentialPassManagerType() == PMT_ModulePassManager &&
1638 "Unable to handle Pass that requires lower level Analysis pass");
1639 assert((P->getPotentialPassManagerType() <
1640 RequiredPass->getPotentialPassManagerType()) &&
1641 "Unable to handle Pass that requires lower level Analysis pass");
1645 FunctionPassManagerImpl *FPP = OnTheFlyManagers[P];
1647 FPP = new FunctionPassManagerImpl();
1648 // FPP is the top level manager.
1649 FPP->setTopLevelManager(FPP);
1651 OnTheFlyManagers[P] = FPP;
1653 const PassInfo *RequiredPassPI =
1654 TPM->findAnalysisPassInfo(RequiredPass->getPassID());
1656 Pass *FoundPass = nullptr;
1657 if (RequiredPassPI && RequiredPassPI->isAnalysis()) {
1659 ((PMTopLevelManager*)FPP)->findAnalysisPass(RequiredPass->getPassID());
1662 FoundPass = RequiredPass;
1663 // This should be guaranteed to add RequiredPass to the passmanager given
1664 // that we checked for an available analysis above.
1665 FPP->add(RequiredPass);
1667 // Register P as the last user of FoundPass or RequiredPass.
1668 SmallVector<Pass *, 1> LU;
1669 LU.push_back(FoundPass);
1670 FPP->setLastUser(LU, P);
1673 /// Return function pass corresponding to PassInfo PI, that is
1674 /// required by module pass MP. Instantiate analysis pass, by using
1675 /// its runOnFunction() for function F.
1676 Pass* MPPassManager::getOnTheFlyPass(Pass *MP, AnalysisID PI, Function &F){
1677 FunctionPassManagerImpl *FPP = OnTheFlyManagers[MP];
1678 assert(FPP && "Unable to find on the fly pass");
1680 FPP->releaseMemoryOnTheFly();
1682 return ((PMTopLevelManager*)FPP)->findAnalysisPass(PI);
1686 //===----------------------------------------------------------------------===//
1687 // PassManagerImpl implementation
1690 /// run - Execute all of the passes scheduled for execution. Keep track of
1691 /// whether any of the passes modifies the module, and if so, return true.
1692 bool PassManagerImpl::run(Module &M) {
1693 bool Changed = false;
1694 TimingInfo::createTheTimeInfo();
1699 for (ImmutablePass *ImPass : getImmutablePasses())
1700 Changed |= ImPass->doInitialization(M);
1702 initializeAllAnalysisInfo();
1703 for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) {
1704 Changed |= getContainedManager(Index)->runOnModule(M);
1705 M.getContext().yield();
1708 for (ImmutablePass *ImPass : getImmutablePasses())
1709 Changed |= ImPass->doFinalization(M);
1714 //===----------------------------------------------------------------------===//
1715 // PassManager implementation
1717 /// Create new pass manager
1718 PassManager::PassManager() {
1719 PM = new PassManagerImpl();
1720 // PM is the top level manager
1721 PM->setTopLevelManager(PM);
1724 PassManager::~PassManager() {
1728 void PassManager::add(Pass *P) {
1732 /// run - Execute all of the passes scheduled for execution. Keep track of
1733 /// whether any of the passes modifies the module, and if so, return true.
1734 bool PassManager::run(Module &M) {
1738 //===----------------------------------------------------------------------===//
1739 // TimingInfo implementation
1741 bool llvm::TimePassesIsEnabled = false;
1742 static cl::opt<bool,true>
1743 EnableTiming("time-passes", cl::location(TimePassesIsEnabled),
1744 cl::desc("Time each pass, printing elapsed time for each on exit"));
1746 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
1747 // a non-null value (if the -time-passes option is enabled) or it leaves it
1748 // null. It may be called multiple times.
1749 void TimingInfo::createTheTimeInfo() {
1750 if (!TimePassesIsEnabled || TheTimeInfo) return;
1752 // Constructed the first time this is called, iff -time-passes is enabled.
1753 // This guarantees that the object will be constructed before static globals,
1754 // thus it will be destroyed before them.
1755 static ManagedStatic<TimingInfo> TTI;
1756 TheTimeInfo = &*TTI;
1759 /// If TimingInfo is enabled then start pass timer.
1760 Timer *llvm::getPassTimer(Pass *P) {
1762 return TheTimeInfo->getPassTimer(P);
1766 //===----------------------------------------------------------------------===//
1767 // PMStack implementation
1770 // Pop Pass Manager from the stack and clear its analysis info.
1771 void PMStack::pop() {
1773 PMDataManager *Top = this->top();
1774 Top->initializeAnalysisInfo();
1779 // Push PM on the stack and set its top level manager.
1780 void PMStack::push(PMDataManager *PM) {
1781 assert(PM && "Unable to push. Pass Manager expected");
1782 assert(PM->getDepth()==0 && "Pass Manager depth set too early");
1784 if (!this->empty()) {
1785 assert(PM->getPassManagerType() > this->top()->getPassManagerType()
1786 && "pushing bad pass manager to PMStack");
1787 PMTopLevelManager *TPM = this->top()->getTopLevelManager();
1789 assert(TPM && "Unable to find top level manager");
1790 TPM->addIndirectPassManager(PM);
1791 PM->setTopLevelManager(TPM);
1792 PM->setDepth(this->top()->getDepth()+1);
1794 assert((PM->getPassManagerType() == PMT_ModulePassManager
1795 || PM->getPassManagerType() == PMT_FunctionPassManager)
1796 && "pushing bad pass manager to PMStack");
1803 // Dump content of the pass manager stack.
1804 void PMStack::dump() const {
1805 for (PMDataManager *Manager : S)
1806 dbgs() << Manager->getAsPass()->getPassName() << ' ';
1812 /// Find appropriate Module Pass Manager in the PM Stack and
1813 /// add self into that manager.
1814 void ModulePass::assignPassManager(PMStack &PMS,
1815 PassManagerType PreferredType) {
1816 // Find Module Pass Manager
1817 while (!PMS.empty()) {
1818 PassManagerType TopPMType = PMS.top()->getPassManagerType();
1819 if (TopPMType == PreferredType)
1820 break; // We found desired pass manager
1821 else if (TopPMType > PMT_ModulePassManager)
1822 PMS.pop(); // Pop children pass managers
1826 assert(!PMS.empty() && "Unable to find appropriate Pass Manager");
1827 PMS.top()->add(this);
1830 /// Find appropriate Function Pass Manager or Call Graph Pass Manager
1831 /// in the PM Stack and add self into that manager.
1832 void FunctionPass::assignPassManager(PMStack &PMS,
1833 PassManagerType PreferredType) {
1835 // Find Function Pass Manager
1836 while (!PMS.empty()) {
1837 if (PMS.top()->getPassManagerType() > PMT_FunctionPassManager)
1843 // Create new Function Pass Manager if needed.
1845 if (PMS.top()->getPassManagerType() == PMT_FunctionPassManager) {
1846 FPP = (FPPassManager *)PMS.top();
1848 assert(!PMS.empty() && "Unable to create Function Pass Manager");
1849 PMDataManager *PMD = PMS.top();
1851 // [1] Create new Function Pass Manager
1852 FPP = new FPPassManager();
1853 FPP->populateInheritedAnalysis(PMS);
1855 // [2] Set up new manager's top level manager
1856 PMTopLevelManager *TPM = PMD->getTopLevelManager();
1857 TPM->addIndirectPassManager(FPP);
1859 // [3] Assign manager to manage this new manager. This may create
1860 // and push new managers into PMS
1861 FPP->assignPassManager(PMS, PMD->getPassManagerType());
1863 // [4] Push new manager into PMS
1867 // Assign FPP as the manager of this pass.
1871 /// Find appropriate Basic Pass Manager or Call Graph Pass Manager
1872 /// in the PM Stack and add self into that manager.
1873 void BasicBlockPass::assignPassManager(PMStack &PMS,
1874 PassManagerType PreferredType) {
1877 // Basic Pass Manager is a leaf pass manager. It does not handle
1878 // any other pass manager.
1880 PMS.top()->getPassManagerType() == PMT_BasicBlockPassManager) {
1881 BBP = (BBPassManager *)PMS.top();
1883 // If leaf manager is not Basic Block Pass manager then create new
1884 // basic Block Pass manager.
1885 assert(!PMS.empty() && "Unable to create BasicBlock Pass Manager");
1886 PMDataManager *PMD = PMS.top();
1888 // [1] Create new Basic Block Manager
1889 BBP = new BBPassManager();
1891 // [2] Set up new manager's top level manager
1892 // Basic Block Pass Manager does not live by itself
1893 PMTopLevelManager *TPM = PMD->getTopLevelManager();
1894 TPM->addIndirectPassManager(BBP);
1896 // [3] Assign manager to manage this new manager. This may create
1897 // and push new managers into PMS
1898 BBP->assignPassManager(PMS, PreferredType);
1900 // [4] Push new manager into PMS
1904 // Assign BBP as the manager of this pass.
1908 PassManagerBase::~PassManagerBase() {}