1 //===- llvm/PassSupport.h - Pass Support code -------------------*- 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 defines stuff that is used to define and "use" Passes. This file
11 // is automatically #included by Pass.h, so:
13 // NO .CPP FILES SHOULD INCLUDE THIS FILE DIRECTLY
15 // Instead, #include Pass.h.
17 // This file defines Pass registration code and classes used for it.
19 //===----------------------------------------------------------------------===//
21 #ifndef LLVM_PASS_SUPPORT_H
22 #define LLVM_PASS_SUPPORT_H
25 #include "llvm/PassRegistry.h"
26 #include "llvm/InitializePasses.h"
27 #include "llvm/System/Atomic.h"
32 //===---------------------------------------------------------------------------
33 /// PassInfo class - An instance of this class exists for every pass known by
34 /// the system, and can be obtained from a live Pass by calling its
35 /// getPassInfo() method. These objects are set up by the RegisterPass<>
36 /// template, defined below.
40 typedef Pass* (*NormalCtor_t)();
43 const char *const PassName; // Nice name for Pass
44 const char *const PassArgument; // Command Line argument to run this pass
46 const bool IsCFGOnlyPass; // Pass only looks at the CFG.
47 const bool IsAnalysis; // True if an analysis pass.
48 const bool IsAnalysisGroup; // True if an analysis group.
49 std::vector<const PassInfo*> ItfImpl;// Interfaces implemented by this pass
51 NormalCtor_t NormalCtor;
54 /// PassInfo ctor - Do not call this directly, this should only be invoked
55 /// through RegisterPass.
56 PassInfo(const char *name, const char *arg, const void *pi,
57 NormalCtor_t normal, bool isCFGOnly, bool is_analysis)
58 : PassName(name), PassArgument(arg), PassID(pi),
59 IsCFGOnlyPass(isCFGOnly),
60 IsAnalysis(is_analysis), IsAnalysisGroup(false), NormalCtor(normal) { }
61 /// PassInfo ctor - Do not call this directly, this should only be invoked
62 /// through RegisterPass. This version is for use by analysis groups; it
63 /// does not auto-register the pass.
64 PassInfo(const char *name, const void *pi)
65 : PassName(name), PassArgument(""), PassID(pi),
67 IsAnalysis(false), IsAnalysisGroup(true), NormalCtor(0) { }
69 /// getPassName - Return the friendly name for the pass, never returns null
71 const char *getPassName() const { return PassName; }
73 /// getPassArgument - Return the command line option that may be passed to
74 /// 'opt' that will cause this pass to be run. This will return null if there
77 const char *getPassArgument() const { return PassArgument; }
79 /// getTypeInfo - Return the id object for the pass...
81 const void *getTypeInfo() const { return PassID; }
83 /// Return true if this PassID implements the specified ID pointer.
84 bool isPassID(const void *IDPtr) const {
85 return PassID == IDPtr;
88 /// isAnalysisGroup - Return true if this is an analysis group, not a normal
91 bool isAnalysisGroup() const { return IsAnalysisGroup; }
92 bool isAnalysis() const { return IsAnalysis; }
94 /// isCFGOnlyPass - return true if this pass only looks at the CFG for the
96 bool isCFGOnlyPass() const { return IsCFGOnlyPass; }
98 /// getNormalCtor - Return a pointer to a function, that when called, creates
99 /// an instance of the pass and returns it. This pointer may be null if there
100 /// is no default constructor for the pass.
102 NormalCtor_t getNormalCtor() const {
105 void setNormalCtor(NormalCtor_t Ctor) {
109 /// createPass() - Use this method to create an instance of this pass.
110 Pass *createPass() const;
112 /// addInterfaceImplemented - This method is called when this pass is
113 /// registered as a member of an analysis group with the RegisterAnalysisGroup
116 void addInterfaceImplemented(const PassInfo *ItfPI) {
117 ItfImpl.push_back(ItfPI);
120 /// getInterfacesImplemented - Return a list of all of the analysis group
121 /// interfaces implemented by this pass.
123 const std::vector<const PassInfo*> &getInterfacesImplemented() const {
128 void operator=(const PassInfo &); // do not implement
129 PassInfo(const PassInfo &); // do not implement
132 #define INITIALIZE_PASS(passName, arg, name, cfg, analysis) \
133 static void* initialize##passName##PassOnce(PassRegistry &Registry) { \
134 PassInfo *PI = new PassInfo(name, arg, & passName ::ID, \
135 PassInfo::NormalCtor_t(callDefaultCtor< passName >), cfg, analysis); \
136 Registry.registerPass(*PI); \
139 void llvm::initialize##passName##Pass(PassRegistry &Registry) { \
140 static sys::cas_flag initialized = 0; \
141 sys::cas_flag old_val = sys::CompareAndSwap(&initialized, 1, 0); \
142 if (old_val == 0) initialize##passName##PassOnce(Registry); \
145 #define INITIALIZE_PASS_BEGIN(passName, arg, name, cfg, analysis) \
146 static void* initialize##passName##PassOnce(PassRegistry &Registry) {
148 #define INITIALIZE_PASS_DEPENDENCY(depName) \
149 initialize##depName##Pass(Registry);
150 #define INITIALIZE_AG_DEPENDENCY(depName) \
151 initialize##depName##AnalysisGroup(Registry);
153 #define INITIALIZE_PASS_END(passName, arg, name, cfg, analysis) \
154 PassInfo *PI = new PassInfo(name, arg, & passName ::ID, \
155 PassInfo::NormalCtor_t(callDefaultCtor< passName >), cfg, analysis); \
156 Registry.registerPass(*PI); \
159 void llvm::initialize##passName##Pass(PassRegistry &Registry) { \
160 static sys::cas_flag initialized = 0; \
161 sys::cas_flag old_val = sys::CompareAndSwap(&initialized, 1, 0); \
162 if (old_val == 0) initialize##passName##PassOnce(Registry); \
165 template<typename PassName>
166 Pass *callDefaultCtor() { return new PassName(); }
168 //===---------------------------------------------------------------------------
169 /// RegisterPass<t> template - This template class is used to notify the system
170 /// that a Pass is available for use, and registers it into the internal
171 /// database maintained by the PassManager. Unless this template is used, opt,
172 /// for example will not be able to see the pass and attempts to create the pass
173 /// will fail. This template is used in the follow manner (at global scope, in
176 /// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name");
178 /// This statement will cause your pass to be created by calling the default
179 /// constructor exposed by the pass. If you have a different constructor that
180 /// must be called, create a global constructor function (which takes the
181 /// arguments you need and returns a Pass*) and register your pass like this:
183 /// static RegisterPass<PassClassName> tmp("passopt", "My Name");
185 template<typename passName>
186 struct RegisterPass : public PassInfo {
188 // Register Pass using default constructor...
189 RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false,
190 bool is_analysis = false)
191 : PassInfo(Name, PassArg, &passName::ID,
192 PassInfo::NormalCtor_t(callDefaultCtor<passName>),
193 CFGOnly, is_analysis) {
194 PassRegistry::getPassRegistry()->registerPass(*this);
199 /// RegisterAnalysisGroup - Register a Pass as a member of an analysis _group_.
200 /// Analysis groups are used to define an interface (which need not derive from
201 /// Pass) that is required by passes to do their job. Analysis Groups differ
202 /// from normal analyses because any available implementation of the group will
203 /// be used if it is available.
205 /// If no analysis implementing the interface is available, a default
206 /// implementation is created and added. A pass registers itself as the default
207 /// implementation by specifying 'true' as the second template argument of this
210 /// In addition to registering itself as an analysis group member, a pass must
211 /// register itself normally as well. Passes may be members of multiple groups
212 /// and may still be "required" specifically by name.
214 /// The actual interface may also be registered as well (by not specifying the
215 /// second template argument). The interface should be registered to associate
216 /// a nice name with the interface.
218 class RegisterAGBase : public PassInfo {
220 RegisterAGBase(const char *Name,
221 const void *InterfaceID,
222 const void *PassID = 0,
223 bool isDefault = false);
226 template<typename Interface, bool Default = false>
227 struct RegisterAnalysisGroup : public RegisterAGBase {
228 explicit RegisterAnalysisGroup(PassInfo &RPB)
229 : RegisterAGBase(RPB.getPassName(),
230 &Interface::ID, RPB.getTypeInfo(),
234 explicit RegisterAnalysisGroup(const char *Name)
235 : RegisterAGBase(Name, &Interface::ID) {
239 #define INITIALIZE_ANALYSIS_GROUP(agName, name, defaultPass) \
240 static void* initialize##agName##AnalysisGroupOnce(PassRegistry &Registry) { \
241 initialize##defaultPass##Pass(Registry); \
242 PassInfo *AI = new PassInfo(name, & agName :: ID); \
243 Registry.registerAnalysisGroup(& agName ::ID, 0, *AI, false); \
246 void llvm::initialize##agName##AnalysisGroup(PassRegistry &Registry) { \
247 static sys::cas_flag initialized = 0; \
248 sys::cas_flag old_val = sys::CompareAndSwap(&initialized, 1, 0); \
249 if (old_val == 0) initialize##agName##AnalysisGroupOnce(Registry); \
253 #define INITIALIZE_AG_PASS(passName, agName, arg, name, cfg, analysis, def) \
254 static void* initialize##passName##PassOnce(PassRegistry &Registry) { \
255 PassInfo *PI = new PassInfo(name, arg, & passName ::ID, \
256 PassInfo::NormalCtor_t(callDefaultCtor< passName >), cfg, analysis); \
257 Registry.registerPass(*PI); \
259 PassInfo *AI = new PassInfo(name, & agName :: ID); \
260 Registry.registerAnalysisGroup(& agName ::ID, & passName ::ID, *AI, def); \
263 void llvm::initialize##passName##Pass(PassRegistry &Registry) { \
264 static sys::cas_flag initialized = 0; \
265 sys::cas_flag old_val = sys::CompareAndSwap(&initialized, 1, 0); \
266 if (old_val == 0) initialize##passName##PassOnce(Registry); \
270 #define INITIALIZE_AG_PASS_BEGIN(passName, agName, arg, n, cfg, analysis, def) \
271 static void* initialize##passName##PassOnce(PassRegistry &Registry) {
273 #define INITIALIZE_AG_PASS_END(passName, agName, arg, n, cfg, analysis, def) \
274 PassInfo *PI = new PassInfo(n, arg, & passName ::ID, \
275 PassInfo::NormalCtor_t(callDefaultCtor< passName >), cfg, analysis); \
276 Registry.registerPass(*PI); \
278 PassInfo *AI = new PassInfo(n, & agName :: ID); \
279 Registry.registerAnalysisGroup(& agName ::ID, & passName ::ID, *AI, def); \
282 void llvm::initialize##passName##Pass(PassRegistry &Registry) { \
283 static sys::cas_flag initialized = 0; \
284 sys::cas_flag old_val = sys::CompareAndSwap(&initialized, 1, 0); \
285 if (old_val == 0) initialize##passName##PassOnce(Registry); \
288 //===---------------------------------------------------------------------------
289 /// PassRegistrationListener class - This class is meant to be derived from by
290 /// clients that are interested in which passes get registered and unregistered
291 /// at runtime (which can be because of the RegisterPass constructors being run
292 /// as the program starts up, or may be because a shared object just got
293 /// loaded). Deriving from the PassRegistationListener class automatically
294 /// registers your object to receive callbacks indicating when passes are loaded
297 struct PassRegistrationListener {
299 /// PassRegistrationListener ctor - Add the current object to the list of
300 /// PassRegistrationListeners...
301 PassRegistrationListener();
303 /// dtor - Remove object from list of listeners...
305 virtual ~PassRegistrationListener();
307 /// Callback functions - These functions are invoked whenever a pass is loaded
308 /// or removed from the current executable.
310 virtual void passRegistered(const PassInfo *) {}
312 /// enumeratePasses - Iterate over the registered passes, calling the
313 /// passEnumerate callback on each PassInfo object.
315 void enumeratePasses();
317 /// passEnumerate - Callback function invoked when someone calls
318 /// enumeratePasses on this PassRegistrationListener object.
320 virtual void passEnumerate(const PassInfo *) {}
324 } // End llvm namespace