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