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 /// PassManagerAnalysisHelper helpes pass manager analysis required by
92 /// the managed passes.
93 class PassManagerAnalysisHelper {
97 /// Return TRUE IFF pass P's required analysis set does not required new
99 bool manageablePass(Pass *P);
101 /// Return TRUE iff AnalysisID AID is currently available.
102 bool analysisCurrentlyAvailable(AnalysisID AID);
104 /// Augment RequiredSet by adding analysis required by pass P.
105 void noteDownRequiredAnalysis(Pass *P);
107 /// Remove AnalysisID from the RequiredSet
108 void removeAnalysis(AnalysisID AID);
110 /// Remove Analysis that is not preserved by the pass
111 void removeNotPreservedAnalysis(Pass *P);
113 /// Remove dead passes
114 void removeDeadPasses() { /* TODO : Implement */ }
117 // Required set of analysis for the passes managed by this manager
118 std::vector<AnalysisID> RequiredSet;
121 /// BasicBlockpassManager_New manages BasicBlockPass. It batches all the
122 /// pass together and sequence them to process one basic block before
123 /// processing next basic block.
124 class BasicBlockPassManager_New: public Pass,
125 public PassManagerAnalysisHelper {
128 BasicBlockPassManager_New() { }
130 /// Add a pass into a passmanager queue.
131 bool addPass(Pass *p);
133 /// Execute all of the passes scheduled for execution. Keep track of
134 /// whether any of the passes modifies the function, and if so, return true.
135 bool runOnFunction(Function &F);
138 // Collection of pass that are not yet scheduled
139 std::vector<Pass *> PassVector;
142 /// FunctionPassManager_New manages FunctionPasses and BasicBlockPassManagers.
143 /// It batches all function passes and basic block pass managers together and
144 /// sequence them to process one function at a time before processing next
146 class FunctionPassManager_New: public Pass,
147 public PassManagerAnalysisHelper {
149 FunctionPassManager_New(ModuleProvider *P) { /* TODO */ }
150 FunctionPassManager_New() {
151 activeBBPassManager = NULL;
153 ~FunctionPassManager_New() { /* TODO */ };
155 /// add - Add a pass to the queue of passes to run. This passes
156 /// ownership of the Pass to the PassManager. When the
157 /// PassManager_X is destroyed, the pass will be destroyed as well, so
158 /// there is no need to delete the pass. (TODO delete passes.)
159 /// This implies that all passes MUST be allocated with 'new'.
160 void add(Pass *P) { /* TODO*/ }
162 /// Add pass into the pass manager queue.
163 bool addPass(Pass *P);
165 /// Execute all of the passes scheduled for execution. Keep
166 /// track of whether any of the passes modifies the function, and if
168 bool runOnModule(Module &M);
171 // Collection of pass that are not yet scheduled
172 std::vector<Pass *> PassVector;
174 // Active Pass Managers
175 BasicBlockPassManager_New *activeBBPassManager;
178 /// ModulePassManager_New manages ModulePasses and function pass managers.
179 /// It batches all Module passes passes and function pass managers together and
180 /// sequence them to process one module.
181 class ModulePassManager_New: public Pass,
182 public PassManagerAnalysisHelper {
185 ModulePassManager_New() { activeFunctionPassManager = NULL; }
187 /// Add a pass into a passmanager queue.
188 bool addPass(Pass *p);
190 /// run - Execute all of the passes scheduled for execution. Keep track of
191 /// whether any of the passes modifies the module, and if so, return true.
192 bool runOnModule(Module &M);
195 // Collection of pass that are not yet scheduled
196 std::vector<Pass *> PassVector;
198 // Active Pass Manager
199 FunctionPassManager_New *activeFunctionPassManager;
202 /// PassManager_New manages ModulePassManagers
203 class PassManager_New: public Pass,
204 public PassManagerAnalysisHelper {
208 /// add - Add a pass to the queue of passes to run. This passes ownership of
209 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
210 /// will be destroyed as well, so there is no need to delete the pass. This
211 /// implies that all passes MUST be allocated with 'new'.
214 /// run - Execute all of the passes scheduled for execution. Keep track of
215 /// whether any of the passes modifies the module, and if so, return true.
220 /// Add a pass into a passmanager queue. This is used by schedulePasses
221 bool addPass(Pass *p);
223 /// Schedule all passes collected in pass queue using add(). Add all the
224 /// schedule passes into various manager's queue using addPass().
225 void schedulePasses();
227 // Collection of pass managers
228 std::vector<ModulePassManager_New *> PassManagers;
230 // Collection of pass that are not yet scheduled
231 std::vector<Pass *> PassVector;
233 // Active Pass Manager
234 ModulePassManager_New *activeManager;
237 } // End llvm namespace