Revision of Brian's threading support library to be a bit more generic and
[oota-llvm.git] / include / llvm / PassManager.h
index 644e30b50c23f80b807a899a2fcda4d83ccd9d5a..b1d369b925d5ff5014d7d844386ec0e14423f9f6 100644 (file)
@@ -1,7 +1,14 @@
-//===- llvm/PassManager.h - Container for Passes -----------------*- C++ -*--=//
+//===- llvm/PassManager.h - Container 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 the PassManager class.  This class is used to hold,
-// maintain, and optimize execution of Pass's.  The PassManager class ensures
+// maintain, and optimize execution of Passes.  The PassManager class ensures
 // that analysis results are available before a pass runs, and that Pass's are
 // destroyed when the PassManager is destroyed.
 //
 #ifndef LLVM_PASSMANAGER_H
 #define LLVM_PASSMANAGER_H
 
+namespace llvm {
+
 class Pass;
 class Module;
+class ModuleProvider;
 template<class UnitType> class PassManagerT;
 
 class PassManager {
@@ -20,17 +30,50 @@ public:
   PassManager();
   ~PassManager();
 
-  // 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'.
-  //
+  /// 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 functions modifies the program, and if so, return true.
-  //
-  bool run(Module *M);
+  /// 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);
 };
 
+class FunctionPass;
+class ImmutablePass;
+class Function;
+
+class FunctionPassManager {
+  PassManagerT<Function> *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);
+
+  /// 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);
+};
+
+} // End llvm namespace
+
 #endif