include/llvm/PassSupport.h

   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 // No need to include Pass.h, we are being included by it!
  25
  26 namespace llvm {
  27
  28 class 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 ///
  36 class PassInfo {
  37 public:
  38   typedef Pass* (*NormalCtor_t)();
  39
  40 private:
  41   const char      *const PassName;     // Nice name for Pass
  42   const char      *const PassArgument; // Command Line argument to run this pass
  43   const intptr_t  PassID;
  44   const bool IsCFGOnlyPass;            // Pass only looks at the CFG.
  45   const bool IsAnalysis;               // True if an analysis pass.
  46   const bool IsAnalysisGroup;          // True if an analysis group.
  47   std::vector<const PassInfo*> ItfImpl;// Interfaces implemented by this pass
  48
  49   NormalCtor_t NormalCtor;
  50
  51 public:
  52   /// PassInfo ctor - Do not call this directly, this should only be invoked
  53   /// through RegisterPass.
  54   PassInfo(const char *name, const char *arg, intptr_t pi,
  55            NormalCtor_t normal = 0,
  56            bool isCFGOnly = false, bool isAnalysis = false)
  57     : PassName(name), PassArgument(arg), PassID(pi),
  58       IsCFGOnlyPass(isCFGOnly),
  59       IsAnalysis(isAnalysis), IsAnalysisGroup(false), NormalCtor(normal) {
  60     registerPass();
  61   }
  62   /// PassInfo ctor - Do not call this directly, this should only be invoked
  63   /// through RegisterPass. This version is for use by analysis groups; it
  64   /// does not auto-register the pass.
  65   PassInfo(const char *name, intptr_t pi)
  66     : PassName(name), PassArgument(""), PassID(pi),
  67       IsCFGOnlyPass(false),
  68       IsAnalysis(false), IsAnalysisGroup(true), NormalCtor(0) {
  69   }
  70
  71   /// getPassName - Return the friendly name for the pass, never returns null
  72   ///
  73   const char *getPassName() const { return PassName; }
  74
  75   /// getPassArgument - Return the command line option that may be passed to
  76   /// 'opt' that will cause this pass to be run.  This will return null if there
  77   /// is no argument.
  78   ///
  79   const char *getPassArgument() const { return PassArgument; }
  80
  81   /// getTypeInfo - Return the id object for the pass...
  82   /// TODO : Rename
  83   intptr_t getTypeInfo() const { return PassID; }
  84
  85   /// isAnalysisGroup - Return true if this is an analysis group, not a normal
  86   /// pass.
  87   ///
  88   bool isAnalysisGroup() const { return IsAnalysisGroup; }
  89   bool isAnalysis() const { return IsAnalysis; }
  90
  91   /// isCFGOnlyPass - return true if this pass only looks at the CFG for the
  92   /// function.
  93   bool isCFGOnlyPass() const { return IsCFGOnlyPass; }
  94
  95   /// getNormalCtor - Return a pointer to a function, that when called, creates
  96   /// an instance of the pass and returns it.  This pointer may be null if there
  97   /// is no default constructor for the pass.
  98   ///
  99   NormalCtor_t getNormalCtor() const {
 100     return NormalCtor;
 101   }
 102   void setNormalCtor(NormalCtor_t Ctor) {
 103     NormalCtor = Ctor;
 104   }
 105
 106   /// createPass() - Use this method to create an instance of this pass.
 107   Pass *createPass() const {
 108     assert((!isAnalysisGroup() || NormalCtor) &&
 109            "No default implementation found for analysis group!");
 110     assert(NormalCtor &&
 111            "Cannot call createPass on PassInfo without default ctor!");
 112     return NormalCtor();
 113   }
 114
 115   /// addInterfaceImplemented - This method is called when this pass is
 116   /// registered as a member of an analysis group with the RegisterAnalysisGroup
 117   /// template.
 118   ///
 119   void addInterfaceImplemented(const PassInfo *ItfPI) {
 120     ItfImpl.push_back(ItfPI);
 121   }
 122
 123   /// getInterfacesImplemented - Return a list of all of the analysis group
 124   /// interfaces implemented by this pass.
 125   ///
 126   const std::vector<const PassInfo*> &getInterfacesImplemented() const {
 127     return ItfImpl;
 128   }
 129
 130   /// getPassInfo - Deprecated API compaatibility function. This function
 131   /// just returns 'this'.
 132   ///
 133   const PassInfo *getPassInfo() const {
 134     return this;
 135   }
 136
 137 protected:
 138   void registerPass();
 139   void unregisterPass();
 140 };
 141
 142
 143 template<typename PassName>
 144 Pass *callDefaultCtor() { return new PassName(); }
 145
 146 //===---------------------------------------------------------------------------
 147 /// RegisterPass<t> template - This template class is used to notify the system
 148 /// that a Pass is available for use, and registers it into the internal
 149 /// database maintained by the PassManager.  Unless this template is used, opt,
 150 /// for example will not be able to see the pass and attempts to create the pass
 151 /// will fail. This template is used in the follow manner (at global scope, in
 152 /// your .cpp file):
 153 ///
 154 /// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name");
 155 ///
 156 /// This statement will cause your pass to be created by calling the default
 157 /// constructor exposed by the pass.  If you have a different constructor that
 158 /// must be called, create a global constructor function (which takes the
 159 /// arguments you need and returns a Pass*) and register your pass like this:
 160 ///
 161 /// static RegisterPass<PassClassName> tmp("passopt", "My Name");
 162 ///
 163 template<typename passName>
 164 struct RegisterPass : public PassInfo {
 165
 166   // Register Pass using default constructor...
 167   RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false,
 168                bool IsAnalysis = false)
 169     : PassInfo(Name, PassArg, intptr_t(&passName::ID),
 170                PassInfo::NormalCtor_t(callDefaultCtor<passName>),
 171                CFGOnly, IsAnalysis) {
 172   }
 173 };
 174
 175
 176 /// RegisterAnalysisGroup - Register a Pass as a member of an analysis _group_.
 177 /// Analysis groups are used to define an interface (which need not derive from
 178 /// Pass) that is required by passes to do their job.  Analysis Groups differ
 179 /// from normal analyses because any available implementation of the group will
 180 /// be used if it is available.
 181 ///
 182 /// If no analysis implementing the interface is available, a default
 183 /// implementation is created and added.  A pass registers itself as the default
 184 /// implementation by specifying 'true' as the third template argument of this
 185 /// class.
 186 ///
 187 /// In addition to registering itself as an analysis group member, a pass must
 188 /// register itself normally as well.  Passes may be members of multiple groups
 189 /// and may still be "required" specifically by name.
 190 ///
 191 /// The actual interface may also be registered as well (by not specifying the
 192 /// second template argument).  The interface should be registered to associate
 193 /// a nice name with the interface.
 194 ///
 195 class RegisterAGBase : public PassInfo {
 196   PassInfo *InterfaceInfo;
 197   const PassInfo *ImplementationInfo;
 198   bool isDefaultImplementation;
 199 protected:
 200   explicit RegisterAGBase(const char *Name,
 201                           intptr_t InterfaceID,
 202                           intptr_t PassID = 0,
 203                           bool isDefault = false);
 204 };
 205
 206 template<typename Interface, bool Default = false>
 207 struct 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 ///
 230 struct 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 *P) {}
 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 *P) {}
 254 };
 255
 256
 257 } // End llvm namespace
 258
 259 #endif