X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FPass.h;h=e6083a3ca88b0f6f0014617124cda4c17e11c881;hb=0c09e5fb91feae42f437d632abf8a42da27fc1d2;hp=0f4b56fdbcc5692fc538ebff766b8cd0d276173c;hpb=3f917b6f99d1835f8bd9be6f7c74876dacf486c8;p=oota-llvm.git diff --git a/include/llvm/Pass.h b/include/llvm/Pass.h index 0f4b56fdbcc..e6083a3ca88 100644 --- a/include/llvm/Pass.h +++ b/include/llvm/Pass.h @@ -1,4 +1,11 @@ -//===- llvm/Pass.h - Base class for XForm Passes -----------------*- C++ -*--=// +//===- 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 defines a base class that indicates that a specified class is a // transformation pass implementation. @@ -26,12 +33,17 @@ #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; @@ -44,9 +56,15 @@ typedef const PassInfo* AnalysisID; /// constrained passes described below. /// class Pass { - friend class AnalysisResolver; + 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; + void operator=(const Pass&); // DO NOT IMPLEMENT Pass(const Pass &); // DO NOT IMPLEMENT public: @@ -57,7 +75,7 @@ public: /// 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. + /// intelligible name for the pass. /// virtual const char *getPassName() const; @@ -66,20 +84,20 @@ public: /// const PassInfo *getPassInfo() const; - /// run - Run this pass, returning true if a modification was made to the + /// 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 run(Module &M) = 0; + 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 - /// 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 dump() const; // dump - call print(std::cerr, 0); @@ -119,7 +137,24 @@ public: // or null if it is not known. static const PassInfo *lookupPassInfo(const std::type_info &TI); -protected: + /// 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. + /// + template + AnalysisType *getAnalysisToUpdate() const; // Defined in PassAnalysisSupport.h + + /// mustPreserveAnalysisID - This method serves the same function as + /// getAnalysisToUpdate, 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. + /// + bool mustPreserveAnalysisID(const PassInfo *AnalysisID) const; /// getAnalysis() - This function is used by subclasses to get /// to the analysis information that they claim to use by overriding the @@ -129,64 +164,103 @@ protected: AnalysisType &getAnalysis() const { assert(Resolver && "Pass has not been inserted into a PassManager object!"); const PassInfo *PI = getClassPassInfo(); + return getAnalysisID(PI); + } + + 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(Resolver->getAnalysis(PI)); + AnalysisType *Result = dynamic_cast(ResultPass); assert(Result && "Pass does not implement interface required!"); return *Result; } - template - AnalysisType &getAnalysisID(const PassInfo *PI) const { - assert(Resolver && "Pass has not been inserted into a PassManager object!"); - assert(PI && "getAnalysis for unregistered pass!"); - return *dynamic_cast(Resolver->getAnalysis(PI)); - } - - /// 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() 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)); - } - - private: friend class PassManagerT; friend class PassManagerT; friend class PassManagerT; - virtual void addToPassManager(PassManagerT *PM, AnalysisUsage &AU); }; 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 +/// 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 bool runPass(Module &M) { return runOnModule(M); } + virtual bool runPass(BasicBlock&) { return false; } + + virtual void addToPassManager(PassManagerT *PM, AnalysisUsage &AU); +}; + + +//===----------------------------------------------------------------------===// +/// 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: + /// 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() {} + + /// ImmutablePasses are never run. + /// + virtual bool runOnModule(Module &M) { return false; } + +private: + friend class PassManagerT; + virtual void addToPassManager(PassManagerT *PM, AnalysisUsage &AU); +}; + //===----------------------------------------------------------------------===// /// 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 +/// 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 /// -struct FunctionPass : public Pass { +class FunctionPass : public ModulePass { +public: /// 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; } @@ -200,10 +274,11 @@ struct FunctionPass : public Pass { /// 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. + /// 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. @@ -228,23 +303,45 @@ 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 contstraints of FunctionPass's. +/// 3. Optimizations conform to all of the constraints of FunctionPass's. /// struct BasicBlockPass : public FunctionPass { + /// doInitialization - Virtual method overridden by subclasses to do + /// any necessary per-module initialization. + /// + virtual bool doInitialization(Module &M) { return false; } + + /// doInitialization - Virtual method overridden by BasicBlockPass subclasses + /// to do any necessary per-function initialization. + /// + virtual bool doInitialization(Function &F) { return false; } + /// runOnBasicBlock - Virtual method overriden by subclasses to do the /// per-basicblock processing of the pass. /// virtual bool runOnBasicBlock(BasicBlock &BB) = 0; - /// To run this pass on a function, we simply call runOnBasicBlock once for - /// each function. + /// doFinalization - Virtual method overriden by BasicBlockPass subclasses to + /// do any post processing needed after all passes have run. /// - virtual bool runOnFunction(Function &F); + virtual bool doFinalization(Function &F) { 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; } + + + // 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 run(BasicBlock &BB); + virtual bool runPass(Module &M) { return false; } + virtual bool runPass(BasicBlock &BB); private: friend class PassManagerT; @@ -253,8 +350,15 @@ private: virtual void addToPassManager(PassManagerT *PM,AnalysisUsage &AU); }; +/// 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 seperate out to make it easier to read the header files. +// but that we want to separate out to make it easier to read the header files. // #include "llvm/PassSupport.h" #include "llvm/PassAnalysisSupport.h"