X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FPass.h;h=bc6b39bbb3145c07a69f3f6480d0344ba9313aad;hb=4b84086e89d86fb16f562166d9fea8df37db6be7;hp=9951a988bf02a6d63cf57662f5905d4d079497e8;hpb=9d133e150faac44b8d8d1b53516cbad4d9bbf84a;p=oota-llvm.git diff --git a/include/llvm/Pass.h b/include/llvm/Pass.h index 9951a988bf0..bc6b39bbb31 100644 --- a/include/llvm/Pass.h +++ b/include/llvm/Pass.h @@ -2,8 +2,8 @@ // // The LLVM Compiler Infrastructure // -// This file was developed by the LLVM research group 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. // //===----------------------------------------------------------------------===// // @@ -29,12 +29,11 @@ #ifndef LLVM_PASS_H #define LLVM_PASS_H +#include "llvm/Support/DataTypes.h" #include "llvm/Support/Streams.h" #include -#include -#include +#include #include -#include #include namespace llvm { @@ -46,10 +45,6 @@ class Module; class AnalysisUsage; class PassInfo; class ImmutablePass; -template class PassManagerT; -class BasicBlockPassManager; -class FunctionPassManagerT; -class ModulePassManager; class PMStack; class AnalysisResolver; class PMDataManager; @@ -57,6 +52,19 @@ 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 +}; + //===----------------------------------------------------------------------===// /// Pass interface - Implemented by all 'passes'. Subclass this if you are an /// interprocedural optimization or you do not fit into any of the more @@ -64,8 +72,7 @@ typedef const PassInfo* AnalysisID; /// class Pass { AnalysisResolver *Resolver; // Used to resolve analysis - const PassInfo *PassInfoCache; - + intptr_t PassID; // AnalysisImpls - This keeps track of which passes implement the interfaces // that are required by the current pass (to implement getAnalysis()). // @@ -74,14 +81,13 @@ class Pass { void operator=(const Pass&); // DO NOT IMPLEMENT Pass(const Pass &); // DO NOT IMPLEMENT public: - Pass() : Resolver(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 - /// Registration templates, but can be overloaded directly, and if nothing - /// else is available, C++ RTTI will be consulted to get a SOMEWHAT - /// intelligible name for the pass. + /// Registration templates, but can be overloaded directly. /// virtual const char *getPassName() const; @@ -90,12 +96,6 @@ public: /// const PassInfo *getPassInfo() const; - /// runPass - Run this pass, returning true if a modification was made to the - /// module argument. This should be implemented by all concrete subclasses. - /// - virtual bool runPass(Module &M) { return false; } - virtual bool runPass(BasicBlock&) { return false; } - /// print - Print out the internal state of the pass. This is called by /// Analyze to print out the contents of an analysis. Otherwise it is not /// necessary to implement this method. Beware that the module pointer MAY be @@ -107,17 +107,34 @@ public: void print(std::ostream *O, const Module *M) const { if (O) print(*O, M); } void dump() const; // dump - call print(std::cerr, 0); - virtual void assignPassManager(PMStack &PMS) {} + /// Each pass is responsible for assigning a pass manager to itself. + /// PMS is the stack of available pass manager. + virtual void assignPassManager(PMStack &, + PassManagerType = PMT_Unknown) {} + /// Check if available pass managers are suitable for this pass or not. + virtual void preparePassManager(PMStack &) {} + + /// Return what kind of Pass Manager can manage this pass. + virtual PassManagerType getPotentialPassManagerType() const { + return PMT_Unknown; + } + // Access AnalysisResolver - inline void setResolver(AnalysisResolver *AR) { Resolver = AR; } - inline AnalysisResolver *getResolver() { return Resolver; } + 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 /// particular analysis result to this function, it can then use the /// getAnalysis() function, below. /// - virtual void getAnalysisUsage(AnalysisUsage &Info) const { + virtual void getAnalysisUsage(AnalysisUsage &) const { // By default, no analysis results are used, all are invalidated. } @@ -134,17 +151,21 @@ public: /// 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); template 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() - This function is used by subclasses /// to get to the analysis information that might be around that needs to be @@ -172,14 +193,14 @@ public: template AnalysisType &getAnalysis() const; // Defined in PassAnalysisSupport.h + template + AnalysisType &getAnalysis(Function &F); // Defined in PassanalysisSupport.h + template AnalysisType &getAnalysisID(const PassInfo *PI) const; - -private: - template friend class PassManagerT; - friend class ModulePassManager; - friend class FunctionPassManagerT; - friend class BasicBlockPassManager; + + template + AnalysisType &getAnalysisID(const PassInfo *PI, Function &F); }; inline std::ostream &operator<<(std::ostream &OS, const Pass &P) { @@ -197,10 +218,16 @@ public: /// being operated on. virtual bool runOnModule(Module &M) = 0; - virtual bool runPass(Module &M) { return runOnModule(M); } - virtual bool runPass(BasicBlock&) { return false; } + virtual void assignPassManager(PMStack &PMS, + PassManagerType T = PMT_ModulePassManager); - virtual void assignPassManager(PMStack &PMS); + /// 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(); }; @@ -223,8 +250,12 @@ public: /// ImmutablePasses are never run. /// - virtual bool runOnModule(Module &M) { return false; } + bool runOnModule(Module &) { return false; } + explicit ImmutablePass(intptr_t pid) : ModulePass(pid) {} + explicit ImmutablePass(const void *pid) + : ModulePass(pid) {} + // Force out-of-line virtual method. virtual ~ImmutablePass(); }; @@ -238,12 +269,15 @@ public: /// 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. /// - virtual bool doInitialization(Module &M) { return false; } + virtual bool doInitialization(Module &) { return false; } /// runOnFunction - Virtual method overriden by subclasses to do the /// per-function processing of the pass. @@ -253,7 +287,7 @@ public: /// doFinalization - Virtual method overriden by subclasses to do any post /// processing needed after all passes have run. /// - virtual bool doFinalization(Module &M) { return false; } + virtual bool doFinalization(Module &) { return false; } /// runOnModule - On a module, we run this pass by initializing, /// ronOnFunction'ing once for every function in the module, then by @@ -266,7 +300,13 @@ public: /// bool run(Function &F); - virtual void assignPassManager(PMStack &PMS); + 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; + } }; @@ -281,17 +321,20 @@ public: /// 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 doInitialization(Module &M) { return false; } + virtual bool doInitialization(Module &) { return false; } /// doInitialization - Virtual method overridden by BasicBlockPass subclasses /// to do any necessary per-function initialization. /// - virtual bool doInitialization(Function &F) { return false; } + virtual bool doInitialization(Function &) { return false; } /// runOnBasicBlock - Virtual method overriden by subclasses to do the /// per-basicblock processing of the pass. @@ -301,12 +344,12 @@ public: /// doFinalization - Virtual method overriden by BasicBlockPass subclasses to /// do any post processing needed after all passes have run. /// - virtual bool doFinalization(Function &F) { return false; } + virtual bool doFinalization(Function &) { return false; } /// doFinalization - Virtual method overriden by subclasses to do any post /// processing needed after all passes have run. /// - virtual bool doFinalization(Module &M) { return false; } + virtual bool doFinalization(Module &) { return false; } // To run this pass on a function, we simply call runOnBasicBlock once for @@ -314,54 +357,15 @@ public: // bool runOnFunction(Function &F); - /// To run directly on the basic block, we initialize, runOnBasicBlock, then - /// finalize. - /// - virtual bool runPass(Module &M) { return false; } - virtual bool runPass(BasicBlock &BB); - - virtual void assignPassManager(PMStack &PMS); -}; + virtual void assignPassManager(PMStack &PMS, + PassManagerType T = PMT_BasicBlockPassManager); -/// 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 -}; - -/// 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::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 S; + /// Return what kind of Pass Manager can manage this pass. + virtual PassManagerType getPotentialPassManagerType() const { + return PMT_BasicBlockPassManager; + } }; - /// 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.