X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=lib%2FVMCore%2FPassManager.cpp;h=5620d0f886cca8fbabcdab447a21a8c0bbfae3fe;hb=e6be34a53ecbe8c2ff9f0793b13d847e94c0de91;hp=d67d25a3f4cb039565740e07bdb20df2c44f25f2;hpb=3162691f69f85f740bc28f3ddca39b166d35187c;p=oota-llvm.git diff --git a/lib/VMCore/PassManager.cpp b/lib/VMCore/PassManager.cpp index d67d25a3f4c..5620d0f886c 100644 --- a/lib/VMCore/PassManager.cpp +++ b/lib/VMCore/PassManager.cpp @@ -2,8 +2,8 @@ // // The LLVM Compiler Infrastructure // -// This file was developed by Devang Patel and is distributed under -// the University of Illinois Open Source License. See LICENSE.TXT for details. +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// // @@ -12,304 +12,62 @@ //===----------------------------------------------------------------------===// -#include "llvm/PassManager.h" +#include "llvm/PassManagers.h" +#include "llvm/Support/CommandLine.h" +#include "llvm/Support/Timer.h" #include "llvm/Module.h" #include "llvm/ModuleProvider.h" #include "llvm/Support/Streams.h" +#include "llvm/Support/ManagedStatic.h" +#include #include #include using namespace llvm; -//===----------------------------------------------------------------------===// -// Overview: -// The Pass Manager Infrastructure manages passes. It's responsibilities are: -// -// o Manage optimization pass execution order -// o Make required Analysis information available before pass P is run -// o Release memory occupied by dead passes -// o If Analysis information is dirtied by a pass then regenerate Analysis -// information before it is consumed by another pass. -// -// Pass Manager Infrastructure uses multipe pass managers. They are PassManager, -// FunctionPassManager, ModulePassManager, BasicBlockPassManager. This class -// hierarcy uses multiple inheritance but pass managers do not derive from -// another pass manager. -// -// PassManager and FunctionPassManager are two top level pass manager that -// represents the external interface of this entire pass manager infrastucture. -// -// Important classes : -// -// [o] class PMTopLevelManager; -// -// Two top level managers, PassManager and FunctionPassManager, derive from -// PMTopLevelManager. PMTopLevelManager manages information used by top level -// managers such as last user info. -// -// [o] class PMDataManager; -// -// PMDataManager manages information, e.g. list of available analysis info, -// used by a pass manager to manage execution order of passes. It also provides -// a place to implement common pass manager APIs. All pass managers derive from -// PMDataManager. -// -// [o] class BasicBlockPassManager : public FunctionPass, public PMDataManager; -// -// BasicBlockPassManager manages BasicBlockPasses. -// -// [o] class FunctionPassManager; -// -// This is a external interface used by JIT to manage FunctionPasses. This -// interface relies on FunctionPassManagerImpl to do all the tasks. -// -// [o] class FunctionPassManagerImpl : public ModulePass, PMDataManager, -// public PMTopLevelManager; -// -// FunctionPassManagerImpl is a top level manager. It manages FunctionPasses -// and BasicBlockPassManagers. -// -// [o] class ModulePassManager : public Pass, public PMDataManager; -// -// ModulePassManager manages ModulePasses and FunctionPassManagerImpls. -// -// [o] class PassManager; -// -// This is a external interface used by various tools to manages passes. It -// relies on PassManagerImpl to do all the tasks. -// -// [o] class PassManagerImpl : public Pass, public PMDataManager, -// public PMDTopLevelManager -// -// PassManagerImpl is a top level pass manager responsible for managing -// ModulePassManagers. -//===----------------------------------------------------------------------===// +// See PassManagers.h for Pass Manager infrastructure overview. -#ifndef USE_OLD_PASSMANAGER namespace llvm { -class PMDataManager; - //===----------------------------------------------------------------------===// -// PMTopLevelManager +// Pass debugging information. Often it is useful to find out what pass is +// running when a crash occurs in a utility. When this library is compiled with +// debugging on, a command line option (--debug-pass) is enabled that causes the +// pass name to be printed before it executes. // -/// PMTopLevelManager manages LastUser info and collects common APIs used by -/// top level pass managers. -class PMTopLevelManager { - -public: - - inline std::vector::iterator passManagersBegin() { - return PassManagers.begin(); - } - - inline std::vector::iterator passManagersEnd() { - return PassManagers.end(); - } - - /// Schedule pass P for execution. Make sure that passes required by - /// P are run before P is run. Update analysis info maintained by - /// the manager. Remove dead passes. This is a recursive function. - void schedulePass(Pass *P); - /// This is implemented by top level pass manager and used by - /// schedulePass() to add analysis info passes that are not available. - virtual void addTopLevelPass(Pass *P) = 0; - - /// Set pass P as the last user of the given analysis passes. - void setLastUser(std::vector &AnalysisPasses, Pass *P); - - /// Collect passes whose last user is P - void collectLastUses(std::vector &LastUses, Pass *P); - - /// Find the pass that implements Analysis AID. Search immutable - /// passes and all pass managers. If desired pass is not found - /// then return NULL. - Pass *findAnalysisPass(AnalysisID AID); - - inline void clearManagers() { - PassManagers.clear(); - } - - virtual ~PMTopLevelManager() { - - for (std::vector::iterator I = PassManagers.begin(), - E = PassManagers.end(); I != E; ++I) - delete *I; - - for (std::vector::iterator - I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I) - delete *I; - - PassManagers.clear(); - } - - /// Add immutable pass and initialize it. - inline void addImmutablePass(ImmutablePass *P) { - P->initializePass(); - ImmutablePasses.push_back(P); - } - - inline std::vector& getImmutablePasses() { - return ImmutablePasses; - } - - void addPassManager(Pass *Manager) { - PassManagers.push_back(Manager); - } - - // Add Manager into the list of managers that are not directly - // maintained by this top level pass manager - inline void addIndirectPassManager(PMDataManager *Manager) { - IndirectPassManagers.push_back(Manager); - } - - // Print passes managed by this top level manager. - void dumpPasses(); - -private: - - /// Collection of pass managers - std::vector PassManagers; - - /// Collection of pass managers that are not directly maintained - /// by this pass manager - std::vector IndirectPassManagers; - - // Map to keep track of last user of the analysis pass. - // LastUser->second is the last user of Lastuser->first. - std::map LastUser; - - /// Immutable passes are managed by top level manager. - std::vector ImmutablePasses; +// Different debug levels that can be enabled... +enum PassDebugLevel { + None, Arguments, Structure, Executions, Details }; - -//===----------------------------------------------------------------------===// -// PMDataManager - -/// PMDataManager provides the common place to manage the analysis data -/// used by pass managers. -class PMDataManager { -public: - - PMDataManager(int D) : TPM(NULL), Depth(D) { - initializeAnalysisInfo(); - } - - virtual ~PMDataManager() { - - for (std::vector::iterator I = PassVector.begin(), - E = PassVector.end(); I != E; ++I) - delete *I; - - PassVector.clear(); - } - - /// Return true IFF pass P's required analysis set does not required new - /// manager. - bool manageablePass(Pass *P); - - /// Augment AvailableAnalysis by adding analysis made available by pass P. - void recordAvailableAnalysis(Pass *P); - - /// Remove Analysis that is not preserved by the pass - void removeNotPreservedAnalysis(Pass *P); - - /// Remove dead passes - void removeDeadPasses(Pass *P); - - /// Add pass P into the PassVector. Update - /// AvailableAnalysis appropriately if ProcessAnalysis is true. - void addPassToManager (Pass *P, bool ProcessAnalysis = true); - - /// Initialize available analysis information. - void initializeAnalysisInfo() { - ForcedLastUses.clear(); - AvailableAnalysis.clear(); - } - - /// Populate RequiredPasses with the analysis pass that are required by - /// pass P. - void collectRequiredAnalysisPasses(std::vector &RequiredPasses, - Pass *P); - - /// All Required analyses should be available to the pass as it runs! Here - /// we fill in the AnalysisImpls member of the pass so that it can - /// successfully use the getAnalysis() method to retrieve the - /// implementations it needs. - void initializeAnalysisImpl(Pass *P); - - /// Find the pass that implements Analysis AID. If desired pass is not found - /// then return NULL. - Pass *findAnalysisPass(AnalysisID AID, bool Direction); - - inline std::vector::iterator passVectorBegin() { - return PassVector.begin(); - } - - inline std::vector::iterator passVectorEnd() { - return PassVector.end(); - } - - // Access toplevel manager - PMTopLevelManager *getTopLevelManager() { return TPM; } - void setTopLevelManager(PMTopLevelManager *T) { TPM = T; } - - unsigned getDepth() { return Depth; } - - // Print list of passes that are last used by P. - void dumpLastUses(Pass *P, unsigned Offset) { - - std::vector LUses; - - assert (TPM && "Top Level Manager is missing"); - TPM->collectLastUses(LUses, P); - - for (std::vector::iterator I = LUses.begin(), - E = LUses.end(); I != E; ++I) { - llvm::cerr << "--" << std::string(Offset*2, ' '); - (*I)->dumpPassStructure(0); - } - } - -protected: - - // Collection of pass whose last user asked this manager to claim - // last use. If a FunctionPass F is the last user of ModulePass info M - // then the F's manager, not F, records itself as a last user of M. - std::vector ForcedLastUses; - - // Top level manager. - PMTopLevelManager *TPM; - -private: - // Set of available Analysis. This information is used while scheduling - // pass. If a pass requires an analysis which is not not available then - // equired analysis pass is scheduled to run before the pass itself is - // scheduled to run. - std::map AvailableAnalysis; - - // Collection of pass that are managed by this manager - std::vector PassVector; +static cl::opt +PassDebugging("debug-pass", cl::Hidden, + cl::desc("Print PassManager debugging information"), + cl::values( + clEnumVal(None , "disable debug output"), + clEnumVal(Arguments , "print pass arguments to pass to 'opt'"), + clEnumVal(Structure , "print pass structure before run()"), + clEnumVal(Executions, "print pass name before it is executed"), + clEnumVal(Details , "print pass details when it is executed"), + clEnumValEnd)); +} // End of llvm namespace - unsigned Depth; -}; +namespace { //===----------------------------------------------------------------------===// -// BasicBlockPassManager +// BBPassManager // -/// BasicBlockPassManager manages BasicBlockPass. It batches all the +/// BBPassManager manages BasicBlockPass. It batches all the /// pass together and sequence them to process one basic block before /// processing next basic block. -class BasicBlockPassManager : public PMDataManager, - public FunctionPass { +class VISIBILITY_HIDDEN BBPassManager : public PMDataManager, + public FunctionPass { public: - BasicBlockPassManager(int D) : PMDataManager(D) { } + static char ID; + explicit BBPassManager(int Depth) + : PMDataManager(Depth), FunctionPass((intptr_t)&ID) {} - /// Add a pass into a passmanager queue. - bool addPass(Pass *p); - /// Execute all of the passes scheduled for execution. Keep track of /// whether any of the passes modifies the function, and if so, return true. bool runOnFunction(Function &F); @@ -324,74 +82,66 @@ public: bool doFinalization(Module &M); bool doFinalization(Function &F); + virtual const char *getPassName() const { + return "BasicBlock Pass Manager"; + } + // Print passes managed by this manager void dumpPassStructure(unsigned Offset) { - llvm::cerr << std::string(Offset*2, ' ') << "BasicBLockPass Manager\n"; - for (std::vector::iterator I = passVectorBegin(), - E = passVectorEnd(); I != E; ++I) { - (*I)->dumpPassStructure(Offset + 1); - dumpLastUses(*I, Offset+1); + llvm::cerr << std::string(Offset*2, ' ') << "BasicBlockPass Manager\n"; + for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { + BasicBlockPass *BP = getContainedPass(Index); + BP->dumpPassStructure(Offset + 1); + dumpLastUses(BP, Offset+1); } } + BasicBlockPass *getContainedPass(unsigned N) { + assert ( N < PassVector.size() && "Pass number out of range!"); + BasicBlockPass *BP = static_cast(PassVector[N]); + return BP; + } + + virtual PassManagerType getPassManagerType() const { + return PMT_BasicBlockPassManager; + } }; +char BBPassManager::ID = 0; +} + +namespace llvm { + //===----------------------------------------------------------------------===// -// FunctionPassManagerImpl_New +// FunctionPassManagerImpl // -/// FunctionPassManagerImpl_New manages FunctionPasses and BasicBlockPassManagers. -/// It batches all function passes and basic block pass managers together and -/// sequence them to process one function at a time before processing next -/// function. -class FunctionPassManagerImpl_New : public ModulePass, - public PMDataManager, - public PMTopLevelManager { +/// FunctionPassManagerImpl manages FPPassManagers +class FunctionPassManagerImpl : public Pass, + public PMDataManager, + public PMTopLevelManager { public: - FunctionPassManagerImpl_New(int D) : PMDataManager(D) { - activeBBPassManager = NULL; - } - ~FunctionPassManagerImpl_New() { /* TODO */ }; - - inline void addTopLevelPass(Pass *P) { - - if (ImmutablePass *IP = dynamic_cast (P)) { + static char ID; + explicit FunctionPassManagerImpl(int Depth) : + Pass((intptr_t)&ID), PMDataManager(Depth), + PMTopLevelManager(TLM_Function) { } - // P is a immutable pass then it will be managed by this - // top level manager. Set up analysis resolver to connect them. - AnalysisResolver_New *AR = new AnalysisResolver_New(*this); - P->setResolver(AR); - initializeAnalysisImpl(P); - addImmutablePass(IP); - recordAvailableAnalysis(IP); - } - else - addPass(P); - } - - /// add - Add a pass to the queue of passes to run. This passes - /// ownership of the Pass to the PassManager. When the - /// PassManager_X is destroyed, the pass will be destroyed as well, so - /// there is no need to delete the pass. (TODO delete passes.) - /// This implies that all passes MUST be allocated with 'new'. - void add(Pass *P) { + /// add - Add a pass to the queue of passes to run. This passes ownership of + /// the Pass to the PassManager. When the PassManager is destroyed, the pass + /// will be destroyed as well, so there is no need to delete the pass. This + /// implies that all passes MUST be allocated with 'new'. + void add(Pass *P) { schedulePass(P); } - - /// Add pass into the pass manager queue. - bool addPass(Pass *P); - - /// Execute all of the passes scheduled for execution. Keep - /// track of whether any of the passes modifies the function, and if - /// so, return true. - bool runOnModule(Module &M); - bool runOnFunction(Function &F); + + /// run - Execute all of the passes scheduled for execution. Keep track of + /// whether any of the passes modifies the module, and if so, return true. bool run(Function &F); /// doInitialization - Run all of the initializers for the function passes. /// bool doInitialization(Module &M); - /// doFinalization - Run all of the initializers for the function passes. + /// doFinalization - Run all of the finalizers for the function passes. /// bool doFinalization(Module &M); @@ -400,38 +150,54 @@ public: Info.setPreservesAll(); } - // Print passes managed by this manager - void dumpPassStructure(unsigned Offset) { - llvm::cerr << std::string(Offset*2, ' ') << "FunctionPass Manager\n"; - for (std::vector::iterator I = passVectorBegin(), - E = passVectorEnd(); I != E; ++I) { - (*I)->dumpPassStructure(Offset + 1); - dumpLastUses(*I, Offset+1); + inline void addTopLevelPass(Pass *P) { + + if (ImmutablePass *IP = dynamic_cast (P)) { + + // P is a immutable pass and it will be managed by this + // top level manager. Set up analysis resolver to connect them. + AnalysisResolver *AR = new AnalysisResolver(*this); + P->setResolver(AR); + initializeAnalysisImpl(P); + addImmutablePass(IP); + recordAvailableAnalysis(IP); + } else { + P->assignPassManager(activeStack); } + } -private: - // Active Pass Managers - BasicBlockPassManager *activeBBPassManager; + FPPassManager *getContainedManager(unsigned N) { + assert ( N < PassManagers.size() && "Pass number out of range!"); + FPPassManager *FP = static_cast(PassManagers[N]); + return FP; + } }; +char FunctionPassManagerImpl::ID = 0; //===----------------------------------------------------------------------===// -// ModulePassManager +// MPPassManager // -/// ModulePassManager manages ModulePasses and function pass managers. +/// MPPassManager manages ModulePasses and function pass managers. /// It batches all Module passes passes and function pass managers together and /// sequence them to process one module. -class ModulePassManager : public Pass, - public PMDataManager { +class MPPassManager : public Pass, public PMDataManager { public: - ModulePassManager(int D) : PMDataManager(D) { - activeFunctionPassManager = NULL; + static char ID; + explicit MPPassManager(int Depth) : + Pass((intptr_t)&ID), PMDataManager(Depth) { } + + // Delete on the fly managers. + virtual ~MPPassManager() { + for (std::map::iterator + I = OnTheFlyManagers.begin(), E = OnTheFlyManagers.end(); + I != E; ++I) { + FunctionPassManagerImpl *FPP = I->second; + delete FPP; + } } - - /// Add a pass into a passmanager queue. - bool addPass(Pass *p); - + /// run - Execute all of the passes scheduled for execution. Keep track of /// whether any of the passes modifies the module, and if so, return true. bool runOnModule(Module &M); @@ -441,34 +207,63 @@ public: Info.setPreservesAll(); } + /// Add RequiredPass into list of lower level passes required by pass P. + /// RequiredPass is run on the fly by Pass Manager when P requests it + /// through getAnalysis interface. + virtual void addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass); + + /// Return function pass corresponding to PassInfo PI, that is + /// required by module pass MP. Instantiate analysis pass, by using + /// its runOnFunction() for function F. + virtual Pass* getOnTheFlyPass(Pass *MP, const PassInfo *PI, Function &F); + + virtual const char *getPassName() const { + return "Module Pass Manager"; + } + // Print passes managed by this manager void dumpPassStructure(unsigned Offset) { llvm::cerr << std::string(Offset*2, ' ') << "ModulePass Manager\n"; - for (std::vector::iterator I = passVectorBegin(), - E = passVectorEnd(); I != E; ++I) { - (*I)->dumpPassStructure(Offset + 1); - dumpLastUses(*I, Offset+1); + for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { + ModulePass *MP = getContainedPass(Index); + MP->dumpPassStructure(Offset + 1); + if (FunctionPassManagerImpl *FPP = OnTheFlyManagers[MP]) + FPP->dumpPassStructure(Offset + 2); + dumpLastUses(MP, Offset+1); } } -private: - // Active Pass Manager - FunctionPassManagerImpl_New *activeFunctionPassManager; + ModulePass *getContainedPass(unsigned N) { + assert ( N < PassVector.size() && "Pass number out of range!"); + ModulePass *MP = static_cast(PassVector[N]); + return MP; + } + + virtual PassManagerType getPassManagerType() const { + return PMT_ModulePassManager; + } + + private: + /// Collection of on the fly FPPassManagers. These managers manage + /// function passes that are required by module passes. + std::map OnTheFlyManagers; }; +char MPPassManager::ID = 0; //===----------------------------------------------------------------------===// -// PassManagerImpl_New +// PassManagerImpl // -/// PassManagerImpl_New manages ModulePassManagers -class PassManagerImpl_New : public Pass, - public PMDataManager, - public PMTopLevelManager { -public: +/// PassManagerImpl manages MPPassManagers +class PassManagerImpl : public Pass, + public PMDataManager, + public PMTopLevelManager { - PassManagerImpl_New(int D) : PMDataManager(D) { - activeManager = NULL; - } +public: + static char ID; + explicit PassManagerImpl(int Depth) : + Pass((intptr_t)&ID), PMDataManager(Depth), + PMTopLevelManager(TLM_Pass) { } /// add - Add a pass to the queue of passes to run. This passes ownership of /// the Pass to the PassManager. When the PassManager is destroyed, the pass @@ -493,38 +288,113 @@ public: // P is a immutable pass and it will be managed by this // top level manager. Set up analysis resolver to connect them. - AnalysisResolver_New *AR = new AnalysisResolver_New(*this); + AnalysisResolver *AR = new AnalysisResolver(*this); P->setResolver(AR); initializeAnalysisImpl(P); addImmutablePass(IP); recordAvailableAnalysis(IP); + } else { + P->assignPassManager(activeStack); } - else - addPass(P); - } -private: + } - /// Add a pass into a passmanager queue. - bool addPass(Pass *p); + MPPassManager *getContainedManager(unsigned N) { + assert ( N < PassManagers.size() && "Pass number out of range!"); + MPPassManager *MP = static_cast(PassManagers[N]); + return MP; + } - // Active Pass Manager - ModulePassManager *activeManager; }; +char PassManagerImpl::ID = 0; } // End of llvm namespace +namespace { + +//===----------------------------------------------------------------------===// +// TimingInfo Class - This class is used to calculate information about the +// amount of time each pass takes to execute. This only happens when +// -time-passes is enabled on the command line. +// + +class VISIBILITY_HIDDEN TimingInfo { + std::map TimingData; + TimerGroup TG; + +public: + // Use 'create' member to get this. + TimingInfo() : TG("... Pass execution timing report ...") {} + + // TimingDtor - Print out information about timing information + ~TimingInfo() { + // Delete all of the timers... + TimingData.clear(); + // TimerGroup is deleted next, printing the report. + } + + // createTheTimeInfo - This method either initializes the TheTimeInfo pointer + // to a non null value (if the -time-passes option is enabled) or it leaves it + // null. It may be called multiple times. + static void createTheTimeInfo(); + + void passStarted(Pass *P) { + + if (dynamic_cast(P)) + return; + + std::map::iterator I = TimingData.find(P); + if (I == TimingData.end()) + I=TimingData.insert(std::make_pair(P, Timer(P->getPassName(), TG))).first; + I->second.startTimer(); + } + void passEnded(Pass *P) { + + if (dynamic_cast(P)) + return; + + std::map::iterator I = TimingData.find(P); + assert (I != TimingData.end() && "passStarted/passEnded not nested right!"); + I->second.stopTimer(); + } +}; + +static TimingInfo *TheTimeInfo; + +} // End of anon namespace + //===----------------------------------------------------------------------===// // PMTopLevelManager implementation +/// Initialize top level manager. Create first pass manager. +PMTopLevelManager::PMTopLevelManager (enum TopLevelManagerType t) { + + if (t == TLM_Pass) { + MPPassManager *MPP = new MPPassManager(1); + MPP->setTopLevelManager(this); + addPassManager(MPP); + activeStack.push(MPP); + } + else if (t == TLM_Function) { + FPPassManager *FPP = new FPPassManager(1); + FPP->setTopLevelManager(this); + addPassManager(FPP); + activeStack.push(FPP); + } +} + /// Set pass P as the last user of the given analysis passes. -void PMTopLevelManager::setLastUser(std::vector &AnalysisPasses, +void PMTopLevelManager::setLastUser(SmallVector &AnalysisPasses, Pass *P) { - for (std::vector::iterator I = AnalysisPasses.begin(), + for (SmallVector::iterator I = AnalysisPasses.begin(), E = AnalysisPasses.end(); I != E; ++I) { Pass *AP = *I; LastUser[AP] = P; + + if (P == AP) + continue; + // If AP is the last user of other passes then make P last user of // such passes. for (std::map::iterator LUI = LastUser.begin(), @@ -533,11 +403,10 @@ void PMTopLevelManager::setLastUser(std::vector &AnalysisPasses, LastUser[LUI->first] = P; } } - } /// Collect passes whose last user is P -void PMTopLevelManager::collectLastUses(std::vector &LastUses, +void PMTopLevelManager::collectLastUses(SmallVector &LastUses, Pass *P) { for (std::map::iterator LUI = LastUser.begin(), LUE = LastUser.end(); LUI != LUE; ++LUI) @@ -553,6 +422,9 @@ void PMTopLevelManager::schedulePass(Pass *P) { // TODO : Allocate function manager for this pass, other wise required set // may be inserted into previous function manager + // Give pass a chance to prepare the stage. + P->preparePassManager(activeStack); + AnalysisUsage AnUsage; P->getAnalysisUsage(AnUsage); const std::vector &RequiredSet = AnUsage.getRequiredSet(); @@ -561,9 +433,14 @@ void PMTopLevelManager::schedulePass(Pass *P) { Pass *AnalysisPass = findAnalysisPass(*I); if (!AnalysisPass) { - // Schedule this analysis run first. AnalysisPass = (*I)->createPass(); - schedulePass(AnalysisPass); + // Schedule this analysis run first only if it is not a lower level + // analysis pass. Lower level analsyis passes are run on the fly. + if (P->getPotentialPassManagerType () >= + AnalysisPass->getPotentialPassManagerType()) + schedulePass(AnalysisPass); + else + delete AnalysisPass; } } @@ -598,12 +475,10 @@ Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) { // If Pass not found then check the interfaces implemented by Immutable Pass if (!P) { - const std::vector &ImmPI = + const std::vector &ImmPI = PI->getInterfacesImplemented(); - for (unsigned Index = 0, End = ImmPI.size(); - P == NULL && Index != End; ++Index) - if (ImmPI[Index] == AID) - P = *I; + if (std::find(ImmPI.begin(), ImmPI.end(), AID) != ImmPI.end()) + P = *I; } } @@ -611,17 +486,62 @@ Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) { } // Print passes managed by this top level manager. -void PMTopLevelManager::dumpPasses() { +void PMTopLevelManager::dumpPasses() const { + + if (PassDebugging < Structure) + return; // Print out the immutable passes for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) { ImmutablePasses[i]->dumpPassStructure(0); } - for (std::vector::iterator I = PassManagers.begin(), + for (std::vector::const_iterator I = PassManagers.begin(), E = PassManagers.end(); I != E; ++I) (*I)->dumpPassStructure(1); +} + +void PMTopLevelManager::dumpArguments() const { + + if (PassDebugging < Arguments) + return; + + cerr << "Pass Arguments: "; + for (std::vector::const_iterator I = PassManagers.begin(), + E = PassManagers.end(); I != E; ++I) { + PMDataManager *PMD = dynamic_cast(*I); + assert(PMD && "This is not a PassManager"); + PMD->dumpPassArguments(); + } + cerr << "\n"; +} + +void PMTopLevelManager::initializeAllAnalysisInfo() { + + for (std::vector::iterator I = PassManagers.begin(), + E = PassManagers.end(); I != E; ++I) { + PMDataManager *PMD = dynamic_cast(*I); + assert(PMD && "This is not a PassManager"); + PMD->initializeAnalysisInfo(); + } + + // Initailize other pass managers + for (std::vector::iterator I = IndirectPassManagers.begin(), + E = IndirectPassManagers.end(); I != E; ++I) + (*I)->initializeAnalysisInfo(); +} +/// Destructor +PMTopLevelManager::~PMTopLevelManager() { + for (std::vector::iterator I = PassManagers.begin(), + E = PassManagers.end(); I != E; ++I) + delete *I; + + for (std::vector::iterator + I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I) + delete *I; + + PassManagers.clear(); } //===----------------------------------------------------------------------===// @@ -655,40 +575,106 @@ void PMDataManager::recordAvailableAnalysis(Pass *P) { } } +// Return true if P preserves high level analysis used by other +// passes managed by this manager +bool PMDataManager::preserveHigherLevelAnalysis(Pass *P) { + + AnalysisUsage AnUsage; + P->getAnalysisUsage(AnUsage); + + if (AnUsage.getPreservesAll()) + return true; + + const std::vector &PreservedSet = AnUsage.getPreservedSet(); + for (std::vector::iterator I = HigherLevelAnalysis.begin(), + E = HigherLevelAnalysis.end(); I != E; ++I) { + Pass *P1 = *I; + if (!dynamic_cast(P1) && + std::find(PreservedSet.begin(), PreservedSet.end(), + P1->getPassInfo()) == + PreservedSet.end()) + return false; + } + + return true; +} + +/// verifyPreservedAnalysis -- Verify analysis presreved by pass P. +void PMDataManager::verifyPreservedAnalysis(Pass *P) { + AnalysisUsage AnUsage; + P->getAnalysisUsage(AnUsage); + const std::vector &PreservedSet = AnUsage.getPreservedSet(); + + // Verify preserved analysis + for (std::vector::const_iterator I = PreservedSet.begin(), + E = PreservedSet.end(); I != E; ++I) { + AnalysisID AID = *I; + Pass *AP = findAnalysisPass(AID, true); + if (AP) + AP->verifyAnalysis(); + } +} + /// Remove Analyss not preserved by Pass P void PMDataManager::removeNotPreservedAnalysis(Pass *P) { AnalysisUsage AnUsage; P->getAnalysisUsage(AnUsage); - if (AnUsage.getPreservesAll()) return; const std::vector &PreservedSet = AnUsage.getPreservedSet(); for (std::map::iterator I = AvailableAnalysis.begin(), E = AvailableAnalysis.end(); I != E; ) { - if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) == - PreservedSet.end()) { + std::map::iterator Info = I++; + if (!dynamic_cast(Info->second) + && std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) == + PreservedSet.end()) // Remove this analysis - if (!dynamic_cast(I->second)) { - std::map::iterator J = I++; - AvailableAnalysis.erase(J); - } else - ++I; - } else - ++I; + AvailableAnalysis.erase(Info); + } + + // Check inherited analysis also. If P is not preserving analysis + // provided by parent manager then remove it here. + for (unsigned Index = 0; Index < PMT_Last; ++Index) { + + if (!InheritedAnalysis[Index]) + continue; + + for (std::map::iterator + I = InheritedAnalysis[Index]->begin(), + E = InheritedAnalysis[Index]->end(); I != E; ) { + std::map::iterator Info = I++; + if (!dynamic_cast(Info->second) && + std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) == + PreservedSet.end()) + // Remove this analysis + InheritedAnalysis[Index]->erase(Info); + } } + } /// Remove analysis passes that are not used any longer -void PMDataManager::removeDeadPasses(Pass *P) { +void PMDataManager::removeDeadPasses(Pass *P, const char *Msg, + enum PassDebuggingString DBG_STR) { + + SmallVector DeadPasses; + + // If this is a on the fly manager then it does not have TPM. + if (!TPM) + return; - std::vector DeadPasses; TPM->collectLastUses(DeadPasses, P); - for (std::vector::iterator I = DeadPasses.begin(), + for (SmallVector::iterator I = DeadPasses.begin(), E = DeadPasses.end(); I != E; ++I) { + + dumpPassInfo(*I, FREEING_MSG, DBG_STR, Msg); + + if (TheTimeInfo) TheTimeInfo->passStarted(*I); (*I)->releaseMemory(); - + if (TheTimeInfo) TheTimeInfo->passEnded(*I); + std::map::iterator Pos = AvailableAnalysis.find((*I)->getPassInfo()); @@ -700,23 +686,30 @@ void PMDataManager::removeDeadPasses(Pass *P) { /// Add pass P into the PassVector. Update /// AvailableAnalysis appropriately if ProcessAnalysis is true. -void PMDataManager::addPassToManager(Pass *P, - bool ProcessAnalysis) { +void PMDataManager::add(Pass *P, + bool ProcessAnalysis) { // This manager is going to manage pass P. Set up analysis resolver // to connect them. - AnalysisResolver_New *AR = new AnalysisResolver_New(*this); + AnalysisResolver *AR = new AnalysisResolver(*this); P->setResolver(AR); + // If a FunctionPass F is the last user of ModulePass info M + // then the F's manager, not F, records itself as a last user of M. + SmallVector TransferLastUses; + if (ProcessAnalysis) { // At the moment, this pass is the last user of all required passes. - std::vector LastUses; - std::vector RequiredPasses; + SmallVector LastUses; + SmallVector RequiredPasses; + SmallVector ReqAnalysisNotAvailable; + unsigned PDepth = this->getDepth(); - collectRequiredAnalysisPasses(RequiredPasses, P); - for (std::vector::iterator I = RequiredPasses.begin(), + collectRequiredAnalysis(RequiredPasses, + ReqAnalysisNotAvailable, P); + for (SmallVector::iterator I = RequiredPasses.begin(), E = RequiredPasses.end(); I != E; ++I) { Pass *PRequired = *I; unsigned RDepth = 0; @@ -728,16 +721,33 @@ void PMDataManager::addPassToManager(Pass *P, LastUses.push_back(PRequired); else if (PDepth > RDepth) { // Let the parent claim responsibility of last use - ForcedLastUses.push_back(PRequired); - } else { - // Note : This feature is not yet implemented - assert (0 && - "Unable to handle Pass that requires lower level Analysis pass"); - } + TransferLastUses.push_back(PRequired); + // Keep track of higher level analysis used by this manager. + HigherLevelAnalysis.push_back(PRequired); + } else + assert (0 && "Unable to accomodate Required Pass"); + } + + // Set P as P's last user until someone starts using P. + // However, if P is a Pass Manager then it does not need + // to record its last user. + if (!dynamic_cast(P)) + LastUses.push_back(P); + TPM->setLastUser(LastUses, P); + + if (!TransferLastUses.empty()) { + Pass *My_PM = dynamic_cast(this); + TPM->setLastUser(TransferLastUses, My_PM); + TransferLastUses.clear(); } - if (!LastUses.empty()) - TPM->setLastUser(LastUses, P); + // Now, take care of required analysises that are not available. + for (SmallVector::iterator + I = ReqAnalysisNotAvailable.begin(), + E = ReqAnalysisNotAvailable.end() ;I != E; ++I) { + Pass *AnalysisPass = (*I)->createPass(); + this->addLowerLevelRequiredPass(P, AnalysisPass); + } // Take a note of analysis required and made available by this pass. // Remove the analysis not preserved by this pass @@ -749,27 +759,34 @@ void PMDataManager::addPassToManager(Pass *P, PassVector.push_back(P); } -/// Populate RequiredPasses with the analysis pass that are required by -/// pass P. -void PMDataManager::collectRequiredAnalysisPasses(std::vector &RP, - Pass *P) { + +/// Populate RP with analysis pass that are required by +/// pass P and are available. Populate RP_NotAvail with analysis +/// pass that are required by pass P but are not available. +void PMDataManager::collectRequiredAnalysis(SmallVector&RP, + SmallVector &RP_NotAvail, + Pass *P) { AnalysisUsage AnUsage; P->getAnalysisUsage(AnUsage); const std::vector &RequiredSet = AnUsage.getRequiredSet(); for (std::vector::const_iterator I = RequiredSet.begin(), E = RequiredSet.end(); I != E; ++I) { - Pass *AnalysisPass = findAnalysisPass(*I, true); - assert (AnalysisPass && "Analysis pass is not available"); - RP.push_back(AnalysisPass); + AnalysisID AID = *I; + if (Pass *AnalysisPass = findAnalysisPass(*I, true)) + RP.push_back(AnalysisPass); + else + RP_NotAvail.push_back(AID); } const std::vector &IDs = AnUsage.getRequiredTransitiveSet(); for (std::vector::const_iterator I = IDs.begin(), E = IDs.end(); I != E; ++I) { - Pass *AnalysisPass = findAnalysisPass(*I, true); - assert (AnalysisPass && "Analysis pass is not available"); - RP.push_back(AnalysisPass); + AnalysisID AID = *I; + if (Pass *AnalysisPass = findAnalysisPass(*I, true)) + RP.push_back(AnalysisPass); + else + RP_NotAvail.push_back(AID); } } @@ -787,8 +804,10 @@ void PMDataManager::initializeAnalysisImpl(Pass *P) { E = AnUsage.getRequiredSet().end(); I != E; ++I) { Pass *Impl = findAnalysisPass(*I, true); if (Impl == 0) - assert(0 && "Analysis used but not available!"); - AnalysisResolver_New *AR = P->getResolver(); + // This may be analysis pass that is initialized on the fly. + // If that is not the case then it will raise an assert when it is used. + continue; + AnalysisResolver *AR = P->getResolver(); AR->addAnalysisImplsPair(*I, Impl); } } @@ -810,109 +829,215 @@ Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) { return NULL; } +// Print list of passes that are last used by P. +void PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{ -//===----------------------------------------------------------------------===// -// NOTE: Is this the right place to define this method ? -// getAnalysisToUpdate - Return an analysis result or null if it doesn't exist -Pass *AnalysisResolver_New::getAnalysisToUpdate(AnalysisID ID, bool dir) const { - return PM.findAnalysisPass(ID, dir); + SmallVector LUses; + + // If this is a on the fly manager then it does not have TPM. + if (!TPM) + return; + + TPM->collectLastUses(LUses, P); + + for (SmallVector::iterator I = LUses.begin(), + E = LUses.end(); I != E; ++I) { + llvm::cerr << "--" << std::string(Offset*2, ' '); + (*I)->dumpPassStructure(0); + } } -//===----------------------------------------------------------------------===// -// BasicBlockPassManager implementation +void PMDataManager::dumpPassArguments() const { + for(std::vector::const_iterator I = PassVector.begin(), + E = PassVector.end(); I != E; ++I) { + if (PMDataManager *PMD = dynamic_cast(*I)) + PMD->dumpPassArguments(); + else + if (const PassInfo *PI = (*I)->getPassInfo()) + if (!PI->isAnalysisGroup()) + cerr << " -" << PI->getPassArgument(); + } +} -/// Add pass P into PassVector and return true. If this pass is not -/// manageable by this manager then return false. -bool -BasicBlockPassManager::addPass(Pass *P) { +void PMDataManager::dumpPassInfo(Pass *P, enum PassDebuggingString S1, + enum PassDebuggingString S2, + const char *Msg) { + if (PassDebugging < Executions) + return; + cerr << (void*)this << std::string(getDepth()*2+1, ' '); + switch (S1) { + case EXECUTION_MSG: + cerr << "Executing Pass '" << P->getPassName(); + break; + case MODIFICATION_MSG: + cerr << "Made Modification '" << P->getPassName(); + break; + case FREEING_MSG: + cerr << " Freeing Pass '" << P->getPassName(); + break; + default: + break; + } + switch (S2) { + case ON_BASICBLOCK_MSG: + cerr << "' on BasicBlock '" << Msg << "'...\n"; + break; + case ON_FUNCTION_MSG: + cerr << "' on Function '" << Msg << "'...\n"; + break; + case ON_MODULE_MSG: + cerr << "' on Module '" << Msg << "'...\n"; + break; + case ON_LOOP_MSG: + cerr << "' on Loop " << Msg << "'...\n"; + break; + case ON_CG_MSG: + cerr << "' on Call Graph " << Msg << "'...\n"; + break; + default: + break; + } +} - BasicBlockPass *BP = dynamic_cast(P); - if (!BP) - return false; +void PMDataManager::dumpAnalysisSetInfo(const char *Msg, Pass *P, + const std::vector &Set) + const { + if (PassDebugging >= Details && !Set.empty()) { + cerr << (void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:"; + for (unsigned i = 0; i != Set.size(); ++i) { + if (i) cerr << ","; + cerr << " " << Set[i]->getPassName(); + } + cerr << "\n"; + } +} - // If this pass does not preserve anlysis that is used by other passes - // managed by this manager than it is not a suiable pass for this manager. - if (!manageablePass(P)) - return false; +/// Add RequiredPass into list of lower level passes required by pass P. +/// RequiredPass is run on the fly by Pass Manager when P requests it +/// through getAnalysis interface. +/// This should be handled by specific pass manager. +void PMDataManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) { + if (TPM) { + TPM->dumpArguments(); + TPM->dumpPasses(); + } - addPassToManager (BP); + // Module Level pass may required Function Level analysis info + // (e.g. dominator info). Pass manager uses on the fly function pass manager + // to provide this on demand. In that case, in Pass manager terminology, + // module level pass is requiring lower level analysis info managed by + // lower level pass manager. - return true; + // When Pass manager is not able to order required analysis info, Pass manager + // checks whether any lower level manager will be able to provide this + // analysis info on demand or not. + assert (0 && "Unable to handle Pass that requires lower level Analysis pass"); +} + +// Destructor +PMDataManager::~PMDataManager() { + + for (std::vector::iterator I = PassVector.begin(), + E = PassVector.end(); I != E; ++I) + delete *I; + + PassVector.clear(); +} + +//===----------------------------------------------------------------------===// +// NOTE: Is this the right place to define this method ? +// getAnalysisToUpdate - Return an analysis result or null if it doesn't exist +Pass *AnalysisResolver::getAnalysisToUpdate(AnalysisID ID, bool dir) const { + return PM.findAnalysisPass(ID, dir); } +Pass *AnalysisResolver::findImplPass(Pass *P, const PassInfo *AnalysisPI, + Function &F) { + return PM.getOnTheFlyPass(P, AnalysisPI, F); +} + +//===----------------------------------------------------------------------===// +// BBPassManager implementation + /// Execute all of the passes scheduled for execution by invoking /// runOnBasicBlock method. Keep track of whether any of the passes modifies /// the function, and if so, return true. bool -BasicBlockPassManager::runOnFunction(Function &F) { +BBPassManager::runOnFunction(Function &F) { - if (F.isExternal()) + if (F.isDeclaration()) return false; bool Changed = doInitialization(F); - initializeAnalysisInfo(); for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I) - for (std::vector::iterator itr = passVectorBegin(), - e = passVectorEnd(); itr != e; ++itr) { - Pass *P = *itr; - initializeAnalysisImpl(P); - BasicBlockPass *BP = dynamic_cast(P); + for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { + BasicBlockPass *BP = getContainedPass(Index); + AnalysisUsage AnUsage; + BP->getAnalysisUsage(AnUsage); + + dumpPassInfo(BP, EXECUTION_MSG, ON_BASICBLOCK_MSG, I->getNameStart()); + dumpAnalysisSetInfo("Required", BP, AnUsage.getRequiredSet()); + + initializeAnalysisImpl(BP); + + if (TheTimeInfo) TheTimeInfo->passStarted(BP); Changed |= BP->runOnBasicBlock(*I); - removeNotPreservedAnalysis(P); - recordAvailableAnalysis(P); - removeDeadPasses(P); + if (TheTimeInfo) TheTimeInfo->passEnded(BP); + + if (Changed) + dumpPassInfo(BP, MODIFICATION_MSG, ON_BASICBLOCK_MSG, + I->getNameStart()); + dumpAnalysisSetInfo("Preserved", BP, AnUsage.getPreservedSet()); + + verifyPreservedAnalysis(BP); + removeNotPreservedAnalysis(BP); + recordAvailableAnalysis(BP); + removeDeadPasses(BP, I->getNameStart(), ON_BASICBLOCK_MSG); } - return Changed | doFinalization(F); + + return Changed |= doFinalization(F); } // Implement doInitialization and doFinalization -inline bool BasicBlockPassManager::doInitialization(Module &M) { +inline bool BBPassManager::doInitialization(Module &M) { bool Changed = false; - for (std::vector::iterator itr = passVectorBegin(), - e = passVectorEnd(); itr != e; ++itr) { - Pass *P = *itr; - BasicBlockPass *BP = dynamic_cast(P); + for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { + BasicBlockPass *BP = getContainedPass(Index); Changed |= BP->doInitialization(M); } return Changed; } -inline bool BasicBlockPassManager::doFinalization(Module &M) { +inline bool BBPassManager::doFinalization(Module &M) { bool Changed = false; - for (std::vector::iterator itr = passVectorBegin(), - e = passVectorEnd(); itr != e; ++itr) { - Pass *P = *itr; - BasicBlockPass *BP = dynamic_cast(P); + for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { + BasicBlockPass *BP = getContainedPass(Index); Changed |= BP->doFinalization(M); } return Changed; } -inline bool BasicBlockPassManager::doInitialization(Function &F) { +inline bool BBPassManager::doInitialization(Function &F) { bool Changed = false; - for (std::vector::iterator itr = passVectorBegin(), - e = passVectorEnd(); itr != e; ++itr) { - Pass *P = *itr; - BasicBlockPass *BP = dynamic_cast(P); + for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { + BasicBlockPass *BP = getContainedPass(Index); Changed |= BP->doInitialization(F); } return Changed; } -inline bool BasicBlockPassManager::doFinalization(Function &F) { +inline bool BBPassManager::doFinalization(Function &F) { bool Changed = false; - for (std::vector::iterator itr = passVectorBegin(), - e = passVectorEnd(); itr != e; ++itr) { - Pass *P = *itr; - BasicBlockPass *BP = dynamic_cast(P); + for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { + BasicBlockPass *BP = getContainedPass(Index); Changed |= BP->doFinalization(F); } @@ -925,26 +1050,18 @@ inline bool BasicBlockPassManager::doFinalization(Function &F) { /// Create new Function pass manager FunctionPassManager::FunctionPassManager(ModuleProvider *P) { - FPM = new FunctionPassManagerImpl_New(0); + FPM = new FunctionPassManagerImpl(0); // FPM is the top level manager. FPM->setTopLevelManager(FPM); PMDataManager *PMD = dynamic_cast(FPM); - AnalysisResolver_New *AR = new AnalysisResolver_New(*PMD); + AnalysisResolver *AR = new AnalysisResolver(*PMD); FPM->setResolver(AR); - FPM->addPassManager(FPM); MP = P; } FunctionPassManager::~FunctionPassManager() { - // Note : FPM maintains one entry in PassManagers vector. - // This one entry is FPM itself. This is not ideal. One - // alternative is have one additional layer between - // FunctionPassManager and FunctionPassManagerImpl. - // Meanwhile, to avoid going into infinte loop, first - // remove FPM from its PassMangers vector. - FPM->clearManagers(); delete FPM; } @@ -964,7 +1081,7 @@ void FunctionPassManager::add(Pass *P) { bool FunctionPassManager::run(Function &F) { std::string errstr; if (MP->materializeFunction(&F, &errstr)) { - cerr << "Error reading bytecode file: " << errstr << "\n"; + cerr << "Error reading bitcode file: " << errstr << "\n"; abort(); } return FPM->run(F); @@ -977,273 +1094,237 @@ bool FunctionPassManager::doInitialization() { return FPM->doInitialization(*MP->getModule()); } -/// doFinalization - Run all of the initializers for the function passes. +/// doFinalization - Run all of the finalizers for the function passes. /// bool FunctionPassManager::doFinalization() { return FPM->doFinalization(*MP->getModule()); } //===----------------------------------------------------------------------===// -// FunctionPassManagerImpl_New implementation +// FunctionPassManagerImpl implementation +// +inline bool FunctionPassManagerImpl::doInitialization(Module &M) { + bool Changed = false; -/// Add pass P into the pass manager queue. If P is a BasicBlockPass then -/// either use it into active basic block pass manager or create new basic -/// block pass manager to handle pass P. -bool -FunctionPassManagerImpl_New::addPass(Pass *P) { + for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) { + FPPassManager *FP = getContainedManager(Index); + Changed |= FP->doInitialization(M); + } - // If P is a BasicBlockPass then use BasicBlockPassManager. - if (BasicBlockPass *BP = dynamic_cast(P)) { + return Changed; +} - if (!activeBBPassManager || !activeBBPassManager->addPass(BP)) { +inline bool FunctionPassManagerImpl::doFinalization(Module &M) { + bool Changed = false; - // If active manager exists then clear its analysis info. - if (activeBBPassManager) - activeBBPassManager->initializeAnalysisInfo(); + for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) { + FPPassManager *FP = getContainedManager(Index); + Changed |= FP->doFinalization(M); + } - // Create and add new manager - activeBBPassManager = - new BasicBlockPassManager(getDepth() + 1); - // Inherit top level manager - activeBBPassManager->setTopLevelManager(this->getTopLevelManager()); + return Changed; +} - // Add new manager into current manager's list. - addPassToManager(activeBBPassManager, false); +// Execute all the passes managed by this top level manager. +// Return true if any function is modified by a pass. +bool FunctionPassManagerImpl::run(Function &F) { - // Add new manager into top level manager's indirect passes list - PMDataManager *PMD = dynamic_cast(activeBBPassManager); - assert (PMD && "Manager is not Pass Manager"); - TPM->addIndirectPassManager(PMD); + bool Changed = false; - // Add pass into new manager. This time it must succeed. - if (!activeBBPassManager->addPass(BP)) - assert(0 && "Unable to add Pass"); - } + TimingInfo::createTheTimeInfo(); - if (!ForcedLastUses.empty()) - TPM->setLastUser(ForcedLastUses, this); + dumpArguments(); + dumpPasses(); - return true; + initializeAllAnalysisInfo(); + for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) { + FPPassManager *FP = getContainedManager(Index); + Changed |= FP->runOnFunction(F); } + return Changed; +} - FunctionPass *FP = dynamic_cast(P); - if (!FP) - return false; - - // If this pass does not preserve anlysis that is used by other passes - // managed by this manager than it is not a suiable pass for this manager. - if (!manageablePass(P)) - return false; - - addPassToManager (FP); - - // If active manager exists then clear its analysis info. - if (activeBBPassManager) { - activeBBPassManager->initializeAnalysisInfo(); - activeBBPassManager = NULL; +//===----------------------------------------------------------------------===// +// FPPassManager implementation + +char FPPassManager::ID = 0; +/// Print passes managed by this manager +void FPPassManager::dumpPassStructure(unsigned Offset) { + llvm::cerr << std::string(Offset*2, ' ') << "FunctionPass Manager\n"; + for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { + FunctionPass *FP = getContainedPass(Index); + FP->dumpPassStructure(Offset + 1); + dumpLastUses(FP, Offset+1); } - - return true; } -/// Execute all of the passes scheduled for execution by invoking -/// runOnFunction method. Keep track of whether any of the passes modifies -/// the function, and if so, return true. -bool FunctionPassManagerImpl_New::runOnModule(Module &M) { - - bool Changed = doInitialization(M); - initializeAnalysisInfo(); - - for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) - this->runOnFunction(*I); - - return Changed | doFinalization(M); -} /// Execute all of the passes scheduled for execution by invoking /// runOnFunction method. Keep track of whether any of the passes modifies /// the function, and if so, return true. -bool FunctionPassManagerImpl_New::runOnFunction(Function &F) { +bool FPPassManager::runOnFunction(Function &F) { bool Changed = false; - if (F.isExternal()) + if (F.isDeclaration()) return false; - initializeAnalysisInfo(); + for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { + FunctionPass *FP = getContainedPass(Index); + + AnalysisUsage AnUsage; + FP->getAnalysisUsage(AnUsage); + + dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getNameStart()); + dumpAnalysisSetInfo("Required", FP, AnUsage.getRequiredSet()); - for (std::vector::iterator itr = passVectorBegin(), - e = passVectorEnd(); itr != e; ++itr) { - Pass *P = *itr; - initializeAnalysisImpl(P); - FunctionPass *FP = dynamic_cast(P); + initializeAnalysisImpl(FP); + + if (TheTimeInfo) TheTimeInfo->passStarted(FP); Changed |= FP->runOnFunction(F); - removeNotPreservedAnalysis(P); - recordAvailableAnalysis(P); - removeDeadPasses(P); + if (TheTimeInfo) TheTimeInfo->passEnded(FP); + + if (Changed) + dumpPassInfo(FP, MODIFICATION_MSG, ON_FUNCTION_MSG, F.getNameStart()); + dumpAnalysisSetInfo("Preserved", FP, AnUsage.getPreservedSet()); + + verifyPreservedAnalysis(FP); + removeNotPreservedAnalysis(FP); + recordAvailableAnalysis(FP); + removeDeadPasses(FP, F.getNameStart(), ON_FUNCTION_MSG); } return Changed; } +bool FPPassManager::runOnModule(Module &M) { -inline bool FunctionPassManagerImpl_New::doInitialization(Module &M) { - bool Changed = false; + bool Changed = doInitialization(M); - for (std::vector::iterator itr = passVectorBegin(), - e = passVectorEnd(); itr != e; ++itr) { - Pass *P = *itr; - - FunctionPass *FP = dynamic_cast(P); - Changed |= FP->doInitialization(M); - } + for(Module::iterator I = M.begin(), E = M.end(); I != E; ++I) + this->runOnFunction(*I); - return Changed; + return Changed |= doFinalization(M); } -inline bool FunctionPassManagerImpl_New::doFinalization(Module &M) { +inline bool FPPassManager::doInitialization(Module &M) { bool Changed = false; - for (std::vector::iterator itr = passVectorBegin(), - e = passVectorEnd(); itr != e; ++itr) { - Pass *P = *itr; - - FunctionPass *FP = dynamic_cast(P); - Changed |= FP->doFinalization(M); + for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { + FunctionPass *FP = getContainedPass(Index); + Changed |= FP->doInitialization(M); } return Changed; } -// Execute all the passes managed by this top level manager. -// Return true if any function is modified by a pass. -bool FunctionPassManagerImpl_New::run(Function &F) { - +inline bool FPPassManager::doFinalization(Module &M) { bool Changed = false; - for (std::vector::iterator I = passManagersBegin(), - E = passManagersEnd(); I != E; ++I) { - FunctionPassManagerImpl_New *FP = - dynamic_cast(*I); - Changed |= FP->runOnFunction(F); + + for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { + FunctionPass *FP = getContainedPass(Index); + Changed |= FP->doFinalization(M); } + return Changed; } //===----------------------------------------------------------------------===// -// ModulePassManager implementation +// MPPassManager implementation -/// Add P into pass vector if it is manageble. If P is a FunctionPass -/// then use FunctionPassManagerImpl_New to manage it. Return false if P -/// is not manageable by this manager. +/// Execute all of the passes scheduled for execution by invoking +/// runOnModule method. Keep track of whether any of the passes modifies +/// the module, and if so, return true. bool -ModulePassManager::addPass(Pass *P) { +MPPassManager::runOnModule(Module &M) { + bool Changed = false; - // If P is FunctionPass then use function pass maanager. - if (FunctionPass *FP = dynamic_cast(P)) { + for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { + ModulePass *MP = getContainedPass(Index); - if (!activeFunctionPassManager || !activeFunctionPassManager->addPass(P)) { + AnalysisUsage AnUsage; + MP->getAnalysisUsage(AnUsage); - // If active manager exists then clear its analysis info. - if (activeFunctionPassManager) - activeFunctionPassManager->initializeAnalysisInfo(); + dumpPassInfo(MP, EXECUTION_MSG, ON_MODULE_MSG, + M.getModuleIdentifier().c_str()); + dumpAnalysisSetInfo("Required", MP, AnUsage.getRequiredSet()); - // Create and add new manager - activeFunctionPassManager = - new FunctionPassManagerImpl_New(getDepth() + 1); - - // Add new manager into current manager's list - addPassToManager(activeFunctionPassManager, false); + initializeAnalysisImpl(MP); - // Inherit top level manager - activeFunctionPassManager->setTopLevelManager(this->getTopLevelManager()); + if (TheTimeInfo) TheTimeInfo->passStarted(MP); + Changed |= MP->runOnModule(M); + if (TheTimeInfo) TheTimeInfo->passEnded(MP); - // Add new manager into top level manager's indirect passes list - PMDataManager *PMD = dynamic_cast(activeFunctionPassManager); - assert (PMD && "Manager is not Pass Manager"); - TPM->addIndirectPassManager(PMD); + if (Changed) + dumpPassInfo(MP, MODIFICATION_MSG, ON_MODULE_MSG, + M.getModuleIdentifier().c_str()); + dumpAnalysisSetInfo("Preserved", MP, AnUsage.getPreservedSet()); - // Add pass into new manager. This time it must succeed. - if (!activeFunctionPassManager->addPass(FP)) - assert(0 && "Unable to add pass"); - } - - if (!ForcedLastUses.empty()) - TPM->setLastUser(ForcedLastUses, this); - - return true; + verifyPreservedAnalysis(MP); + removeNotPreservedAnalysis(MP); + recordAvailableAnalysis(MP); + removeDeadPasses(MP, M.getModuleIdentifier().c_str(), ON_MODULE_MSG); } + return Changed; +} - ModulePass *MP = dynamic_cast(P); - if (!MP) - return false; +/// Add RequiredPass into list of lower level passes required by pass P. +/// RequiredPass is run on the fly by Pass Manager when P requests it +/// through getAnalysis interface. +void MPPassManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) { - // If this pass does not preserve anlysis that is used by other passes - // managed by this manager than it is not a suiable pass for this manager. - if (!manageablePass(P)) - return false; + assert (P->getPotentialPassManagerType() == PMT_ModulePassManager + && "Unable to handle Pass that requires lower level Analysis pass"); + assert ((P->getPotentialPassManagerType() < + RequiredPass->getPotentialPassManagerType()) + && "Unable to handle Pass that requires lower level Analysis pass"); + + FunctionPassManagerImpl *FPP = OnTheFlyManagers[P]; + if (!FPP) { + FPP = new FunctionPassManagerImpl(0); + // FPP is the top level manager. + FPP->setTopLevelManager(FPP); - addPassToManager(MP); - // If active manager exists then clear its analysis info. - if (activeFunctionPassManager) { - activeFunctionPassManager->initializeAnalysisInfo(); - activeFunctionPassManager = NULL; + OnTheFlyManagers[P] = FPP; } + FPP->add(RequiredPass); - return true; + // Register P as the last user of RequiredPass. + SmallVector LU; + LU.push_back(RequiredPass); + FPP->setLastUser(LU, P); } - -/// Execute all of the passes scheduled for execution by invoking -/// runOnModule method. Keep track of whether any of the passes modifies -/// the module, and if so, return true. -bool -ModulePassManager::runOnModule(Module &M) { - bool Changed = false; - initializeAnalysisInfo(); - - for (std::vector::iterator itr = passVectorBegin(), - e = passVectorEnd(); itr != e; ++itr) { - Pass *P = *itr; - initializeAnalysisImpl(P); - ModulePass *MP = dynamic_cast(P); - Changed |= MP->runOnModule(M); - removeNotPreservedAnalysis(P); - recordAvailableAnalysis(P); - removeDeadPasses(P); - } - return Changed; +/// Return function pass corresponding to PassInfo PI, that is +/// required by module pass MP. Instantiate analysis pass, by using +/// its runOnFunction() for function F. +Pass* MPPassManager::getOnTheFlyPass(Pass *MP, const PassInfo *PI, + Function &F) { + AnalysisID AID = PI; + FunctionPassManagerImpl *FPP = OnTheFlyManagers[MP]; + assert (FPP && "Unable to find on the fly pass"); + + FPP->run(F); + return (dynamic_cast(FPP))->findAnalysisPass(AID); } + //===----------------------------------------------------------------------===// // PassManagerImpl implementation // -/// Add P into active pass manager or use new module pass manager to -/// manage it. -bool PassManagerImpl_New::addPass(Pass *P) { - - if (!activeManager || !activeManager->addPass(P)) { - activeManager = new ModulePassManager(getDepth() + 1); - // Inherit top level manager - activeManager->setTopLevelManager(this->getTopLevelManager()); - - // This top level manager is going to manage activeManager. - // Set up analysis resolver to connect them. - AnalysisResolver_New *AR = new AnalysisResolver_New(*this); - activeManager->setResolver(AR); - - addPassManager(activeManager); - return activeManager->addPass(P); - } - return true; -} - /// run - Execute all of the passes scheduled for execution. Keep track of /// whether any of the passes modifies the module, and if so, return true. -bool PassManagerImpl_New::run(Module &M) { +bool PassManagerImpl::run(Module &M) { bool Changed = false; - for (std::vector::iterator I = passManagersBegin(), - E = passManagersEnd(); I != E; ++I) { - ModulePassManager *MP = dynamic_cast(*I); + + TimingInfo::createTheTimeInfo(); + + dumpArguments(); + dumpPasses(); + + initializeAllAnalysisInfo(); + for (unsigned Index = 0; Index < getNumContainedManagers(); ++Index) { + MPPassManager *MP = getContainedManager(Index); Changed |= MP->runOnModule(M); } return Changed; @@ -1254,7 +1335,7 @@ bool PassManagerImpl_New::run(Module &M) { /// Create new pass manager PassManager::PassManager() { - PM = new PassManagerImpl_New(0); + PM = new PassManagerImpl(0); // PM is the top level manager PM->setTopLevelManager(PM); } @@ -1279,4 +1360,189 @@ PassManager::run(Module &M) { return PM->run(M); } -#endif +//===----------------------------------------------------------------------===// +// TimingInfo Class - This class is used to calculate information about the +// amount of time each pass takes to execute. This only happens with +// -time-passes is enabled on the command line. +// +bool llvm::TimePassesIsEnabled = false; +static cl::opt +EnableTiming("time-passes", cl::location(TimePassesIsEnabled), + cl::desc("Time each pass, printing elapsed time for each on exit")); + +// createTheTimeInfo - This method either initializes the TheTimeInfo pointer to +// a non null value (if the -time-passes option is enabled) or it leaves it +// null. It may be called multiple times. +void TimingInfo::createTheTimeInfo() { + if (!TimePassesIsEnabled || TheTimeInfo) return; + + // Constructed the first time this is called, iff -time-passes is enabled. + // This guarantees that the object will be constructed before static globals, + // thus it will be destroyed before them. + static ManagedStatic TTI; + TheTimeInfo = &*TTI; +} + +/// If TimingInfo is enabled then start pass timer. +void StartPassTimer(Pass *P) { + if (TheTimeInfo) + TheTimeInfo->passStarted(P); +} + +/// If TimingInfo is enabled then stop pass timer. +void StopPassTimer(Pass *P) { + if (TheTimeInfo) + TheTimeInfo->passEnded(P); +} + +//===----------------------------------------------------------------------===// +// PMStack implementation +// + +// Pop Pass Manager from the stack and clear its analysis info. +void PMStack::pop() { + + PMDataManager *Top = this->top(); + Top->initializeAnalysisInfo(); + + S.pop_back(); +} + +// Push PM on the stack and set its top level manager. +void PMStack::push(Pass *P) { + + PMDataManager *Top = NULL; + PMDataManager *PM = dynamic_cast(P); + assert (PM && "Unable to push. Pass Manager expected"); + + if (this->empty()) { + Top = PM; + } + else { + Top = this->top(); + PMTopLevelManager *TPM = Top->getTopLevelManager(); + + assert (TPM && "Unable to find top level manager"); + TPM->addIndirectPassManager(PM); + PM->setTopLevelManager(TPM); + } + + S.push_back(PM); +} + +// Dump content of the pass manager stack. +void PMStack::dump() { + for(std::deque::iterator I = S.begin(), + E = S.end(); I != E; ++I) { + Pass *P = dynamic_cast(*I); + printf("%s ", P->getPassName()); + } + if (!S.empty()) + printf("\n"); +} + +/// Find appropriate Module Pass Manager in the PM Stack and +/// add self into that manager. +void ModulePass::assignPassManager(PMStack &PMS, + PassManagerType PreferredType) { + + // Find Module Pass Manager + while(!PMS.empty()) { + PassManagerType TopPMType = PMS.top()->getPassManagerType(); + if (TopPMType == PreferredType) + break; // We found desired pass manager + else if (TopPMType > PMT_ModulePassManager) + PMS.pop(); // Pop children pass managers + else + break; + } + + PMS.top()->add(this); +} + +/// Find appropriate Function Pass Manager or Call Graph Pass Manager +/// in the PM Stack and add self into that manager. +void FunctionPass::assignPassManager(PMStack &PMS, + PassManagerType PreferredType) { + + // Find Module Pass Manager (TODO : Or Call Graph Pass Manager) + while(!PMS.empty()) { + if (PMS.top()->getPassManagerType() > PMT_FunctionPassManager) + PMS.pop(); + else + break; + } + FPPassManager *FPP = dynamic_cast(PMS.top()); + + // Create new Function Pass Manager + if (!FPP) { + assert(!PMS.empty() && "Unable to create Function Pass Manager"); + PMDataManager *PMD = PMS.top(); + + // [1] Create new Function Pass Manager + FPP = new FPPassManager(PMD->getDepth() + 1); + + // [2] Set up new manager's top level manager + PMTopLevelManager *TPM = PMD->getTopLevelManager(); + TPM->addIndirectPassManager(FPP); + + // [3] Assign manager to manage this new manager. This may create + // and push new managers into PMS + Pass *P = dynamic_cast(FPP); + + // If Call Graph Pass Manager is active then use it to manage + // this new Function Pass manager. + if (PMD->getPassManagerType() == PMT_CallGraphPassManager) + P->assignPassManager(PMS, PMT_CallGraphPassManager); + else + P->assignPassManager(PMS); + + // [4] Push new manager into PMS + PMS.push(FPP); + } + + // Assign FPP as the manager of this pass. + FPP->add(this); +} + +/// Find appropriate Basic Pass Manager or Call Graph Pass Manager +/// in the PM Stack and add self into that manager. +void BasicBlockPass::assignPassManager(PMStack &PMS, + PassManagerType PreferredType) { + + BBPassManager *BBP = NULL; + + // Basic Pass Manager is a leaf pass manager. It does not handle + // any other pass manager. + if (!PMS.empty()) + BBP = dynamic_cast(PMS.top()); + + // If leaf manager is not Basic Block Pass manager then create new + // basic Block Pass manager. + + if (!BBP) { + assert(!PMS.empty() && "Unable to create BasicBlock Pass Manager"); + PMDataManager *PMD = PMS.top(); + + // [1] Create new Basic Block Manager + BBP = new BBPassManager(PMD->getDepth() + 1); + + // [2] Set up new manager's top level manager + // Basic Block Pass Manager does not live by itself + PMTopLevelManager *TPM = PMD->getTopLevelManager(); + TPM->addIndirectPassManager(BBP); + + // [3] Assign manager to manage this new manager. This may create + // and push new managers into PMS + Pass *P = dynamic_cast(BBP); + P->assignPassManager(PMS); + + // [4] Push new manager into PMS + PMS.push(BBP); + } + + // Assign BBP as the manager of this pass. + BBP->add(this); +} + +