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