X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FPass.h;h=35ec022516a546f166a1fb2dfbc81e80a7bce4ce;hb=2c46deb1d07f4588ee70059cdd4c7145f81bc8e8;hp=f604921601f6c3583b737cf134224369c855433d;hpb=4445519fab769d36f5a97466f5cfe1c618c44921;p=oota-llvm.git diff --git a/include/llvm/Pass.h b/include/llvm/Pass.h index f604921601f..35ec022516a 100644 --- a/include/llvm/Pass.h +++ b/include/llvm/Pass.h @@ -1,329 +1,369 @@ -//===- 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. +// executed as efficiently as possible. // // Passes should extend one of the classes below, depending on the guarantees // that it can make about what will be modified as it is run. For example, most // global optimizations should derive from FunctionPass, because they do not add // or delete functions, they operate on the internals of the function. // +// Note that this file #includes PassSupport.h and PassAnalysisSupport.h (at the +// bottom), so the APIs exposed by these files are also automatically available +// to all users of this file. +// //===----------------------------------------------------------------------===// #ifndef LLVM_PASS_H #define LLVM_PASS_H -#include -#include -class Value; +#include "llvm/Support/Compiler.h" +#include + +namespace llvm { + class BasicBlock; class Function; class Module; class AnalysisUsage; -class AnalysisID; -template class PassManagerT; -struct AnalysisResolver; +class PassInfo; +class ImmutablePass; +class PMStack; +class AnalysisResolver; +class PMDataManager; +class raw_ostream; +class StringRef; + +// AnalysisID - Use the PassInfo to identify a pass... +typedef const void* 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_RegionPassManager, ///< RGPassManager + PMT_BasicBlockPassManager, ///< BBPassManager + PMT_Last +}; + +// Different types of passes. +enum PassKind { + PT_BasicBlock, + PT_Region, + PT_Loop, + PT_Function, + PT_CallGraphSCC, + PT_Module, + PT_PassManager +}; //===----------------------------------------------------------------------===// -// 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. -// +/// 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... + AnalysisResolver *Resolver; // Used to resolve analysis + const void *PassID; + PassKind Kind; + void operator=(const Pass&) LLVM_DELETED_FUNCTION; + Pass(const Pass &) LLVM_DELETED_FUNCTION; + public: - inline Pass(AnalysisResolver *AR = 0) : Resolver(AR) {} - inline virtual ~Pass() {} // Destructor is virtual so we can be subclassed + explicit Pass(PassKind K, char &pid) : Resolver(0), PassID(&pid), Kind(K) { } + virtual ~Pass(); + - // getPassName - Return a nice clean name for a pass. This should be - // overloaded by the pass, but if it is not, C++ RTTI will be consulted to get - // a SOMEWHAT intelligable name for the pass. - // + PassKind getPassKind() const { return Kind; } + + /// 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. + /// virtual const char *getPassName() 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; - - // 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 { - // By default, no analysis results are used, all are invalidated. + /// getPassID - Return the PassID number that corresponds to this pass. + AnalysisID getPassID() const { + return PassID; } - // releaseMemory() - This member can be implemented by a pass if it wants to - // be able to release its memory when it is no longer needed. The default - // behavior of passes is to hold onto memory for the entire duration of their - // lifetime (which is the entire compile time). For pipelined passes, this - // is not a big deal because that memory gets recycled every time the pass is - // invoked on another program unit. For IP passes, it is more important to - // free memory when it is unused. - // - // Optionally implement this function to release pass memory when it is no - // longer used. - // - virtual void releaseMemory() {} + /// doInitialization - Virtual method overridden by subclasses to do + /// any necessary initialization before any pass is run. + /// + virtual bool doInitialization(Module &) { return false; } + + /// doFinalization - Virtual method overriden by subclasses to do any + /// necessary clean up after all passes have run. + /// + virtual bool doFinalization(Module &) { 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 + /// 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(raw_ostream &O, const Module *M) const; + void dump() const; // dump - Print to stderr. + + /// createPrinterPass - Get a Pass appropriate to print the IR this + /// pass operates on (Module, Function or MachineFunction). + virtual Pass *createPrinterPass(raw_ostream &O, + const std::string &Banner) const = 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) {} + /// 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; + + // Access AnalysisResolver + void setResolver(AnalysisResolver *AR); + AnalysisResolver *getResolver() const { 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 &) const; + + /// releaseMemory() - This member can be implemented by a pass if it wants to + /// be able to release its memory when it is no longer needed. The default + /// behavior of passes is to hold onto memory for the entire duration of their + /// lifetime (which is the entire compile time). For pipelined passes, this + /// is not a big deal because that memory gets recycled every time the pass is + /// invoked on another program unit. For IP passes, it is more important to + /// free memory when it is unused. + /// + /// Optionally implement this function to release pass memory when it is no + /// longer used. + /// + virtual void releaseMemory(); + + /// getAdjustedAnalysisPointer - This method is used when a pass implements + /// an analysis interface through multiple inheritance. If needed, it should + /// override this to adjust the this pointer as needed for the specified pass + /// info. + virtual void *getAdjustedAnalysisPointer(AnalysisID ID); + virtual ImmutablePass *getAsImmutablePass(); + virtual PMDataManager *getAsPMDataManager(); + + /// 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); -protected: - // getAnalysis() - This function is used by subclasses to get to - // the analysis information that they claim to use by overriding the - // getAnalysisUsage function. - // + // lookupPassInfo - Return the pass info object for the specified pass class, + // or null if it is not known. + static const PassInfo *lookupPassInfo(const void *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(StringRef Arg); + + // createPass - Create a object for the specified pass class, + // or null if it is not known. + static Pass *createPass(AnalysisID ID); + + /// 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 * + getAnalysisIfAvailable() const; // Defined in PassAnalysisSupport.h + + /// mustPreserveAnalysisID - This method serves the same function as + /// 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 getAnalysisIfAvailable if you + /// do), but it can tell you if you need to preserve the pass at least. + /// + bool mustPreserveAnalysisID(char &AID) const; + + /// getAnalysis() - This function is used by subclasses to get + /// to the analysis information that they claim to use by overriding the + /// getAnalysisUsage function. + /// template - AnalysisType &getAnalysis(AnalysisID AID = AnalysisType::ID) { - assert(Resolver && "Pass not resident in a PassManager object!"); - return *(AnalysisType*)Resolver->getAnalysis(AID); - } + AnalysisType &getAnalysis() const; // Defined in PassAnalysisSupport.h - // 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. - // template - AnalysisType *getAnalysisToUpdate(AnalysisID AID = AnalysisType::ID) { - assert(Resolver && "Pass not resident in a PassManager object!"); - return (AnalysisType*)Resolver->getAnalysisToUpdate(AID); - } + AnalysisType &getAnalysis(Function &F); // Defined in PassAnalysisSupport.h + template + AnalysisType &getAnalysisID(AnalysisID PI) const; -private: - friend class PassManagerT; - friend class PassManagerT; - friend class PassManagerT; - virtual void addToPassManager(PassManagerT *PM, AnalysisUsage &AU); + template + AnalysisType &getAnalysisID(AnalysisID PI, Function &F); }; //===----------------------------------------------------------------------===// -// FunctionPass class - This class is used to implement most global -// optimizations. Optimizations should subclass this class if they meet the -// following constraints: -// -// 1. Optimizations are organized globally, ie a function at a time -// 2. Optimizing a function does not cause the addition or removal of any -// functions in the module -// -struct FunctionPass : public Pass { - // doInitialization - Virtual method overridden by subclasses to do - // any neccesary per-module initialization. - // - virtual bool doInitialization(Module *M) { return false; } - - // runOnFunction - Virtual method overriden by subclasses to do the - // per-function processing of the pass. - // - virtual bool runOnFunction(Function *F) = 0; - - // doFinalization - Virtual method overriden by subclasses to do any post - // processing needed after all passes have run. - // - virtual bool doFinalization(Module *M) { return false; } - - // run - 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); - - // 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); -}; +/// 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: + /// createPrinterPass - Get a module printer pass. + Pass *createPrinterPass(raw_ostream &O, const std::string &Banner) const; + /// 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); -//===----------------------------------------------------------------------===// -// BasicBlockPass class - This class is used to implement most local -// optimizations. Optimizations should subclass this class if they -// meet the following constraints: -// 1. Optimizations are local, operating on either a basic block or -// 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 contstraints of FunctionPass's. -// -struct BasicBlockPass : public FunctionPass { - // runOnBasicBlock - Virtual method overriden by subclasses to do the - // per-basicblock processing of the pass. - // - virtual bool runOnBasicBlock(BasicBlock *M) = 0; - - // To run this pass on a function, we simply call runOnBasicBlock once for - // each function. - // - virtual bool runOnFunction(Function *F); - - // To run directly on the basic block, we initialize, runOnBasicBlock, then - // finalize. - // - bool run(BasicBlock *BB); - -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; + explicit ModulePass(char &pid) : Pass(PT_Module, pid) {} + // Force out-of-line virtual method. + virtual ~ModulePass(); +}; -// CreatePass - Helper template to invoke the constructor for the AnalysisID -// class. Note that this should be a template internal to AnalysisID, but -// GCC 2.95.3 crashes if we do that, doh. -// -template -static Pass *CreatePass(AnalysisID ID) { return new AnalysisType(ID); } //===----------------------------------------------------------------------===// -// AnalysisID - This class is used to uniquely identify an analysis pass that -// is referenced by a transformation. -// -class AnalysisID { - static unsigned NextID; // Next ID # to deal out... - unsigned ID; // Unique ID for this analysis - Pass *(*Constructor)(AnalysisID); // Constructor to return the Analysis - - AnalysisID(); // Disable default ctor - AnalysisID(unsigned id, Pass *(*Ct)(AnalysisID)) : ID(id), Constructor(Ct) {} +/// ImmutablePass class - This class is used to provide information that does +/// not need to be run. This is useful for things like target information and +/// "basic" versions of AnalysisGroups. +/// +class ImmutablePass : public ModulePass { public: - // create - the only way to define a new AnalysisID. This static method is - // supposed to be used to define the class static AnalysisID's that are - // provided by analysis passes. In the implementation (.cpp) file for the - // class, there should be a line that looks like this (using CallGraph as an - // example): - // - // AnalysisID CallGraph::ID(AnalysisID::create()); - // - template - static AnalysisID create() { - return AnalysisID(NextID++, CreatePass); - } + /// 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, + /// and if it does, the overloaded version of initializePass may get access to + /// these passes with getAnalysis<>. + /// + virtual void initializePass(); - // Special Copy Constructor - This is how analysis passes declare that they - // only depend on the CFG of the function they are working on, so they are not - // invalidated by other passes that do not modify the CFG. This should be - // used like this: - // AnalysisID DominatorSet::ID(AnalysisID::create(), true); - // - AnalysisID(const AnalysisID &AID, bool DependsOnlyOnCFG = false); + virtual ImmutablePass *getAsImmutablePass() { return this; } + /// ImmutablePasses are never run. + /// + bool runOnModule(Module &) { return false; } - inline Pass *createPass() const { return Constructor(*this); } + explicit ImmutablePass(char &pid) + : ModulePass(pid) {} - inline bool operator==(const AnalysisID &A) const { - return A.ID == ID; - } - inline bool operator!=(const AnalysisID &A) const { - return A.ID != ID; - } - inline bool operator<(const AnalysisID &A) const { - return ID < A.ID; - } + // Force out-of-line virtual method. + virtual ~ImmutablePass(); }; //===----------------------------------------------------------------------===// -// AnalysisUsage - Represent the analysis usage information of a pass. This -// tracks analyses that the pass REQUIRES (must available when the pass runs), -// and analyses that the pass PRESERVES (the pass does not invalidate the -// results of these analyses). This information is provided by a pass to the -// Pass infrastructure through the getAnalysisUsage virtual function. -// -class AnalysisUsage { - // Sets of analyses required and preserved by a pass - std::vector Required, Preserved, Provided; - bool PreservesAll; +/// FunctionPass class - This class is used to implement most global +/// optimizations. Optimizations should subclass this class if they meet the +/// following constraints: +/// +/// 1. Optimizations are organized globally, i.e., a function at a time +/// 2. Optimizing a function does not cause the addition or removal of any +/// functions in the module +/// +class FunctionPass : public Pass { public: - AnalysisUsage() : PreservesAll(false) {} - - // addRequires - Add the specified ID to the required set of the usage info - // for a pass. - // - AnalysisUsage &addRequired(AnalysisID ID) { - Required.push_back(ID); - return *this; - } + explicit FunctionPass(char &pid) : Pass(PT_Function, pid) {} - // addPreserves - Add the specified ID to the set of analyses preserved by - // this pass - // - AnalysisUsage &addPreserved(AnalysisID ID) { - Preserved.push_back(ID); - return *this; - } + /// createPrinterPass - Get a function printer pass. + Pass *createPrinterPass(raw_ostream &O, const std::string &Banner) const; - void addProvided(AnalysisID ID) { - Provided.push_back(ID); - } + /// runOnFunction - Virtual method overriden by subclasses to do the + /// per-function processing of the pass. + /// + virtual bool runOnFunction(Function &F) = 0; - // PreservesAll - Set by analyses that do not transform their input at all - void setPreservesAll() { PreservesAll = true; } - bool preservesAll() const { return PreservesAll; } - - // preservesCFG - This function should be called to by the pass, iff they do - // not: - // - // 1. Add or remove basic blocks from the function - // 2. Modify terminator instructions in any way. - // - // This function annotates the AnalysisUsage info object to say that analyses - // that only depend on the CFG are preserved by this pass. - // - void preservesCFG(); - - const std::vector &getRequiredSet() const { return Required; } - const std::vector &getPreservedSet() const { return Preserved; } - const std::vector &getProvidedSet() const { return Provided; } + virtual void assignPassManager(PMStack &PMS, + PassManagerType T); + + /// Return what kind of Pass Manager can manage this pass. + virtual PassManagerType getPotentialPassManagerType() const; }; //===----------------------------------------------------------------------===// -// AnalysisResolver - Simple interface implemented by PassManagers objects that -// is used to pull analysis information out of them. -// -struct AnalysisResolver { - virtual Pass *getAnalysisOrNullUp(AnalysisID ID) const = 0; - virtual Pass *getAnalysisOrNullDown(AnalysisID ID) const = 0; - Pass *getAnalysis(AnalysisID ID) { - Pass *Result = getAnalysisOrNullUp(ID); - assert(Result && "Pass has an incorrect analysis uses set!"); - return Result; - } +/// BasicBlockPass class - This class is used to implement most local +/// optimizations. Optimizations should subclass this class if they +/// meet the following constraints: +/// 1. Optimizations are local, operating on either a basic block or +/// 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 FunctionPasses. +/// +class BasicBlockPass : public Pass { +public: + explicit BasicBlockPass(char &pid) : Pass(PT_BasicBlock, pid) {} - // getAnalysisToUpdate - Return an analysis result or null if it doesn't exist - Pass *getAnalysisToUpdate(AnalysisID ID) { - Pass *Result = getAnalysisOrNullUp(ID); - return Result; - } + /// createPrinterPass - Get a basic block printer pass. + Pass *createPrinterPass(raw_ostream &O, const std::string &Banner) const; + + using llvm::Pass::doInitialization; + using llvm::Pass::doFinalization; - virtual unsigned getDepth() const = 0; + /// doInitialization - Virtual method overridden by BasicBlockPass subclasses + /// to do any necessary per-function initialization. + /// + virtual bool doInitialization(Function &); - virtual void markPassUsed(AnalysisID P, Pass *User) = 0; + /// runOnBasicBlock - Virtual method overriden by subclasses to do the + /// per-basicblock processing of the pass. + /// + virtual bool runOnBasicBlock(BasicBlock &BB) = 0; - void startPass(Pass *P) {} - void endPass(Pass *P) {} -protected: - void setAnalysisResolver(Pass *P, AnalysisResolver *AR); + /// doFinalization - Virtual method overriden by BasicBlockPass subclasses to + /// do any post processing needed after all passes have run. + /// + virtual bool doFinalization(Function &); + + virtual void assignPassManager(PMStack &PMS, + PassManagerType T); + + /// Return what kind of Pass Manager can manage this pass. + virtual PassManagerType getPotentialPassManagerType() const; }; +/// 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. +// +#include "llvm/PassSupport.h" +#include "llvm/PassAnalysisSupport.h" + #endif