//
// 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.
//
//===----------------------------------------------------------------------===//
//
#ifndef LLVM_PASS_H
#define LLVM_PASS_H
-#include <vector>
-#include <map>
-#include <iosfwd>
-#include <typeinfo>
+#include "llvm/Support/DataTypes.h"
+#include "llvm/Support/Streams.h"
#include <cassert>
+#include <iosfwd>
+#include <utility>
+#include <vector>
namespace llvm {
-class Value;
class BasicBlock;
class Function;
class Module;
class AnalysisUsage;
class PassInfo;
class ImmutablePass;
-template<class Trait> class PassManagerT;
-class BasicBlockPassManager;
-class FunctionPassManagerT;
-class ModulePassManager;
-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 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<std::pair<const PassInfo*, Pass*> > 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
- /// intelligible name for the pass.
+ /// Registration templates, but can be overloaded directly.
///
virtual const char *getPassName() const;
///
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
/// 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);
+ /// 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<AnalysisType>() function, below.
///
- virtual void getAnalysisUsage(AnalysisUsage &Info) const {
+ virtual void getAnalysisUsage(AnalysisUsage &) const {
// By default, no analysis results are used, all are invalidated.
}
///
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<typename AnalysisClass>
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<AnalysisType>() - 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<AnalysisType>() - 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<typename AnalysisType>
- AnalysisType *getAnalysisToUpdate() const; // Defined in PassAnalysisSupport.h
+ template<typename AnalysisType> 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;
/// getAnalysisUsage function.
///
template<typename AnalysisType>
- AnalysisType &getAnalysis() const {
- assert(Resolver && "Pass has not been inserted into a PassManager object!");
- const PassInfo *PI = getClassPassInfo<AnalysisType>();
- return getAnalysisID<AnalysisType>(PI);
- }
+ AnalysisType &getAnalysis() const; // Defined in PassAnalysisSupport.h
template<typename AnalysisType>
- 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<AnalysisType*>(ResultPass);
- assert(Result && "Pass does not implement interface required!");
- return *Result;
- }
+ AnalysisType &getAnalysis(Function &F); // Defined in PassanalysisSupport.h
-private:
- template<typename Trait> friend class PassManagerT;
- friend class ModulePassManager;
- friend class FunctionPassManagerT;
- friend class BasicBlockPassManager;
+ template<typename AnalysisType>
+ AnalysisType &getAnalysisID(const PassInfo *PI) const;
+
+ template<typename AnalysisType>
+ AnalysisType &getAnalysisID(const PassInfo *PI, Function &F);
};
inline std::ostream &operator<<(std::ostream &OS, const Pass &P) {
/// 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);
+
+ /// Return what kind of Pass Manager can manage this pass.
+ virtual PassManagerType getPotentialPassManagerType() const {
+ return PMT_ModulePassManager;
+ }
- virtual void addToPassManager(ModulePassManager *PM, AnalysisUsage &AU);
+ explicit ModulePass(intptr_t pid) : Pass(pid) {}
+ explicit ModulePass(const void *pid) : Pass(pid) {}
+ // Force out-of-line virtual method.
+ virtual ~ModulePass();
};
/// ImmutablePasses are never run.
///
- virtual bool runOnModule(Module &M) { return false; }
-
-private:
- template<typename Trait> friend class PassManagerT;
- friend class ModulePassManager;
- virtual void addToPassManager(ModulePassManager *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();
};
//===----------------------------------------------------------------------===//
/// 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.
/// 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
///
bool run(Function &F);
-protected:
- template<typename Trait> 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);
+ 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;
+ }
};
/// 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.
/// 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
//
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);
-
-private:
- template<typename Trait> 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);
};
/// If the user specifies the -time-passes argument on an LLVM tool command line
projects / oota-llvm.git / blobdiff