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
  46 public:
  47   /// PassInfo ctor - Do not call this directly, this should only be invoked
  48   /// through RegisterPass.
  49   PassInfo(const char *name, const char *arg, const std::type_info &ti,
  50            Pass *(*normal)() = 0)
  51     : PassName(name), PassArgument(arg), TypeInfo(ti), IsAnalysisGroup(false),
  52       NormalCtor(normal) {
  53   }
  54
  55   /// getPassName - Return the friendly name for the pass, never returns null
  56   ///
  57   const char *getPassName() const { return PassName; }
  58   void setPassName(const char *Name) { PassName = Name; }
  59
  60   /// getPassArgument - Return the command line option that may be passed to
  61   /// 'opt' that will cause this pass to be run.  This will return null if there
  62   /// is no argument.
  63   ///
  64   const char *getPassArgument() const { return PassArgument; }
  65
  66   /// getTypeInfo - Return the type_info object for the pass...
  67   ///
  68   const std::type_info &getTypeInfo() const { return TypeInfo; }
  69
  70   /// isAnalysisGroup - Return true if this is an analysis group, not a normal
  71   /// pass.
  72   ///
  73   bool isAnalysisGroup() const { return IsAnalysisGroup; }
  74   void SetIsAnalysisGroup() { IsAnalysisGroup = true; }
  75
  76   /// getNormalCtor - Return a pointer to a function, that when called, creates
  77   /// an instance of the pass and returns it.  This pointer may be null if there
  78   /// is no default constructor for the pass.
  79   ///
  80   Pass *(*getNormalCtor() const)() {
  81     return NormalCtor;
  82   }
  83   void setNormalCtor(Pass *(*Ctor)()) {
  84     NormalCtor = Ctor;
  85   }
  86
  87   /// createPass() - Use this method to create an instance of this pass.
  88   Pass *createPass() const {
  89     assert((!isAnalysisGroup() || NormalCtor) &&
  90            "No default implementation found for analysis group!");
  91     assert(NormalCtor &&
  92            "Cannot call createPass on PassInfo without default ctor!");
  93     return NormalCtor();
  94   }
  95
  96   /// addInterfaceImplemented - This method is called when this pass is
  97   /// registered as a member of an analysis group with the RegisterAnalysisGroup
  98   /// template.
  99   ///
 100   void addInterfaceImplemented(const PassInfo *ItfPI) {
 101     ItfImpl.push_back(ItfPI);
 102   }
 103
 104   /// getInterfacesImplemented - Return a list of all of the analysis group
 105   /// interfaces implemented by this pass.
 106   ///
 107   const std::vector<const PassInfo*> &getInterfacesImplemented() const {
 108     return ItfImpl;
 109   }
 110 };
 111
 112
 113 //===---------------------------------------------------------------------------
 114 /// RegisterPass<t> template - This template class is used to notify the system
 115 /// that a Pass is available for use, and registers it into the internal
 116 /// database maintained by the PassManager.  Unless this template is used, opt,
 117 /// for example will not be able to see the pass and attempts to create the pass
 118 /// will fail. This template is used in the follow manner (at global scope, in
 119 /// your .cpp file):
 120 ///
 121 /// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name");
 122 ///
 123 /// This statement will cause your pass to be created by calling the default
 124 /// constructor exposed by the pass.  If you have a different constructor that
 125 /// must be called, create a global constructor function (which takes the
 126 /// arguments you need and returns a Pass*) and register your pass like this:
 127 ///
 128 /// Pass *createMyPass(foo &opt) { return new MyPass(opt); }
 129 /// static RegisterPass<PassClassName> tmp("passopt", "My Name", createMyPass);
 130 ///
 131 struct RegisterPassBase {
 132   /// getPassInfo - Get the pass info for the registered class...
 133   ///
 134   const PassInfo *getPassInfo() const { return &PIObj; }
 135
 136   RegisterPassBase(const char *Name, const char *Arg, const std::type_info &TI,
 137                    Pass *(*NormalCtor)() = 0)
 138     : PIObj(Name, Arg, TI, NormalCtor) {
 139     registerPass();
 140   }
 141   RegisterPassBase(const std::type_info &TI)
 142     : PIObj("", "", TI) {
 143     // This ctor may only be used for analysis groups: it does not auto-register
 144     // the pass.
 145     PIObj.SetIsAnalysisGroup();
 146   }
 147
 148   ~RegisterPassBase() {   // Intentionally non-virtual.
 149     // Analysis groups are registered/unregistered by their dtor.
 150     if (!PIObj.isAnalysisGroup())
 151       unregisterPass();
 152   }
 153
 154 protected:
 155   PassInfo PIObj;       // The PassInfo object for this pass
 156   void registerPass();
 157   void unregisterPass();
 158
 159   /// setOnlyUsesCFG - Notice that this pass only depends on the CFG, so
 160   /// transformations that do not modify the CFG do not invalidate this pass.
 161   ///
 162   void setOnlyUsesCFG();
 163 };
 164
 165 template<typename PassName>
 166 Pass *callDefaultCtor() { return new PassName(); }
 167
 168 template<typename PassName>
 169 struct RegisterPass : public RegisterPassBase {
 170
 171   // Register Pass using default constructor...
 172   RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false)
 173   : RegisterPassBase(Name, PassArg, typeid(PassName),
 174                      callDefaultCtor<PassName>) {
 175     if (CFGOnly) setOnlyUsesCFG();
 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 ///
 199 class RegisterAGBase : public RegisterPassBase {
 200   PassInfo *InterfaceInfo;
 201   const PassInfo *ImplementationInfo;
 202   bool isDefaultImplementation;
 203 protected:
 204   RegisterAGBase(const std::type_info &Interface,
 205                  const std::type_info *Pass = 0,
 206                  bool isDefault = false);
 207   void setGroupName(const char *Name);
 208 public:
 209   ~RegisterAGBase();
 210 };
 211
 212 template<typename Interface, bool Default = false>
 213 struct RegisterAnalysisGroup : public RegisterAGBase {
 214   RegisterAnalysisGroup(RegisterPassBase &RPB)
 215     : RegisterAGBase(typeid(Interface), &RPB.getPassInfo()->getTypeInfo(),
 216                      Default) {
 217   }
 218
 219   RegisterAnalysisGroup(const char *Name)
 220   : RegisterAGBase(typeid(Interface)) {
 221     setGroupName(Name);
 222   }
 223 };
 224
 225
 226
 227 //===---------------------------------------------------------------------------
 228 /// PassRegistrationListener class - This class is meant to be derived from by
 229 /// clients that are interested in which passes get registered and unregistered
 230 /// at runtime (which can be because of the RegisterPass constructors being run
 231 /// as the program starts up, or may be because a shared object just got
 232 /// loaded).  Deriving from the PassRegistationListener class automatically
 233 /// registers your object to receive callbacks indicating when passes are loaded
 234 /// and removed.
 235 ///
 236 struct PassRegistrationListener {
 237
 238   /// PassRegistrationListener ctor - Add the current object to the list of
 239   /// PassRegistrationListeners...
 240   PassRegistrationListener();
 241
 242   /// dtor - Remove object from list of listeners...
 243   ///
 244   virtual ~PassRegistrationListener();
 245
 246   /// Callback functions - These functions are invoked whenever a pass is loaded
 247   /// or removed from the current executable.
 248   ///
 249   virtual void passRegistered(const PassInfo *P) {}
 250   virtual void passUnregistered(const PassInfo *P) {}
 251
 252   /// enumeratePasses - Iterate over the registered passes, calling the
 253   /// passEnumerate callback on each PassInfo object.
 254   ///
 255   void enumeratePasses();
 256
 257   /// passEnumerate - Callback function invoked when someone calls
 258   /// enumeratePasses on this PassRegistrationListener object.
 259   ///
 260   virtual void passEnumerate(const PassInfo *P) {}
 261 };
 262
 263
 264 } // End llvm namespace
 265
 266 #endif