PassSupport.h revision 423c2260f95883f7c84ac962e58ac66c3a11efac
1//===- llvm/PassSupport.h - Pass Support code -------------------*- C++ -*-===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file was developed by the LLVM research group and is distributed under 6// the University of Illinois Open Source 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 "llvm/System/IncludeFile.h" 25// No need to include Pass.h, we are being included by it! 26 27namespace llvm { 28 29class TargetMachine; 30 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. 36/// 37class PassInfo { 38 const char *PassName; // Nice name for Pass 39 const char *PassArgument; // Command Line argument to run this pass 40 const std::type_info &TypeInfo; // type_info object for this Pass class 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 44 45 Pass *(*NormalCtor)(); // No argument ctor 46 47public: 48 /// PassInfo ctor - Do not call this directly, this should only be invoked 49 /// through RegisterPass. 50 PassInfo(const char *name, const char *arg, const std::type_info &ti, 51 Pass *(*normal)() = 0, bool isCFGOnly = false) 52 : PassName(name), PassArgument(arg), TypeInfo(ti), 53 IsCFGOnlyPass(isCFGOnly), IsAnalysisGroup(false), NormalCtor(normal) { 54 } 55 56 /// getPassName - Return the friendly name for the pass, never returns null 57 /// 58 const char *getPassName() const { return PassName; } 59 void setPassName(const char *Name) { PassName = Name; } 60 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 63 /// is no argument. 64 /// 65 const char *getPassArgument() const { return PassArgument; } 66 67 /// getTypeInfo - Return the type_info object for the pass... 68 /// 69 const std::type_info &getTypeInfo() const { return TypeInfo; } 70 71 /// isAnalysisGroup - Return true if this is an analysis group, not a normal 72 /// pass. 73 /// 74 bool isAnalysisGroup() const { return IsAnalysisGroup; } 75 void SetIsAnalysisGroup() { IsAnalysisGroup = true; } 76 77 /// isCFGOnlyPass - return true if this pass only looks at the CFG for the 78 /// function. 79 bool isCFGOnlyPass() const { return IsCFGOnlyPass; } 80 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. 84 /// 85 Pass *(*getNormalCtor() const)() { 86 return NormalCtor; 87 } 88 void setNormalCtor(Pass *(*Ctor)()) { 89 NormalCtor = Ctor; 90 } 91 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!"); 96 assert(NormalCtor && 97 "Cannot call createPass on PassInfo without default ctor!"); 98 return NormalCtor(); 99 } 100 101 /// addInterfaceImplemented - This method is called when this pass is 102 /// registered as a member of an analysis group with the RegisterAnalysisGroup 103 /// template. 104 /// 105 void addInterfaceImplemented(const PassInfo *ItfPI) { 106 ItfImpl.push_back(ItfPI); 107 } 108 109 /// getInterfacesImplemented - Return a list of all of the analysis group 110 /// interfaces implemented by this pass. 111 /// 112 const std::vector<const PassInfo*> &getInterfacesImplemented() const { 113 return ItfImpl; 114 } 115}; 116 117 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 124/// your .cpp file): 125/// 126/// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name"); 127/// 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: 132/// 133/// static RegisterPass<PassClassName> tmp("passopt", "My Name"); 134/// 135struct RegisterPassBase { 136 /// getPassInfo - Get the pass info for the registered class... 137 /// 138 const PassInfo *getPassInfo() const { return &PIObj; } 139 140 RegisterPassBase(const char *Name, const char *Arg, const std::type_info &TI, 141 Pass *(*NormalCtor)() = 0, bool CFGOnly = false) 142 : PIObj(Name, Arg, TI, NormalCtor, CFGOnly) { 143 registerPass(); 144 } 145 RegisterPassBase(const std::type_info &TI) 146 : PIObj("", "", TI) { 147 // This ctor may only be used for analysis groups: it does not auto-register 148 // the pass. 149 PIObj.SetIsAnalysisGroup(); 150 } 151 152protected: 153 PassInfo PIObj; // The PassInfo object for this pass 154 void registerPass(); 155 void unregisterPass(); 156}; 157 158template<typename PassName> 159Pass *callDefaultCtor() { return new PassName(); } 160 161template<typename PassName> 162struct RegisterPass : public RegisterPassBase { 163 164 // Register Pass using default constructor... 165 RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false) 166 : RegisterPassBase(Name, PassArg, typeid(PassName), 167 callDefaultCtor<PassName>, CFGOnly) { 168 } 169}; 170 171 172/// RegisterAnalysisGroup - Register a Pass as a member of an analysis _group_. 173/// Analysis groups are used to define an interface (which need not derive from 174/// Pass) that is required by passes to do their job. Analysis Groups differ 175/// from normal analyses because any available implementation of the group will 176/// be used if it is available. 177/// 178/// If no analysis implementing the interface is available, a default 179/// implementation is created and added. A pass registers itself as the default 180/// implementation by specifying 'true' as the third template argument of this 181/// class. 182/// 183/// In addition to registering itself as an analysis group member, a pass must 184/// register itself normally as well. Passes may be members of multiple groups 185/// and may still be "required" specifically by name. 186/// 187/// The actual interface may also be registered as well (by not specifying the 188/// second template argument). The interface should be registered to associate 189/// a nice name with the interface. 190/// 191class RegisterAGBase : public RegisterPassBase { 192 PassInfo *InterfaceInfo; 193 const PassInfo *ImplementationInfo; 194 bool isDefaultImplementation; 195protected: 196 explicit RegisterAGBase(const std::type_info &Interface, 197 const std::type_info *Pass = 0, 198 bool isDefault = false); 199 void setGroupName(const char *Name); 200}; 201 202template<typename Interface, bool Default = false> 203struct RegisterAnalysisGroup : public RegisterAGBase { 204 explicit RegisterAnalysisGroup(RegisterPassBase &RPB) 205 : RegisterAGBase(typeid(Interface), &RPB.getPassInfo()->getTypeInfo(), 206 Default) { 207 } 208 209 explicit RegisterAnalysisGroup(const char *Name) 210 : RegisterAGBase(typeid(Interface)) { 211 setGroupName(Name); 212 } 213}; 214 215 216 217//===--------------------------------------------------------------------------- 218/// PassRegistrationListener class - This class is meant to be derived from by 219/// clients that are interested in which passes get registered and unregistered 220/// at runtime (which can be because of the RegisterPass constructors being run 221/// as the program starts up, or may be because a shared object just got 222/// loaded). Deriving from the PassRegistationListener class automatically 223/// registers your object to receive callbacks indicating when passes are loaded 224/// and removed. 225/// 226struct PassRegistrationListener { 227 228 /// PassRegistrationListener ctor - Add the current object to the list of 229 /// PassRegistrationListeners... 230 PassRegistrationListener(); 231 232 /// dtor - Remove object from list of listeners... 233 /// 234 virtual ~PassRegistrationListener(); 235 236 /// Callback functions - These functions are invoked whenever a pass is loaded 237 /// or removed from the current executable. 238 /// 239 virtual void passRegistered(const PassInfo *P) {} 240 241 /// enumeratePasses - Iterate over the registered passes, calling the 242 /// passEnumerate callback on each PassInfo object. 243 /// 244 void enumeratePasses(); 245 246 /// passEnumerate - Callback function invoked when someone calls 247 /// enumeratePasses on this PassRegistrationListener object. 248 /// 249 virtual void passEnumerate(const PassInfo *P) {} 250}; 251 252 253} // End llvm namespace 254 255#endif 256