1 //===- llvm/PassManagers.h - Pass Infrastructure classes -------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the LLVM Pass Manager infrastructure.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_PASSMANAGERS_H
15 #define LLVM_PASSMANAGERS_H
17 #include "llvm/PassManager.h"
18 #include "llvm/ADT/SmallVector.h"
19 #include "llvm/ADT/SmallPtrSet.h"
20 #include "llvm/ADT/DenseMap.h"
24 //===----------------------------------------------------------------------===//
26 // The Pass Manager Infrastructure manages passes. It's responsibilities are:
28 // o Manage optimization pass execution order
29 // o Make required Analysis information available before pass P is run
30 // o Release memory occupied by dead passes
31 // o If Analysis information is dirtied by a pass then regenerate Analysis
32 // information before it is consumed by another pass.
34 // Pass Manager Infrastructure uses multiple pass managers. They are
35 // PassManager, FunctionPassManager, MPPassManager, FPPassManager, BBPassManager.
36 // This class hierarchy uses multiple inheritance but pass managers do not
37 // derive from another pass manager.
39 // PassManager and FunctionPassManager are two top-level pass manager that
40 // represents the external interface of this entire pass manager infrastucture.
42 // Important classes :
44 // [o] class PMTopLevelManager;
46 // Two top level managers, PassManager and FunctionPassManager, derive from
47 // PMTopLevelManager. PMTopLevelManager manages information used by top level
48 // managers such as last user info.
50 // [o] class PMDataManager;
52 // PMDataManager manages information, e.g. list of available analysis info,
53 // used by a pass manager to manage execution order of passes. It also provides
54 // a place to implement common pass manager APIs. All pass managers derive from
57 // [o] class BBPassManager : public FunctionPass, public PMDataManager;
59 // BBPassManager manages BasicBlockPasses.
61 // [o] class FunctionPassManager;
63 // This is a external interface used by JIT to manage FunctionPasses. This
64 // interface relies on FunctionPassManagerImpl to do all the tasks.
66 // [o] class FunctionPassManagerImpl : public ModulePass, PMDataManager,
67 // public PMTopLevelManager;
69 // FunctionPassManagerImpl is a top level manager. It manages FPPassManagers
71 // [o] class FPPassManager : public ModulePass, public PMDataManager;
73 // FPPassManager manages FunctionPasses and BBPassManagers
75 // [o] class MPPassManager : public Pass, public PMDataManager;
77 // MPPassManager manages ModulePasses and FPPassManagers
79 // [o] class PassManager;
81 // This is a external interface used by various tools to manages passes. It
82 // relies on PassManagerImpl to do all the tasks.
84 // [o] class PassManagerImpl : public Pass, public PMDataManager,
85 // public PMDTopLevelManager
87 // PassManagerImpl is a top level pass manager responsible for managing
89 //===----------------------------------------------------------------------===//
93 /// FunctionPassManager and PassManager, two top level managers, serve
94 /// as the public interface of pass manager infrastructure.
95 enum TopLevelManagerType {
96 TLM_Function, // FunctionPassManager
97 TLM_Pass // PassManager
100 // enums for debugging strings
101 enum PassDebuggingString {
102 EXECUTION_MSG, // "Executing Pass '"
103 MODIFICATION_MSG, // "' Made Modification '"
104 FREEING_MSG, // " Freeing Pass '"
105 ON_BASICBLOCK_MSG, // "' on BasicBlock '" + PassName + "'...\n"
106 ON_FUNCTION_MSG, // "' on Function '" + FunctionName + "'...\n"
107 ON_MODULE_MSG, // "' on Module '" + ModuleName + "'...\n"
108 ON_LOOP_MSG, // " 'on Loop ...\n'"
109 ON_CG_MSG // "' on Call Graph ...\n'"
112 //===----------------------------------------------------------------------===//
116 /// Top level pass managers (see PassManager.cpp) maintain active Pass Managers
117 /// using PMStack. Each Pass implements assignPassManager() to connect itself
118 /// with appropriate manager. assignPassManager() walks PMStack to find
119 /// suitable manager.
121 /// PMStack is just a wrapper around standard deque that overrides pop() and
125 typedef std::deque<PMDataManager *>::reverse_iterator iterator;
126 iterator begin() { return S.rbegin(); }
127 iterator end() { return S.rend(); }
129 void handleLastUserOverflow();
132 inline PMDataManager *top() { return S.back(); }
133 void push(PMDataManager *PM);
134 inline bool empty() { return S.empty(); }
138 std::deque<PMDataManager *> S;
142 //===----------------------------------------------------------------------===//
145 /// PMTopLevelManager manages LastUser info and collects common APIs used by
146 /// top level pass managers.
147 class PMTopLevelManager {
150 virtual unsigned getNumContainedManagers() const {
151 return (unsigned)PassManagers.size();
154 /// Schedule pass P for execution. Make sure that passes required by
155 /// P are run before P is run. Update analysis info maintained by
156 /// the manager. Remove dead passes. This is a recursive function.
157 void schedulePass(Pass *P);
159 /// This is implemented by top level pass manager and used by
160 /// schedulePass() to add analysis info passes that are not available.
161 virtual void addTopLevelPass(Pass *P) = 0;
163 /// Set pass P as the last user of the given analysis passes.
164 void setLastUser(SmallVector<Pass *, 12> &AnalysisPasses, Pass *P);
166 /// Collect passes whose last user is P
167 void collectLastUses(SmallVector<Pass *, 12> &LastUses, Pass *P);
169 /// Find the pass that implements Analysis AID. Search immutable
170 /// passes and all pass managers. If desired pass is not found
171 /// then return NULL.
172 Pass *findAnalysisPass(AnalysisID AID);
174 /// Find analysis usage information for the pass P.
175 AnalysisUsage *findAnalysisUsage(Pass *P);
177 explicit PMTopLevelManager(enum TopLevelManagerType t);
178 virtual ~PMTopLevelManager();
180 /// Add immutable pass and initialize it.
181 inline void addImmutablePass(ImmutablePass *P) {
183 ImmutablePasses.push_back(P);
186 inline SmallVector<ImmutablePass *, 8>& getImmutablePasses() {
187 return ImmutablePasses;
190 void addPassManager(PMDataManager *Manager) {
191 PassManagers.push_back(Manager);
194 // Add Manager into the list of managers that are not directly
195 // maintained by this top level pass manager
196 inline void addIndirectPassManager(PMDataManager *Manager) {
197 IndirectPassManagers.push_back(Manager);
200 // Print passes managed by this top level manager.
201 void dumpPasses() const;
202 void dumpArguments() const;
204 void initializeAllAnalysisInfo();
206 // Active Pass Managers
211 /// Collection of pass managers
212 SmallVector<PMDataManager *, 8> PassManagers;
216 /// Collection of pass managers that are not directly maintained
217 /// by this pass manager
218 SmallVector<PMDataManager *, 8> IndirectPassManagers;
220 // Map to keep track of last user of the analysis pass.
221 // LastUser->second is the last user of Lastuser->first.
222 DenseMap<Pass *, Pass *> LastUser;
224 // Map to keep track of passes that are last used by a pass.
225 // This inverse map is initialized at PM->run() based on
227 DenseMap<Pass *, SmallPtrSet<Pass *, 8> > InversedLastUser;
229 /// Immutable passes are managed by top level manager.
230 SmallVector<ImmutablePass *, 8> ImmutablePasses;
232 DenseMap<Pass *, AnalysisUsage *> AnUsageMap;
237 //===----------------------------------------------------------------------===//
240 /// PMDataManager provides the common place to manage the analysis data
241 /// used by pass managers.
242 class PMDataManager {
245 explicit PMDataManager(int Depth) : TPM(NULL), Depth(Depth) {
246 initializeAnalysisInfo();
249 virtual ~PMDataManager();
251 /// Augment AvailableAnalysis by adding analysis made available by pass P.
252 void recordAvailableAnalysis(Pass *P);
254 /// verifyPreservedAnalysis -- Verify analysis presreved by pass P.
255 void verifyPreservedAnalysis(Pass *P);
257 /// verifyDomInfo -- Verify dominator information if it is available.
258 void verifyDomInfo(Pass &P, Function &F);
260 /// Remove Analysis that is not preserved by the pass
261 void removeNotPreservedAnalysis(Pass *P);
263 /// Remove dead passes
264 void removeDeadPasses(Pass *P, const char *Msg, enum PassDebuggingString);
266 /// Add pass P into the PassVector. Update
267 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
268 void add(Pass *P, bool ProcessAnalysis = true);
270 /// Add RequiredPass into list of lower level passes required by pass P.
271 /// RequiredPass is run on the fly by Pass Manager when P requests it
272 /// through getAnalysis interface.
273 virtual void addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass);
275 virtual Pass * getOnTheFlyPass(Pass *P, const PassInfo *PI, Function &F) {
276 assert (0 && "Unable to find on the fly pass");
280 /// Initialize available analysis information.
281 void initializeAnalysisInfo() {
282 AvailableAnalysis.clear();
283 for (unsigned i = 0; i < PMT_Last; ++i)
284 InheritedAnalysis[i] = NULL;
287 // Return true if P preserves high level analysis used by other
288 // passes that are managed by this manager.
289 bool preserveHigherLevelAnalysis(Pass *P);
292 /// Populate RequiredPasses with analysis pass that are required by
293 /// pass P and are available. Populate ReqPassNotAvailable with analysis
294 /// pass that are required by pass P but are not available.
295 void collectRequiredAnalysis(SmallVector<Pass *, 8> &RequiredPasses,
296 SmallVector<AnalysisID, 8> &ReqPassNotAvailable,
299 /// All Required analyses should be available to the pass as it runs! Here
300 /// we fill in the AnalysisImpls member of the pass so that it can
301 /// successfully use the getAnalysis() method to retrieve the
302 /// implementations it needs.
303 void initializeAnalysisImpl(Pass *P);
305 /// Find the pass that implements Analysis AID. If desired pass is not found
306 /// then return NULL.
307 Pass *findAnalysisPass(AnalysisID AID, bool Direction);
309 // Access toplevel manager
310 PMTopLevelManager *getTopLevelManager() { return TPM; }
311 void setTopLevelManager(PMTopLevelManager *T) { TPM = T; }
313 unsigned getDepth() const { return Depth; }
315 // Print routines used by debug-pass
316 void dumpLastUses(Pass *P, unsigned Offset) const;
317 void dumpPassArguments() const;
318 void dumpPassInfo(Pass *P, enum PassDebuggingString S1,
319 enum PassDebuggingString S2, const char *Msg);
320 void dumpRequiredSet(const Pass *P) const;
321 void dumpPreservedSet(const Pass *P) const;
323 virtual unsigned getNumContainedPasses() const {
324 return (unsigned)PassVector.size();
327 virtual PassManagerType getPassManagerType() const {
328 assert ( 0 && "Invalid use of getPassManagerType");
332 std::map<AnalysisID, Pass*> *getAvailableAnalysis() {
333 return &AvailableAnalysis;
336 // Collect AvailableAnalysis from all the active Pass Managers.
337 void populateInheritedAnalysis(PMStack &PMS) {
339 for (PMStack::iterator I = PMS.begin(), E = PMS.end();
341 InheritedAnalysis[Index++] = (*I)->getAvailableAnalysis();
346 // Top level manager.
347 PMTopLevelManager *TPM;
349 // Collection of pass that are managed by this manager
350 SmallVector<Pass *, 16> PassVector;
352 // Collection of Analysis provided by Parent pass manager and
353 // used by current pass manager. At at time there can not be more
354 // then PMT_Last active pass mangers.
355 std::map<AnalysisID, Pass *> *InheritedAnalysis[PMT_Last];
358 void dumpAnalysisUsage(const char *Msg, const Pass *P,
359 const AnalysisUsage::VectorType &Set) const;
361 // Set of available Analysis. This information is used while scheduling
362 // pass. If a pass requires an analysis which is not not available then
363 // equired analysis pass is scheduled to run before the pass itself is
365 std::map<AnalysisID, Pass*> AvailableAnalysis;
367 // Collection of higher level analysis used by the pass managed by
369 SmallVector<Pass *, 8> HigherLevelAnalysis;
374 //===----------------------------------------------------------------------===//
377 /// FPPassManager manages BBPassManagers and FunctionPasses.
378 /// It batches all function passes and basic block pass managers together and
379 /// sequence them to process one function at a time before processing next
382 class FPPassManager : public ModulePass, public PMDataManager {
386 explicit FPPassManager(int Depth)
387 : ModulePass(intptr_t(&ID)), PMDataManager(Depth) { }
389 /// run - Execute all of the passes scheduled for execution. Keep track of
390 /// whether any of the passes modifies the module, and if so, return true.
391 bool runOnFunction(Function &F);
392 bool runOnModule(Module &M);
394 /// doInitialization - Run all of the initializers for the function passes.
396 bool doInitialization(Module &M);
398 /// doFinalization - Run all of the finalizers for the function passes.
400 bool doFinalization(Module &M);
402 /// Pass Manager itself does not invalidate any analysis info.
403 void getAnalysisUsage(AnalysisUsage &Info) const {
404 Info.setPreservesAll();
407 // Print passes managed by this manager
408 void dumpPassStructure(unsigned Offset);
410 virtual const char *getPassName() const {
411 return "Function Pass Manager";
414 FunctionPass *getContainedPass(unsigned N) {
415 assert ( N < PassVector.size() && "Pass number out of range!");
416 FunctionPass *FP = static_cast<FunctionPass *>(PassVector[N]);
420 virtual PassManagerType getPassManagerType() const {
421 return PMT_FunctionPassManager;
427 extern void StartPassTimer(llvm::Pass *);
428 extern void StopPassTimer(llvm::Pass *);