include/llvm/PassManager.h

   1 //===- llvm/PassManager.h - Container for Passes ----------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the PassManager class.  This class is used to hold,
  11 // maintain, and optimize execution of Passes.  The PassManager class ensures
  12 // that analysis results are available before a pass runs, and that Pass's are
  13 // destroyed when the PassManager is destroyed.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef LLVM_PASSMANAGER_H
  18 #define LLVM_PASSMANAGER_H
  19
  20 #include "llvm/Pass.h"
  21
  22 namespace llvm {
  23
  24 class Pass;
  25 class ModulePass;
  26 class Module;
  27 class ModuleProvider;
  28
  29 class PassManagerImpl;
  30 class FunctionPassManagerImpl;
  31
  32 /// PassManager manages ModulePassManagers
  33 class PassManager {
  34
  35 public:
  36
  37   PassManager();
  38   ~PassManager();
  39
  40   /// add - Add a pass to the queue of passes to run.  This passes ownership of
  41   /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
  42   /// will be destroyed as well, so there is no need to delete the pass.  This
  43   /// implies that all passes MUST be allocated with 'new'.
  44   void add(Pass *P);
  45
  46   /// run - Execute all of the passes scheduled for execution.  Keep track of
  47   /// whether any of the passes modifies the module, and if so, return true.
  48   bool run(Module &M);
  49
  50 private:
  51
  52   /// PassManagerImpl_New is the actual class. PassManager is just the
  53   /// wraper to publish simple pass manager interface
  54   PassManagerImpl *PM;
  55
  56 };
  57
  58 /// FunctionPassManager manages FunctionPasses and BasicBlockPassManagers.
  59 class FunctionPassManager {
  60 public:
  61   explicit FunctionPassManager(ModuleProvider *P);
  62   FunctionPassManager();
  63   ~FunctionPassManager();
  64
  65   /// add - Add a pass to the queue of passes to run.  This passes
  66   /// ownership of the Pass to the PassManager.  When the
  67   /// PassManager_X is destroyed, the pass will be destroyed as well, so
  68   /// there is no need to delete the pass. (TODO delete passes.)
  69   /// This implies that all passes MUST be allocated with 'new'.
  70   void add(Pass *P);
  71
  72   /// run - Execute all of the passes scheduled for execution.  Keep
  73   /// track of whether any of the passes modifies the function, and if
  74   /// so, return true.
  75   ///
  76   bool run(Function &F);
  77
  78   /// doInitialization - Run all of the initializers for the function passes.
  79   ///
  80   bool doInitialization();
  81
  82   /// doFinalization - Run all of the finalizers for the function passes.
  83   ///
  84   bool doFinalization();
  85 private:
  86
  87   FunctionPassManagerImpl *FPM;
  88   ModuleProvider *MP;
  89 };
  90
  91 } // End llvm namespace
  92
  93 #endif