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
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.
38 typedef Pass* (*NormalCtor_t)();
41 const char *const PassName; // Nice name for Pass
42 const char *const PassArgument; // Command Line argument to run this pass
43 const intptr_t PassID;
44 const bool IsCFGOnlyPass; // Pass only looks at the CFG.
45 const bool IsAnalysis; // True if an analysis pass.
46 const bool IsAnalysisGroup; // True if an analysis group.
47 std::vector<const PassInfo*> ItfImpl;// Interfaces implemented by this pass
49 NormalCtor_t NormalCtor;
52 /// PassInfo ctor - Do not call this directly, this should only be invoked
53 /// through RegisterPass.
54 PassInfo(const char *name, const char *arg, intptr_t pi,
55 NormalCtor_t normal = 0,
56 bool isCFGOnly = false, bool is_analysis = false)
57 : PassName(name), PassArgument(arg), PassID(pi),
58 IsCFGOnlyPass(isCFGOnly),
59 IsAnalysis(is_analysis), IsAnalysisGroup(false), NormalCtor(normal) {
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, intptr_t 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 intptr_t getTypeInfo() const { return PassID; }
85 /// Return true if this PassID implements the specified ID pointer.
86 bool isPassID(void *IDPtr) const {
87 return PassID == (intptr_t)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 {
113 assert((!isAnalysisGroup() || NormalCtor) &&
114 "No default implementation found for analysis group!");
116 "Cannot call createPass on PassInfo without default ctor!");
120 /// addInterfaceImplemented - This method is called when this pass is
121 /// registered as a member of an analysis group with the RegisterAnalysisGroup
124 void addInterfaceImplemented(const PassInfo *ItfPI) {
125 ItfImpl.push_back(ItfPI);
128 /// getInterfacesImplemented - Return a list of all of the analysis group
129 /// interfaces implemented by this pass.
131 const std::vector<const PassInfo*> &getInterfacesImplemented() const {
137 void unregisterPass();
140 void operator=(const PassInfo &); // do not implement
141 PassInfo(const PassInfo &); // do not implement
145 template<typename PassName>
146 Pass *callDefaultCtor() { return new PassName(); }
148 //===---------------------------------------------------------------------------
149 /// RegisterPass<t> template - This template class is used to notify the system
150 /// that a Pass is available for use, and registers it into the internal
151 /// database maintained by the PassManager. Unless this template is used, opt,
152 /// for example will not be able to see the pass and attempts to create the pass
153 /// will fail. This template is used in the follow manner (at global scope, in
156 /// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name");
158 /// This statement will cause your pass to be created by calling the default
159 /// constructor exposed by the pass. If you have a different constructor that
160 /// must be called, create a global constructor function (which takes the
161 /// arguments you need and returns a Pass*) and register your pass like this:
163 /// static RegisterPass<PassClassName> tmp("passopt", "My Name");
165 template<typename passName>
166 struct RegisterPass : public PassInfo {
168 // Register Pass using default constructor...
169 RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false,
170 bool is_analysis = false)
171 : PassInfo(Name, PassArg, intptr_t(&passName::ID),
172 PassInfo::NormalCtor_t(callDefaultCtor<passName>),
173 CFGOnly, is_analysis) {
178 /// RegisterAnalysisGroup - Register a Pass as a member of an analysis _group_.
179 /// Analysis groups are used to define an interface (which need not derive from
180 /// Pass) that is required by passes to do their job. Analysis Groups differ
181 /// from normal analyses because any available implementation of the group will
182 /// be used if it is available.
184 /// If no analysis implementing the interface is available, a default
185 /// implementation is created and added. A pass registers itself as the default
186 /// implementation by specifying 'true' as the second template argument of this
189 /// In addition to registering itself as an analysis group member, a pass must
190 /// register itself normally as well. Passes may be members of multiple groups
191 /// and may still be "required" specifically by name.
193 /// The actual interface may also be registered as well (by not specifying the
194 /// second template argument). The interface should be registered to associate
195 /// a nice name with the interface.
197 class RegisterAGBase : public PassInfo {
199 RegisterAGBase(const char *Name,
200 intptr_t InterfaceID,
202 bool isDefault = false);
205 template<typename Interface, bool Default = false>
206 struct RegisterAnalysisGroup : public RegisterAGBase {
207 explicit RegisterAnalysisGroup(PassInfo &RPB)
208 : RegisterAGBase(RPB.getPassName(),
209 intptr_t(&Interface::ID), RPB.getTypeInfo(),
213 explicit RegisterAnalysisGroup(const char *Name)
214 : RegisterAGBase(Name, intptr_t(&Interface::ID)) {
220 //===---------------------------------------------------------------------------
221 /// PassRegistrationListener class - This class is meant to be derived from by
222 /// clients that are interested in which passes get registered and unregistered
223 /// at runtime (which can be because of the RegisterPass constructors being run
224 /// as the program starts up, or may be because a shared object just got
225 /// loaded). Deriving from the PassRegistationListener class automatically
226 /// registers your object to receive callbacks indicating when passes are loaded
229 struct PassRegistrationListener {
231 /// PassRegistrationListener ctor - Add the current object to the list of
232 /// PassRegistrationListeners...
233 PassRegistrationListener();
235 /// dtor - Remove object from list of listeners...
237 virtual ~PassRegistrationListener();
239 /// Callback functions - These functions are invoked whenever a pass is loaded
240 /// or removed from the current executable.
242 virtual void passRegistered(const PassInfo *) {}
244 /// enumeratePasses - Iterate over the registered passes, calling the
245 /// passEnumerate callback on each PassInfo object.
247 void enumeratePasses();
249 /// passEnumerate - Callback function invoked when someone calls
250 /// enumeratePasses on this PassRegistrationListener object.
252 virtual void passEnumerate(const PassInfo *) {}
256 } // End llvm namespace