X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FPass.h;h=0ae94e3933374e751f40b1cf1c3283b07ff92eb4;hb=65513605353c7e3ee8be6fc92892f257ad399d92;hp=ff710d37664ea909c50741e198cfdd19c3ea3cea;hpb=1fca5ff62bb2ecb5bfc8974f4dbfc56e9d3ca721;p=oota-llvm.git diff --git a/include/llvm/Pass.h b/include/llvm/Pass.h index ff710d37664..ed0fb39f5d6 100644 --- a/include/llvm/Pass.h +++ b/include/llvm/Pass.h @@ -1,16 +1,16 @@ //===- llvm/Pass.h - Base class for Passes ----------------------*- C++ -*-===// -// +// // 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. +// //===----------------------------------------------------------------------===// // // 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. @@ -29,26 +29,49 @@ #ifndef LLVM_PASS_H #define LLVM_PASS_H -#include -#include -#include -#include -#include +#include namespace llvm { -class Value; class BasicBlock; class Function; class Module; class AnalysisUsage; class PassInfo; class ImmutablePass; -template class PassManagerT; -struct AnalysisResolver; +class PMStack; +class AnalysisResolver; +class PMDataManager; +class raw_ostream; +class StringRef; // AnalysisID - Use the PassInfo to identify a pass... -typedef const PassInfo* AnalysisID; +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 @@ -56,38 +79,29 @@ typedef const PassInfo* AnalysisID; /// constrained passes described below. /// class Pass { - friend struct 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 + const void *PassID; + PassKind Kind; 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(PassKind K, char &pid); + virtual ~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, 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; - /// getPassInfo - Return the PassInfo data structure that corresponds to this - /// pass... If the pass has not been registered, this will return null. - /// - 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) = 0; + /// getPassID - Return the PassID number that corresponds to this pass. + virtual AnalysisID getPassID() const { + return PassID; + } /// 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 @@ -96,19 +110,34 @@ 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 { print(O); } - virtual void print(std::ostream &O) const; - 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. + + /// createPrinterPass - Get a Pass appropriate to print the IR this + /// pass operates one (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 &Info) const { - // By default, no analysis results are used, all are invalidated. - } + 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 @@ -121,105 +150,91 @@ public: /// Optionally implement this function to release pass memory when it is no /// longer used. /// - virtual void releaseMemory() {} + 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); - - // getPassInfo - Static method to get the pass information from a class name. - template - static const PassInfo *getClassPassInfo() { - return lookupPassInfo(typeid(AnalysisClass)); - } - // 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(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); + + /// 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; + 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() 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 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(ResultPass); - assert(Result && "Pass does not implement interface required!"); - return *Result; - } + AnalysisType &getAnalysis(Function &F); // Defined in PassAnalysisSupport.h + + template + AnalysisType &getAnalysisID(AnalysisID PI) const; -private: - friend class PassManagerT; - friend class PassManagerT; - friend class PassManagerT; + template + AnalysisType &getAnalysisID(AnalysisID 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. ModulePass's may do anything +/// 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; - bool runPass(Module &M) { return runOnModule(M); } + virtual void assignPassManager(PMStack &PMS, + PassManagerType T); - 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(); }; @@ -236,15 +251,19 @@ public: /// and if it does, the overloaded version of initializePass may get access to /// these passes with getAnalysis<>. /// - virtual void initializePass() {} + virtual void initializePass(); + + virtual ImmutablePass *getAsImmutablePass() { return this; } /// ImmutablePasses are never run. /// - virtual bool runOnModule(Module &M) { return false; } + bool runOnModule(Module &) { return false; } -private: - friend class PassManagerT; - virtual void addToPassManager(PassManagerT *PM, AnalysisUsage &AU); + explicit ImmutablePass(char &pid) + : ModulePass(pid) {} + + // Force out-of-line virtual method. + virtual ~ImmutablePass(); }; //===----------------------------------------------------------------------===// @@ -256,13 +275,18 @@ 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(char &pid) : Pass(PT_Function, pid) {} + + /// createPrinterPass - Get a function printer pass. + Pass *createPrinterPass(raw_ostream &O, const std::string &Banner) const; + /// doInitialization - Virtual method overridden by subclasses to do /// any necessary per-module initialization. /// - virtual bool doInitialization(Module &M) { return false; } - + virtual bool doInitialization(Module &); + /// runOnFunction - Virtual method overriden by subclasses to do the /// per-function processing of the pass. /// @@ -271,25 +295,13 @@ 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 &); - /// runOnModule - On a module, we run this pass by initializing, - /// ronOnFunction'ing once for every function in the module, then by - /// finalizing. - /// - virtual bool runOnModule(Module &M); + virtual void assignPassManager(PMStack &PMS, + PassManagerType T); - /// 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); + /// Return what kind of Pass Manager can manage this pass. + virtual PassManagerType getPotentialPassManagerType() const; }; @@ -302,18 +314,24 @@ 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(char &pid) : Pass(PT_BasicBlock, pid) {} + + /// createPrinterPass - Get a function printer pass. + Pass *createPrinterPass(raw_ostream &O, const std::string &Banner) const; + /// doInitialization - Virtual method overridden by subclasses to do /// any necessary per-module initialization. /// - virtual bool doInitialization(Module &M) { return false; } + virtual bool doInitialization(Module &); /// 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 &); /// runOnBasicBlock - Virtual method overriden by subclasses to do the /// per-basicblock processing of the pass. @@ -323,29 +341,18 @@ 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 &); /// 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 &); - // To run this pass on a function, we simply call runOnBasicBlock once for - // each function. - // - bool runOnFunction(Function &F); - - /// To run directly on the basic block, we initialize, runOnBasicBlock, then - /// finalize. - /// - bool runPass(BasicBlock &BB); + virtual void assignPassManager(PMStack &PMS, + PassManagerType T); -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; }; /// If the user specifies the -time-passes argument on an LLVM tool command line