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
24 // No need to include Pass.h, we are being included by it!
30 //===---------------------------------------------------------------------------
31 /// PassInfo class - An instance of this class exists for every pass known by
32 /// the system, and can be obtained from a live Pass by calling its
33 /// getPassInfo() method. These objects are set up by the RegisterPass<>
34 /// template, defined below.
37 const char *PassName; // Nice name for Pass
38 const char *PassArgument; // Command Line argument to run this pass
40 bool IsCFGOnlyPass; // Pass only looks at the CFG.
41 bool IsAnalysis; // True if an analysis pass.
42 bool IsAnalysisGroup; // True if an analysis group.
43 std::vector<const PassInfo*> ItfImpl;// Interfaces implemented by this pass
45 Pass *(*NormalCtor)();
48 /// PassInfo ctor - Do not call this directly, this should only be invoked
49 /// through RegisterPass.
50 PassInfo(const char *name, const char *arg, intptr_t pi,
51 Pass *(*normal)() = 0, bool isCFGOnly = false, bool isAnalysis = false)
52 : PassName(name), PassArgument(arg), PassID(pi),
53 IsCFGOnlyPass(isCFGOnly),
54 IsAnalysis(isAnalysis), IsAnalysisGroup(false), NormalCtor(normal) {
57 /// getPassName - Return the friendly name for the pass, never returns null
59 const char *getPassName() const { return PassName; }
60 void setPassName(const char *Name) { PassName = Name; }
62 /// getPassArgument - Return the command line option that may be passed to
63 /// 'opt' that will cause this pass to be run. This will return null if there
66 const char *getPassArgument() const { return PassArgument; }
68 /// getTypeInfo - Return the id object for the pass...
70 intptr_t getTypeInfo() const { return PassID; }
72 /// isAnalysisGroup - Return true if this is an analysis group, not a normal
75 bool isAnalysisGroup() const { return IsAnalysisGroup; }
76 bool isAnalysis() const { return IsAnalysis; }
77 void SetIsAnalysisGroup() { IsAnalysisGroup = true; }
79 /// isCFGOnlyPass - return true if this pass only looks at the CFG for the
81 bool isCFGOnlyPass() const { return IsCFGOnlyPass; }
83 /// getNormalCtor - Return a pointer to a function, that when called, creates
84 /// an instance of the pass and returns it. This pointer may be null if there
85 /// is no default constructor for the pass.
87 Pass *(*getNormalCtor() const)() {
90 void setNormalCtor(Pass *(*Ctor)()) {
94 /// createPass() - Use this method to create an instance of this pass.
95 Pass *createPass() const {
96 assert((!isAnalysisGroup() || NormalCtor) &&
97 "No default implementation found for analysis group!");
99 "Cannot call createPass on PassInfo without default ctor!");
103 /// addInterfaceImplemented - This method is called when this pass is
104 /// registered as a member of an analysis group with the RegisterAnalysisGroup
107 void addInterfaceImplemented(const PassInfo *ItfPI) {
108 ItfImpl.push_back(ItfPI);
111 /// getInterfacesImplemented - Return a list of all of the analysis group
112 /// interfaces implemented by this pass.
114 const std::vector<const PassInfo*> &getInterfacesImplemented() const {
120 //===---------------------------------------------------------------------------
121 /// RegisterPass<t> template - This template class is used to notify the system
122 /// that a Pass is available for use, and registers it into the internal
123 /// database maintained by the PassManager. Unless this template is used, opt,
124 /// for example will not be able to see the pass and attempts to create the pass
125 /// will fail. This template is used in the follow manner (at global scope, in
128 /// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name");
130 /// This statement will cause your pass to be created by calling the default
131 /// constructor exposed by the pass. If you have a different constructor that
132 /// must be called, create a global constructor function (which takes the
133 /// arguments you need and returns a Pass*) and register your pass like this:
135 /// static RegisterPass<PassClassName> tmp("passopt", "My Name");
137 struct RegisterPassBase {
138 /// getPassInfo - Get the pass info for the registered class...
140 const PassInfo *getPassInfo() const { return &PIObj; }
142 typedef Pass* (*NormalCtor_t)();
144 RegisterPassBase(const char *Name, const char *Arg, intptr_t TI,
145 NormalCtor_t NormalCtor = 0, bool CFGOnly = false,
146 bool IsAnalysis = false)
147 : PIObj(Name, Arg, TI, NormalCtor, CFGOnly, IsAnalysis) {
150 explicit RegisterPassBase(intptr_t TI)
151 : PIObj("", "", TI) {
152 // This ctor may only be used for analysis groups: it does not auto-register
154 PIObj.SetIsAnalysisGroup();
158 PassInfo PIObj; // The PassInfo object for this pass
160 void unregisterPass();
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, bool CFGOnly = false,
171 bool IsAnalysis = false)
172 : RegisterPassBase(Name, PassArg, intptr_t(&PassName::ID),
173 RegisterPassBase::NormalCtor_t(callDefaultCtor<PassName>),
174 CFGOnly, IsAnalysis) {
179 /// RegisterAnalysisGroup - Register a Pass as a member of an analysis _group_.
180 /// Analysis groups are used to define an interface (which need not derive from
181 /// Pass) that is required by passes to do their job. Analysis Groups differ
182 /// from normal analyses because any available implementation of the group will
183 /// be used if it is available.
185 /// If no analysis implementing the interface is available, a default
186 /// implementation is created and added. A pass registers itself as the default
187 /// implementation by specifying 'true' as the third template argument of this
190 /// In addition to registering itself as an analysis group member, a pass must
191 /// register itself normally as well. Passes may be members of multiple groups
192 /// and may still be "required" specifically by name.
194 /// The actual interface may also be registered as well (by not specifying the
195 /// second template argument). The interface should be registered to associate
196 /// a nice name with the interface.
198 class RegisterAGBase : public RegisterPassBase {
199 PassInfo *InterfaceInfo;
200 const PassInfo *ImplementationInfo;
201 bool isDefaultImplementation;
203 explicit RegisterAGBase(intptr_t InterfaceID,
205 bool isDefault = false);
206 void setGroupName(const char *Name);
209 template<typename Interface, bool Default = false>
210 struct RegisterAnalysisGroup : public RegisterAGBase {
211 explicit RegisterAnalysisGroup(RegisterPassBase &RPB)
212 : RegisterAGBase(intptr_t(&Interface::ID), RPB.getPassInfo()->getTypeInfo(),
216 explicit RegisterAnalysisGroup(const char *Name)
217 : RegisterAGBase(intptr_t(&Interface::ID)) {
224 //===---------------------------------------------------------------------------
225 /// PassRegistrationListener class - This class is meant to be derived from by
226 /// clients that are interested in which passes get registered and unregistered
227 /// at runtime (which can be because of the RegisterPass constructors being run
228 /// as the program starts up, or may be because a shared object just got
229 /// loaded). Deriving from the PassRegistationListener class automatically
230 /// registers your object to receive callbacks indicating when passes are loaded
233 struct PassRegistrationListener {
235 /// PassRegistrationListener ctor - Add the current object to the list of
236 /// PassRegistrationListeners...
237 PassRegistrationListener();
239 /// dtor - Remove object from list of listeners...
241 virtual ~PassRegistrationListener();
243 /// Callback functions - These functions are invoked whenever a pass is loaded
244 /// or removed from the current executable.
246 virtual void passRegistered(const PassInfo *P) {}
248 /// enumeratePasses - Iterate over the registered passes, calling the
249 /// passEnumerate callback on each PassInfo object.
251 void enumeratePasses();
253 /// passEnumerate - Callback function invoked when someone calls
254 /// enumeratePasses on this PassRegistrationListener object.
256 virtual void passEnumerate(const PassInfo *P) {}
260 } // End llvm namespace