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/Pass.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"
101 // enums for debugging strings
102 enum PassDebuggingString {
103 EXECUTION_MSG, // "Executing Pass '"
104 MODIFICATION_MSG, // "' Made Modification '"
105 FREEING_MSG, // " Freeing Pass '"
106 ON_BASICBLOCK_MSG, // "' on BasicBlock '" + PassName + "'...\n"
107 ON_FUNCTION_MSG, // "' on Function '" + FunctionName + "'...\n"
108 ON_MODULE_MSG, // "' on Module '" + ModuleName + "'...\n"
109 ON_REGION_MSG, // " 'on Region ...\n'"
110 ON_LOOP_MSG, // " 'on Loop ...\n'"
111 ON_CG_MSG // "' on Call Graph ...\n'"
114 /// PassManagerPrettyStackEntry - This is used to print informative information
115 /// about what pass is running when/if a stack trace is generated.
116 class PassManagerPrettyStackEntry : public PrettyStackTraceEntry {
121 explicit PassManagerPrettyStackEntry(Pass *p)
122 : P(p), V(0), M(0) {} // When P is releaseMemory'd.
123 PassManagerPrettyStackEntry(Pass *p, Value &v)
124 : P(p), V(&v), M(0) {} // When P is run on V
125 PassManagerPrettyStackEntry(Pass *p, Module &m)
126 : P(p), V(0), M(&m) {} // When P is run on M
128 /// print - Emit information about this stack frame to OS.
129 virtual void print(raw_ostream &OS) const;
133 //===----------------------------------------------------------------------===//
136 /// PMStack - This class implements a stack data structure of PMDataManager
139 /// Top level pass managers (see PassManager.cpp) maintain active Pass Managers
140 /// using PMStack. Each Pass implements assignPassManager() to connect itself
141 /// with appropriate manager. assignPassManager() walks PMStack to find
142 /// suitable manager.
145 typedef std::vector<PMDataManager *>::const_reverse_iterator iterator;
146 iterator begin() const { return S.rbegin(); }
147 iterator end() const { return S.rend(); }
150 PMDataManager *top() const { return S.back(); }
151 void push(PMDataManager *PM);
152 bool empty() const { return S.empty(); }
157 std::vector<PMDataManager *> S;
161 //===----------------------------------------------------------------------===//
164 /// PMTopLevelManager manages LastUser info and collects common APIs used by
165 /// top level pass managers.
166 class PMTopLevelManager {
168 explicit PMTopLevelManager(PMDataManager *PMDM);
170 virtual unsigned getNumContainedManagers() const {
171 return (unsigned)PassManagers.size();
174 void initializeAllAnalysisInfo();
177 /// This is implemented by top level pass manager and used by
178 /// schedulePass() to add analysis info passes that are not available.
179 virtual void addTopLevelPass(Pass *P) = 0;
182 /// Schedule pass P for execution. Make sure that passes required by
183 /// P are run before P is run. Update analysis info maintained by
184 /// the manager. Remove dead passes. This is a recursive function.
185 void schedulePass(Pass *P);
187 /// Set pass P as the last user of the given analysis passes.
188 void setLastUser(const SmallVectorImpl<Pass *> &AnalysisPasses, Pass *P);
190 /// Collect passes whose last user is P
191 void collectLastUses(SmallVectorImpl<Pass *> &LastUses, Pass *P);
193 /// Find the pass that implements Analysis AID. Search immutable
194 /// passes and all pass managers. If desired pass is not found
195 /// then return NULL.
196 Pass *findAnalysisPass(AnalysisID AID);
198 /// Find analysis usage information for the pass P.
199 AnalysisUsage *findAnalysisUsage(Pass *P);
201 virtual ~PMTopLevelManager();
203 /// Add immutable pass and initialize it.
204 inline void addImmutablePass(ImmutablePass *P) {
206 ImmutablePasses.push_back(P);
209 inline SmallVectorImpl<ImmutablePass *>& getImmutablePasses() {
210 return ImmutablePasses;
213 void addPassManager(PMDataManager *Manager) {
214 PassManagers.push_back(Manager);
217 // Add Manager into the list of managers that are not directly
218 // maintained by this top level pass manager
219 inline void addIndirectPassManager(PMDataManager *Manager) {
220 IndirectPassManagers.push_back(Manager);
223 // Print passes managed by this top level manager.
224 void dumpPasses() const;
225 void dumpArguments() const;
227 // Active Pass Managers
232 /// Collection of pass managers
233 SmallVector<PMDataManager *, 8> PassManagers;
237 /// Collection of pass managers that are not directly maintained
238 /// by this pass manager
239 SmallVector<PMDataManager *, 8> IndirectPassManagers;
241 // Map to keep track of last user of the analysis pass.
242 // LastUser->second is the last user of Lastuser->first.
243 DenseMap<Pass *, Pass *> LastUser;
245 // Map to keep track of passes that are last used by a pass.
246 // This inverse map is initialized at PM->run() based on
248 DenseMap<Pass *, SmallPtrSet<Pass *, 8> > InversedLastUser;
250 /// Immutable passes are managed by top level manager.
251 SmallVector<ImmutablePass *, 8> ImmutablePasses;
253 DenseMap<Pass *, AnalysisUsage *> AnUsageMap;
258 //===----------------------------------------------------------------------===//
261 /// PMDataManager provides the common place to manage the analysis data
262 /// used by pass managers.
263 class PMDataManager {
266 explicit PMDataManager(int Depth) : TPM(NULL), Depth(Depth) {
267 initializeAnalysisInfo();
270 virtual ~PMDataManager();
272 virtual Pass *getAsPass() = 0;
274 /// Augment AvailableAnalysis by adding analysis made available by pass P.
275 void recordAvailableAnalysis(Pass *P);
277 /// verifyPreservedAnalysis -- Verify analysis presreved by pass P.
278 void verifyPreservedAnalysis(Pass *P);
280 /// Remove Analysis that is not preserved by the pass
281 void removeNotPreservedAnalysis(Pass *P);
283 /// Remove dead passes used by P.
284 void removeDeadPasses(Pass *P, StringRef Msg,
285 enum PassDebuggingString);
288 void freePass(Pass *P, StringRef Msg,
289 enum PassDebuggingString);
291 /// Add pass P into the PassVector. Update
292 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
293 void add(Pass *P, bool ProcessAnalysis = true);
295 /// Add RequiredPass into list of lower level passes required by pass P.
296 /// RequiredPass is run on the fly by Pass Manager when P requests it
297 /// through getAnalysis interface.
298 virtual void addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass);
300 virtual Pass *getOnTheFlyPass(Pass *P, AnalysisID PI, Function &F);
302 /// Initialize available analysis information.
303 void initializeAnalysisInfo() {
304 AvailableAnalysis.clear();
305 for (unsigned i = 0; i < PMT_Last; ++i)
306 InheritedAnalysis[i] = NULL;
309 // Return true if P preserves high level analysis used by other
310 // passes that are managed by this manager.
311 bool preserveHigherLevelAnalysis(Pass *P);
314 /// Populate RequiredPasses with analysis pass that are required by
315 /// pass P and are available. Populate ReqPassNotAvailable with analysis
316 /// pass that are required by pass P but are not available.
317 void collectRequiredAnalysis(SmallVectorImpl<Pass *> &RequiredPasses,
318 SmallVectorImpl<AnalysisID> &ReqPassNotAvailable,
321 /// All Required analyses should be available to the pass as it runs! Here
322 /// we fill in the AnalysisImpls member of the pass so that it can
323 /// successfully use the getAnalysis() method to retrieve the
324 /// implementations it needs.
325 void initializeAnalysisImpl(Pass *P);
327 /// Find the pass that implements Analysis AID. If desired pass is not found
328 /// then return NULL.
329 Pass *findAnalysisPass(AnalysisID AID, bool Direction);
331 // Access toplevel manager
332 PMTopLevelManager *getTopLevelManager() { return TPM; }
333 void setTopLevelManager(PMTopLevelManager *T) { TPM = T; }
335 unsigned getDepth() const { return Depth; }
337 // Print routines used by debug-pass
338 void dumpLastUses(Pass *P, unsigned Offset) const;
339 void dumpPassArguments() const;
340 void dumpPassInfo(Pass *P, enum PassDebuggingString S1,
341 enum PassDebuggingString S2, StringRef Msg);
342 void dumpRequiredSet(const Pass *P) const;
343 void dumpPreservedSet(const Pass *P) const;
345 virtual unsigned getNumContainedPasses() const {
346 return (unsigned)PassVector.size();
349 virtual PassManagerType getPassManagerType() const {
350 assert ( 0 && "Invalid use of getPassManagerType");
354 std::map<AnalysisID, Pass*> *getAvailableAnalysis() {
355 return &AvailableAnalysis;
358 // Collect AvailableAnalysis from all the active Pass Managers.
359 void populateInheritedAnalysis(PMStack &PMS) {
361 for (PMStack::iterator I = PMS.begin(), E = PMS.end();
363 InheritedAnalysis[Index++] = (*I)->getAvailableAnalysis();
368 // Top level manager.
369 PMTopLevelManager *TPM;
371 // Collection of pass that are managed by this manager
372 SmallVector<Pass *, 16> PassVector;
374 // Collection of Analysis provided by Parent pass manager and
375 // used by current pass manager. At at time there can not be more
376 // then PMT_Last active pass mangers.
377 std::map<AnalysisID, Pass *> *InheritedAnalysis[PMT_Last];
380 /// isPassDebuggingExecutionsOrMore - Return true if -debug-pass=Executions
381 /// or higher is specified.
382 bool isPassDebuggingExecutionsOrMore() const;
385 void dumpAnalysisUsage(StringRef Msg, const Pass *P,
386 const AnalysisUsage::VectorType &Set) const;
388 // Set of available Analysis. This information is used while scheduling
389 // pass. If a pass requires an analysis which is not available then
390 // the required analysis pass is scheduled to run before the pass itself is
392 std::map<AnalysisID, Pass*> AvailableAnalysis;
394 // Collection of higher level analysis used by the pass managed by
396 SmallVector<Pass *, 8> HigherLevelAnalysis;
401 //===----------------------------------------------------------------------===//
404 /// FPPassManager manages BBPassManagers and FunctionPasses.
405 /// It batches all function passes and basic block pass managers together and
406 /// sequence them to process one function at a time before processing next
408 class FPPassManager : public ModulePass, public PMDataManager {
411 explicit FPPassManager(int Depth)
412 : ModulePass(ID), PMDataManager(Depth) { }
414 /// run - Execute all of the passes scheduled for execution. Keep track of
415 /// whether any of the passes modifies the module, and if so, return true.
416 bool runOnFunction(Function &F);
417 bool runOnModule(Module &M);
419 /// cleanup - After running all passes, clean up pass manager cache.
422 /// doInitialization - Run all of the initializers for the function passes.
424 bool doInitialization(Module &M);
426 /// doFinalization - Run all of the finalizers for the function passes.
428 bool doFinalization(Module &M);
430 virtual PMDataManager *getAsPMDataManager() { return this; }
431 virtual Pass *getAsPass() { return this; }
433 /// Pass Manager itself does not invalidate any analysis info.
434 void getAnalysisUsage(AnalysisUsage &Info) const {
435 Info.setPreservesAll();
438 // Print passes managed by this manager
439 void dumpPassStructure(unsigned Offset);
441 virtual const char *getPassName() const {
442 return "Function Pass Manager";
445 FunctionPass *getContainedPass(unsigned N) {
446 assert ( N < PassVector.size() && "Pass number out of range!");
447 FunctionPass *FP = static_cast<FunctionPass *>(PassVector[N]);
451 virtual PassManagerType getPassManagerType() const {
452 return PMT_FunctionPassManager;
456 Timer *getPassTimer(Pass *);