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
44 const intptr_t PassID;
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, intptr_t pi,
56 NormalCtor_t normal = 0,
57 bool isCFGOnly = false, bool is_analysis = false)
58 : PassName(name), PassArgument(arg), PassID(pi),
59 IsCFGOnlyPass(isCFGOnly),
60 IsAnalysis(is_analysis), IsAnalysisGroup(false), NormalCtor(normal) {
61 PassRegistry::getPassRegistry()->registerPass(*this);
63 /// PassInfo ctor - Do not call this directly, this should only be invoked
64 /// through RegisterPass. This version is for use by analysis groups; it
65 /// does not auto-register the pass.
66 PassInfo(const char *name, intptr_t pi)
67 : PassName(name), PassArgument(""), PassID(pi),
69 IsAnalysis(false), IsAnalysisGroup(true), NormalCtor(0) {
72 /// getPassName - Return the friendly name for the pass, never returns null
74 const char *getPassName() const { return PassName; }
76 /// getPassArgument - Return the command line option that may be passed to
77 /// 'opt' that will cause this pass to be run. This will return null if there
80 const char *getPassArgument() const { return PassArgument; }
82 /// getTypeInfo - Return the id object for the pass...
84 intptr_t getTypeInfo() const { return PassID; }
86 /// Return true if this PassID implements the specified ID pointer.
87 bool isPassID(void *IDPtr) const {
88 return PassID == (intptr_t)IDPtr;
91 /// isAnalysisGroup - Return true if this is an analysis group, not a normal
94 bool isAnalysisGroup() const { return IsAnalysisGroup; }
95 bool isAnalysis() const { return IsAnalysis; }
97 /// isCFGOnlyPass - return true if this pass only looks at the CFG for the
99 bool isCFGOnlyPass() const { return IsCFGOnlyPass; }
101 /// getNormalCtor - Return a pointer to a function, that when called, creates
102 /// an instance of the pass and returns it. This pointer may be null if there
103 /// is no default constructor for the pass.
105 NormalCtor_t getNormalCtor() const {
108 void setNormalCtor(NormalCtor_t Ctor) {
112 /// createPass() - Use this method to create an instance of this pass.
113 Pass *createPass() const;
115 /// addInterfaceImplemented - This method is called when this pass is
116 /// registered as a member of an analysis group with the RegisterAnalysisGroup
119 void addInterfaceImplemented(const PassInfo *ItfPI) {
120 ItfImpl.push_back(ItfPI);
123 /// getInterfacesImplemented - Return a list of all of the analysis group
124 /// interfaces implemented by this pass.
126 const std::vector<const PassInfo*> &getInterfacesImplemented() const {
131 void operator=(const PassInfo &); // do not implement
132 PassInfo(const PassInfo &); // do not implement
135 #define INITIALIZE_PASS(passName, arg, name, cfg, analysis) \
136 static RegisterPass<passName> passName ## _info(arg, name, cfg, analysis)
138 template<typename PassName>
139 Pass *callDefaultCtor() { return new PassName(); }
141 //===---------------------------------------------------------------------------
142 /// RegisterPass<t> template - This template class is used to notify the system
143 /// that a Pass is available for use, and registers it into the internal
144 /// database maintained by the PassManager. Unless this template is used, opt,
145 /// for example will not be able to see the pass and attempts to create the pass
146 /// will fail. This template is used in the follow manner (at global scope, in
149 /// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name");
151 /// This statement will cause your pass to be created by calling the default
152 /// constructor exposed by the pass. If you have a different constructor that
153 /// must be called, create a global constructor function (which takes the
154 /// arguments you need and returns a Pass*) and register your pass like this:
156 /// static RegisterPass<PassClassName> tmp("passopt", "My Name");
158 template<typename passName>
159 struct RegisterPass : public PassInfo {
161 // Register Pass using default constructor...
162 RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false,
163 bool is_analysis = false)
164 : PassInfo(Name, PassArg, intptr_t(&passName::ID),
165 PassInfo::NormalCtor_t(callDefaultCtor<passName>),
166 CFGOnly, is_analysis) {
172 /// RegisterAnalysisGroup - Register a Pass as a member of an analysis _group_.
173 /// Analysis groups are used to define an interface (which need not derive from
174 /// Pass) that is required by passes to do their job. Analysis Groups differ
175 /// from normal analyses because any available implementation of the group will
176 /// be used if it is available.
178 /// If no analysis implementing the interface is available, a default
179 /// implementation is created and added. A pass registers itself as the default
180 /// implementation by specifying 'true' as the second template argument of this
183 /// In addition to registering itself as an analysis group member, a pass must
184 /// register itself normally as well. Passes may be members of multiple groups
185 /// and may still be "required" specifically by name.
187 /// The actual interface may also be registered as well (by not specifying the
188 /// second template argument). The interface should be registered to associate
189 /// a nice name with the interface.
191 class RegisterAGBase : public PassInfo {
193 RegisterAGBase(const char *Name,
194 intptr_t InterfaceID,
196 bool isDefault = false);
199 template<typename Interface, bool Default = false>
200 struct RegisterAnalysisGroup : public RegisterAGBase {
201 explicit RegisterAnalysisGroup(PassInfo &RPB)
202 : RegisterAGBase(RPB.getPassName(),
203 intptr_t(&Interface::ID), RPB.getTypeInfo(),
207 explicit RegisterAnalysisGroup(const char *Name)
208 : RegisterAGBase(Name, intptr_t(&Interface::ID)) {
212 #define INITIALIZE_AG_PASS(passName, agName, arg, name, cfg, analysis, def) \
213 static RegisterPass<passName> passName ## _info(arg, name, cfg, analysis); \
214 static RegisterAnalysisGroup<agName, def> passName ## _ag(passName ## _info)
216 //===---------------------------------------------------------------------------
217 /// PassRegistrationListener class - This class is meant to be derived from by
218 /// clients that are interested in which passes get registered and unregistered
219 /// at runtime (which can be because of the RegisterPass constructors being run
220 /// as the program starts up, or may be because a shared object just got
221 /// loaded). Deriving from the PassRegistationListener class automatically
222 /// registers your object to receive callbacks indicating when passes are loaded
225 struct PassRegistrationListener {
227 /// PassRegistrationListener ctor - Add the current object to the list of
228 /// PassRegistrationListeners...
229 PassRegistrationListener();
231 /// dtor - Remove object from list of listeners...
233 virtual ~PassRegistrationListener();
235 /// Callback functions - These functions are invoked whenever a pass is loaded
236 /// or removed from the current executable.
238 virtual void passRegistered(const PassInfo *) {}
240 /// enumeratePasses - Iterate over the registered passes, calling the
241 /// passEnumerate callback on each PassInfo object.
243 void enumeratePasses();
245 /// passEnumerate - Callback function invoked when someone calls
246 /// enumeratePasses on this PassRegistrationListener object.
248 virtual void passEnumerate(const PassInfo *) {}
252 } // End llvm namespace