1 //===- llvm/PassManager.h - Pass Inftrastructre classes --------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Devang Patel and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the LLVM Pass Manager infrastructure.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/PassManager.h"
15 #include "llvm/ADT/SmallVector.h"
17 class llvm::PMDataManager;
20 //===----------------------------------------------------------------------===//
22 // The Pass Manager Infrastructure manages passes. It's responsibilities are:
24 // o Manage optimization pass execution order
25 // o Make required Analysis information available before pass P is run
26 // o Release memory occupied by dead passes
27 // o If Analysis information is dirtied by a pass then regenerate Analysis
28 // information before it is consumed by another pass.
30 // Pass Manager Infrastructure uses multiple pass managers. They are
31 // PassManager, FunctionPassManager, MPPassManager, FPPassManager, BBPassManager.
32 // This class hierarcy uses multiple inheritance but pass managers do not derive
33 // from another pass manager.
35 // PassManager and FunctionPassManager are two top-level pass manager that
36 // represents the external interface of this entire pass manager infrastucture.
38 // Important classes :
40 // [o] class PMTopLevelManager;
42 // Two top level managers, PassManager and FunctionPassManager, derive from
43 // PMTopLevelManager. PMTopLevelManager manages information used by top level
44 // managers such as last user info.
46 // [o] class PMDataManager;
48 // PMDataManager manages information, e.g. list of available analysis info,
49 // used by a pass manager to manage execution order of passes. It also provides
50 // a place to implement common pass manager APIs. All pass managers derive from
53 // [o] class BBPassManager : public FunctionPass, public PMDataManager;
55 // BBPassManager manages BasicBlockPasses.
57 // [o] class FunctionPassManager;
59 // This is a external interface used by JIT to manage FunctionPasses. This
60 // interface relies on FunctionPassManagerImpl to do all the tasks.
62 // [o] class FunctionPassManagerImpl : public ModulePass, PMDataManager,
63 // public PMTopLevelManager;
65 // FunctionPassManagerImpl is a top level manager. It manages FPPassManagers
67 // [o] class FPPassManager : public ModulePass, public PMDataManager;
69 // FPPassManager manages FunctionPasses and BBPassManagers
71 // [o] class MPPassManager : public Pass, public PMDataManager;
73 // MPPassManager manages ModulePasses and FPPassManagers
75 // [o] class PassManager;
77 // This is a external interface used by various tools to manages passes. It
78 // relies on PassManagerImpl to do all the tasks.
80 // [o] class PassManagerImpl : public Pass, public PMDataManager,
81 // public PMDTopLevelManager
83 // PassManagerImpl is a top level pass manager responsible for managing
85 //===----------------------------------------------------------------------===//
87 #ifndef PASSMANAGERS_H
88 #define PASSMANAGERS_H
92 /// FunctionPassManager and PassManager, two top level managers, serve
93 /// as the public interface of pass manager infrastructure.
94 enum TopLevelManagerType {
95 TLM_Function, // FunctionPassManager
96 TLM_Pass // PassManager
99 // enums for debugging strings
100 enum PassDebuggingString {
101 EXECUTION_MSG, // "Executing Pass '"
102 MODIFICATION_MSG, // "' Made Modification '"
103 FREEING_MSG, // " Freeing Pass '"
104 ON_BASICBLOCK_MSG, // "' on BasicBlock '" + PassName + "'...\n"
105 ON_FUNCTION_MSG, // "' on Function '" + FunctionName + "'...\n"
106 ON_MODULE_MSG, // "' on Module '" + ModuleName + "'...\n"
107 ON_LOOP_MSG, // " 'on Loop ...\n'"
108 ON_CG_MSG // "' on Call Graph ...\n'"
111 //===----------------------------------------------------------------------===//
114 /// PMTopLevelManager manages LastUser info and collects common APIs used by
115 /// top level pass managers.
116 class PMTopLevelManager {
119 virtual unsigned getNumContainedManagers() {
120 return PassManagers.size();
123 /// Schedule pass P for execution. Make sure that passes required by
124 /// P are run before P is run. Update analysis info maintained by
125 /// the manager. Remove dead passes. This is a recursive function.
126 void schedulePass(Pass *P);
128 /// This is implemented by top level pass manager and used by
129 /// schedulePass() to add analysis info passes that are not available.
130 virtual void addTopLevelPass(Pass *P) = 0;
132 /// Set pass P as the last user of the given analysis passes.
133 void setLastUser(SmallVector<Pass *, 12> &AnalysisPasses, Pass *P);
135 /// Collect passes whose last user is P
136 void collectLastUses(SmallVector<Pass *, 12> &LastUses, Pass *P);
138 /// Find the pass that implements Analysis AID. Search immutable
139 /// passes and all pass managers. If desired pass is not found
140 /// then return NULL.
141 Pass *findAnalysisPass(AnalysisID AID);
143 explicit PMTopLevelManager(enum TopLevelManagerType t);
144 virtual ~PMTopLevelManager();
146 /// Add immutable pass and initialize it.
147 inline void addImmutablePass(ImmutablePass *P) {
149 ImmutablePasses.push_back(P);
152 inline std::vector<ImmutablePass *>& getImmutablePasses() {
153 return ImmutablePasses;
156 void addPassManager(Pass *Manager) {
157 PassManagers.push_back(Manager);
160 // Add Manager into the list of managers that are not directly
161 // maintained by this top level pass manager
162 inline void addIndirectPassManager(PMDataManager *Manager) {
163 IndirectPassManagers.push_back(Manager);
166 // Print passes managed by this top level manager.
167 void dumpPasses() const;
168 void dumpArguments() const;
170 void initializeAllAnalysisInfo();
172 // Active Pass Managers
177 /// Collection of pass managers
178 std::vector<Pass *> PassManagers;
182 /// Collection of pass managers that are not directly maintained
183 /// by this pass manager
184 std::vector<PMDataManager *> IndirectPassManagers;
186 // Map to keep track of last user of the analysis pass.
187 // LastUser->second is the last user of Lastuser->first.
188 std::map<Pass *, Pass *> LastUser;
190 /// Immutable passes are managed by top level manager.
191 std::vector<ImmutablePass *> ImmutablePasses;
196 //===----------------------------------------------------------------------===//
199 /// PMDataManager provides the common place to manage the analysis data
200 /// used by pass managers.
201 class PMDataManager {
204 explicit PMDataManager(int Depth) : TPM(NULL), Depth(Depth) {
205 initializeAnalysisInfo();
208 virtual ~PMDataManager();
210 /// Return true IFF pass P's required analysis set does not required new
212 bool manageablePass(Pass *P);
214 /// Augment AvailableAnalysis by adding analysis made available by pass P.
215 void recordAvailableAnalysis(Pass *P);
217 /// verifyPreservedAnalysis -- Verify analysis presreved by pass P.
218 void verifyPreservedAnalysis(Pass *P);
220 /// Remove Analysis that is not preserved by the pass
221 void removeNotPreservedAnalysis(Pass *P);
223 /// Remove dead passes
224 void removeDeadPasses(Pass *P, const char *Msg, enum PassDebuggingString);
226 /// Add pass P into the PassVector. Update
227 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
228 void add(Pass *P, bool ProcessAnalysis = true);
230 /// Add RequiredPass into list of lower level passes required by pass P.
231 /// RequiredPass is run on the fly by Pass Manager when P requests it
232 /// through getAnalysis interface.
233 virtual void addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass);
235 virtual Pass * getOnTheFlyPass(Pass *P, const PassInfo *PI, Function &F) {
236 assert (0 && "Unable to find on the fly pass");
240 /// Initialize available analysis information.
241 void initializeAnalysisInfo() {
242 AvailableAnalysis.clear();
243 for (unsigned i = 0; i < PMT_Last; ++i)
244 InheritedAnalysis[i] = NULL;
247 // Return true if P preserves high level analysis used by other
248 // passes that are managed by this manager.
249 bool preserveHigherLevelAnalysis(Pass *P);
252 /// Populate RequiredPasses with analysis pass that are required by
253 /// pass P and are available. Populate ReqPassNotAvailable with analysis
254 /// pass that are required by pass P but are not available.
255 void collectRequiredAnalysis(SmallVector<Pass *, 8> &RequiredPasses,
256 SmallVector<AnalysisID, 8> &ReqPassNotAvailable,
259 /// All Required analyses should be available to the pass as it runs! Here
260 /// we fill in the AnalysisImpls member of the pass so that it can
261 /// successfully use the getAnalysis() method to retrieve the
262 /// implementations it needs.
263 void initializeAnalysisImpl(Pass *P);
265 /// Find the pass that implements Analysis AID. If desired pass is not found
266 /// then return NULL.
267 Pass *findAnalysisPass(AnalysisID AID, bool Direction);
269 // Access toplevel manager
270 PMTopLevelManager *getTopLevelManager() { return TPM; }
271 void setTopLevelManager(PMTopLevelManager *T) { TPM = T; }
273 unsigned getDepth() const { return Depth; }
275 // Print routines used by debug-pass
276 void dumpLastUses(Pass *P, unsigned Offset) const;
277 void dumpPassArguments() const;
278 void dumpPassInfo(Pass *P, enum PassDebuggingString S1,
279 enum PassDebuggingString S2, const char *Msg);
280 void dumpAnalysisSetInfo(const char *Msg, Pass *P,
281 const std::vector<AnalysisID> &Set) const;
283 virtual unsigned getNumContainedPasses() {
284 return PassVector.size();
287 virtual PassManagerType getPassManagerType() const {
288 assert ( 0 && "Invalid use of getPassManagerType");
292 std::map<AnalysisID, Pass*> *getAvailableAnalysis() {
293 return &AvailableAnalysis;
296 // Collect AvailableAnalysis from all the active Pass Managers.
297 void populateInheritedAnalysis(PMStack &PMS) {
299 for (PMStack::iterator I = PMS.begin(), E = PMS.end();
301 InheritedAnalysis[Index++] = (*I)->getAvailableAnalysis();
306 // Top level manager.
307 PMTopLevelManager *TPM;
309 // Collection of pass that are managed by this manager
310 std::vector<Pass *> PassVector;
312 // Collection of Analysis provided by Parent pass manager and
313 // used by current pass manager. At at time there can not be more
314 // then PMT_Last active pass mangers.
315 std::map<AnalysisID, Pass *> *InheritedAnalysis[PMT_Last];
318 // Set of available Analysis. This information is used while scheduling
319 // pass. If a pass requires an analysis which is not not available then
320 // equired analysis pass is scheduled to run before the pass itself is
322 std::map<AnalysisID, Pass*> AvailableAnalysis;
324 // Collection of higher level analysis used by the pass managed by
326 std::vector<Pass *> HigherLevelAnalysis;
331 //===----------------------------------------------------------------------===//
334 /// FPPassManager manages BBPassManagers and FunctionPasses.
335 /// It batches all function passes and basic block pass managers together and
336 /// sequence them to process one function at a time before processing next
339 class FPPassManager : public ModulePass, public PMDataManager {
343 explicit FPPassManager(int Depth)
344 : ModulePass(intptr_t(&ID)), PMDataManager(Depth) { }
346 /// run - Execute all of the passes scheduled for execution. Keep track of
347 /// whether any of the passes modifies the module, and if so, return true.
348 bool runOnFunction(Function &F);
349 bool runOnModule(Module &M);
351 /// doInitialization - Run all of the initializers for the function passes.
353 bool doInitialization(Module &M);
355 /// doFinalization - Run all of the finalizers for the function passes.
357 bool doFinalization(Module &M);
359 /// Pass Manager itself does not invalidate any analysis info.
360 void getAnalysisUsage(AnalysisUsage &Info) const {
361 Info.setPreservesAll();
364 // Print passes managed by this manager
365 void dumpPassStructure(unsigned Offset);
367 virtual const char *getPassName() const {
368 return "Function Pass Manager";
371 FunctionPass *getContainedPass(unsigned N) {
372 assert ( N < PassVector.size() && "Pass number out of range!");
373 FunctionPass *FP = static_cast<FunctionPass *>(PassVector[N]);
377 virtual PassManagerType getPassManagerType() const {
378 return PMT_FunctionPassManager;
384 extern void StartPassTimer(Pass *);
385 extern void StopPassTimer(Pass *);