#ifndef LLVM_PASS_H
#define LLVM_PASS_H
+#include "llvm/Support/DataTypes.h"
#include "llvm/Support/Streams.h"
#include <vector>
+#include <deque>
#include <map>
#include <iosfwd>
-#include <typeinfo>
#include <cassert>
namespace llvm {
class AnalysisUsage;
class PassInfo;
class ImmutablePass;
-template<class Trait> class PassManagerT;
-class BasicBlockPassManager;
-class FunctionPassManagerT;
-class ModulePassManager;
-struct AnalysisResolver;
-class AnalysisResolver_New;
+class PMStack;
+class AnalysisResolver;
+class PMDataManager;
// AnalysisID - Use the PassInfo to identify a pass...
typedef const PassInfo* AnalysisID;
+/// Different types of internal pass managers. External pass managers
+/// (PassManager and FunctionPassManager) are not represented here.
+/// Ordering of pass manager types is important here.
+enum PassManagerType {
+ PMT_Unknown = 0,
+ PMT_ModulePassManager = 1, /// MPPassManager
+ PMT_CallGraphPassManager, /// CGPassManager
+ PMT_FunctionPassManager, /// FPPassManager
+ PMT_LoopPassManager, /// LPPassManager
+ PMT_BasicBlockPassManager, /// BBPassManager
+ PMT_Last
+};
+
+typedef enum PassManagerType PassManagerType;
+
//===----------------------------------------------------------------------===//
/// Pass interface - Implemented by all 'passes'. Subclass this if you are an
/// interprocedural optimization or you do not fit into any of the more
/// constrained passes described below.
///
class Pass {
- friend struct AnalysisResolver;
- AnalysisResolver *Resolver; // AnalysisResolver this pass is owned by...
- AnalysisResolver_New *Resolver_New; // Used to resolve analysis
- const PassInfo *PassInfoCache;
+ AnalysisResolver *Resolver; // Used to resolve analysis
+ intptr_t PassID;
// AnalysisImpls - This keeps track of which passes implement the interfaces
// that are required by the current pass (to implement getAnalysis()).
void operator=(const Pass&); // DO NOT IMPLEMENT
Pass(const Pass &); // DO NOT IMPLEMENT
public:
- Pass() : Resolver(0), Resolver_New(0), PassInfoCache(0) {}
- virtual ~Pass() {} // Destructor is virtual so we can be subclassed
+ explicit Pass(intptr_t pid) : Resolver(0), PassID(pid) {}
+ explicit Pass(const void *pid) : Resolver(0), PassID((intptr_t)pid) {}
+ virtual ~Pass();
/// getPassName - Return a nice clean name for a pass. This usually
/// implemented in terms of the name that is registered by one of the
/// provide the Module* in case the analysis doesn't need it it can just be
/// ignored.
///
- void print(OStream &O, const Module *M) const {
- if (O.stream()) print(*O.stream(), M);
- }
virtual void print(std::ostream &O, const Module *M) const;
+ void print(std::ostream *O, const Module *M) const { if (O) print(*O, M); }
void dump() const; // dump - call print(std::cerr, 0);
- // Access AnalysisResolver_New
- inline void setResolver(AnalysisResolver_New *AR) { Resolver_New = AR; }
- inline AnalysisResolver_New *getResolver() { return Resolver_New; }
+ /// Each pass is responsible for assigning a pass manager to itself.
+ /// PMS is the stack of available pass manager.
+ virtual void assignPassManager(PMStack &PMS,
+ PassManagerType T = PMT_Unknown) {}
+ /// Check if available pass managers are suitable for this pass or not.
+ virtual void preparePassManager(PMStack &PMS) {}
+
+ /// Return what kind of Pass Manager can manage this pass.
+ virtual PassManagerType getPotentialPassManagerType() const {
+ return PMT_Unknown;
+ }
+
+ // Access AnalysisResolver
+ inline void setResolver(AnalysisResolver *AR) {
+ assert (!Resolver && "Resolver is already set");
+ Resolver = AR;
+ }
+ inline AnalysisResolver *getResolver() {
+ assert (Resolver && "Resolver is not set");
+ return Resolver;
+ }
/// getAnalysisUsage - This function should be overriden by passes that need
/// analysis information to do their job. If a pass specifies that it uses a
///
virtual void releaseMemory() {}
+ /// verifyAnalysis() - This member can be implemented by a analysis pass to
+ /// check state of analysis information.
+ virtual void verifyAnalysis() const {}
+
// dumpPassStructure - Implement the -debug-passes=PassStructure option
virtual void dumpPassStructure(unsigned Offset = 0);
-
- // getPassInfo - Static method to get the pass information from a class name.
template<typename AnalysisClass>
static const PassInfo *getClassPassInfo() {
- return lookupPassInfo(typeid(AnalysisClass));
+ return lookupPassInfo(intptr_t(&AnalysisClass::ID));
}
// lookupPassInfo - Return the pass info object for the specified pass class,
// or null if it is not known.
- static const PassInfo *lookupPassInfo(const std::type_info &TI);
+ static const PassInfo *lookupPassInfo(intptr_t TI);
/// getAnalysisToUpdate<AnalysisType>() - This function is used by subclasses
/// to get to the analysis information that might be around that needs to be
/// getAnalysisUsage function.
///
template<typename AnalysisType>
- AnalysisType &getAnalysis() const {
- assert(Resolver && "Pass has not been inserted into a PassManager object!");
- const PassInfo *PI = getClassPassInfo<AnalysisType>();
- return getAnalysisID<AnalysisType>(PI);
- }
+ AnalysisType &getAnalysis() const; // Defined in PassAnalysisSupport.h
template<typename AnalysisType>
- AnalysisType &getAnalysisID(const PassInfo *PI) const {
- assert(Resolver && "Pass has not been inserted into a PassManager object!");
- assert(PI && "getAnalysis for unregistered pass!");
-
- // PI *must* appear in AnalysisImpls. Because the number of passes used
- // should be a small number, we just do a linear search over a (dense)
- // vector.
- Pass *ResultPass = 0;
- for (unsigned i = 0; ; ++i) {
- assert(i != AnalysisImpls.size() &&
- "getAnalysis*() called on an analysis that was not "
- "'required' by pass!");
- if (AnalysisImpls[i].first == PI) {
- ResultPass = AnalysisImpls[i].second;
- break;
- }
- }
-
- // Because the AnalysisType may not be a subclass of pass (for
- // AnalysisGroups), we must use dynamic_cast here to potentially adjust the
- // return pointer (because the class may multiply inherit, once from pass,
- // once from AnalysisType).
- //
- AnalysisType *Result = dynamic_cast<AnalysisType*>(ResultPass);
- assert(Result && "Pass does not implement interface required!");
- return *Result;
- }
+ AnalysisType &getAnalysis(Function &F); // Defined in PassanalysisSupport.h
-private:
- template<typename Trait> friend class PassManagerT;
- friend class ModulePassManager;
- friend class FunctionPassManagerT;
- friend class BasicBlockPassManager;
+ template<typename AnalysisType>
+ AnalysisType &getAnalysisID(const PassInfo *PI) const;
+
+ template<typename AnalysisType>
+ AnalysisType &getAnalysisID(const PassInfo *PI, Function &F);
};
inline std::ostream &operator<<(std::ostream &OS, const Pass &P) {
virtual bool runPass(Module &M) { return runOnModule(M); }
virtual bool runPass(BasicBlock&) { return false; }
- virtual void addToPassManager(ModulePassManager *PM, AnalysisUsage &AU);
+ virtual void assignPassManager(PMStack &PMS,
+ PassManagerType T = PMT_ModulePassManager);
+
+ /// Return what kind of Pass Manager can manage this pass.
+ virtual PassManagerType getPotentialPassManagerType() const {
+ return PMT_ModulePassManager;
+ }
+
+ explicit ModulePass(intptr_t pid) : Pass(pid) {}
+ explicit ModulePass(const void *pid) : Pass(pid) {}
+ // Force out-of-line virtual method.
+ virtual ~ModulePass();
};
/// ImmutablePasses are never run.
///
- virtual bool runOnModule(Module &M) { return false; }
+ bool runOnModule(Module &M) { return false; }
-private:
- template<typename Trait> friend class PassManagerT;
- friend class ModulePassManager;
- virtual void addToPassManager(ModulePassManager *PM, AnalysisUsage &AU);
+ explicit ImmutablePass(intptr_t pid) : ModulePass(pid) {}
+ explicit ImmutablePass(const void *pid) : ModulePass(pid) {}
+
+ // Force out-of-line virtual method.
+ virtual ~ImmutablePass();
};
//===----------------------------------------------------------------------===//
/// 2. Optimizing a function does not cause the addition or removal of any
/// functions in the module
///
-class FunctionPass : public ModulePass {
+class FunctionPass : public Pass {
public:
+ explicit FunctionPass(intptr_t pid) : Pass(pid) {}
+ explicit FunctionPass(const void *pid) : Pass(pid) {}
+
/// doInitialization - Virtual method overridden by subclasses to do
/// any necessary per-module initialization.
///
///
bool run(Function &F);
-protected:
- template<typename Trait> friend class PassManagerT;
- friend class ModulePassManager;
- friend class FunctionPassManagerT;
- friend class BasicBlockPassManager;
- virtual void addToPassManager(ModulePassManager *PM, AnalysisUsage &AU);
- virtual void addToPassManager(FunctionPassManagerT *PM, AnalysisUsage &AU);
+ virtual void assignPassManager(PMStack &PMS,
+ PassManagerType T = PMT_FunctionPassManager);
+
+ /// Return what kind of Pass Manager can manage this pass.
+ virtual PassManagerType getPotentialPassManagerType() const {
+ return PMT_FunctionPassManager;
+ }
};
/// other basic block in the function.
/// 3. Optimizations conform to all of the constraints of FunctionPasses.
///
-class BasicBlockPass : public FunctionPass {
+class BasicBlockPass : public Pass {
public:
+ explicit BasicBlockPass(intptr_t pid) : Pass(pid) {}
+ explicit BasicBlockPass(const void *pid) : Pass(pid) {}
+
/// doInitialization - Virtual method overridden by subclasses to do
/// any necessary per-module initialization.
///
virtual bool runPass(Module &M) { return false; }
virtual bool runPass(BasicBlock &BB);
-private:
- template<typename Trait> friend class PassManagerT;
- friend class FunctionPassManagerT;
- friend class BasicBlockPassManager;
- virtual void addToPassManager(ModulePassManager *PM, AnalysisUsage &AU) {
- FunctionPass::addToPassManager(PM, AU);
+ virtual void assignPassManager(PMStack &PMS,
+ PassManagerType T = PMT_BasicBlockPassManager);
+
+ /// Return what kind of Pass Manager can manage this pass.
+ virtual PassManagerType getPotentialPassManagerType() const {
+ return PMT_BasicBlockPassManager;
}
- virtual void addToPassManager(FunctionPassManagerT *PM, AnalysisUsage &AU);
- virtual void addToPassManager(BasicBlockPassManager *PM,AnalysisUsage &AU);
};
+/// PMStack
+/// Top level pass manager (see PasManager.cpp) maintains active Pass Managers
+/// using PMStack. Each Pass implements assignPassManager() to connect itself
+/// with appropriate manager. assignPassManager() walks PMStack to find
+/// suitable manager.
+///
+/// PMStack is just a wrapper around standard deque that overrides pop() and
+/// push() methods.
+class PMStack {
+public:
+ typedef std::deque<PMDataManager *>::reverse_iterator iterator;
+ iterator begin() { return S.rbegin(); }
+ iterator end() { return S.rend(); }
+
+ void handleLastUserOverflow();
+
+ void pop();
+ inline PMDataManager *top() { return S.back(); }
+ void push(Pass *P);
+ inline bool empty() { return S.empty(); }
+
+ void dump();
+private:
+ std::deque<PMDataManager *> S;
+};
+
+
/// If the user specifies the -time-passes argument on an LLVM tool command line
/// then the value of this boolean will be true, otherwise false.
/// @brief This is the storage for the -time-passes option.
projects / oota-llvm.git / blobdiff