1 //===- llvm/PassSupport.h - Pass Support code -------------------*- 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 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
24 #include "llvm/System/IncludeFile.h"
25 // No need to include Pass.h, we are being included by it!
31 //===---------------------------------------------------------------------------
32 /// PassInfo class - An instance of this class exists for every pass known by
33 /// the system, and can be obtained from a live Pass by calling its
34 /// getPassInfo() method. These objects are set up by the RegisterPass<>
35 /// template, defined below.
38 const char *PassName; // Nice name for Pass
39 const char *PassArgument; // Command Line argument to run this pass
40 const std::type_info &TypeInfo; // type_info object for this Pass class
41 bool IsAnalysisGroup; // True if an analysis group.
42 std::vector<const PassInfo*> ItfImpl;// Interfaces implemented by this pass
44 Pass *(*NormalCtor)(); // No argument ctor
45 Pass *(*TargetCtor)(TargetMachine&); // Ctor taking TargetMachine object...
48 /// PassInfo ctor - Do not call this directly, this should only be invoked
49 /// through RegisterPass.
50 PassInfo(const char *name, const char *arg, const std::type_info &ti,
51 Pass *(*normal)() = 0, Pass *(*targetctor)(TargetMachine &) = 0)
52 : PassName(name), PassArgument(arg), TypeInfo(ti), IsAnalysisGroup(false),
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 /// isAnalysisGroup - Return true if this is an analysis group, not a normal
74 bool isAnalysisGroup() const { return IsAnalysisGroup; }
75 void SetIsAnalysisGroup() { IsAnalysisGroup = true; }
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((!isAnalysisGroup() || 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(const char *Name, const char *Arg, const std::type_info &TI,
146 Pass *(*Normal)() = 0,
147 Pass *(*TargetCtor)(TargetMachine &) = 0)
148 : PIObj(Name, Arg, TI, Normal, TargetCtor) {
151 RegisterPassBase(const std::type_info &TI)
152 : PIObj("", "", TI, 0, 0) {
153 // This ctor may only be used for analysis groups: it does not auto-register
155 PIObj.SetIsAnalysisGroup();
158 ~RegisterPassBase() { // Intentionally non-virtual.
159 // Analysis groups are registered/unregistered by their dtor.
160 if (!PIObj.isAnalysisGroup())
165 PassInfo PIObj; // The PassInfo object for this pass
167 void unregisterPass();
169 /// setOnlyUsesCFG - Notice that this pass only depends on the CFG, so
170 /// transformations that do not modify the CFG do not invalidate this pass.
172 void setOnlyUsesCFG();
175 template<typename PassName>
176 Pass *callDefaultCtor() { return new PassName(); }
178 template<typename PassName>
179 struct RegisterPass : public RegisterPassBase {
181 // Register Pass using default constructor...
182 RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false)
183 : RegisterPassBase(Name, PassArg, typeid(PassName),
184 callDefaultCtor<PassName>) {
185 if (CFGOnly) setOnlyUsesCFG();
188 // Register Pass using default constructor explicitly...
189 RegisterPass(const char *PassArg, const char *Name,
190 Pass *(*ctor)(), bool CFGOnly = false)
191 : RegisterPassBase(Name, PassArg, typeid(PassName), ctor) {
192 if (CFGOnly) setOnlyUsesCFG();
195 // Register Pass using TargetMachine constructor...
196 RegisterPass(const char *PassArg, const char *Name,
197 Pass *(*targetctor)(TargetMachine &), bool CFGOnly = false)
198 : RegisterPassBase(Name, PassArg, typeid(PassName), 0, targetctor) {
199 if (CFGOnly) setOnlyUsesCFG();
202 // Generic constructor version that has an unknown ctor type...
203 template<typename CtorType>
204 RegisterPass(const char *PassArg, const char *Name, CtorType *Fn,
205 bool CFGOnly = false)
206 : RegisterPassBase(Name, PassArg, typeid(PassName), 0) {
207 if (CFGOnly) setOnlyUsesCFG();
211 /// RegisterOpt - Register something that is to show up in Opt, this is just a
212 /// shortcut for specifying RegisterPass...
214 template<typename PassName>
215 struct RegisterOpt : public RegisterPassBase {
216 RegisterOpt(const char *PassArg, const char *Name, bool CFGOnly = false)
217 : RegisterPassBase(Name, PassArg, typeid(PassName),
218 callDefaultCtor<PassName>) {
219 if (CFGOnly) setOnlyUsesCFG();
222 /// Register Pass using default constructor explicitly...
224 RegisterOpt(const char *PassArg, const char *Name, Pass *(*ctor)(),
225 bool CFGOnly = false)
226 : RegisterPassBase(Name, PassArg, typeid(PassName), ctor) {
227 if (CFGOnly) setOnlyUsesCFG();
230 /// Register FunctionPass using default constructor explicitly...
232 RegisterOpt(const char *PassArg, const char *Name, FunctionPass *(*ctor)(),
233 bool CFGOnly = false)
234 : RegisterPassBase(Name, PassArg, typeid(PassName),
235 static_cast<Pass*(*)()>(ctor)) {
236 if (CFGOnly) setOnlyUsesCFG();
239 /// Register Pass using TargetMachine constructor...
241 RegisterOpt(const char *PassArg, const char *Name,
242 Pass *(*targetctor)(TargetMachine &), bool CFGOnly = false)
243 : RegisterPassBase(Name, PassArg, typeid(PassName), 0, targetctor) {
244 if (CFGOnly) setOnlyUsesCFG();
247 /// Register FunctionPass using TargetMachine constructor...
249 RegisterOpt(const char *PassArg, const char *Name,
250 FunctionPass *(*targetctor)(TargetMachine &),
251 bool CFGOnly = false)
252 : RegisterPassBase(Name, PassArg, typeid(PassName), 0,
253 static_cast<Pass*(*)(TargetMachine&)>(targetctor)) {
254 if (CFGOnly) setOnlyUsesCFG();
259 /// RegisterAnalysisGroup - Register a Pass as a member of an analysis _group_.
260 /// Analysis groups are used to define an interface (which need not derive from
261 /// Pass) that is required by passes to do their job. Analysis Groups differ
262 /// from normal analyses because any available implementation of the group will
263 /// be used if it is available.
265 /// If no analysis implementing the interface is available, a default
266 /// implementation is created and added. A pass registers itself as the default
267 /// implementation by specifying 'true' as the third template argument of this
270 /// In addition to registering itself as an analysis group member, a pass must
271 /// register itself normally as well. Passes may be members of multiple groups
272 /// and may still be "required" specifically by name.
274 /// The actual interface may also be registered as well (by not specifying the
275 /// second template argument). The interface should be registered to associate
276 /// a nice name with the interface.
278 class RegisterAGBase : public RegisterPassBase {
279 PassInfo *InterfaceInfo;
280 const PassInfo *ImplementationInfo;
281 bool isDefaultImplementation;
283 RegisterAGBase(const std::type_info &Interface,
284 const std::type_info *Pass = 0,
285 bool isDefault = false);
286 void setGroupName(const char *Name);
292 template<typename Interface, typename DefaultImplementationPass = void,
293 bool Default = false>
294 struct RegisterAnalysisGroup : public RegisterAGBase {
295 RegisterAnalysisGroup() : RegisterAGBase(typeid(Interface),
296 &typeid(DefaultImplementationPass),
301 /// Define a specialization of RegisterAnalysisGroup that is used to set the
302 /// name for the analysis group.
304 template<typename Interface>
305 struct RegisterAnalysisGroup<Interface, void, false> : public RegisterAGBase {
306 RegisterAnalysisGroup(const char *Name)
307 : RegisterAGBase(typeid(Interface)) {
314 //===---------------------------------------------------------------------------
315 /// PassRegistrationListener class - This class is meant to be derived from by
316 /// clients that are interested in which passes get registered and unregistered
317 /// at runtime (which can be because of the RegisterPass constructors being run
318 /// as the program starts up, or may be because a shared object just got
319 /// loaded). Deriving from the PassRegistationListener class automatically
320 /// registers your object to receive callbacks indicating when passes are loaded
323 struct PassRegistrationListener {
325 /// PassRegistrationListener ctor - Add the current object to the list of
326 /// PassRegistrationListeners...
327 PassRegistrationListener();
329 /// dtor - Remove object from list of listeners...
331 virtual ~PassRegistrationListener();
333 /// Callback functions - These functions are invoked whenever a pass is loaded
334 /// or removed from the current executable.
336 virtual void passRegistered(const PassInfo *P) {}
337 virtual void passUnregistered(const PassInfo *P) {}
339 /// enumeratePasses - Iterate over the registered passes, calling the
340 /// passEnumerate callback on each PassInfo object.
342 void enumeratePasses();
344 /// passEnumerate - Callback function invoked when someone calls
345 /// enumeratePasses on this PassRegistrationListener object.
347 virtual void passEnumerate(const PassInfo *P) {}
351 } // End llvm namespace