Finish removing DestroySource.
[oota-llvm.git] / include / llvm / PassManager.h
index 2769a4dbf2a4bb66355f4da4b590330b5a11d0ec..2a191b339931a80b222fb7d35fbb1208e7b81193 100644 (file)
 //
 //                     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.
 //
 //===----------------------------------------------------------------------===//
 //
-// This file defines the PassManager class.  This class is used to hold,
-// 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.
+// This is a legacy redirect header for the old PassManager. It is intended to
+// be used by clients that have not been converted to be aware of the new pass
+// management infrastructure being built for LLVM, which is every client
+// initially. Eventually this header (and the legacy management layer) will go
+// away, but we want to minimize changes to out-of-tree users of LLVM in the
+// interim.
+//
+// Note that this header *must not* be included into the same file as the new
+// pass management infrastructure is included. Things will break spectacularly.
+// If you are starting that conversion, you should switch to explicitly
+// including LegacyPassManager.h and using the legacy namespace.
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef LLVM_PASSMANAGER_H
 #define LLVM_PASSMANAGER_H
 
-#include "llvm/Pass.h"
-#include <vector>
+#include "llvm/IR/LegacyPassManager.h"
 
 namespace llvm {
 
-class Pass;
-class ModulePass;
-class Module;
-class ModuleProvider;
-class ModulePassManager;
-class FunctionPassManagerT;
-class BasicBlockPassManager;
-
-class PassManager {
-  ModulePassManager *PM;    // This is a straightforward Pimpl class
-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'.
-  ///
-  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);
-};
-
-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();
-};
-
-/// BasicBlockpassManager_New manages BasicBlockPass. It batches all the
-/// pass together and sequence them to process one basic block before
-/// processing next basic block.
-class BasicBlockPassManager_New: public Pass {
-
-public:
-  BasicBlockPassManager_New() { }
-
-  /// Add a pass into a passmanager queue. 
-  bool addPass(Pass *p);
-  
-  /// 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 runOnFunction(Function &F);
-
-private:
-  // Collection of pass that are not yet scheduled
-  std::vector<Pass *> PassVector;
-};
+// Pull these into the llvm namespace so that existing code that expects it
+// there can find it.
+using legacy::PassManagerBase;
+using legacy::PassManager;
+using legacy::FunctionPassManager;
 
-} // End llvm namespace
+}
 
 #endif