PassInfo keep tracks whether a pass is an analysis pass or not.
[oota-llvm.git] / include / llvm / Pass.h
index 3a271bb54bb446057018b45cf859893e165107f3..a0ffcde4da1c7b41b7137c9f3bc7adab5103285d 100644 (file)
@@ -2,8 +2,8 @@
 //
 //                     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 "llvm/Support/DataTypes.h"
 #include "llvm/Support/Streams.h"
 #include <vector>
 #include <map>
 #include <iosfwd>
-#include <typeinfo>
 #include <cassert>
 
-//#define USE_OLD_PASSMANAGER 1
-
 namespace llvm {
 
 class Value;
@@ -47,27 +45,34 @@ class Module;
 class AnalysisUsage;
 class PassInfo;
 class ImmutablePass;
-template<class Trait> class PassManagerT;
-class BasicBlockPassManager;
-class FunctionPassManagerT;
-class ModulePassManager;
-struct AnalysisResolver;
-class AnalysisResolver_New;
+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...
-  AnalysisResolver_New *Resolver_New;  // Used to resolve analysis
-  const PassInfo *PassInfoCache;
-
+  AnalysisResolver *Resolver;  // Used to resolve analysis
+  intptr_t PassID;
   // AnalysisImpls - This keeps track of which passes implement the interfaces
   // that are required by the current pass (to implement getAnalysis()).
   //
@@ -76,14 +81,14 @@ class Pass {
   void operator=(const Pass&);  // DO NOT IMPLEMENT
   Pass(const Pass &);           // DO NOT IMPLEMENT
 public:
-  Pass() : Resolver(0), Resolver_New(0), PassInfoCache(0) {}
-  virtual ~Pass() {} // Destructor is virtual so we can be subclassed
+  explicit Pass(intptr_t pid) : Resolver(0), PassID(pid) {}
+  explicit Pass(const void *pid) : Resolver(0), 
+                                                    PassID((intptr_t)pid) {}
+  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;
 
@@ -92,12 +97,6 @@ public:
   ///
   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
@@ -109,9 +108,27 @@ public:
   void print(std::ostream *O, const Module *M) const { if (O) print(*O, M); }
   void dump() const; // dump - call print(std::cerr, 0);
 
-  // Access AnalysisResolver_New
-  inline void setResolver(AnalysisResolver_New *AR) { Resolver_New = AR; }
-  inline AnalysisResolver_New *getResolver() { return Resolver_New; }
+  /// Each pass is responsible for assigning a pass manager to itself.
+  /// PMS is the stack of available pass manager. 
+  virtual void assignPassManager(PMStack &PMS, 
+                                 PassManagerType T = PMT_Unknown) {}
+  /// Check if available pass managers are suitable for this pass or not.
+  virtual void preparePassManager(PMStack &PMS) {}
+  
+  ///  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() { 
+    assert (Resolver && "Resolver is not set");
+    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
@@ -135,19 +152,21 @@ 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<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);
+  static const PassInfo *lookupPassInfo(intptr_t TI);
 
   /// getAnalysisToUpdate<AnalysisType>() - This function is used by subclasses
   /// to get to the analysis information that might be around that needs to be
@@ -175,14 +194,14 @@ public:
   template<typename AnalysisType>
   AnalysisType &getAnalysis() const; // Defined in PassAnalysisSupport.h
 
+  template<typename AnalysisType>
+  AnalysisType &getAnalysis(Function &F); // Defined in PassanalysisSupport.h
+
   template<typename AnalysisType>
   AnalysisType &getAnalysisID(const PassInfo *PI) const;
-    
-private:
-  template<typename Trait> friend class PassManagerT;
-  friend class ModulePassManager;
-  friend class FunctionPassManagerT;
-  friend class BasicBlockPassManager;
+
+  template<typename AnalysisType>
+  AnalysisType &getAnalysisID(const PassInfo *PI, Function &F);
 };
 
 inline std::ostream &operator<<(std::ostream &OS, const Pass &P) {
@@ -200,15 +219,18 @@ public:
   /// 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;
+  }
 
-#ifdef USE_OLD_PASSMANAGER
-  virtual void addToPassManager(ModulePassManager *PM, AnalysisUsage &AU);
-#else
+  explicit ModulePass(intptr_t pid) : Pass(pid) {}
+  explicit ModulePass(const void *pid) : Pass(pid) {}
   // Force out-of-line virtual method.
   virtual ~ModulePass();
-#endif
 };
 
 
@@ -229,17 +251,14 @@ public:
 
   /// ImmutablePasses are never run.
   ///
-  virtual bool runOnModule(Module &M) { return false; }
-
-#ifdef USE_OLD_PASSMANAGER
-private:
-  template<typename Trait> friend class PassManagerT;
-  friend class ModulePassManager;
-  virtual void addToPassManager(ModulePassManager *PM, AnalysisUsage &AU);
-#else
+  bool runOnModule(Module &M) { return false; }
+
+  explicit ImmutablePass(intptr_t pid) : ModulePass(pid) {}
+  explicit ImmutablePass(const void *pid) 
+  : ModulePass(pid) {}
+  
   // Force out-of-line virtual method.
   virtual ~ImmutablePass();
-#endif
 };
 
 //===----------------------------------------------------------------------===//
@@ -251,8 +270,11 @@ 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(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.
   ///
@@ -279,15 +301,13 @@ public:
   ///
   bool run(Function &F);
 
-#ifdef USE_OLD_PASSMANAGER
-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);
-#endif
+  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;
+  }
 };
 
 
@@ -302,8 +322,11 @@ protected:
 ///      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.
   ///
@@ -335,23 +358,13 @@ public:
   //
   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);
-
-#ifdef USE_OLD_PASSMANAGER
-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);
-#endif
 };
 
 /// If the user specifies the -time-passes argument on an LLVM tool command line