1 //===- llvm/PassSupport.h - Pass Support code -------------------*- C++ -*-===//
3 // This file defines stuff that is used to define and "use" Passes. This file
4 // is automatically #included by Pass.h, so:
6 // NO .CPP FILES SHOULD INCLUDE THIS FILE DIRECTLY
8 // Instead, #include Pass.h.
10 // This file defines Pass registration code and classes used for it.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_PASS_SUPPORT_H
15 #define LLVM_PASS_SUPPORT_H
17 // No need to include Pass.h, we are being included by it!
21 //===---------------------------------------------------------------------------
22 /// PassInfo class - An instance of this class exists for every pass known by
23 /// the system, and can be obtained from a live Pass by calling its
24 /// getPassInfo() method. These objects are set up by the RegisterPass<>
25 /// template, defined below.
28 const char *PassName; // Nice name for Pass
29 const char *PassArgument; // Command Line argument to run this pass
30 const std::type_info &TypeInfo; // type_info object for this Pass class
31 unsigned char PassType; // Set of enums values below...
32 std::vector<const PassInfo*> ItfImpl;// Interfaces implemented by this pass
34 Pass *(*NormalCtor)(); // No argument ctor
35 Pass *(*TargetCtor)(TargetMachine&); // Ctor taking TargetMachine object...
38 /// PassType - Define symbolic constants that can be used to test to see if
39 /// this pass should be listed by analyze or opt. Passes can use none, one or
40 /// many of these flags or'd together. It is not legal to combine the
41 /// AnalysisGroup flag with others.
44 Analysis = 1, Optimization = 2, LLC = 4, AnalysisGroup = 8
47 /// PassInfo ctor - Do not call this directly, this should only be invoked
48 /// through RegisterPass.
49 PassInfo(const char *name, const char *arg, const std::type_info &ti,
50 unsigned pt, Pass *(*normal)() = 0,
51 Pass *(*targetctor)(TargetMachine &) = 0)
52 : PassName(name), PassArgument(arg), TypeInfo(ti), PassType(pt),
53 NormalCtor(normal), TargetCtor(targetctor) {
56 /// getPassName - Return the friendly name for the pass, never returns null
58 const char *getPassName() const { return PassName; }
59 void setPassName(const char *Name) { PassName = Name; }
61 /// getPassArgument - Return the command line option that may be passed to
62 /// 'opt' that will cause this pass to be run. This will return null if there
65 const char *getPassArgument() const { return PassArgument; }
67 /// getTypeInfo - Return the type_info object for the pass...
69 const std::type_info &getTypeInfo() const { return TypeInfo; }
71 /// getPassType - Return the PassType of a pass. Note that this can be
72 /// several different types or'd together. This is _strictly_ for use by opt,
73 /// analyze and llc for deciding which passes to use as command line options.
75 unsigned getPassType() const { return PassType; }
77 /// getNormalCtor - Return a pointer to a function, that when called, creates
78 /// an instance of the pass and returns it. This pointer may be null if there
79 /// is no default constructor for the pass.
81 Pass *(*getNormalCtor() const)() {
84 void setNormalCtor(Pass *(*Ctor)()) {
88 /// createPass() - Use this method to create an instance of this pass.
89 Pass *createPass() const {
90 assert((PassType != AnalysisGroup || NormalCtor) &&
91 "No default implementation found for analysis group!");
93 "Cannot call createPass on PassInfo without default ctor!");
97 /// getTargetCtor - Return a pointer to a function that creates an instance of
98 /// the pass and returns it. This returns a constructor for a version of the
99 /// pass that takes a TargetMachine object as a parameter.
101 Pass *(*getTargetCtor() const)(TargetMachine &) {
105 /// addInterfaceImplemented - This method is called when this pass is
106 /// registered as a member of an analysis group with the RegisterAnalysisGroup
109 void addInterfaceImplemented(const PassInfo *ItfPI) {
110 ItfImpl.push_back(ItfPI);
113 /// getInterfacesImplemented - Return a list of all of the analysis group
114 /// interfaces implemented by this pass.
116 const std::vector<const PassInfo*> &getInterfacesImplemented() const {
122 //===---------------------------------------------------------------------------
123 /// RegisterPass<t> template - This template class is used to notify the system
124 /// that a Pass is available for use, and registers it into the internal
125 /// database maintained by the PassManager. Unless this template is used, opt,
126 /// for example will not be able to see the pass and attempts to create the pass
127 /// will fail. This template is used in the follow manner (at global scope, in
130 /// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name");
132 /// This statement will cause your pass to be created by calling the default
133 /// constructor exposed by the pass. If you have a different constructor that
134 /// must be called, create a global constructor function (which takes the
135 /// arguments you need and returns a Pass*) and register your pass like this:
137 /// Pass *createMyPass(foo &opt) { return new MyPass(opt); }
138 /// static RegisterPass<PassClassName> tmp("passopt", "My Name", createMyPass);
140 struct RegisterPassBase {
141 /// getPassInfo - Get the pass info for the registered class...
143 const PassInfo *getPassInfo() const { return PIObj; }
145 RegisterPassBase() : PIObj(0) {}
146 ~RegisterPassBase() { // Intentionally non-virtual...
147 if (PIObj) unregisterPass(PIObj);
151 PassInfo *PIObj; // The PassInfo object for this pass
152 void registerPass(PassInfo *);
153 void unregisterPass(PassInfo *);
155 /// setPreservesCFG - Notice that this pass only depends on the CFG, so
156 /// transformations that do not modify the CFG do not invalidate this pass.
158 void setPreservesCFG();
161 template<typename PassName>
162 Pass *callDefaultCtor() { return new PassName(); }
164 template<typename PassName>
165 struct RegisterPass : public RegisterPassBase {
167 // Register Pass using default constructor...
168 RegisterPass(const char *PassArg, const char *Name, unsigned PassTy = 0) {
169 registerPass(new PassInfo(Name, PassArg, typeid(PassName), PassTy,
170 callDefaultCtor<PassName>));
173 // Register Pass using default constructor explicitly...
174 RegisterPass(const char *PassArg, const char *Name, unsigned PassTy,
176 registerPass(new PassInfo(Name, PassArg, typeid(PassName), PassTy, ctor));
179 // Register Pass using TargetMachine constructor...
180 RegisterPass(const char *PassArg, const char *Name, unsigned PassTy,
181 Pass *(*targetctor)(TargetMachine &)) {
182 registerPass(new PassInfo(Name, PassArg, typeid(PassName), PassTy,
186 // Generic constructor version that has an unknown ctor type...
187 template<typename CtorType>
188 RegisterPass(const char *PassArg, const char *Name, unsigned PassTy,
190 registerPass(new PassInfo(Name, PassArg, typeid(PassName), PassTy, 0));
194 /// RegisterOpt - Register something that is to show up in Opt, this is just a
195 /// shortcut for specifying RegisterPass...
197 template<typename PassName>
198 struct RegisterOpt : public RegisterPassBase {
199 RegisterOpt(const char *PassArg, const char *Name) {
200 registerPass(new PassInfo(Name, PassArg, typeid(PassName),
201 PassInfo::Optimization,
202 callDefaultCtor<PassName>));
205 /// Register Pass using default constructor explicitly...
207 RegisterOpt(const char *PassArg, const char *Name, Pass *(*ctor)()) {
208 registerPass(new PassInfo(Name, PassArg, typeid(PassName),
209 PassInfo::Optimization, ctor));
212 /// Register Pass using TargetMachine constructor...
214 RegisterOpt(const char *PassArg, const char *Name,
215 Pass *(*targetctor)(TargetMachine &)) {
216 registerPass(new PassInfo(Name, PassArg, typeid(PassName),
217 PassInfo::Optimization, 0, targetctor));
221 /// RegisterAnalysis - Register something that is to show up in Analysis, this
222 /// is just a shortcut for specifying RegisterPass... Analyses take a special
223 /// argument that, when set to true, tells the system that the analysis ONLY
224 /// depends on the shape of the CFG, so if a transformation preserves the CFG
225 /// that the analysis is not invalidated.
227 template<typename PassName>
228 struct RegisterAnalysis : public RegisterPassBase {
229 RegisterAnalysis(const char *PassArg, const char *Name,
230 bool CFGOnly = false) {
231 registerPass(new PassInfo(Name, PassArg, typeid(PassName),
233 callDefaultCtor<PassName>));
239 /// RegisterLLC - Register something that is to show up in LLC, this is just a
240 /// shortcut for specifying RegisterPass...
242 template<typename PassName>
243 struct RegisterLLC : public RegisterPassBase {
244 RegisterLLC(const char *PassArg, const char *Name) {
245 registerPass(new PassInfo(Name, PassArg, typeid(PassName),
247 callDefaultCtor<PassName>));
250 /// Register Pass using default constructor explicitly...
252 RegisterLLC(const char *PassArg, const char *Name, Pass *(*ctor)()) {
253 registerPass(new PassInfo(Name, PassArg, typeid(PassName),
254 PassInfo::LLC, ctor));
257 /// Register Pass using TargetMachine constructor...
259 RegisterLLC(const char *PassArg, const char *Name,
260 Pass *(*datactor)(TargetMachine &)) {
261 registerPass(new PassInfo(Name, PassArg, typeid(PassName),
267 /// RegisterAnalysisGroup - Register a Pass as a member of an analysis _group_.
268 /// Analysis groups are used to define an interface (which need not derive from
269 /// Pass) that is required by passes to do their job. Analysis Groups differ
270 /// from normal analyses because any available implementation of the group will
271 /// be used if it is available.
273 /// If no analysis implementing the interface is available, a default
274 /// implementation is created and added. A pass registers itself as the default
275 /// implementation by specifying 'true' as the third template argument of this
278 /// In addition to registering itself as an analysis group member, a pass must
279 /// register itself normally as well. Passes may be members of multiple groups
280 /// and may still be "required" specifically by name.
282 /// The actual interface may also be registered as well (by not specifying the
283 /// second template argument). The interface should be registered to associate
284 /// a nice name with the interface.
286 class RegisterAGBase : public RegisterPassBase {
287 PassInfo *InterfaceInfo;
288 const PassInfo *ImplementationInfo;
289 bool isDefaultImplementation;
291 RegisterAGBase(const std::type_info &Interface,
292 const std::type_info *Pass = 0,
293 bool isDefault = false);
294 void setGroupName(const char *Name);
300 template<typename Interface, typename DefaultImplementationPass = void,
301 bool Default = false>
302 struct RegisterAnalysisGroup : public RegisterAGBase {
303 RegisterAnalysisGroup() : RegisterAGBase(typeid(Interface),
304 &typeid(DefaultImplementationPass),
309 /// Define a specialization of RegisterAnalysisGroup that is used to set the
310 /// name for the analysis group.
312 template<typename Interface>
313 struct RegisterAnalysisGroup<Interface, void, false> : public RegisterAGBase {
314 RegisterAnalysisGroup(const char *Name)
315 : RegisterAGBase(typeid(Interface)) {
322 //===---------------------------------------------------------------------------
323 /// PassRegistrationListener class - This class is meant to be derived from by
324 /// clients that are interested in which passes get registered and unregistered
325 /// at runtime (which can be because of the RegisterPass constructors being run
326 /// as the program starts up, or may be because a shared object just got
327 /// loaded). Deriving from the PassRegistationListener class automatically
328 /// registers your object to receive callbacks indicating when passes are loaded
331 struct PassRegistrationListener {
333 /// PassRegistrationListener ctor - Add the current object to the list of
334 /// PassRegistrationListeners...
335 PassRegistrationListener();
337 /// dtor - Remove object from list of listeners...
339 virtual ~PassRegistrationListener();
341 /// Callback functions - These functions are invoked whenever a pass is loaded
342 /// or removed from the current executable.
344 virtual void passRegistered(const PassInfo *P) {}
345 virtual void passUnregistered(const PassInfo *P) {}
347 /// enumeratePasses - Iterate over the registered passes, calling the
348 /// passEnumerate callback on each PassInfo object.
350 void enumeratePasses();
352 /// passEnumerate - Callback function invoked when someone calls
353 /// enumeratePasses on this PassRegistrationListener object.
355 virtual void passEnumerate(const PassInfo *P) {}
359 //===---------------------------------------------------------------------------
360 /// IncludeFile class - This class is used as a hack to make sure that the
361 /// implementation of a header file is included into a tool that uses the
362 /// header. This is solely to overcome problems linking .a files and not
363 /// getting the implementation of passes we need.