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"
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.
39 typedef Pass* (*NormalCtor_t)();
42 const char *const PassName; // Nice name for Pass
43 const char *const PassArgument; // Command Line argument to run this pass
45 const bool IsCFGOnlyPass; // Pass only looks at the CFG.
46 const bool IsAnalysis; // True if an analysis pass.
47 const bool IsAnalysisGroup; // True if an analysis group.
48 std::vector<const PassInfo*> ItfImpl;// Interfaces implemented by this pass
50 NormalCtor_t NormalCtor;
53 /// PassInfo ctor - Do not call this directly, this should only be invoked
54 /// through RegisterPass.
55 PassInfo(const char *name, const char *arg, const void *pi,
56 NormalCtor_t normal, bool isCFGOnly, bool is_analysis)
57 : PassName(name), PassArgument(arg), PassID(pi),
58 IsCFGOnlyPass(isCFGOnly),
59 IsAnalysis(is_analysis), IsAnalysisGroup(false), NormalCtor(normal) {
60 PassRegistry::getPassRegistry()->registerPass(*this);
62 /// PassInfo ctor - Do not call this directly, this should only be invoked
63 /// through RegisterPass. This version is for use by analysis groups; it
64 /// does not auto-register the pass.
65 PassInfo(const char *name, const void *pi)
66 : PassName(name), PassArgument(""), PassID(pi),
68 IsAnalysis(false), IsAnalysisGroup(true), NormalCtor(0) {
71 /// getPassName - Return the friendly name for the pass, never returns null
73 const char *getPassName() const { return PassName; }
75 /// getPassArgument - Return the command line option that may be passed to
76 /// 'opt' that will cause this pass to be run. This will return null if there
79 const char *getPassArgument() const { return PassArgument; }
81 /// getTypeInfo - Return the id object for the pass...
83 const void *getTypeInfo() const { return PassID; }
85 /// Return true if this PassID implements the specified ID pointer.
86 bool isPassID(const void *IDPtr) const {
87 return PassID == IDPtr;
90 /// isAnalysisGroup - Return true if this is an analysis group, not a normal
93 bool isAnalysisGroup() const { return IsAnalysisGroup; }
94 bool isAnalysis() const { return IsAnalysis; }
96 /// isCFGOnlyPass - return true if this pass only looks at the CFG for the
98 bool isCFGOnlyPass() const { return IsCFGOnlyPass; }
100 /// getNormalCtor - Return a pointer to a function, that when called, creates
101 /// an instance of the pass and returns it. This pointer may be null if there
102 /// is no default constructor for the pass.
104 NormalCtor_t getNormalCtor() const {
107 void setNormalCtor(NormalCtor_t Ctor) {
111 /// createPass() - Use this method to create an instance of this pass.
112 Pass *createPass() const;
114 /// addInterfaceImplemented - This method is called when this pass is
115 /// registered as a member of an analysis group with the RegisterAnalysisGroup
118 void addInterfaceImplemented(const PassInfo *ItfPI) {
119 ItfImpl.push_back(ItfPI);
122 /// getInterfacesImplemented - Return a list of all of the analysis group
123 /// interfaces implemented by this pass.
125 const std::vector<const PassInfo*> &getInterfacesImplemented() const {
130 void operator=(const PassInfo &); // do not implement
131 PassInfo(const PassInfo &); // do not implement
134 #define INITIALIZE_PASS(passName, arg, name, cfg, analysis) \
135 static RegisterPass<passName> passName ## _info(arg, name, cfg, analysis)
137 template<typename PassName>
138 Pass *callDefaultCtor() { return new PassName(); }
140 //===---------------------------------------------------------------------------
141 /// RegisterPass<t> template - This template class is used to notify the system
142 /// that a Pass is available for use, and registers it into the internal
143 /// database maintained by the PassManager. Unless this template is used, opt,
144 /// for example will not be able to see the pass and attempts to create the pass
145 /// will fail. This template is used in the follow manner (at global scope, in
148 /// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name");
150 /// This statement will cause your pass to be created by calling the default
151 /// constructor exposed by the pass. If you have a different constructor that
152 /// must be called, create a global constructor function (which takes the
153 /// arguments you need and returns a Pass*) and register your pass like this:
155 /// static RegisterPass<PassClassName> tmp("passopt", "My Name");
157 template<typename passName>
158 struct RegisterPass : public PassInfo {
160 // Register Pass using default constructor...
161 RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false,
162 bool is_analysis = false)
163 : PassInfo(Name, PassArg, &passName::ID,
164 PassInfo::NormalCtor_t(callDefaultCtor<passName>),
165 CFGOnly, is_analysis) {
171 /// RegisterAnalysisGroup - Register a Pass as a member of an analysis _group_.
172 /// Analysis groups are used to define an interface (which need not derive from
173 /// Pass) that is required by passes to do their job. Analysis Groups differ
174 /// from normal analyses because any available implementation of the group will
175 /// be used if it is available.
177 /// If no analysis implementing the interface is available, a default
178 /// implementation is created and added. A pass registers itself as the default
179 /// implementation by specifying 'true' as the second template argument of this
182 /// In addition to registering itself as an analysis group member, a pass must
183 /// register itself normally as well. Passes may be members of multiple groups
184 /// and may still be "required" specifically by name.
186 /// The actual interface may also be registered as well (by not specifying the
187 /// second template argument). The interface should be registered to associate
188 /// a nice name with the interface.
190 class RegisterAGBase : public PassInfo {
192 RegisterAGBase(const char *Name,
193 const void *InterfaceID,
194 const void *PassID = 0,
195 bool isDefault = false);
198 template<typename Interface, bool Default = false>
199 struct RegisterAnalysisGroup : public RegisterAGBase {
200 explicit RegisterAnalysisGroup(PassInfo &RPB)
201 : RegisterAGBase(RPB.getPassName(),
202 &Interface::ID, RPB.getTypeInfo(),
206 explicit RegisterAnalysisGroup(const char *Name)
207 : RegisterAGBase(Name, &Interface::ID) {
211 #define INITIALIZE_AG_PASS(passName, agName, arg, name, cfg, analysis, def) \
212 static RegisterPass<passName> passName ## _info(arg, name, cfg, analysis); \
213 static RegisterAnalysisGroup<agName, def> passName ## _ag(passName ## _info)
215 //===---------------------------------------------------------------------------
216 /// PassRegistrationListener class - This class is meant to be derived from by
217 /// clients that are interested in which passes get registered and unregistered
218 /// at runtime (which can be because of the RegisterPass constructors being run
219 /// as the program starts up, or may be because a shared object just got
220 /// loaded). Deriving from the PassRegistationListener class automatically
221 /// registers your object to receive callbacks indicating when passes are loaded
224 struct PassRegistrationListener {
226 /// PassRegistrationListener ctor - Add the current object to the list of
227 /// PassRegistrationListeners...
228 PassRegistrationListener();
230 /// dtor - Remove object from list of listeners...
232 virtual ~PassRegistrationListener();
234 /// Callback functions - These functions are invoked whenever a pass is loaded
235 /// or removed from the current executable.
237 virtual void passRegistered(const PassInfo *) {}
239 /// enumeratePasses - Iterate over the registered passes, calling the
240 /// passEnumerate callback on each PassInfo object.
242 void enumeratePasses();
244 /// passEnumerate - Callback function invoked when someone calls
245 /// enumeratePasses on this PassRegistrationListener object.
247 virtual void passEnumerate(const PassInfo *) {}
251 } // End llvm namespace