1 //===- llvm/PassManager.h - Container for Passes ----------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
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.
15 //===----------------------------------------------------------------------===//
17 #ifndef LLVM_PASSMANAGER_H
18 #define LLVM_PASSMANAGER_H
20 #include "llvm/Pass.h"
29 class ModulePassManager;
30 class FunctionPassManagerT;
31 class BasicBlockPassManager;
34 ModulePassManager *PM; // This is a straightforward Pimpl class
39 /// add - Add a pass to the queue of passes to run. This passes ownership of
40 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
41 /// will be destroyed as well, so there is no need to delete the pass. This
42 /// implies that all passes MUST be allocated with 'new'.
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.
56 class FunctionPassManager {
57 FunctionPassManagerT *PM; // This is a straightforward Pimpl class
60 FunctionPassManager(ModuleProvider *P);
61 ~FunctionPassManager();
63 /// add - Add a pass to the queue of passes to run. This passes
64 /// ownership of the FunctionPass to the PassManager. When the
65 /// PassManager is destroyed, the pass will be destroyed as well, so
66 /// there is no need to delete the pass. This implies that all
67 /// passes MUST be allocated with 'new'.
69 void add(FunctionPass *P);
71 /// add - ImmutablePasses are not FunctionPasses, so we have a
72 /// special hack to get them into a FunctionPassManager.
74 void add(ImmutablePass *IP);
76 /// doInitialization - Run all of the initializers for the function passes.
78 bool doInitialization();
80 /// run - Execute all of the passes scheduled for execution. Keep
81 /// track of whether any of the passes modifies the function, and if
84 bool run(Function &F);
86 /// doFinalization - Run all of the initializers for the function passes.
88 bool doFinalization();
91 /// BasicBlockpassManager_New manages BasicBlockPass. It batches all the
92 /// pass together and sequence them to process one basic block before
93 /// processing next basic block.
94 class BasicBlockPassManager_New: public Pass {
97 BasicBlockPassManager_New() { }
99 /// Add a pass into a passmanager queue.
100 bool addPass(Pass *p);
102 /// Execute all of the passes scheduled for execution. Keep track of
103 /// whether any of the passes modifies the function, and if so, return true.
104 bool runOnFunction(Function &F);
107 // Collection of pass that are not yet scheduled
108 std::vector<Pass *> PassVector;
111 /// FunctionPassManager_New manages FunctionPasses and BasicBlockPassManagers.
112 /// It batches all function passes and basic block pass managers together and
113 /// sequence them to process one function at a time before processing next
115 class FunctionPassManager_New:public Pass {
117 FunctionPassManager_New(ModuleProvider *P) { /* TODO */ }
118 FunctionPassManager_New() {
119 activeBBPassManager = NULL;
121 ~FunctionPassManager_New() { /* TODO */ };
123 /// add - Add a pass to the queue of passes to run. This passes
124 /// ownership of the Pass to the PassManager. When the
125 /// PassManager_X is destroyed, the pass will be destroyed as well, so
126 /// there is no need to delete the pass. (TODO delete passes.)
127 /// This implies that all passes MUST be allocated with 'new'.
128 void add(Pass *P) { /* TODO*/ }
130 /// Add pass into the pass manager queue.
131 bool addPass(Pass *P);
133 /// Execute all of the passes scheduled for execution. Keep
134 /// track of whether any of the passes modifies the function, and if
136 bool runOnModule(Module &M);
139 // Collection of pass that are not yet scheduled
140 std::vector<Pass *> PassVector;
142 // Active Pass Managers
143 BasicBlockPassManager_New *activeBBPassManager;
146 /// ModulePassManager_New manages ModulePasses and function pass managers.
147 /// It batches all Module passes passes and function pass managers together and
148 /// sequence them to process one module.
149 class ModulePassManager_New: public Pass {
152 ModulePassManager_New() { activeFunctionPassManager = NULL; }
154 /// Add a pass into a passmanager queue.
155 bool addPass(Pass *p);
157 /// run - Execute all of the passes scheduled for execution. Keep track of
158 /// whether any of the passes modifies the module, and if so, return true.
159 bool runOnModule(Module &M);
162 // Collection of pass that are not yet scheduled
163 std::vector<Pass *> PassVector;
165 // Active Pass Manager
166 FunctionPassManager_New *activeFunctionPassManager;
169 } // End llvm namespace