PassSupport.h revision 325e2643559fcec8b0396dfa16e415cc86a22a09
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#include "Pass.h" 25#include "llvm/PassRegistry.h" 26#include "llvm/InitializePasses.h" 27#include "llvm/Support/Compiler.h" 28#include <vector> 29 30namespace llvm { 31 32//===--------------------------------------------------------------------------- 33/// PassInfo class - An instance of this class exists for every pass known by 34/// the system, and can be obtained from a live Pass by calling its 35/// getPassInfo() method. These objects are set up by the RegisterPass<> 36/// template, defined below. 37/// 38class PassInfo { 39public: 40 typedef Pass* (*NormalCtor_t)(); 41 42private: 43 const char *const PassName; // Nice name for Pass 44 const char *const PassArgument; // Command Line argument to run this pass 45 const void *PassID; 46 const bool IsCFGOnlyPass; // Pass only looks at the CFG. 47 const bool IsAnalysis; // True if an analysis pass. 48 const bool IsAnalysisGroup; // True if an analysis group. 49 std::vector<const PassInfo*> ItfImpl;// Interfaces implemented by this pass 50 51 NormalCtor_t NormalCtor; 52 53public: 54 /// PassInfo ctor - Do not call this directly, this should only be invoked 55 /// through RegisterPass. 56 PassInfo(const char *name, const char *arg, const void *pi, 57 NormalCtor_t normal, bool isCFGOnly, bool is_analysis) 58 : PassName(name), PassArgument(arg), PassID(pi), 59 IsCFGOnlyPass(isCFGOnly), 60 IsAnalysis(is_analysis), IsAnalysisGroup(false), NormalCtor(normal) { } 61 /// PassInfo ctor - Do not call this directly, this should only be invoked 62 /// through RegisterPass. This version is for use by analysis groups; it 63 /// does not auto-register the pass. 64 PassInfo(const char *name, const void *pi) 65 : PassName(name), PassArgument(""), PassID(pi), 66 IsCFGOnlyPass(false), 67 IsAnalysis(false), IsAnalysisGroup(true), NormalCtor(0) { } 68 69 /// getPassName - Return the friendly name for the pass, never returns null 70 /// 71 const char *getPassName() const { return PassName; } 72 73 /// getPassArgument - Return the command line option that may be passed to 74 /// 'opt' that will cause this pass to be run. This will return null if there 75 /// is no argument. 76 /// 77 const char *getPassArgument() const { return PassArgument; } 78 79 /// getTypeInfo - Return the id object for the pass... 80 /// TODO : Rename 81 const void *getTypeInfo() const { return PassID; } 82 83 /// Return true if this PassID implements the specified ID pointer. 84 bool isPassID(const void *IDPtr) const { 85 return PassID == IDPtr; 86 } 87 88 /// isAnalysisGroup - Return true if this is an analysis group, not a normal 89 /// pass. 90 /// 91 bool isAnalysisGroup() const { return IsAnalysisGroup; } 92 bool isAnalysis() const { return IsAnalysis; } 93 94 /// isCFGOnlyPass - return true if this pass only looks at the CFG for the 95 /// function. 96 bool isCFGOnlyPass() const { return IsCFGOnlyPass; } 97 98 /// getNormalCtor - Return a pointer to a function, that when called, creates 99 /// an instance of the pass and returns it. This pointer may be null if there 100 /// is no default constructor for the pass. 101 /// 102 NormalCtor_t getNormalCtor() const { 103 return NormalCtor; 104 } 105 void setNormalCtor(NormalCtor_t Ctor) { 106 NormalCtor = Ctor; 107 } 108 109 /// createPass() - Use this method to create an instance of this pass. 110 Pass *createPass() const; 111 112 /// addInterfaceImplemented - This method is called when this pass is 113 /// registered as a member of an analysis group with the RegisterAnalysisGroup 114 /// template. 115 /// 116 void addInterfaceImplemented(const PassInfo *ItfPI) { 117 ItfImpl.push_back(ItfPI); 118 } 119 120 /// getInterfacesImplemented - Return a list of all of the analysis group 121 /// interfaces implemented by this pass. 122 /// 123 const std::vector<const PassInfo*> &getInterfacesImplemented() const { 124 return ItfImpl; 125 } 126 127private: 128 void operator=(const PassInfo &); // do not implement 129 PassInfo(const PassInfo &); // do not implement 130}; 131 132#define INITIALIZE_PASS(passName, arg, name, cfg, analysis) \ 133 static void* initialize##passName##PassOnce(PassRegistry &Registry) { \ 134 PassInfo *PI = new PassInfo(name, arg, & passName ::ID, \ 135 PassInfo::NormalCtor_t(callDefaultCtor< passName >), cfg, analysis); \ 136 Registry.registerPass(*PI); \ 137 return PI; \ 138 } \ 139 void llvm::initialize##passName##Pass(PassRegistry &Registry) { \ 140 ATTRIBUTE_USED \ 141 static void* initialized = initialize##passName##PassOnce(Registry); \ 142 } \ 143 static RegisterPass<passName> passName ## _info(arg, name, cfg, analysis); 144 145#define INITIALIZE_PASS_BEGIN(passName, arg, name, cfg, analysis) \ 146 static void* initialize##passName##PassOnce(PassRegistry &Registry) { 147 148#define INITIALIZE_PASS_DEPENDENCY(depName) \ 149 initialize##depName##Pass(Registry); 150#define INITIALIZE_AG_DEPENDENCY(depName) \ 151 initialize##depName##AnalysisGroup(Registry); 152 153#define INITIALIZE_PASS_END(passName, arg, name, cfg, analysis) \ 154 PassInfo *PI = new PassInfo(name, arg, & passName ::ID, \ 155 PassInfo::NormalCtor_t(callDefaultCtor< passName >), cfg, analysis); \ 156 Registry.registerPass(*PI); \ 157 return PI; \ 158 } \ 159 void llvm::initialize##passName##Pass(PassRegistry &Registry) { \ 160 ATTRIBUTE_USED \ 161 static void* initialized = initialize##passName##PassOnce(Registry); \ 162 } \ 163 static RegisterPass<passName> passName ## _info(arg, name, cfg, analysis); 164 165template<typename PassName> 166Pass *callDefaultCtor() { return new PassName(); } 167 168//===--------------------------------------------------------------------------- 169/// RegisterPass<t> template - This template class is used to notify the system 170/// that a Pass is available for use, and registers it into the internal 171/// database maintained by the PassManager. Unless this template is used, opt, 172/// for example will not be able to see the pass and attempts to create the pass 173/// will fail. This template is used in the follow manner (at global scope, in 174/// your .cpp file): 175/// 176/// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name"); 177/// 178/// This statement will cause your pass to be created by calling the default 179/// constructor exposed by the pass. If you have a different constructor that 180/// must be called, create a global constructor function (which takes the 181/// arguments you need and returns a Pass*) and register your pass like this: 182/// 183/// static RegisterPass<PassClassName> tmp("passopt", "My Name"); 184/// 185template<typename passName> 186struct RegisterPass : public PassInfo { 187 188 // Register Pass using default constructor... 189 RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false, 190 bool is_analysis = false) 191 : PassInfo(Name, PassArg, &passName::ID, 192 PassInfo::NormalCtor_t(callDefaultCtor<passName>), 193 CFGOnly, is_analysis) { 194 PassRegistry::getPassRegistry()->registerPass(*this); 195 } 196}; 197 198 199/// RegisterAnalysisGroup - Register a Pass as a member of an analysis _group_. 200/// Analysis groups are used to define an interface (which need not derive from 201/// Pass) that is required by passes to do their job. Analysis Groups differ 202/// from normal analyses because any available implementation of the group will 203/// be used if it is available. 204/// 205/// If no analysis implementing the interface is available, a default 206/// implementation is created and added. A pass registers itself as the default 207/// implementation by specifying 'true' as the second template argument of this 208/// class. 209/// 210/// In addition to registering itself as an analysis group member, a pass must 211/// register itself normally as well. Passes may be members of multiple groups 212/// and may still be "required" specifically by name. 213/// 214/// The actual interface may also be registered as well (by not specifying the 215/// second template argument). The interface should be registered to associate 216/// a nice name with the interface. 217/// 218class RegisterAGBase : public PassInfo { 219public: 220 RegisterAGBase(const char *Name, 221 const void *InterfaceID, 222 const void *PassID = 0, 223 bool isDefault = false); 224}; 225 226template<typename Interface, bool Default = false> 227struct RegisterAnalysisGroup : public RegisterAGBase { 228 explicit RegisterAnalysisGroup(PassInfo &RPB) 229 : RegisterAGBase(RPB.getPassName(), 230 &Interface::ID, RPB.getTypeInfo(), 231 Default) { 232 } 233 234 explicit RegisterAnalysisGroup(const char *Name) 235 : RegisterAGBase(Name, &Interface::ID) { 236 } 237}; 238 239#define INITIALIZE_ANALYSIS_GROUP(agName, name, defaultPass) \ 240 static void* initialize##agName##AnalysisGroupOnce(PassRegistry &Registry) { \ 241 initialize##defaultPass##Pass(Registry); \ 242 PassInfo *AI = new PassInfo(name, & agName :: ID); \ 243 Registry.registerAnalysisGroup(& agName ::ID, 0, *AI, false); \ 244 return AI; \ 245 } \ 246 void llvm::initialize##agName##AnalysisGroup(PassRegistry &Registry) { \ 247 ATTRIBUTE_USED static void* initialized = \ 248 initialize##agName##AnalysisGroupOnce(Registry); \ 249 } \ 250 static RegisterAnalysisGroup<agName> agName##_info (name); 251 252#define INITIALIZE_AG_PASS(passName, agName, arg, name, cfg, analysis, def) \ 253 static void* initialize##passName##PassOnce(PassRegistry &Registry) { \ 254 initialize##agName##AnalysisGroup(Registry); \ 255 PassInfo *PI = new PassInfo(name, arg, & passName ::ID, \ 256 PassInfo::NormalCtor_t(callDefaultCtor< passName >), cfg, analysis); \ 257 Registry.registerPass(*PI); \ 258 \ 259 PassInfo *AI = new PassInfo(name, & agName :: ID); \ 260 Registry.registerAnalysisGroup(& agName ::ID, & passName ::ID, *AI, def); \ 261 return AI; \ 262 } \ 263 void llvm::initialize##passName##Pass(PassRegistry &Registry) { \ 264 ATTRIBUTE_USED \ 265 static void* initialized = initialize##passName##PassOnce(Registry); \ 266 } \ 267 static RegisterPass<passName> passName ## _info(arg, name, cfg, analysis); \ 268 static RegisterAnalysisGroup<agName, def> passName ## _ag(passName ## _info); 269 270#define INITIALIZE_AG_PASS_BEGIN(passName, agName, arg, n, cfg, analysis, def) \ 271 static void* initialize##passName##PassOnce(PassRegistry &Registry) { \ 272 initialize##agName##AnalysisGroup(Registry); 273 274#define INITIALIZE_AG_PASS_END(passName, agName, arg, n, cfg, analysis, def) \ 275 PassInfo *PI = new PassInfo(n, arg, & passName ::ID, \ 276 PassInfo::NormalCtor_t(callDefaultCtor< passName >), cfg, analysis); \ 277 Registry.registerPass(*PI); \ 278 \ 279 PassInfo *AI = new PassInfo(n, & agName :: ID); \ 280 Registry.registerAnalysisGroup(& agName ::ID, & passName ::ID, *AI, def); \ 281 return AI; \ 282 } \ 283 void llvm::initialize##passName##Pass(PassRegistry &Registry) { \ 284 ATTRIBUTE_USED \ 285 static void* initialized = initialize##passName##PassOnce(Registry); \ 286 } \ 287 static RegisterPass<passName> passName ## _info(arg, n, cfg, analysis); \ 288 static RegisterAnalysisGroup<agName, def> passName ## _ag(passName ## _info); 289 290//===--------------------------------------------------------------------------- 291/// PassRegistrationListener class - This class is meant to be derived from by 292/// clients that are interested in which passes get registered and unregistered 293/// at runtime (which can be because of the RegisterPass constructors being run 294/// as the program starts up, or may be because a shared object just got 295/// loaded). Deriving from the PassRegistationListener class automatically 296/// registers your object to receive callbacks indicating when passes are loaded 297/// and removed. 298/// 299struct PassRegistrationListener { 300 301 /// PassRegistrationListener ctor - Add the current object to the list of 302 /// PassRegistrationListeners... 303 PassRegistrationListener(); 304 305 /// dtor - Remove object from list of listeners... 306 /// 307 virtual ~PassRegistrationListener(); 308 309 /// Callback functions - These functions are invoked whenever a pass is loaded 310 /// or removed from the current executable. 311 /// 312 virtual void passRegistered(const PassInfo *) {} 313 314 /// enumeratePasses - Iterate over the registered passes, calling the 315 /// passEnumerate callback on each PassInfo object. 316 /// 317 void enumeratePasses(); 318 319 /// passEnumerate - Callback function invoked when someone calls 320 /// enumeratePasses on this PassRegistrationListener object. 321 /// 322 virtual void passEnumerate(const PassInfo *) {} 323}; 324 325 326} // End llvm namespace 327 328#endif 329