PassSupport.h revision 13d57320bd212483463d4f8992d5787b29eda5df
1//===- llvm/PassSupport.h - Pass Support code -------------------*- C++ -*-===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// This file defines stuff that is used to define and "use" Passes. This file 11// is automatically #included by Pass.h, so: 12// 13// NO .CPP FILES SHOULD INCLUDE THIS FILE DIRECTLY 14// 15// Instead, #include Pass.h. 16// 17// This file defines Pass registration code and classes used for it. 18// 19//===----------------------------------------------------------------------===// 20 21#ifndef LLVM_PASS_SUPPORT_H 22#define LLVM_PASS_SUPPORT_H 23 24// No need to include Pass.h, we are being included by it! 25 26namespace llvm { 27 28class TargetMachine; 29 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. 35/// 36class PassInfo { 37public: 38 typedef Pass* (*NormalCtor_t)(); 39 40private: 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 48 49 NormalCtor_t NormalCtor; 50 51public: 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) { 60 registerPass(); 61 } 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), 67 IsCFGOnlyPass(false), 68 IsAnalysis(false), IsAnalysisGroup(true), NormalCtor(0) { 69 } 70 71 /// getPassName - Return the friendly name for the pass, never returns null 72 /// 73 const char *getPassName() const { return PassName; } 74 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 77 /// is no argument. 78 /// 79 const char *getPassArgument() const { return PassArgument; } 80 81 /// getTypeInfo - Return the id object for the pass... 82 /// TODO : Rename 83 intptr_t getTypeInfo() const { return PassID; } 84 85 /// isAnalysisGroup - Return true if this is an analysis group, not a normal 86 /// pass. 87 /// 88 bool isAnalysisGroup() const { return IsAnalysisGroup; } 89 bool isAnalysis() const { return IsAnalysis; } 90 91 /// isCFGOnlyPass - return true if this pass only looks at the CFG for the 92 /// function. 93 bool isCFGOnlyPass() const { return IsCFGOnlyPass; } 94 95 /// getNormalCtor - Return a pointer to a function, that when called, creates 96 /// an instance of the pass and returns it. This pointer may be null if there 97 /// is no default constructor for the pass. 98 /// 99 NormalCtor_t getNormalCtor() const { 100 return NormalCtor; 101 } 102 void setNormalCtor(NormalCtor_t Ctor) { 103 NormalCtor = Ctor; 104 } 105 106 /// createPass() - Use this method to create an instance of this pass. 107 Pass *createPass() const { 108 assert((!isAnalysisGroup() || NormalCtor) && 109 "No default implementation found for analysis group!"); 110 assert(NormalCtor && 111 "Cannot call createPass on PassInfo without default ctor!"); 112 return NormalCtor(); 113 } 114 115 /// addInterfaceImplemented - This method is called when this pass is 116 /// registered as a member of an analysis group with the RegisterAnalysisGroup 117 /// template. 118 /// 119 void addInterfaceImplemented(const PassInfo *ItfPI) { 120 ItfImpl.push_back(ItfPI); 121 } 122 123 /// getInterfacesImplemented - Return a list of all of the analysis group 124 /// interfaces implemented by this pass. 125 /// 126 const std::vector<const PassInfo*> &getInterfacesImplemented() const { 127 return ItfImpl; 128 } 129 130 /// getPassInfo - Deprecated API compaatibility function. This function 131 /// just returns 'this'. 132 /// 133 const PassInfo *getPassInfo() const { 134 return this; 135 } 136 137protected: 138 void registerPass(); 139 void unregisterPass(); 140 141private: 142 void operator=(const PassInfo &); // do not implement 143 PassInfo(const PassInfo &); // do not implement 144}; 145 146 147template<typename PassName> 148Pass *callDefaultCtor() { return new PassName(); } 149 150//===--------------------------------------------------------------------------- 151/// RegisterPass<t> template - This template class is used to notify the system 152/// that a Pass is available for use, and registers it into the internal 153/// database maintained by the PassManager. Unless this template is used, opt, 154/// for example will not be able to see the pass and attempts to create the pass 155/// will fail. This template is used in the follow manner (at global scope, in 156/// your .cpp file): 157/// 158/// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name"); 159/// 160/// This statement will cause your pass to be created by calling the default 161/// constructor exposed by the pass. If you have a different constructor that 162/// must be called, create a global constructor function (which takes the 163/// arguments you need and returns a Pass*) and register your pass like this: 164/// 165/// static RegisterPass<PassClassName> tmp("passopt", "My Name"); 166/// 167template<typename passName> 168struct RegisterPass : public PassInfo { 169 170 // Register Pass using default constructor... 171 RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false, 172 bool is_analysis = false) 173 : PassInfo(Name, PassArg, intptr_t(&passName::ID), 174 PassInfo::NormalCtor_t(callDefaultCtor<passName>), 175 CFGOnly, is_analysis) { 176 } 177}; 178 179 180/// RegisterAnalysisGroup - Register a Pass as a member of an analysis _group_. 181/// Analysis groups are used to define an interface (which need not derive from 182/// Pass) that is required by passes to do their job. Analysis Groups differ 183/// from normal analyses because any available implementation of the group will 184/// be used if it is available. 185/// 186/// If no analysis implementing the interface is available, a default 187/// implementation is created and added. A pass registers itself as the default 188/// implementation by specifying 'true' as the third template argument of this 189/// class. 190/// 191/// In addition to registering itself as an analysis group member, a pass must 192/// register itself normally as well. Passes may be members of multiple groups 193/// and may still be "required" specifically by name. 194/// 195/// The actual interface may also be registered as well (by not specifying the 196/// second template argument). The interface should be registered to associate 197/// a nice name with the interface. 198/// 199class RegisterAGBase : public PassInfo { 200 PassInfo *InterfaceInfo; 201 const PassInfo *ImplementationInfo; 202 bool isDefaultImplementation; 203protected: 204 explicit RegisterAGBase(const char *Name, 205 intptr_t InterfaceID, 206 intptr_t PassID = 0, 207 bool isDefault = false); 208}; 209 210template<typename Interface, bool Default = false> 211struct RegisterAnalysisGroup : public RegisterAGBase { 212 explicit RegisterAnalysisGroup(PassInfo &RPB) 213 : RegisterAGBase(RPB.getPassName(), 214 intptr_t(&Interface::ID), RPB.getTypeInfo(), 215 Default) { 216 } 217 218 explicit RegisterAnalysisGroup(const char *Name) 219 : RegisterAGBase(Name, intptr_t(&Interface::ID)) { 220 } 221}; 222 223 224 225//===--------------------------------------------------------------------------- 226/// PassRegistrationListener class - This class is meant to be derived from by 227/// clients that are interested in which passes get registered and unregistered 228/// at runtime (which can be because of the RegisterPass constructors being run 229/// as the program starts up, or may be because a shared object just got 230/// loaded). Deriving from the PassRegistationListener class automatically 231/// registers your object to receive callbacks indicating when passes are loaded 232/// and removed. 233/// 234struct PassRegistrationListener { 235 236 /// PassRegistrationListener ctor - Add the current object to the list of 237 /// PassRegistrationListeners... 238 PassRegistrationListener(); 239 240 /// dtor - Remove object from list of listeners... 241 /// 242 virtual ~PassRegistrationListener(); 243 244 /// Callback functions - These functions are invoked whenever a pass is loaded 245 /// or removed from the current executable. 246 /// 247 virtual void passRegistered(const PassInfo *) {} 248 249 /// enumeratePasses - Iterate over the registered passes, calling the 250 /// passEnumerate callback on each PassInfo object. 251 /// 252 void enumeratePasses(); 253 254 /// passEnumerate - Callback function invoked when someone calls 255 /// enumeratePasses on this PassRegistrationListener object. 256 /// 257 virtual void passEnumerate(const PassInfo *) {} 258}; 259 260 261} // End llvm namespace 262 263#endif 264