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