PassSupport.h revision 6bcd3a02653c45b87094577517547b7eb9f76395
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 <vector> 27 28namespace llvm { 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 void *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, const void *pi, 55 NormalCtor_t normal, bool isCFGOnly, bool is_analysis) 56 : PassName(name), PassArgument(arg), PassID(pi), 57 IsCFGOnlyPass(isCFGOnly), 58 IsAnalysis(is_analysis), IsAnalysisGroup(false), NormalCtor(normal) { 59 PassRegistry::getPassRegistry()->registerPass(*this); 60 } 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 70 /// getPassName - Return the friendly name for the pass, never returns null 71 /// 72 const char *getPassName() const { return PassName; } 73 74 /// getPassArgument - Return the command line option that may be passed to 75 /// 'opt' that will cause this pass to be run. This will return null if there 76 /// is no argument. 77 /// 78 const char *getPassArgument() const { return PassArgument; } 79 80 /// getTypeInfo - Return the id object for the pass... 81 /// TODO : Rename 82 const void *getTypeInfo() const { return PassID; } 83 84 /// Return true if this PassID implements the specified ID pointer. 85 bool isPassID(const void *IDPtr) const { 86 return PassID == IDPtr; 87 } 88 89 /// isAnalysisGroup - Return true if this is an analysis group, not a normal 90 /// pass. 91 /// 92 bool isAnalysisGroup() const { return IsAnalysisGroup; } 93 bool isAnalysis() const { return IsAnalysis; } 94 95 /// isCFGOnlyPass - return true if this pass only looks at the CFG for the 96 /// function. 97 bool isCFGOnlyPass() const { return IsCFGOnlyPass; } 98 99 /// getNormalCtor - Return a pointer to a function, that when called, creates 100 /// an instance of the pass and returns it. This pointer may be null if there 101 /// is no default constructor for the pass. 102 /// 103 NormalCtor_t getNormalCtor() const { 104 return NormalCtor; 105 } 106 void setNormalCtor(NormalCtor_t Ctor) { 107 NormalCtor = Ctor; 108 } 109 110 /// createPass() - Use this method to create an instance of this pass. 111 Pass *createPass() const; 112 113 /// addInterfaceImplemented - This method is called when this pass is 114 /// registered as a member of an analysis group with the RegisterAnalysisGroup 115 /// template. 116 /// 117 void addInterfaceImplemented(const PassInfo *ItfPI) { 118 ItfImpl.push_back(ItfPI); 119 } 120 121 /// getInterfacesImplemented - Return a list of all of the analysis group 122 /// interfaces implemented by this pass. 123 /// 124 const std::vector<const PassInfo*> &getInterfacesImplemented() const { 125 return ItfImpl; 126 } 127 128private: 129 void operator=(const PassInfo &); // do not implement 130 PassInfo(const PassInfo &); // do not implement 131}; 132 133#define INITIALIZE_PASS(passName, arg, name, cfg, analysis) \ 134 static RegisterPass<passName> passName ## _info(arg, name, cfg, analysis) 135 136template<typename PassName> 137Pass *callDefaultCtor() { return new PassName(); } 138 139//===--------------------------------------------------------------------------- 140/// RegisterPass<t> template - This template class is used to notify the system 141/// that a Pass is available for use, and registers it into the internal 142/// database maintained by the PassManager. Unless this template is used, opt, 143/// for example will not be able to see the pass and attempts to create the pass 144/// will fail. This template is used in the follow manner (at global scope, in 145/// your .cpp file): 146/// 147/// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name"); 148/// 149/// This statement will cause your pass to be created by calling the default 150/// constructor exposed by the pass. If you have a different constructor that 151/// must be called, create a global constructor function (which takes the 152/// arguments you need and returns a Pass*) and register your pass like this: 153/// 154/// static RegisterPass<PassClassName> tmp("passopt", "My Name"); 155/// 156template<typename passName> 157struct RegisterPass : public PassInfo { 158 159 // Register Pass using default constructor... 160 RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false, 161 bool is_analysis = false) 162 : PassInfo(Name, PassArg, &passName::ID, 163 PassInfo::NormalCtor_t(callDefaultCtor<passName>), 164 CFGOnly, is_analysis) { 165 166 } 167}; 168 169 170/// RegisterAnalysisGroup - Register a Pass as a member of an analysis _group_. 171/// Analysis groups are used to define an interface (which need not derive from 172/// Pass) that is required by passes to do their job. Analysis Groups differ 173/// from normal analyses because any available implementation of the group will 174/// be used if it is available. 175/// 176/// If no analysis implementing the interface is available, a default 177/// implementation is created and added. A pass registers itself as the default 178/// implementation by specifying 'true' as the second template argument of this 179/// class. 180/// 181/// In addition to registering itself as an analysis group member, a pass must 182/// register itself normally as well. Passes may be members of multiple groups 183/// and may still be "required" specifically by name. 184/// 185/// The actual interface may also be registered as well (by not specifying the 186/// second template argument). The interface should be registered to associate 187/// a nice name with the interface. 188/// 189class RegisterAGBase : public PassInfo { 190protected: 191 RegisterAGBase(const char *Name, 192 const void *InterfaceID, 193 const void *PassID = 0, 194 bool isDefault = false); 195}; 196 197template<typename Interface, bool Default = false> 198struct RegisterAnalysisGroup : public RegisterAGBase { 199 explicit RegisterAnalysisGroup(PassInfo &RPB) 200 : RegisterAGBase(RPB.getPassName(), 201 &Interface::ID, RPB.getTypeInfo(), 202 Default) { 203 } 204 205 explicit RegisterAnalysisGroup(const char *Name) 206 : RegisterAGBase(Name, &Interface::ID) { 207 } 208}; 209 210#define INITIALIZE_AG_PASS(passName, agName, arg, name, cfg, analysis, def) \ 211 static RegisterPass<passName> passName ## _info(arg, name, cfg, analysis); \ 212 static RegisterAnalysisGroup<agName, def> passName ## _ag(passName ## _info) 213 214//===--------------------------------------------------------------------------- 215/// PassRegistrationListener class - This class is meant to be derived from by 216/// clients that are interested in which passes get registered and unregistered 217/// at runtime (which can be because of the RegisterPass constructors being run 218/// as the program starts up, or may be because a shared object just got 219/// loaded). Deriving from the PassRegistationListener class automatically 220/// registers your object to receive callbacks indicating when passes are loaded 221/// and removed. 222/// 223struct PassRegistrationListener { 224 225 /// PassRegistrationListener ctor - Add the current object to the list of 226 /// PassRegistrationListeners... 227 PassRegistrationListener(); 228 229 /// dtor - Remove object from list of listeners... 230 /// 231 virtual ~PassRegistrationListener(); 232 233 /// Callback functions - These functions are invoked whenever a pass is loaded 234 /// or removed from the current executable. 235 /// 236 virtual void passRegistered(const PassInfo *) {} 237 238 /// enumeratePasses - Iterate over the registered passes, calling the 239 /// passEnumerate callback on each PassInfo object. 240 /// 241 void enumeratePasses(); 242 243 /// passEnumerate - Callback function invoked when someone calls 244 /// enumeratePasses on this PassRegistrationListener object. 245 /// 246 virtual void passEnumerate(const PassInfo *) {} 247}; 248 249 250} // End llvm namespace 251 252#endif 253