PassSupport.h revision c758209153ca0f6da6737f25ada269c573fba456
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 "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 intptr_t PassID; 41 bool IsCFGOnlyPass; // Pass only looks at the CFG. 42 bool IsAnalysis; // True if an analysis pass. 43 bool IsAnalysisGroup; // True if an analysis group. 44 std::vector<const PassInfo*> ItfImpl;// Interfaces implemented by this pass 45 46 Pass *(*NormalCtor)(); 47 48public: 49 /// PassInfo ctor - Do not call this directly, this should only be invoked 50 /// through RegisterPass. 51 PassInfo(const char *name, const char *arg, intptr_t pi, 52 Pass *(*normal)() = 0, bool isCFGOnly = false, bool isAnalysis = false) 53 : PassName(name), PassArgument(arg), PassID(pi), 54 IsCFGOnlyPass(isCFGOnly), 55 IsAnalysis(isAnalysis), IsAnalysisGroup(false), NormalCtor(normal) { 56 } 57 58 /// getPassName - Return the friendly name for the pass, never returns null 59 /// 60 const char *getPassName() const { return PassName; } 61 void setPassName(const char *Name) { PassName = Name; } 62 63 /// getPassArgument - Return the command line option that may be passed to 64 /// 'opt' that will cause this pass to be run. This will return null if there 65 /// is no argument. 66 /// 67 const char *getPassArgument() const { return PassArgument; } 68 69 /// getTypeInfo - Return the id object for the pass... 70 /// TODO : Rename 71 intptr_t getTypeInfo() const { return PassID; } 72 73 /// isAnalysisGroup - Return true if this is an analysis group, not a normal 74 /// pass. 75 /// 76 bool isAnalysisGroup() const { return IsAnalysisGroup; } 77 bool isAnalysis() const { return IsAnalysis; } 78 void SetIsAnalysisGroup() { IsAnalysisGroup = true; } 79 80 /// isCFGOnlyPass - return true if this pass only looks at the CFG for the 81 /// function. 82 bool isCFGOnlyPass() const { return IsCFGOnlyPass; } 83 84 /// getNormalCtor - Return a pointer to a function, that when called, creates 85 /// an instance of the pass and returns it. This pointer may be null if there 86 /// is no default constructor for the pass. 87 /// 88 Pass *(*getNormalCtor() const)() { 89 return NormalCtor; 90 } 91 void setNormalCtor(Pass *(*Ctor)()) { 92 NormalCtor = Ctor; 93 } 94 95 /// createPass() - Use this method to create an instance of this pass. 96 Pass *createPass() const { 97 assert((!isAnalysisGroup() || NormalCtor) && 98 "No default implementation found for analysis group!"); 99 assert(NormalCtor && 100 "Cannot call createPass on PassInfo without default ctor!"); 101 return NormalCtor(); 102 } 103 104 /// addInterfaceImplemented - This method is called when this pass is 105 /// registered as a member of an analysis group with the RegisterAnalysisGroup 106 /// template. 107 /// 108 void addInterfaceImplemented(const PassInfo *ItfPI) { 109 ItfImpl.push_back(ItfPI); 110 } 111 112 /// getInterfacesImplemented - Return a list of all of the analysis group 113 /// interfaces implemented by this pass. 114 /// 115 const std::vector<const PassInfo*> &getInterfacesImplemented() const { 116 return ItfImpl; 117 } 118}; 119 120 121//===--------------------------------------------------------------------------- 122/// RegisterPass<t> template - This template class is used to notify the system 123/// that a Pass is available for use, and registers it into the internal 124/// database maintained by the PassManager. Unless this template is used, opt, 125/// for example will not be able to see the pass and attempts to create the pass 126/// will fail. This template is used in the follow manner (at global scope, in 127/// your .cpp file): 128/// 129/// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name"); 130/// 131/// This statement will cause your pass to be created by calling the default 132/// constructor exposed by the pass. If you have a different constructor that 133/// must be called, create a global constructor function (which takes the 134/// arguments you need and returns a Pass*) and register your pass like this: 135/// 136/// static RegisterPass<PassClassName> tmp("passopt", "My Name"); 137/// 138struct RegisterPassBase { 139 /// getPassInfo - Get the pass info for the registered class... 140 /// 141 const PassInfo *getPassInfo() const { return &PIObj; } 142 143 typedef Pass* (*NormalCtor_t)(); 144 145 RegisterPassBase(const char *Name, const char *Arg, intptr_t TI, 146 NormalCtor_t NormalCtor = 0, bool CFGOnly = false, 147 bool IsAnalysis = false) 148 : PIObj(Name, Arg, TI, NormalCtor, CFGOnly, IsAnalysis) { 149 registerPass(); 150 } 151 explicit RegisterPassBase(intptr_t TI) 152 : PIObj("", "", TI) { 153 // This ctor may only be used for analysis groups: it does not auto-register 154 // the pass. 155 PIObj.SetIsAnalysisGroup(); 156 } 157 158protected: 159 PassInfo PIObj; // The PassInfo object for this pass 160 void registerPass(); 161 void unregisterPass(); 162}; 163 164template<typename PassName> 165Pass *callDefaultCtor() { return new PassName(); } 166 167template<typename PassName> 168struct RegisterPass : public RegisterPassBase { 169 170 // Register Pass using default constructor... 171 RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false, 172 bool IsAnalysis = false) 173 : RegisterPassBase(Name, PassArg, intptr_t(&PassName::ID), 174 RegisterPassBase::NormalCtor_t(callDefaultCtor<PassName>), 175 CFGOnly, IsAnalysis) { 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 RegisterPassBase { 200 PassInfo *InterfaceInfo; 201 const PassInfo *ImplementationInfo; 202 bool isDefaultImplementation; 203protected: 204 explicit RegisterAGBase(intptr_t InterfaceID, 205 intptr_t PassID = 0, 206 bool isDefault = false); 207 void setGroupName(const char *Name); 208}; 209 210template<typename Interface, bool Default = false> 211struct RegisterAnalysisGroup : public RegisterAGBase { 212 explicit RegisterAnalysisGroup(RegisterPassBase &RPB) 213 : RegisterAGBase(intptr_t(&Interface::ID), RPB.getPassInfo()->getTypeInfo(), 214 Default) { 215 } 216 217 explicit RegisterAnalysisGroup(const char *Name) 218 : RegisterAGBase(intptr_t(&Interface::ID)) { 219 setGroupName(Name); 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 *P) {} 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 *P) {} 258}; 259 260 261} // End llvm namespace 262 263#endif 264