1 //===- llvm/Pass.h - Base class 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 a base class that indicates that a specified class is a
11 // transformation pass implementation.
13 // Passes are designed this way so that it is possible to run passes in a cache
14 // and organizationally optimal order without having to specify it at the front
15 // end. This allows arbitrary passes to be strung together and have them
16 // executed as effeciently as possible.
18 // Passes should extend one of the classes below, depending on the guarantees
19 // that it can make about what will be modified as it is run. For example, most
20 // global optimizations should derive from FunctionPass, because they do not add
21 // or delete functions, they operate on the internals of the function.
23 // Note that this file #includes PassSupport.h and PassAnalysisSupport.h (at the
24 // bottom), so the APIs exposed by these files are also automatically available
25 // to all users of this file.
27 //===----------------------------------------------------------------------===//
32 #include "llvm/Support/Streams.h"
49 class BasicBlockPassManager;
50 class ModulePassManager;
52 class AnalysisResolver;
55 // AnalysisID - Use the PassInfo to identify a pass...
56 typedef const PassInfo* AnalysisID;
58 /// Different types of internal pass managers. External pass managers
59 /// (PassManager and FunctionPassManager) are not represented here.
60 /// Ordering of pass manager types is important here.
61 enum PassManagerType {
63 PMT_ModulePassManager = 1, /// MPPassManager
64 PMT_CallGraphPassManager, /// CGPassManager
65 PMT_FunctionPassManager, /// FPPassManager
66 PMT_LoopPassManager, /// LPPassManager
67 PMT_BasicBlockPassManager, /// BBPassManager
71 typedef enum PassManagerType PassManagerType;
73 //===----------------------------------------------------------------------===//
74 /// Pass interface - Implemented by all 'passes'. Subclass this if you are an
75 /// interprocedural optimization or you do not fit into any of the more
76 /// constrained passes described below.
79 AnalysisResolver *Resolver; // Used to resolve analysis
80 const PassInfo *PassInfoCache;
82 // AnalysisImpls - This keeps track of which passes implement the interfaces
83 // that are required by the current pass (to implement getAnalysis()).
85 std::vector<std::pair<const PassInfo*, Pass*> > AnalysisImpls;
87 void operator=(const Pass&); // DO NOT IMPLEMENT
88 Pass(const Pass &); // DO NOT IMPLEMENT
90 Pass() : Resolver(0), PassInfoCache(0) {}
91 virtual ~Pass() {} // Destructor is virtual so we can be subclassed
93 /// getPassName - Return a nice clean name for a pass. This usually
94 /// implemented in terms of the name that is registered by one of the
95 /// Registration templates, but can be overloaded directly, and if nothing
96 /// else is available, C++ RTTI will be consulted to get a SOMEWHAT
97 /// intelligible name for the pass.
99 virtual const char *getPassName() const;
101 /// getPassInfo - Return the PassInfo data structure that corresponds to this
102 /// pass... If the pass has not been registered, this will return null.
104 const PassInfo *getPassInfo() const;
106 /// runPass - Run this pass, returning true if a modification was made to the
107 /// module argument. This should be implemented by all concrete subclasses.
109 virtual bool runPass(Module &M) { return false; }
110 virtual bool runPass(BasicBlock&) { return false; }
112 /// print - Print out the internal state of the pass. This is called by
113 /// Analyze to print out the contents of an analysis. Otherwise it is not
114 /// necessary to implement this method. Beware that the module pointer MAY be
115 /// null. This automatically forwards to a virtual function that does not
116 /// provide the Module* in case the analysis doesn't need it it can just be
119 virtual void print(std::ostream &O, const Module *M) const;
120 void print(std::ostream *O, const Module *M) const { if (O) print(*O, M); }
121 void dump() const; // dump - call print(std::cerr, 0);
123 /// Each pass is responsible for assigning a pass manager to itself.
124 /// PMS is the stack of available pass manager.
125 virtual void assignPassManager(PMStack &PMS,
126 PassManagerType T = PMT_Unknown) {}
127 /// Check if available pass managers are suitable for this pass or not.
128 virtual void preparePassManager(PMStack &PMS) {}
130 /// Return what kind of Pass Manager can manage this pass.
131 virtual PassManagerType getPotentialPassManagerType() const {
135 // Access AnalysisResolver
136 inline void setResolver(AnalysisResolver *AR) { Resolver = AR; }
137 inline AnalysisResolver *getResolver() { return Resolver; }
139 /// getAnalysisUsage - This function should be overriden by passes that need
140 /// analysis information to do their job. If a pass specifies that it uses a
141 /// particular analysis result to this function, it can then use the
142 /// getAnalysis<AnalysisType>() function, below.
144 virtual void getAnalysisUsage(AnalysisUsage &Info) const {
145 // By default, no analysis results are used, all are invalidated.
148 /// releaseMemory() - This member can be implemented by a pass if it wants to
149 /// be able to release its memory when it is no longer needed. The default
150 /// behavior of passes is to hold onto memory for the entire duration of their
151 /// lifetime (which is the entire compile time). For pipelined passes, this
152 /// is not a big deal because that memory gets recycled every time the pass is
153 /// invoked on another program unit. For IP passes, it is more important to
154 /// free memory when it is unused.
156 /// Optionally implement this function to release pass memory when it is no
159 virtual void releaseMemory() {}
161 // dumpPassStructure - Implement the -debug-passes=PassStructure option
162 virtual void dumpPassStructure(unsigned Offset = 0);
164 template<typename AnalysisClass>
165 static const PassInfo *getClassPassInfo() {
166 return lookupPassInfo(typeid(AnalysisClass));
169 // lookupPassInfo - Return the pass info object for the specified pass class,
170 // or null if it is not known.
171 static const PassInfo *lookupPassInfo(const std::type_info &TI);
173 /// getAnalysisToUpdate<AnalysisType>() - This function is used by subclasses
174 /// to get to the analysis information that might be around that needs to be
175 /// updated. This is different than getAnalysis in that it can fail (ie the
176 /// analysis results haven't been computed), so should only be used if you
177 /// provide the capability to update an analysis that exists. This method is
178 /// often used by transformation APIs to update analysis results for a pass
179 /// automatically as the transform is performed.
181 template<typename AnalysisType>
182 AnalysisType *getAnalysisToUpdate() const; // Defined in PassAnalysisSupport.h
184 /// mustPreserveAnalysisID - This method serves the same function as
185 /// getAnalysisToUpdate, but works if you just have an AnalysisID. This
186 /// obviously cannot give you a properly typed instance of the class if you
187 /// don't have the class name available (use getAnalysisToUpdate if you do),
188 /// but it can tell you if you need to preserve the pass at least.
190 bool mustPreserveAnalysisID(const PassInfo *AnalysisID) const;
192 /// getAnalysis<AnalysisType>() - This function is used by subclasses to get
193 /// to the analysis information that they claim to use by overriding the
194 /// getAnalysisUsage function.
196 template<typename AnalysisType>
197 AnalysisType &getAnalysis() const; // Defined in PassAnalysisSupport.h
199 template<typename AnalysisType>
200 AnalysisType &getAnalysis(Function &F); // Defined in PassanalysisSupport.h
202 template<typename AnalysisType>
203 AnalysisType &getAnalysisID(const PassInfo *PI) const;
205 template<typename AnalysisType>
206 AnalysisType &getAnalysisID(const PassInfo *PI, Function &F);
209 inline std::ostream &operator<<(std::ostream &OS, const Pass &P) {
210 P.print(OS, 0); return OS;
213 //===----------------------------------------------------------------------===//
214 /// ModulePass class - This class is used to implement unstructured
215 /// interprocedural optimizations and analyses. ModulePasses may do anything
216 /// they want to the program.
218 class ModulePass : public Pass {
220 /// runOnModule - Virtual method overriden by subclasses to process the module
221 /// being operated on.
222 virtual bool runOnModule(Module &M) = 0;
224 virtual bool runPass(Module &M) { return runOnModule(M); }
225 virtual bool runPass(BasicBlock&) { return false; }
227 virtual void assignPassManager(PMStack &PMS,
228 PassManagerType T = PMT_ModulePassManager);
230 /// Return what kind of Pass Manager can manage this pass.
231 virtual PassManagerType getPotentialPassManagerType() const {
232 return PMT_ModulePassManager;
235 // Force out-of-line virtual method.
236 virtual ~ModulePass();
240 //===----------------------------------------------------------------------===//
241 /// ImmutablePass class - This class is used to provide information that does
242 /// not need to be run. This is useful for things like target information and
243 /// "basic" versions of AnalysisGroups.
245 class ImmutablePass : public ModulePass {
247 /// initializePass - This method may be overriden by immutable passes to allow
248 /// them to perform various initialization actions they require. This is
249 /// primarily because an ImmutablePass can "require" another ImmutablePass,
250 /// and if it does, the overloaded version of initializePass may get access to
251 /// these passes with getAnalysis<>.
253 virtual void initializePass() {}
255 /// ImmutablePasses are never run.
257 virtual bool runOnModule(Module &M) { return false; }
259 // Force out-of-line virtual method.
260 virtual ~ImmutablePass();
263 //===----------------------------------------------------------------------===//
264 /// FunctionPass class - This class is used to implement most global
265 /// optimizations. Optimizations should subclass this class if they meet the
266 /// following constraints:
268 /// 1. Optimizations are organized globally, i.e., a function at a time
269 /// 2. Optimizing a function does not cause the addition or removal of any
270 /// functions in the module
272 class FunctionPass : public Pass {
274 /// doInitialization - Virtual method overridden by subclasses to do
275 /// any necessary per-module initialization.
277 virtual bool doInitialization(Module &M) { return false; }
279 /// runOnFunction - Virtual method overriden by subclasses to do the
280 /// per-function processing of the pass.
282 virtual bool runOnFunction(Function &F) = 0;
284 /// doFinalization - Virtual method overriden by subclasses to do any post
285 /// processing needed after all passes have run.
287 virtual bool doFinalization(Module &M) { return false; }
289 /// runOnModule - On a module, we run this pass by initializing,
290 /// ronOnFunction'ing once for every function in the module, then by
293 virtual bool runOnModule(Module &M);
295 /// run - On a function, we simply initialize, run the function, then
298 bool run(Function &F);
300 virtual void assignPassManager(PMStack &PMS,
301 PassManagerType T = PMT_FunctionPassManager);
303 /// Return what kind of Pass Manager can manage this pass.
304 virtual PassManagerType getPotentialPassManagerType() const {
305 return PMT_FunctionPassManager;
311 //===----------------------------------------------------------------------===//
312 /// BasicBlockPass class - This class is used to implement most local
313 /// optimizations. Optimizations should subclass this class if they
314 /// meet the following constraints:
315 /// 1. Optimizations are local, operating on either a basic block or
316 /// instruction at a time.
317 /// 2. Optimizations do not modify the CFG of the contained function, or any
318 /// other basic block in the function.
319 /// 3. Optimizations conform to all of the constraints of FunctionPasses.
321 class BasicBlockPass : public Pass {
323 /// doInitialization - Virtual method overridden by subclasses to do
324 /// any necessary per-module initialization.
326 virtual bool doInitialization(Module &M) { return false; }
328 /// doInitialization - Virtual method overridden by BasicBlockPass subclasses
329 /// to do any necessary per-function initialization.
331 virtual bool doInitialization(Function &F) { return false; }
333 /// runOnBasicBlock - Virtual method overriden by subclasses to do the
334 /// per-basicblock processing of the pass.
336 virtual bool runOnBasicBlock(BasicBlock &BB) = 0;
338 /// doFinalization - Virtual method overriden by BasicBlockPass subclasses to
339 /// do any post processing needed after all passes have run.
341 virtual bool doFinalization(Function &F) { return false; }
343 /// doFinalization - Virtual method overriden by subclasses to do any post
344 /// processing needed after all passes have run.
346 virtual bool doFinalization(Module &M) { return false; }
349 // To run this pass on a function, we simply call runOnBasicBlock once for
352 bool runOnFunction(Function &F);
354 /// To run directly on the basic block, we initialize, runOnBasicBlock, then
357 virtual bool runPass(Module &M) { return false; }
358 virtual bool runPass(BasicBlock &BB);
360 virtual void assignPassManager(PMStack &PMS,
361 PassManagerType T = PMT_BasicBlockPassManager);
363 /// Return what kind of Pass Manager can manage this pass.
364 virtual PassManagerType getPotentialPassManagerType() const {
365 return PMT_BasicBlockPassManager;
370 /// Top level pass manager (see PasManager.cpp) maintains active Pass Managers
371 /// using PMStack. Each Pass implements assignPassManager() to connect itself
372 /// with appropriate manager. assignPassManager() walks PMStack to find
373 /// suitable manager.
375 /// PMStack is just a wrapper around standard deque that overrides pop() and
379 typedef std::deque<PMDataManager *>::reverse_iterator iterator;
380 iterator begin() { return S.rbegin(); }
381 iterator end() { return S.rend(); }
383 void handleLastUserOverflow();
386 inline PMDataManager *top() { return S.back(); }
388 inline bool empty() { return S.empty(); }
392 std::deque<PMDataManager *> S;
396 /// If the user specifies the -time-passes argument on an LLVM tool command line
397 /// then the value of this boolean will be true, otherwise false.
398 /// @brief This is the storage for the -time-passes option.
399 extern bool TimePassesIsEnabled;
401 } // End llvm namespace
403 // Include support files that contain important APIs commonly used by Passes,
404 // but that we want to separate out to make it easier to read the header files.
406 #include "llvm/PassSupport.h"
407 #include "llvm/PassAnalysisSupport.h"