Revert r168635 "Step towards implementation of pass manager with doInitialization...
[oota-llvm.git] / include / llvm / PassManager.h
index 1e4f554802c62c8a3744c445fa247cd921fbf215..1d5e800b4daaba525062e25a5a53b9daf8d5bd28 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.
 //
 //===----------------------------------------------------------------------===//
 //
 namespace llvm {
 
 class Pass;
-class ModulePass;
 class Module;
-class ModuleProvider;
 
-#ifdef USE_OLD_PASSMANAGER
+class PassManagerImpl;
+class FunctionPassManagerImpl;
 
-class ModulePassManager;
-class FunctionPassManagerT;
-class BasicBlockPassManager;
-
-class PassManager {
-  ModulePassManager *PM;    // This is a straightforward Pimpl class
+/// PassManagerBase - An abstract interface to allow code to add passes to
+/// a pass manager without having to hard-code what kind of pass manager
+/// it is.
+class PassManagerBase {
 public:
-  PassManager();
-  ~PassManager();
+  virtual ~PassManagerBase();
 
   /// add - Add a pass to the queue of passes to run.  This passes ownership of
   /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
   /// will be destroyed as well, so there is no need to delete the pass.  This
   /// implies that all passes MUST be allocated with 'new'.
-  ///
-  void add(Pass *P);
-
-  /// run - Execute all of the passes scheduled for execution.  Keep track of
-  /// whether any of the passes modifies the module, and if so, return true.
-  ///
-  bool run(Module &M);
+  virtual void add(Pass *P) = 0;
 };
 
-class FunctionPass;
-class ImmutablePass;
-class Function;
-
-class FunctionPassManager {
-  FunctionPassManagerT *PM;    // This is a straightforward Pimpl class
-  ModuleProvider *MP;
-public:
-  FunctionPassManager(ModuleProvider *P);
-  ~FunctionPassManager();
-
-  /// add - Add a pass to the queue of passes to run.  This passes
-  /// ownership of the FunctionPass to the PassManager.  When the
-  /// PassManager is destroyed, the pass will be destroyed as well, so
-  /// there is no need to delete the pass.  This implies that all
-  /// passes MUST be allocated with 'new'.
-  ///
-  void add(FunctionPass *P);
-
-  /// add - ImmutablePasses are not FunctionPasses, so we have a
-  /// special hack to get them into a FunctionPassManager.
-  ///
-  void add(ImmutablePass *IP);
-
-  /// doInitialization - Run all of the initializers for the function passes.
-  ///
-  bool doInitialization();
-  
-  /// run - Execute all of the passes scheduled for execution.  Keep
-  /// track of whether any of the passes modifies the function, and if
-  /// so, return true.
-  ///
-  bool run(Function &F);
-  
-  /// doFinalization - Run all of the initializers for the function passes.
-  ///
-  bool doFinalization();
-};
-
-#else
-
-class ModulePassManager;
-class PassManagerImpl_New;
-class FunctionPassManagerImpl_New;
-
 /// PassManager manages ModulePassManagers
-class PassManager {
-
+class PassManager : public PassManagerBase {
 public:
 
   PassManager();
@@ -109,30 +53,37 @@ public:
   /// will be destroyed as well, so there is no need to delete the pass.  This
   /// implies that all passes MUST be allocated with 'new'.
   void add(Pass *P);
+
   /// run - Execute all of the passes scheduled for execution.  Keep track of
   /// whether any of the passes modifies the module, and if so, return true.
   bool run(Module &M);
 
-private:
+  /// doInitialization - Run all of the initializers for the module passes.
+  ///
+  bool doInitialization();
 
-  /// PassManagerImpl_New is the actual class. PassManager is just the 
-  /// wraper to publish simple pass manager interface
-  PassManagerImpl_New *PM;
+  /// doFinalization - Run all of the finalizers for the module passes.
+  ///
+  bool doFinalization();
 
+private:
+  /// PassManagerImpl_New is the actual class. PassManager is just the
+  /// wraper to publish simple pass manager interface
+  PassManagerImpl *PM;
 };
 
 /// FunctionPassManager manages FunctionPasses and BasicBlockPassManagers.
-class FunctionPassManager {
+class FunctionPassManager : public PassManagerBase {
 public:
-  FunctionPassManager(ModuleProvider *P);
-  FunctionPassManager();
+  /// FunctionPassManager ctor - This initializes the pass manager.  It needs,
+  /// but does not take ownership of, the specified Module.
+  explicit FunctionPassManager(Module *M);
   ~FunctionPassManager();
+
   /// add - Add a pass to the queue of passes to run.  This passes
   /// ownership of the Pass to the PassManager.  When the
   /// PassManager_X is destroyed, the pass will be destroyed as well, so
-  /// there is no need to delete the pass. (TODO delete passes.)
+  /// there is no need to delete the pass.
   /// This implies that all passes MUST be allocated with 'new'.
   void add(Pass *P);
 
@@ -141,22 +92,20 @@ public:
   /// so, return true.
   ///
   bool run(Function &F);
-  
+
   /// doInitialization - Run all of the initializers for the function passes.
   ///
   bool doInitialization();
-  
-  /// doFinalization - Run all of the initializers for the function passes.
+
+  /// doFinalization - Run all of the finalizers for the function passes.
   ///
   bool doFinalization();
+
 private:
-  
-  FunctionPassManagerImpl_New *FPM;
-  ModuleProvider *MP;
+  FunctionPassManagerImpl *FPM;
+  Module *M;
 };
 
-#endif
-
 } // End llvm namespace
 
 #endif