include/llvm/PassSupport.h

   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
  27 namespace llvm {
  28
  29 class 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 ///
  37 class 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 IsAnalysisGroup;                // True if an analysis group.
  42   std::vector<const PassInfo*> ItfImpl;// Interfaces implemented by this pass
  43
  44   Pass *(*NormalCtor)();               // No argument ctor
  45   Pass *(*TargetCtor)(TargetMachine&);   // Ctor taking TargetMachine object...
  46
  47 public:
  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, Pass *(*targetctor)(TargetMachine &) = 0)
  52     : PassName(name), PassArgument(arg), TypeInfo(ti), IsAnalysisGroup(false),
  53       NormalCtor(normal), TargetCtor(targetctor)  {
  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   /// getNormalCtor - Return a pointer to a function, that when called, creates
  78   /// an instance of the pass and returns it.  This pointer may be null if there
  79   /// is no default constructor for the pass.
  80   ///
  81   Pass *(*getNormalCtor() const)() {
  82     return NormalCtor;
  83   }
  84   void setNormalCtor(Pass *(*Ctor)()) {
  85     NormalCtor = Ctor;
  86   }
  87
  88   /// createPass() - Use this method to create an instance of this pass.
  89   Pass *createPass() const {
  90     assert((!isAnalysisGroup() || NormalCtor) &&
  91            "No default implementation found for analysis group!");
  92     assert(NormalCtor &&
  93            "Cannot call createPass on PassInfo without default ctor!");
  94     return NormalCtor();
  95   }
  96
  97   /// getTargetCtor - Return a pointer to a function that creates an instance of
  98   /// the pass and returns it.  This returns a constructor for a version of the
  99   /// pass that takes a TargetMachine object as a parameter.
 100   ///
 101   Pass *(*getTargetCtor() const)(TargetMachine &) {
 102     return TargetCtor;
 103   }
 104
 105   /// addInterfaceImplemented - This method is called when this pass is
 106   /// registered as a member of an analysis group with the RegisterAnalysisGroup
 107   /// template.
 108   ///
 109   void addInterfaceImplemented(const PassInfo *ItfPI) {
 110     ItfImpl.push_back(ItfPI);
 111   }
 112
 113   /// getInterfacesImplemented - Return a list of all of the analysis group
 114   /// interfaces implemented by this pass.
 115   ///
 116   const std::vector<const PassInfo*> &getInterfacesImplemented() const {
 117     return ItfImpl;
 118   }
 119 };
 120
 121
 122 //===---------------------------------------------------------------------------
 123 /// RegisterPass<t> template - This template class is used to notify the system
 124 /// that a Pass is available for use, and registers it into the internal
 125 /// database maintained by the PassManager.  Unless this template is used, opt,
 126 /// for example will not be able to see the pass and attempts to create the pass
 127 /// will fail. This template is used in the follow manner (at global scope, in
 128 /// your .cpp file):
 129 ///
 130 /// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name");
 131 ///
 132 /// This statement will cause your pass to be created by calling the default
 133 /// constructor exposed by the pass.  If you have a different constructor that
 134 /// must be called, create a global constructor function (which takes the
 135 /// arguments you need and returns a Pass*) and register your pass like this:
 136 ///
 137 /// Pass *createMyPass(foo &opt) { return new MyPass(opt); }
 138 /// static RegisterPass<PassClassName> tmp("passopt", "My Name", createMyPass);
 139 ///
 140 struct RegisterPassBase {
 141   /// getPassInfo - Get the pass info for the registered class...
 142   ///
 143   const PassInfo *getPassInfo() const { return &PIObj; }
 144
 145   RegisterPassBase(const char *Name, const char *Arg, const std::type_info &TI,
 146                    Pass *(*Normal)() = 0,
 147                    Pass *(*TargetCtor)(TargetMachine &) = 0)
 148     : PIObj(Name, Arg, TI, Normal, TargetCtor) {
 149     registerPass();
 150   }
 151   RegisterPassBase(const std::type_info &TI)
 152     : PIObj("", "", TI, 0, 0) {
 153     // This ctor may only be used for analysis groups: it does not auto-register
 154     // the pass.
 155     PIObj.SetIsAnalysisGroup();
 156   }
 157
 158   ~RegisterPassBase() {   // Intentionally non-virtual.
 159     // Analysis groups are registered/unregistered by their dtor.
 160     if (!PIObj.isAnalysisGroup())
 161       unregisterPass();
 162   }
 163
 164 protected:
 165   PassInfo PIObj;       // The PassInfo object for this pass
 166   void registerPass();
 167   void unregisterPass();
 168
 169   /// setOnlyUsesCFG - Notice that this pass only depends on the CFG, so
 170   /// transformations that do not modify the CFG do not invalidate this pass.
 171   ///
 172   void setOnlyUsesCFG();
 173 };
 174
 175 template<typename PassName>
 176 Pass *callDefaultCtor() { return new PassName(); }
 177
 178 template<typename PassName>
 179 struct RegisterPass : public RegisterPassBase {
 180
 181   // Register Pass using default constructor...
 182   RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false)
 183   : RegisterPassBase(Name, PassArg, typeid(PassName),
 184                      callDefaultCtor<PassName>) {
 185     if (CFGOnly) setOnlyUsesCFG();
 186   }
 187
 188   // Register Pass using default constructor explicitly...
 189   RegisterPass(const char *PassArg, const char *Name,
 190                Pass *(*ctor)(), bool CFGOnly = false)
 191   : RegisterPassBase(Name, PassArg, typeid(PassName), ctor) {
 192     if (CFGOnly) setOnlyUsesCFG();
 193   }
 194
 195   // Register Pass using TargetMachine constructor...
 196   RegisterPass(const char *PassArg, const char *Name,
 197                Pass *(*targetctor)(TargetMachine &), bool CFGOnly = false)
 198   : RegisterPassBase(Name, PassArg, typeid(PassName), 0, targetctor) {
 199     if (CFGOnly) setOnlyUsesCFG();
 200   }
 201
 202   // Generic constructor version that has an unknown ctor type...
 203   template<typename CtorType>
 204   RegisterPass(const char *PassArg, const char *Name, CtorType *Fn,
 205                bool CFGOnly = false)
 206   : RegisterPassBase(Name, PassArg, typeid(PassName), 0) {
 207     if (CFGOnly) setOnlyUsesCFG();
 208   }
 209 };
 210
 211
 212 /// RegisterAnalysisGroup - Register a Pass as a member of an analysis _group_.
 213 /// Analysis groups are used to define an interface (which need not derive from
 214 /// Pass) that is required by passes to do their job.  Analysis Groups differ
 215 /// from normal analyses because any available implementation of the group will
 216 /// be used if it is available.
 217 ///
 218 /// If no analysis implementing the interface is available, a default
 219 /// implementation is created and added.  A pass registers itself as the default
 220 /// implementation by specifying 'true' as the third template argument of this
 221 /// class.
 222 ///
 223 /// In addition to registering itself as an analysis group member, a pass must
 224 /// register itself normally as well.  Passes may be members of multiple groups
 225 /// and may still be "required" specifically by name.
 226 ///
 227 /// The actual interface may also be registered as well (by not specifying the
 228 /// second template argument).  The interface should be registered to associate
 229 /// a nice name with the interface.
 230 ///
 231 class RegisterAGBase : public RegisterPassBase {
 232   PassInfo *InterfaceInfo;
 233   const PassInfo *ImplementationInfo;
 234   bool isDefaultImplementation;
 235 protected:
 236   RegisterAGBase(const std::type_info &Interface,
 237                  const std::type_info *Pass = 0,
 238                  bool isDefault = false);
 239   void setGroupName(const char *Name);
 240 public:
 241   ~RegisterAGBase();
 242 };
 243
 244
 245 template<typename Interface, typename DefaultImplementationPass = void,
 246          bool Default = false>
 247 struct RegisterAnalysisGroup : public RegisterAGBase {
 248   RegisterAnalysisGroup() : RegisterAGBase(typeid(Interface),
 249                                            &typeid(DefaultImplementationPass),
 250                                            Default) {
 251   }
 252 };
 253
 254 /// Define a specialization of RegisterAnalysisGroup that is used to set the
 255 /// name for the analysis group.
 256 ///
 257 template<typename Interface>
 258 struct RegisterAnalysisGroup<Interface, void, false> : public RegisterAGBase {
 259   RegisterAnalysisGroup(const char *Name)
 260     : RegisterAGBase(typeid(Interface)) {
 261     setGroupName(Name);
 262   }
 263 };
 264
 265
 266
 267 //===---------------------------------------------------------------------------
 268 /// PassRegistrationListener class - This class is meant to be derived from by
 269 /// clients that are interested in which passes get registered and unregistered
 270 /// at runtime (which can be because of the RegisterPass constructors being run
 271 /// as the program starts up, or may be because a shared object just got
 272 /// loaded).  Deriving from the PassRegistationListener class automatically
 273 /// registers your object to receive callbacks indicating when passes are loaded
 274 /// and removed.
 275 ///
 276 struct PassRegistrationListener {
 277
 278   /// PassRegistrationListener ctor - Add the current object to the list of
 279   /// PassRegistrationListeners...
 280   PassRegistrationListener();
 281
 282   /// dtor - Remove object from list of listeners...
 283   ///
 284   virtual ~PassRegistrationListener();
 285
 286   /// Callback functions - These functions are invoked whenever a pass is loaded
 287   /// or removed from the current executable.
 288   ///
 289   virtual void passRegistered(const PassInfo *P) {}
 290   virtual void passUnregistered(const PassInfo *P) {}
 291
 292   /// enumeratePasses - Iterate over the registered passes, calling the
 293   /// passEnumerate callback on each PassInfo object.
 294   ///
 295   void enumeratePasses();
 296
 297   /// passEnumerate - Callback function invoked when someone calls
 298   /// enumeratePasses on this PassRegistrationListener object.
 299   ///
 300   virtual void passEnumerate(const PassInfo *P) {}
 301 };
 302
 303
 304 } // End llvm namespace
 305
 306 #endif