X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FPass.h;h=6bef2e79b2a604a44ac49c6ad215f7312c50afff;hb=24f934d0551e33508c4ffd24318ea0e970db9810;hp=9663826ccf615343b006d8b31899bb91202d9961;hpb=52fc5feb862d9fb5b9e76eda0906d27cb429b918;p=oota-llvm.git diff --git a/include/llvm/Pass.h b/include/llvm/Pass.h index 9663826ccf6..6bef2e79b2a 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,61 +29,65 @@ #ifndef LLVM_PASS_H #define LLVM_PASS_H -#include "llvm/Support/Streams.h" -#include -#include -#include -#include +#include "llvm/System/DataTypes.h" #include - -#define USE_OLD_PASSMANAGER 1 +#include +#include namespace llvm { -class Value; class BasicBlock; class Function; class Module; class AnalysisUsage; class PassInfo; class ImmutablePass; -template class PassManagerT; -class BasicBlockPassManager; -class FunctionPassManagerT; -class ModulePassManager; -struct AnalysisResolver; -class AnalysisResolver_New; +class PMStack; +class AnalysisResolver; +class PMDataManager; +class raw_ostream; +class StringRef; // 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 /// 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; - - // AnalysisImpls - This keeps track of which passes implement the interfaces - // that are required by the current pass (to implement getAnalysis()). - // - std::vector > AnalysisImpls; + AnalysisResolver *Resolver; // Used to resolve analysis + intptr_t PassID; 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) { + assert(pid && "pid cannot be 0"); + } + explicit Pass(const void *pid) : Resolver(0), PassID((intptr_t)pid) { + assert(pid && "pid cannot be 0"); + } + 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; @@ -92,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 @@ -105,20 +103,36 @@ public: /// provide the Module* in case the analysis doesn't need it it can just be /// ignored. /// - 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); + virtual void print(raw_ostream &O, const Module *M) const; + void dump() const; // dump - Print to stderr. + + /// 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_New - inline void setResolver(AnalysisResolver_New *AR) { Resolver_New = AR; } - inline AnalysisResolver_New *getResolver() { return Resolver_New; } + // Access AnalysisResolver + inline void setResolver(AnalysisResolver *AR) { + assert (!Resolver && "Resolver is already set"); + Resolver = AR; + } + inline AnalysisResolver *getResolver() { + 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. } @@ -135,36 +149,42 @@ 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); - - // getPassInfo - Static method to get the pass information from a class name. 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); - - /// getAnalysisToUpdate() - This function is used by subclasses - /// to get to the analysis information that might be around that needs to be - /// updated. This is different than getAnalysis in that it can fail (ie the - /// analysis results haven't been computed), so should only be used if you - /// provide the capability to update an analysis that exists. This method is - /// often used by transformation APIs to update analysis results for a pass - /// automatically as the transform is performed. + static const PassInfo *lookupPassInfo(intptr_t TI); + + // lookupPassInfo - Return the pass info object for the pass with the given + // argument string, or null if it is not known. + static const PassInfo *lookupPassInfo(const StringRef &Arg); + + /// getAnalysisIfAvailable() - Subclasses use this function to + /// get analysis information that might be around, for example to update it. + /// This is different than getAnalysis in that it can fail (if the analysis + /// results haven't been computed), so should only be used if you can handle + /// the case when the analysis is not available. This method is often used by + /// transformation APIs to update analysis results for a pass automatically as + /// the transform is performed. /// - template - AnalysisType *getAnalysisToUpdate() const; // Defined in PassAnalysisSupport.h + template AnalysisType * + getAnalysisIfAvailable() const; // Defined in PassAnalysisSupport.h /// mustPreserveAnalysisID - This method serves the same function as - /// getAnalysisToUpdate, but works if you just have an AnalysisID. This + /// getAnalysisIfAvailable, but works if you just have an AnalysisID. This /// obviously cannot give you a properly typed instance of the class if you - /// don't have the class name available (use getAnalysisToUpdate if you do), - /// but it can tell you if you need to preserve the pass at least. + /// don't have the class name available (use getAnalysisIfAvailable if you + /// do), but it can tell you if you need to preserve the pass at least. /// bool mustPreserveAnalysisID(const PassInfo *AnalysisID) const; @@ -175,19 +195,16 @@ 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) { - P.print(OS, 0); return OS; -} //===----------------------------------------------------------------------===// /// ModulePass class - This class is used to implement unstructured @@ -200,12 +217,18 @@ 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); -#ifdef USE_OLD_PASSMANAGER - virtual void addToPassManager(ModulePassManager *PM, AnalysisUsage &AU); -#endif + /// 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(); }; @@ -226,14 +249,14 @@ public: /// ImmutablePasses are never run. /// - virtual bool runOnModule(Module &M) { return false; } - -#ifdef USE_OLD_PASSMANAGER -private: - template friend class PassManagerT; - friend class ModulePassManager; - virtual void addToPassManager(ModulePassManager *PM, AnalysisUsage &AU); -#endif + 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(); }; //===----------------------------------------------------------------------===// @@ -245,13 +268,16 @@ private: /// 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. /// @@ -260,7 +286,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 @@ -273,15 +299,13 @@ public: /// bool run(Function &F); -#ifdef USE_OLD_PASSMANAGER -protected: - template 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); -#endif + 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; + } }; @@ -296,17 +320,20 @@ protected: /// 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. @@ -316,12 +343,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 @@ -329,23 +356,13 @@ 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); - -#ifdef USE_OLD_PASSMANAGER -private: - template 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); -#endif }; /// If the user specifies the -time-passes argument on an LLVM tool command line