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 #include "llvm/System/IncludeFile.h"
25 // No need to include Pass.h, we are being included by it!
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.
38 const char *PassName; // Nice name for Pass
39 const char *PassArgument; // Command Line argument to run this pass
41 bool IsCFGOnlyPass; // Pass only looks at the CFG.
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)
52 : PassName(name), PassArgument(arg), PassID(pi),
53 IsCFGOnlyPass(isCFGOnly), IsAnalysisGroup(false), NormalCtor(normal) {
56 /// getPassName - Return the friendly name for the pass, never returns null
58 const char *getPassName() const { return PassName; }
59 void setPassName(const char *Name) { PassName = Name; }
61 /// getPassArgument - Return the command line option that may be passed to
62 /// 'opt' that will cause this pass to be run. This will return null if there
65 const char *getPassArgument() const { return PassArgument; }
67 /// getTypeInfo - Return the id object for the pass...
69 intptr_t getTypeInfo() const { return PassID; }
71 /// isAnalysisGroup - Return true if this is an analysis group, not a normal
74 bool isAnalysisGroup() const { return IsAnalysisGroup; }
75 void SetIsAnalysisGroup() { IsAnalysisGroup = true; }
77 /// isCFGOnlyPass - return true if this pass only looks at the CFG for the
79 bool isCFGOnlyPass() const { return IsCFGOnlyPass; }
81 /// getNormalCtor - Return a pointer to a function, that when called, creates
82 /// an instance of the pass and returns it. This pointer may be null if there
83 /// is no default constructor for the pass.
85 Pass *(*getNormalCtor() const)() {
88 void setNormalCtor(Pass *(*Ctor)()) {
92 /// createPass() - Use this method to create an instance of this pass.
93 Pass *createPass() const {
94 assert((!isAnalysisGroup() || NormalCtor) &&
95 "No default implementation found for analysis group!");
97 "Cannot call createPass on PassInfo without default ctor!");
101 /// addInterfaceImplemented - This method is called when this pass is
102 /// registered as a member of an analysis group with the RegisterAnalysisGroup
105 void addInterfaceImplemented(const PassInfo *ItfPI) {
106 ItfImpl.push_back(ItfPI);
109 /// getInterfacesImplemented - Return a list of all of the analysis group
110 /// interfaces implemented by this pass.
112 const std::vector<const PassInfo*> &getInterfacesImplemented() const {
118 //===---------------------------------------------------------------------------
119 /// RegisterPass<t> template - This template class is used to notify the system
120 /// that a Pass is available for use, and registers it into the internal
121 /// database maintained by the PassManager. Unless this template is used, opt,
122 /// for example will not be able to see the pass and attempts to create the pass
123 /// will fail. This template is used in the follow manner (at global scope, in
126 /// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name");
128 /// This statement will cause your pass to be created by calling the default
129 /// constructor exposed by the pass. If you have a different constructor that
130 /// must be called, create a global constructor function (which takes the
131 /// arguments you need and returns a Pass*) and register your pass like this:
133 /// static RegisterPass<PassClassName> tmp("passopt", "My Name");
135 struct RegisterPassBase {
136 /// getPassInfo - Get the pass info for the registered class...
138 const PassInfo *getPassInfo() const { return &PIObj; }
140 typedef Pass* (*NormalCtor_t)();
142 RegisterPassBase(const char *Name, const char *Arg, intptr_t TI,
143 NormalCtor_t NormalCtor = 0, bool CFGOnly = false)
144 : PIObj(Name, Arg, TI, NormalCtor, CFGOnly) {
147 RegisterPassBase(intptr_t TI)
148 : PIObj("", "", TI) {
149 // This ctor may only be used for analysis groups: it does not auto-register
151 PIObj.SetIsAnalysisGroup();
155 PassInfo PIObj; // The PassInfo object for this pass
157 void unregisterPass();
160 template<typename PassName>
161 Pass *callDefaultCtor() { return new PassName(); }
163 template<typename PassName>
164 struct RegisterPass : public RegisterPassBase {
166 // Register Pass using default constructor...
167 RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false)
168 : RegisterPassBase(Name, PassArg, intptr_t(&PassName::ID),
169 RegisterPassBase::NormalCtor_t(callDefaultCtor<PassName>), CFGOnly) {
174 /// RegisterAnalysisGroup - Register a Pass as a member of an analysis _group_.
175 /// Analysis groups are used to define an interface (which need not derive from
176 /// Pass) that is required by passes to do their job. Analysis Groups differ
177 /// from normal analyses because any available implementation of the group will
178 /// be used if it is available.
180 /// If no analysis implementing the interface is available, a default
181 /// implementation is created and added. A pass registers itself as the default
182 /// implementation by specifying 'true' as the third template argument of this
185 /// In addition to registering itself as an analysis group member, a pass must
186 /// register itself normally as well. Passes may be members of multiple groups
187 /// and may still be "required" specifically by name.
189 /// The actual interface may also be registered as well (by not specifying the
190 /// second template argument). The interface should be registered to associate
191 /// a nice name with the interface.
193 class RegisterAGBase : public RegisterPassBase {
194 PassInfo *InterfaceInfo;
195 const PassInfo *ImplementationInfo;
196 bool isDefaultImplementation;
198 explicit RegisterAGBase(intptr_t InterfaceID,
200 bool isDefault = false);
201 void setGroupName(const char *Name);
204 template<typename Interface, bool Default = false>
205 struct RegisterAnalysisGroup : public RegisterAGBase {
206 explicit RegisterAnalysisGroup(RegisterPassBase &RPB)
207 : RegisterAGBase(intptr_t(&Interface::ID), RPB.getPassInfo()->getTypeInfo(),
211 explicit RegisterAnalysisGroup(const char *Name)
212 : RegisterAGBase(intptr_t(&Interface::ID)) {
219 //===---------------------------------------------------------------------------
220 /// PassRegistrationListener class - This class is meant to be derived from by
221 /// clients that are interested in which passes get registered and unregistered
222 /// at runtime (which can be because of the RegisterPass constructors being run
223 /// as the program starts up, or may be because a shared object just got
224 /// loaded). Deriving from the PassRegistationListener class automatically
225 /// registers your object to receive callbacks indicating when passes are loaded
228 struct PassRegistrationListener {
230 /// PassRegistrationListener ctor - Add the current object to the list of
231 /// PassRegistrationListeners...
232 PassRegistrationListener();
234 /// dtor - Remove object from list of listeners...
236 virtual ~PassRegistrationListener();
238 /// Callback functions - These functions are invoked whenever a pass is loaded
239 /// or removed from the current executable.
241 virtual void passRegistered(const PassInfo *P) {}
243 /// enumeratePasses - Iterate over the registered passes, calling the
244 /// passEnumerate callback on each PassInfo object.
246 void enumeratePasses();
248 /// passEnumerate - Callback function invoked when someone calls
249 /// enumeratePasses on this PassRegistrationListener object.
251 virtual void passEnumerate(const PassInfo *P) {}
255 } // End llvm namespace