X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FPass.h;h=923de658c3b95e33006fcb33dbf187322d9cbef6;hb=71417827e8d8b42be7ca903295d42891c2a002b8;hp=7ca3fddaf1e3945fed59a5a6f5d3f66d70a28366;hpb=3889a2cb05c36f30050941679d5fd55d45e6a3ed;p=oota-llvm.git diff --git a/include/llvm/Pass.h b/include/llvm/Pass.h index 7ca3fddaf1e..923de658c3b 100644 --- a/include/llvm/Pass.h +++ b/include/llvm/Pass.h @@ -1,9 +1,16 @@ -//===- llvm/Pass.h - Base class for XForm Passes -----------------*- C++ -*--=// +//===- llvm/Pass.h - Base class for Passes ----------------------*- C++ -*-===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// // // This file defines a base class that indicates that a specified class is a // transformation pass implementation. // -// Pass's are designed this way so that it is possible to run passes in a cache +// Passes are designed this way so that it is possible to run passes in a cache // and organizationally optimal order without having to specify it at the front // end. This allows arbitrary passes to be strung together and have them // executed as effeciently as possible. @@ -22,50 +29,64 @@ #ifndef LLVM_PASS_H #define LLVM_PASS_H -#include -#include -#include +#include "llvm/Support/DataTypes.h" +#include "llvm/Support/Streams.h" +#include #include -#include -class Value; +#include +#include + +namespace llvm { + class BasicBlock; class Function; class Module; class AnalysisUsage; class PassInfo; class ImmutablePass; -template class PassManagerT; -struct AnalysisResolver; +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 +}; + //===----------------------------------------------------------------------===// /// 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 class AnalysisResolver; - AnalysisResolver *Resolver; // AnalysisResolver this pass is owned by... - 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), 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 - /// intelligable name for the pass. + /// Registration templates, but can be overloaded directly. /// virtual const char *getPassName() const; @@ -74,29 +95,44 @@ public: /// const PassInfo *getPassInfo() const; - /// run - Run this pass, returning true if a modification was made to the - /// module argument. This should be implemented by all concrete subclasses. - /// - virtual bool run(Module &M) = 0; - /// 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 - /// neccesary to implement this method. Beware that the module pointer MAY be + /// necessary to implement this method. Beware that the module pointer MAY be /// null. This automatically forwards to a virtual function that does not /// 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 { print(O); } - virtual void print(std::ostream &O) const; + 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); + /// 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) { + 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. } @@ -113,41 +149,38 @@ 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); + + /// 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 { - assert(Resolver && "Pass not resident in a PassManager object!"); - const PassInfo *PI = getClassPassInfo(); - if (PI == 0) return 0; - return dynamic_cast(Resolver->getAnalysisToUpdate(PI)); - } + 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; @@ -156,52 +189,46 @@ public: /// getAnalysisUsage function. /// template - AnalysisType &getAnalysis() const { - assert(Resolver && "Pass has not been inserted into a PassManager object!"); - const PassInfo *PI = getClassPassInfo(); - return getAnalysisID(PI); - } + AnalysisType &getAnalysis() const; // Defined in PassAnalysisSupport.h template - 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 we 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(ResultPass); - assert(Result && "Pass does not implement interface required!"); - return *Result; - } + AnalysisType &getAnalysis(Function &F); // Defined in PassanalysisSupport.h -private: - friend class PassManagerT; - friend class PassManagerT; - friend class PassManagerT; - virtual void addToPassManager(PassManagerT *PM, AnalysisUsage &AU); + template + AnalysisType &getAnalysisID(const PassInfo *PI) const; + + 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 +/// interprocedural optimizations and analyses. ModulePasses may do anything +/// they want to the program. +/// +class ModulePass : public Pass { +public: + /// runOnModule - Virtual method overriden by subclasses to process the module + /// being operated on. + virtual bool runOnModule(Module &M) = 0; + + 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(); +}; //===----------------------------------------------------------------------===// @@ -209,7 +236,8 @@ inline std::ostream &operator<<(std::ostream &OS, const Pass &P) { /// not need to be run. This is useful for things like target information and /// "basic" versions of AnalysisGroups. /// -struct ImmutablePass : public Pass { +class ImmutablePass : public ModulePass { +public: /// initializePass - This method may be overriden by immutable passes to allow /// them to perform various initialization actions they require. This is /// primarily because an ImmutablePass can "require" another ImmutablePass, @@ -220,14 +248,16 @@ struct ImmutablePass : public Pass { /// ImmutablePasses are never run. /// - virtual bool run(Module &M) { return false; } - -private: - friend class PassManagerT; - virtual void addToPassManager(PassManagerT *PM, AnalysisUsage &AU); + 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(); }; - //===----------------------------------------------------------------------===// /// FunctionPass class - This class is used to implement most global /// optimizations. Optimizations should subclass this class if they meet the @@ -237,11 +267,15 @@ private: /// 2. Optimizing a function does not cause the addition or removal of any /// functions in the module /// -struct FunctionPass : public Pass { +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 neccesary per-module initialization. + /// 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. @@ -251,24 +285,26 @@ struct FunctionPass : public Pass { /// 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; } - /// run - On a module, we run this pass by initializing, ronOnFunction'ing - /// once for every function in the module, then by finalizing. + /// runOnModule - On a module, we run this pass by initializing, + /// ronOnFunction'ing once for every function in the module, then by + /// finalizing. /// - virtual bool run(Module &M); + virtual bool runOnModule(Module &M); /// run - On a function, we simply initialize, run the function, then /// finalize. /// bool run(Function &F); -private: - friend class PassManagerT; - friend class PassManagerT; - friend class PassManagerT; - virtual void addToPassManager(PassManagerT *PM, AnalysisUsage &AU); - virtual void addToPassManager(PassManagerT *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; + } }; @@ -281,18 +317,22 @@ private: /// instruction at a time. /// 2. Optimizations do not modify the CFG of the contained function, or any /// other basic block in the function. -/// 3. Optimizations conform to all of the constraints of FunctionPass's. +/// 3. Optimizations conform to all of the constraints of FunctionPasses. /// -struct 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 neccesary per-module initialization. + /// 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 neccesary per-function initialization. + /// 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. @@ -302,12 +342,12 @@ struct BasicBlockPass : public FunctionPass { /// 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 @@ -315,18 +355,22 @@ struct BasicBlockPass : public FunctionPass { // bool runOnFunction(Function &F); - /// To run directly on the basic block, we initialize, runOnBasicBlock, then - /// finalize. - /// - bool run(BasicBlock &BB); + virtual void assignPassManager(PMStack &PMS, + PassManagerType T = PMT_BasicBlockPassManager); -private: - friend class PassManagerT; - friend class PassManagerT; - virtual void addToPassManager(PassManagerT *PM, AnalysisUsage &AU); - virtual void addToPassManager(PassManagerT *PM,AnalysisUsage &AU); + /// 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. +extern bool TimePassesIsEnabled; + +} // End llvm namespace + // Include support files that contain important APIs commonly used by Passes, // but that we want to separate out to make it easier to read the header files. //