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