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
19 // No need to include Pass.h, we are being included by it!
23 //===---------------------------------------------------------------------------
24 /// PassInfo class - An instance of this class exists for every pass known by
25 /// the system, and can be obtained from a live Pass by calling its
26 /// getPassInfo() method. These objects are set up by the RegisterPass<>
27 /// template, defined below.
30 const char *PassName; // Nice name for Pass
31 const char *PassArgument; // Command Line argument to run this pass
32 const std::type_info &TypeInfo; // type_info object for this Pass class
33 unsigned char PassType; // Set of enums values below...
34 std::vector<const PassInfo*> ItfImpl;// Interfaces implemented by this pass
36 Pass *(*NormalCtor)(); // No argument ctor
37 Pass *(*TargetCtor)(TargetMachine&); // Ctor taking TargetMachine object...
40 /// PassType - Define symbolic constants that can be used to test to see if
41 /// this pass should be listed by analyze or opt. Passes can use none, one or
42 /// many of these flags or'd together. It is not legal to combine the
43 /// AnalysisGroup flag with others.
46 Analysis = 1, Optimization = 2, LLC = 4, AnalysisGroup = 8
49 /// PassInfo ctor - Do not call this directly, this should only be invoked
50 /// through RegisterPass.
51 PassInfo(const char *name, const char *arg, const std::type_info &ti,
52 unsigned pt, Pass *(*normal)() = 0,
53 Pass *(*targetctor)(TargetMachine &) = 0)
54 : PassName(name), PassArgument(arg), TypeInfo(ti), PassType(pt),
55 NormalCtor(normal), TargetCtor(targetctor) {
58 /// getPassName - Return the friendly name for the pass, never returns null
60 const char *getPassName() const { return PassName; }
61 void setPassName(const char *Name) { PassName = Name; }
63 /// getPassArgument - Return the command line option that may be passed to
64 /// 'opt' that will cause this pass to be run. This will return null if there
67 const char *getPassArgument() const { return PassArgument; }
69 /// getTypeInfo - Return the type_info object for the pass...
71 const std::type_info &getTypeInfo() const { return TypeInfo; }
73 /// getPassType - Return the PassType of a pass. Note that this can be
74 /// several different types or'd together. This is _strictly_ for use by opt,
75 /// analyze and llc for deciding which passes to use as command line options.
77 unsigned getPassType() const { return PassType; }
79 /// getNormalCtor - Return a pointer to a function, that when called, creates
80 /// an instance of the pass and returns it. This pointer may be null if there
81 /// is no default constructor for the pass.
83 Pass *(*getNormalCtor() const)() {
86 void setNormalCtor(Pass *(*Ctor)()) {
90 /// createPass() - Use this method to create an instance of this pass.
91 Pass *createPass() const {
92 assert((PassType != AnalysisGroup || NormalCtor) &&
93 "No default implementation found for analysis group!");
95 "Cannot call createPass on PassInfo without default ctor!");
99 /// getTargetCtor - Return a pointer to a function that creates an instance of
100 /// the pass and returns it. This returns a constructor for a version of the
101 /// pass that takes a TargetMachine object as a parameter.
103 Pass *(*getTargetCtor() const)(TargetMachine &) {
107 /// addInterfaceImplemented - This method is called when this pass is
108 /// registered as a member of an analysis group with the RegisterAnalysisGroup
111 void addInterfaceImplemented(const PassInfo *ItfPI) {
112 ItfImpl.push_back(ItfPI);
115 /// getInterfacesImplemented - Return a list of all of the analysis group
116 /// interfaces implemented by this pass.
118 const std::vector<const PassInfo*> &getInterfacesImplemented() const {
124 //===---------------------------------------------------------------------------
125 /// RegisterPass<t> template - This template class is used to notify the system
126 /// that a Pass is available for use, and registers it into the internal
127 /// database maintained by the PassManager. Unless this template is used, opt,
128 /// for example will not be able to see the pass and attempts to create the pass
129 /// will fail. This template is used in the follow manner (at global scope, in
132 /// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name");
134 /// This statement will cause your pass to be created by calling the default
135 /// constructor exposed by the pass. If you have a different constructor that
136 /// must be called, create a global constructor function (which takes the
137 /// arguments you need and returns a Pass*) and register your pass like this:
139 /// Pass *createMyPass(foo &opt) { return new MyPass(opt); }
140 /// static RegisterPass<PassClassName> tmp("passopt", "My Name", createMyPass);
142 struct RegisterPassBase {
143 /// getPassInfo - Get the pass info for the registered class...
145 const PassInfo *getPassInfo() const { return PIObj; }
147 RegisterPassBase() : PIObj(0) {}
148 ~RegisterPassBase() { // Intentionally non-virtual...
149 if (PIObj) unregisterPass(PIObj);
153 PassInfo *PIObj; // The PassInfo object for this pass
154 void registerPass(PassInfo *);
155 void unregisterPass(PassInfo *);
157 /// setPreservesCFG - Notice that this pass only depends on the CFG, so
158 /// transformations that do not modify the CFG do not invalidate this pass.
160 void setPreservesCFG();
163 template<typename PassName>
164 Pass *callDefaultCtor() { return new PassName(); }
166 template<typename PassName>
167 struct RegisterPass : public RegisterPassBase {
169 // Register Pass using default constructor...
170 RegisterPass(const char *PassArg, const char *Name, unsigned PassTy = 0) {
171 registerPass(new PassInfo(Name, PassArg, typeid(PassName), PassTy,
172 callDefaultCtor<PassName>));
175 // Register Pass using default constructor explicitly...
176 RegisterPass(const char *PassArg, const char *Name, unsigned PassTy,
178 registerPass(new PassInfo(Name, PassArg, typeid(PassName), PassTy, ctor));
181 // Register Pass using TargetMachine constructor...
182 RegisterPass(const char *PassArg, const char *Name, unsigned PassTy,
183 Pass *(*targetctor)(TargetMachine &)) {
184 registerPass(new PassInfo(Name, PassArg, typeid(PassName), PassTy,
188 // Generic constructor version that has an unknown ctor type...
189 template<typename CtorType>
190 RegisterPass(const char *PassArg, const char *Name, unsigned PassTy,
192 registerPass(new PassInfo(Name, PassArg, typeid(PassName), PassTy, 0));
196 /// RegisterOpt - Register something that is to show up in Opt, this is just a
197 /// shortcut for specifying RegisterPass...
199 template<typename PassName>
200 struct RegisterOpt : public RegisterPassBase {
201 RegisterOpt(const char *PassArg, const char *Name) {
202 registerPass(new PassInfo(Name, PassArg, typeid(PassName),
203 PassInfo::Optimization,
204 callDefaultCtor<PassName>));
207 /// Register Pass using default constructor explicitly...
209 RegisterOpt(const char *PassArg, const char *Name, Pass *(*ctor)()) {
210 registerPass(new PassInfo(Name, PassArg, typeid(PassName),
211 PassInfo::Optimization, ctor));
214 /// Register Pass using TargetMachine constructor...
216 RegisterOpt(const char *PassArg, const char *Name,
217 Pass *(*targetctor)(TargetMachine &)) {
218 registerPass(new PassInfo(Name, PassArg, typeid(PassName),
219 PassInfo::Optimization, 0, targetctor));
223 /// RegisterAnalysis - Register something that is to show up in Analysis, this
224 /// is just a shortcut for specifying RegisterPass... Analyses take a special
225 /// argument that, when set to true, tells the system that the analysis ONLY
226 /// depends on the shape of the CFG, so if a transformation preserves the CFG
227 /// that the analysis is not invalidated.
229 template<typename PassName>
230 struct RegisterAnalysis : public RegisterPassBase {
231 RegisterAnalysis(const char *PassArg, const char *Name,
232 bool CFGOnly = false) {
233 registerPass(new PassInfo(Name, PassArg, typeid(PassName),
235 callDefaultCtor<PassName>));
241 /// RegisterLLC - Register something that is to show up in LLC, this is just a
242 /// shortcut for specifying RegisterPass...
244 template<typename PassName>
245 struct RegisterLLC : public RegisterPassBase {
246 RegisterLLC(const char *PassArg, const char *Name) {
247 registerPass(new PassInfo(Name, PassArg, typeid(PassName),
249 callDefaultCtor<PassName>));
252 /// Register Pass using default constructor explicitly...
254 RegisterLLC(const char *PassArg, const char *Name, Pass *(*ctor)()) {
255 registerPass(new PassInfo(Name, PassArg, typeid(PassName),
256 PassInfo::LLC, ctor));
259 /// Register Pass using TargetMachine constructor...
261 RegisterLLC(const char *PassArg, const char *Name,
262 Pass *(*datactor)(TargetMachine &)) {
263 registerPass(new PassInfo(Name, PassArg, typeid(PassName),
269 /// RegisterAnalysisGroup - Register a Pass as a member of an analysis _group_.
270 /// Analysis groups are used to define an interface (which need not derive from
271 /// Pass) that is required by passes to do their job. Analysis Groups differ
272 /// from normal analyses because any available implementation of the group will
273 /// be used if it is available.
275 /// If no analysis implementing the interface is available, a default
276 /// implementation is created and added. A pass registers itself as the default
277 /// implementation by specifying 'true' as the third template argument of this
280 /// In addition to registering itself as an analysis group member, a pass must
281 /// register itself normally as well. Passes may be members of multiple groups
282 /// and may still be "required" specifically by name.
284 /// The actual interface may also be registered as well (by not specifying the
285 /// second template argument). The interface should be registered to associate
286 /// a nice name with the interface.
288 class RegisterAGBase : public RegisterPassBase {
289 PassInfo *InterfaceInfo;
290 const PassInfo *ImplementationInfo;
291 bool isDefaultImplementation;
293 RegisterAGBase(const std::type_info &Interface,
294 const std::type_info *Pass = 0,
295 bool isDefault = false);
296 void setGroupName(const char *Name);
302 template<typename Interface, typename DefaultImplementationPass = void,
303 bool Default = false>
304 struct RegisterAnalysisGroup : public RegisterAGBase {
305 RegisterAnalysisGroup() : RegisterAGBase(typeid(Interface),
306 &typeid(DefaultImplementationPass),
311 /// Define a specialization of RegisterAnalysisGroup that is used to set the
312 /// name for the analysis group.
314 template<typename Interface>
315 struct RegisterAnalysisGroup<Interface, void, false> : public RegisterAGBase {
316 RegisterAnalysisGroup(const char *Name)
317 : RegisterAGBase(typeid(Interface)) {
324 //===---------------------------------------------------------------------------
325 /// PassRegistrationListener class - This class is meant to be derived from by
326 /// clients that are interested in which passes get registered and unregistered
327 /// at runtime (which can be because of the RegisterPass constructors being run
328 /// as the program starts up, or may be because a shared object just got
329 /// loaded). Deriving from the PassRegistationListener class automatically
330 /// registers your object to receive callbacks indicating when passes are loaded
333 struct PassRegistrationListener {
335 /// PassRegistrationListener ctor - Add the current object to the list of
336 /// PassRegistrationListeners...
337 PassRegistrationListener();
339 /// dtor - Remove object from list of listeners...
341 virtual ~PassRegistrationListener();
343 /// Callback functions - These functions are invoked whenever a pass is loaded
344 /// or removed from the current executable.
346 virtual void passRegistered(const PassInfo *P) {}
347 virtual void passUnregistered(const PassInfo *P) {}
349 /// enumeratePasses - Iterate over the registered passes, calling the
350 /// passEnumerate callback on each PassInfo object.
352 void enumeratePasses();
354 /// passEnumerate - Callback function invoked when someone calls
355 /// enumeratePasses on this PassRegistrationListener object.
357 virtual void passEnumerate(const PassInfo *P) {}
361 //===---------------------------------------------------------------------------
362 /// IncludeFile class - This class is used as a hack to make sure that the
363 /// implementation of a header file is included into a tool that uses the
364 /// header. This is solely to overcome problems linking .a files and not
365 /// getting the implementation of passes we need.