PassSupport.h revision 081c34b725980f995be9080eaec24cd3dfaaf065
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/System/Atomic.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 static volatile sys::cas_flag initialized = 0; \ 141 sys::cas_flag old_val = sys::CompareAndSwap(&initialized, 1, 0); \ 142 if (old_val == 0) { \ 143 initialize##passName##PassOnce(Registry); \ 144 sys::MemoryFence(); \ 145 initialized = 2; \ 146 } else { \ 147 sys::cas_flag tmp = initialized; \ 148 sys::MemoryFence(); \ 149 while (tmp != 2) { \ 150 tmp = initialized; \ 151 sys::MemoryFence(); \ 152 } \ 153 } \ 154 } 155 156#define INITIALIZE_PASS_BEGIN(passName, arg, name, cfg, analysis) \ 157 static void* initialize##passName##PassOnce(PassRegistry &Registry) { 158 159#define INITIALIZE_PASS_DEPENDENCY(depName) \ 160 initialize##depName##Pass(Registry); 161#define INITIALIZE_AG_DEPENDENCY(depName) \ 162 initialize##depName##AnalysisGroup(Registry); 163 164#define INITIALIZE_PASS_END(passName, arg, name, cfg, analysis) \ 165 PassInfo *PI = new PassInfo(name, arg, & passName ::ID, \ 166 PassInfo::NormalCtor_t(callDefaultCtor< passName >), cfg, analysis); \ 167 Registry.registerPass(*PI); \ 168 return PI; \ 169 } \ 170 void llvm::initialize##passName##Pass(PassRegistry &Registry) { \ 171 static volatile sys::cas_flag initialized = 0; \ 172 sys::cas_flag old_val = sys::CompareAndSwap(&initialized, 1, 0); \ 173 if (old_val == 0) { \ 174 initialize##passName##PassOnce(Registry); \ 175 sys::MemoryFence(); \ 176 initialized = 2; \ 177 } else { \ 178 sys::cas_flag tmp = initialized; \ 179 sys::MemoryFence(); \ 180 while (tmp != 2) { \ 181 tmp = initialized; \ 182 sys::MemoryFence(); \ 183 } \ 184 } \ 185 } 186 187template<typename PassName> 188Pass *callDefaultCtor() { return new PassName(); } 189 190//===--------------------------------------------------------------------------- 191/// RegisterPass<t> template - This template class is used to notify the system 192/// that a Pass is available for use, and registers it into the internal 193/// database maintained by the PassManager. Unless this template is used, opt, 194/// for example will not be able to see the pass and attempts to create the pass 195/// will fail. This template is used in the follow manner (at global scope, in 196/// your .cpp file): 197/// 198/// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name"); 199/// 200/// This statement will cause your pass to be created by calling the default 201/// constructor exposed by the pass. If you have a different constructor that 202/// must be called, create a global constructor function (which takes the 203/// arguments you need and returns a Pass*) and register your pass like this: 204/// 205/// static RegisterPass<PassClassName> tmp("passopt", "My Name"); 206/// 207template<typename passName> 208struct RegisterPass : public PassInfo { 209 210 // Register Pass using default constructor... 211 RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false, 212 bool is_analysis = false) 213 : PassInfo(Name, PassArg, &passName::ID, 214 PassInfo::NormalCtor_t(callDefaultCtor<passName>), 215 CFGOnly, is_analysis) { 216 PassRegistry::getPassRegistry()->registerPass(*this); 217 } 218}; 219 220 221/// RegisterAnalysisGroup - Register a Pass as a member of an analysis _group_. 222/// Analysis groups are used to define an interface (which need not derive from 223/// Pass) that is required by passes to do their job. Analysis Groups differ 224/// from normal analyses because any available implementation of the group will 225/// be used if it is available. 226/// 227/// If no analysis implementing the interface is available, a default 228/// implementation is created and added. A pass registers itself as the default 229/// implementation by specifying 'true' as the second template argument of this 230/// class. 231/// 232/// In addition to registering itself as an analysis group member, a pass must 233/// register itself normally as well. Passes may be members of multiple groups 234/// and may still be "required" specifically by name. 235/// 236/// The actual interface may also be registered as well (by not specifying the 237/// second template argument). The interface should be registered to associate 238/// a nice name with the interface. 239/// 240class RegisterAGBase : public PassInfo { 241public: 242 RegisterAGBase(const char *Name, 243 const void *InterfaceID, 244 const void *PassID = 0, 245 bool isDefault = false); 246}; 247 248template<typename Interface, bool Default = false> 249struct RegisterAnalysisGroup : public RegisterAGBase { 250 explicit RegisterAnalysisGroup(PassInfo &RPB) 251 : RegisterAGBase(RPB.getPassName(), 252 &Interface::ID, RPB.getTypeInfo(), 253 Default) { 254 } 255 256 explicit RegisterAnalysisGroup(const char *Name) 257 : RegisterAGBase(Name, &Interface::ID) { 258 } 259}; 260 261#define INITIALIZE_ANALYSIS_GROUP(agName, name, defaultPass) \ 262 static void* initialize##agName##AnalysisGroupOnce(PassRegistry &Registry) { \ 263 initialize##defaultPass##Pass(Registry); \ 264 PassInfo *AI = new PassInfo(name, & agName :: ID); \ 265 Registry.registerAnalysisGroup(& agName ::ID, 0, *AI, false); \ 266 return AI; \ 267 } \ 268 void llvm::initialize##agName##AnalysisGroup(PassRegistry &Registry) { \ 269 static volatile sys::cas_flag initialized = 0; \ 270 sys::cas_flag old_val = sys::CompareAndSwap(&initialized, 1, 0); \ 271 if (old_val == 0) { \ 272 initialize##agName##AnalysisGroupOnce(Registry); \ 273 sys::MemoryFence(); \ 274 initialized = 2; \ 275 } else { \ 276 sys::cas_flag tmp = initialized; \ 277 sys::MemoryFence(); \ 278 while (tmp != 2) { \ 279 tmp = initialized; \ 280 sys::MemoryFence(); \ 281 } \ 282 } \ 283 } 284 285 286#define INITIALIZE_AG_PASS(passName, agName, arg, name, cfg, analysis, def) \ 287 static void* initialize##passName##PassOnce(PassRegistry &Registry) { \ 288 if (!def) initialize##agName##AnalysisGroup(Registry); \ 289 PassInfo *PI = new PassInfo(name, arg, & passName ::ID, \ 290 PassInfo::NormalCtor_t(callDefaultCtor< passName >), cfg, analysis); \ 291 Registry.registerPass(*PI); \ 292 \ 293 PassInfo *AI = new PassInfo(name, & agName :: ID); \ 294 Registry.registerAnalysisGroup(& agName ::ID, & passName ::ID, *AI, def); \ 295 return AI; \ 296 } \ 297 void llvm::initialize##passName##Pass(PassRegistry &Registry) { \ 298 static volatile sys::cas_flag initialized = 0; \ 299 sys::cas_flag old_val = sys::CompareAndSwap(&initialized, 1, 0); \ 300 if (old_val == 0) { \ 301 initialize##passName##PassOnce(Registry); \ 302 sys::MemoryFence(); \ 303 initialized = 2; \ 304 } else { \ 305 sys::cas_flag tmp = initialized; \ 306 sys::MemoryFence(); \ 307 while (tmp != 2) { \ 308 tmp = initialized; \ 309 sys::MemoryFence(); \ 310 } \ 311 } \ 312 } 313 314 315#define INITIALIZE_AG_PASS_BEGIN(passName, agName, arg, n, cfg, analysis, def) \ 316 static void* initialize##passName##PassOnce(PassRegistry &Registry) { \ 317 if (!def) initialize##agName##AnalysisGroup(Registry); 318 319#define INITIALIZE_AG_PASS_END(passName, agName, arg, n, cfg, analysis, def) \ 320 PassInfo *PI = new PassInfo(n, arg, & passName ::ID, \ 321 PassInfo::NormalCtor_t(callDefaultCtor< passName >), cfg, analysis); \ 322 Registry.registerPass(*PI); \ 323 \ 324 PassInfo *AI = new PassInfo(n, & agName :: ID); \ 325 Registry.registerAnalysisGroup(& agName ::ID, & passName ::ID, *AI, def); \ 326 return AI; \ 327 } \ 328 void llvm::initialize##passName##Pass(PassRegistry &Registry) { \ 329 static volatile sys::cas_flag initialized = 0; \ 330 sys::cas_flag old_val = sys::CompareAndSwap(&initialized, 1, 0); \ 331 if (old_val == 0) { \ 332 initialize##passName##PassOnce(Registry); \ 333 sys::MemoryFence(); \ 334 initialized = 2; \ 335 } else { \ 336 sys::cas_flag tmp = initialized; \ 337 sys::MemoryFence(); \ 338 while (tmp != 2) { \ 339 tmp = initialized; \ 340 sys::MemoryFence(); \ 341 } \ 342 } \ 343 } 344 345//===--------------------------------------------------------------------------- 346/// PassRegistrationListener class - This class is meant to be derived from by 347/// clients that are interested in which passes get registered and unregistered 348/// at runtime (which can be because of the RegisterPass constructors being run 349/// as the program starts up, or may be because a shared object just got 350/// loaded). Deriving from the PassRegistationListener class automatically 351/// registers your object to receive callbacks indicating when passes are loaded 352/// and removed. 353/// 354struct PassRegistrationListener { 355 356 /// PassRegistrationListener ctor - Add the current object to the list of 357 /// PassRegistrationListeners... 358 PassRegistrationListener(); 359 360 /// dtor - Remove object from list of listeners... 361 /// 362 virtual ~PassRegistrationListener(); 363 364 /// Callback functions - These functions are invoked whenever a pass is loaded 365 /// or removed from the current executable. 366 /// 367 virtual void passRegistered(const PassInfo *) {} 368 369 /// enumeratePasses - Iterate over the registered passes, calling the 370 /// passEnumerate callback on each PassInfo object. 371 /// 372 void enumeratePasses(); 373 374 /// passEnumerate - Callback function invoked when someone calls 375 /// enumeratePasses on this PassRegistrationListener object. 376 /// 377 virtual void passEnumerate(const PassInfo *) {} 378}; 379 380 381} // End llvm namespace 382 383#endif 384