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 //===----------------------------------------------------------------------===//
91 #include "llvm/Support/PrettyStackTrace.h"
99 /// FunctionPassManager and PassManager, two top level managers, serve
100 /// as the public interface of pass manager infrastructure.
101 enum TopLevelManagerType {
102 TLM_Function, // FunctionPassManager
103 TLM_Pass // PassManager
106 // enums for debugging strings
107 enum PassDebuggingString {
108 EXECUTION_MSG, // "Executing Pass '"
109 MODIFICATION_MSG, // "' Made Modification '"
110 FREEING_MSG, // " Freeing Pass '"
111 ON_BASICBLOCK_MSG, // "' on BasicBlock '" + PassName + "'...\n"
112 ON_FUNCTION_MSG, // "' on Function '" + FunctionName + "'...\n"
113 ON_MODULE_MSG, // "' on Module '" + ModuleName + "'...\n"
114 ON_LOOP_MSG, // " 'on Loop ...\n'"
115 ON_CG_MSG // "' on Call Graph ...\n'"
118 /// PassManagerPrettyStackEntry - This is used to print informative information
119 /// about what pass is running when/if a stack trace is generated.
120 class PassManagerPrettyStackEntry : public PrettyStackTraceEntry {
125 explicit PassManagerPrettyStackEntry(Pass *p)
126 : P(p), V(0), M(0) {} // When P is releaseMemory'd.
127 PassManagerPrettyStackEntry(Pass *p, Value &v)
128 : P(p), V(&v), M(0) {} // When P is run on V
129 PassManagerPrettyStackEntry(Pass *p, Module &m)
130 : P(p), V(0), M(&m) {} // When P is run on M
132 /// print - Emit information about this stack frame to OS.
133 virtual void print(raw_ostream &OS) const;
137 //===----------------------------------------------------------------------===//
141 /// Top level pass managers (see PassManager.cpp) maintain active Pass Managers
142 /// using PMStack. Each Pass implements assignPassManager() to connect itself
143 /// with appropriate manager. assignPassManager() walks PMStack to find
144 /// suitable manager.
146 /// PMStack is just a wrapper around standard deque that overrides pop() and
150 typedef std::deque<PMDataManager *>::reverse_iterator iterator;
151 iterator begin() { return S.rbegin(); }
152 iterator end() { return S.rend(); }
154 void handleLastUserOverflow();
157 inline PMDataManager *top() { return S.back(); }
158 void push(PMDataManager *PM);
159 inline bool empty() { return S.empty(); }
163 std::deque<PMDataManager *> S;
167 //===----------------------------------------------------------------------===//
170 /// PMTopLevelManager manages LastUser info and collects common APIs used by
171 /// top level pass managers.
172 class PMTopLevelManager {
175 virtual unsigned getNumContainedManagers() const {
176 return (unsigned)PassManagers.size();
179 /// Schedule pass P for execution. Make sure that passes required by
180 /// P are run before P is run. Update analysis info maintained by
181 /// the manager. Remove dead passes. This is a recursive function.
182 void schedulePass(Pass *P);
184 /// This is implemented by top level pass manager and used by
185 /// schedulePass() to add analysis info passes that are not available.
186 virtual void addTopLevelPass(Pass *P) = 0;
188 /// Set pass P as the last user of the given analysis passes.
189 void setLastUser(SmallVector<Pass *, 12> &AnalysisPasses, Pass *P);
191 /// Collect passes whose last user is P
192 void collectLastUses(SmallVector<Pass *, 12> &LastUses, Pass *P);
194 /// Find the pass that implements Analysis AID. Search immutable
195 /// passes and all pass managers. If desired pass is not found
196 /// then return NULL.
197 Pass *findAnalysisPass(AnalysisID AID);
199 /// Find analysis usage information for the pass P.
200 AnalysisUsage *findAnalysisUsage(Pass *P);
202 explicit PMTopLevelManager(enum TopLevelManagerType t);
203 virtual ~PMTopLevelManager();
205 /// Add immutable pass and initialize it.
206 inline void addImmutablePass(ImmutablePass *P) {
208 ImmutablePasses.push_back(P);
211 inline SmallVector<ImmutablePass *, 8>& getImmutablePasses() {
212 return ImmutablePasses;
215 void addPassManager(PMDataManager *Manager) {
216 PassManagers.push_back(Manager);
219 // Add Manager into the list of managers that are not directly
220 // maintained by this top level pass manager
221 inline void addIndirectPassManager(PMDataManager *Manager) {
222 IndirectPassManagers.push_back(Manager);
225 // Print passes managed by this top level manager.
226 void dumpPasses() const;
227 void dumpArguments() const;
229 void initializeAllAnalysisInfo();
231 // Active Pass Managers
236 /// Collection of pass managers
237 SmallVector<PMDataManager *, 8> PassManagers;
241 /// Collection of pass managers that are not directly maintained
242 /// by this pass manager
243 SmallVector<PMDataManager *, 8> IndirectPassManagers;
245 // Map to keep track of last user of the analysis pass.
246 // LastUser->second is the last user of Lastuser->first.
247 DenseMap<Pass *, Pass *> LastUser;
249 // Map to keep track of passes that are last used by a pass.
250 // This inverse map is initialized at PM->run() based on
252 DenseMap<Pass *, SmallPtrSet<Pass *, 8> > InversedLastUser;
254 /// Immutable passes are managed by top level manager.
255 SmallVector<ImmutablePass *, 8> ImmutablePasses;
257 DenseMap<Pass *, AnalysisUsage *> AnUsageMap;
262 //===----------------------------------------------------------------------===//
265 /// PMDataManager provides the common place to manage the analysis data
266 /// used by pass managers.
267 class PMDataManager {
270 explicit PMDataManager(int Depth) : TPM(NULL), Depth(Depth) {
271 initializeAnalysisInfo();
274 virtual ~PMDataManager();
276 /// Augment AvailableAnalysis by adding analysis made available by pass P.
277 void recordAvailableAnalysis(Pass *P);
279 /// verifyPreservedAnalysis -- Verify analysis presreved by pass P.
280 void verifyPreservedAnalysis(Pass *P);
282 /// verifyDomInfo -- Verify dominator information if it is available.
283 void verifyDomInfo(Pass &P, Function &F);
285 /// Remove Analysis that is not preserved by the pass
286 void removeNotPreservedAnalysis(Pass *P);
288 /// Remove dead passes
289 void removeDeadPasses(Pass *P, const StringRef &Msg,
290 enum PassDebuggingString);
292 /// Add pass P into the PassVector. Update
293 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
294 void add(Pass *P, bool ProcessAnalysis = true);
296 /// Add RequiredPass into list of lower level passes required by pass P.
297 /// RequiredPass is run on the fly by Pass Manager when P requests it
298 /// through getAnalysis interface.
299 virtual void addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass);
301 virtual Pass * getOnTheFlyPass(Pass *P, const PassInfo *PI, Function &F) {
302 assert (0 && "Unable to find on the fly pass");
306 /// Initialize available analysis information.
307 void initializeAnalysisInfo() {
308 AvailableAnalysis.clear();
309 for (unsigned i = 0; i < PMT_Last; ++i)
310 InheritedAnalysis[i] = NULL;
313 // Return true if P preserves high level analysis used by other
314 // passes that are managed by this manager.
315 bool preserveHigherLevelAnalysis(Pass *P);
318 /// Populate RequiredPasses with analysis pass that are required by
319 /// pass P and are available. Populate ReqPassNotAvailable with analysis
320 /// pass that are required by pass P but are not available.
321 void collectRequiredAnalysis(SmallVector<Pass *, 8> &RequiredPasses,
322 SmallVector<AnalysisID, 8> &ReqPassNotAvailable,
325 /// All Required analyses should be available to the pass as it runs! Here
326 /// we fill in the AnalysisImpls member of the pass so that it can
327 /// successfully use the getAnalysis() method to retrieve the
328 /// implementations it needs.
329 void initializeAnalysisImpl(Pass *P);
331 /// Find the pass that implements Analysis AID. If desired pass is not found
332 /// then return NULL.
333 Pass *findAnalysisPass(AnalysisID AID, bool Direction);
335 // Access toplevel manager
336 PMTopLevelManager *getTopLevelManager() { return TPM; }
337 void setTopLevelManager(PMTopLevelManager *T) { TPM = T; }
339 unsigned getDepth() const { return Depth; }
341 // Print routines used by debug-pass
342 void dumpLastUses(Pass *P, unsigned Offset) const;
343 void dumpPassArguments() const;
344 void dumpPassInfo(Pass *P, enum PassDebuggingString S1,
345 enum PassDebuggingString S2, const StringRef &Msg);
346 void dumpRequiredSet(const Pass *P) const;
347 void dumpPreservedSet(const Pass *P) const;
349 virtual unsigned getNumContainedPasses() const {
350 return (unsigned)PassVector.size();
353 virtual PassManagerType getPassManagerType() const {
354 assert ( 0 && "Invalid use of getPassManagerType");
358 std::map<AnalysisID, Pass*> *getAvailableAnalysis() {
359 return &AvailableAnalysis;
362 // Collect AvailableAnalysis from all the active Pass Managers.
363 void populateInheritedAnalysis(PMStack &PMS) {
365 for (PMStack::iterator I = PMS.begin(), E = PMS.end();
367 InheritedAnalysis[Index++] = (*I)->getAvailableAnalysis();
372 // Top level manager.
373 PMTopLevelManager *TPM;
375 // Collection of pass that are managed by this manager
376 SmallVector<Pass *, 16> PassVector;
378 // Collection of Analysis provided by Parent pass manager and
379 // used by current pass manager. At at time there can not be more
380 // then PMT_Last active pass mangers.
381 std::map<AnalysisID, Pass *> *InheritedAnalysis[PMT_Last];
384 /// isPassDebuggingExecutionsOrMore - Return true if -debug-pass=Executions
385 /// or higher is specified.
386 bool isPassDebuggingExecutionsOrMore() const;
389 void dumpAnalysisUsage(const StringRef &Msg, const Pass *P,
390 const AnalysisUsage::VectorType &Set) const;
392 // Set of available Analysis. This information is used while scheduling
393 // pass. If a pass requires an analysis which is not not available then
394 // equired analysis pass is scheduled to run before the pass itself is
396 std::map<AnalysisID, Pass*> AvailableAnalysis;
398 // Collection of higher level analysis used by the pass managed by
400 SmallVector<Pass *, 8> HigherLevelAnalysis;
405 //===----------------------------------------------------------------------===//
408 /// FPPassManager manages BBPassManagers and FunctionPasses.
409 /// It batches all function passes and basic block pass managers together and
410 /// sequence them to process one function at a time before processing next
413 class FPPassManager : public ModulePass, public PMDataManager {
417 explicit FPPassManager(int Depth)
418 : ModulePass(&ID), PMDataManager(Depth) { }
420 /// run - Execute all of the passes scheduled for execution. Keep track of
421 /// whether any of the passes modifies the module, and if so, return true.
422 bool runOnFunction(Function &F);
423 bool runOnModule(Module &M);
425 /// cleanup - After running all passes, clean up pass manager cache.
428 /// doInitialization - Run all of the initializers for the function passes.
430 bool doInitialization(Module &M);
432 /// doFinalization - Run all of the finalizers for the function passes.
434 bool doFinalization(Module &M);
436 /// Pass Manager itself does not invalidate any analysis info.
437 void getAnalysisUsage(AnalysisUsage &Info) const {
438 Info.setPreservesAll();
441 // Print passes managed by this manager
442 void dumpPassStructure(unsigned Offset);
444 virtual const char *getPassName() const {
445 return "Function Pass Manager";
448 FunctionPass *getContainedPass(unsigned N) {
449 assert ( N < PassVector.size() && "Pass number out of range!");
450 FunctionPass *FP = static_cast<FunctionPass *>(PassVector[N]);
454 virtual PassManagerType getPassManagerType() const {
455 return PMT_FunctionPassManager;
459 extern void StartPassTimer(llvm::Pass *);
460 extern void StopPassTimer(llvm::Pass *);