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