include/llvm/CodeGen/MachinePassRegistry.h

   1 //===-- llvm/CodeGen/MachinePassRegistry.h ----------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the James M. Laskey and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains the mechanics for machine function pass registries.  A
  11 // function pass registry (MachinePassRegistry) is auto filled by the static
  12 // constructors of MachinePassRegistryNode.  Further there is a command line
  13 // parser (RegisterPassParser) which listens to each registry for additions
  14 // and deletions, so that the appropriate command option is updated.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #ifndef LLVM_CODEGEN_MACHINEPASSREGISTRY_H
  19 #define LLVM_CODEGEN_MACHINEPASSREGISTRY_H
  20
  21 #include "llvm/CodeGen/Passes.h"
  22 #include "llvm/CodeGen/ScheduleDAG.h"
  23 #include "llvm/Support/CommandLine.h"
  24
  25 namespace llvm {
  26
  27 typedef void *(*MachinePassCtor)();
  28
  29
  30 //===----------------------------------------------------------------------===//
  31 ///
  32 /// MachinePassRegistryListener - Listener to adds and removals of nodes in
  33 /// registration list.
  34 ///
  35 //===----------------------------------------------------------------------===//
  36 class MachinePassRegistryListener {
  37 public:
  38   MachinePassRegistryListener() {}
  39   virtual ~MachinePassRegistryListener() {}
  40   virtual void NotifyAdd(const char *N, MachinePassCtor C, const char *D) = 0;
  41   virtual void NotifyRemove(const char *N) = 0;
  42 };
  43
  44
  45 //===----------------------------------------------------------------------===//
  46 ///
  47 /// MachinePassRegistryNode - Machine pass node stored in registration list.
  48 ///
  49 //===----------------------------------------------------------------------===//
  50 class MachinePassRegistryNode {
  51
  52 private:
  53
  54   MachinePassRegistryNode *Next;        // Next function pass in list.
  55   const char *Name;                     // Name of function pass.
  56   const char *Description;              // Description string.
  57   MachinePassCtor Ctor;                 // Function pass creator.
  58
  59 public:
  60
  61   MachinePassRegistryNode(const char *N, const char *D, MachinePassCtor C)
  62   : Next(NULL)
  63   , Name(N)
  64   , Description(D)
  65   , Ctor(C)
  66   {}
  67
  68   // Accessors
  69   MachinePassRegistryNode *getNext()      const { return Next; }
  70   MachinePassRegistryNode **getNextAddress()    { return &Next; }
  71   const char *getName()                   const { return Name; }
  72   const char *getDescription()            const { return Description; }
  73   MachinePassCtor getCtor()               const { return Ctor; }
  74   void setNext(MachinePassRegistryNode *N)      { Next = N; }
  75
  76 };
  77
  78
  79 //===----------------------------------------------------------------------===//
  80 ///
  81 /// MachinePassRegistry - Track the registration of machine passes.
  82 ///
  83 //===----------------------------------------------------------------------===//
  84 class MachinePassRegistry {
  85
  86 private:
  87
  88   MachinePassRegistryNode *List;        // List of registry nodes.
  89   MachinePassCtor Default;              // Default function pass creator.
  90   MachinePassRegistryListener* Listener;// Listener for list adds are removes.
  91
  92 public:
  93
  94   // NO CONSTRUCTOR - we don't want static constructor ordering to mess
  95   // with the registry.
  96
  97   // Accessors.
  98   //
  99   MachinePassRegistryNode *getList()                    { return List; }
 100   MachinePassCtor getDefault()                          { return Default; }
 101   void setDefault(MachinePassCtor C)                    { Default = C; }
 102   void setListener(MachinePassRegistryListener *L)      { Listener = L; }
 103
 104   /// Add - Adds a function pass to the registration list.
 105   ///
 106   void Add(MachinePassRegistryNode *Node);
 107
 108   /// Remove - Removes a function pass from the registration list.
 109   ///
 110   void Remove(MachinePassRegistryNode *Node);
 111
 112 };
 113
 114
 115 //===----------------------------------------------------------------------===//
 116 ///
 117 /// RegisterPassParser class - Handle the addition of new machine passes.
 118 ///
 119 //===----------------------------------------------------------------------===//
 120 template<class RegistryClass>
 121 class RegisterPassParser : public MachinePassRegistryListener,
 122                    public cl::parser<typename RegistryClass::FunctionPassCtor> {
 123 public:
 124   RegisterPassParser() {}
 125   ~RegisterPassParser() { RegistryClass::setListener(NULL); }
 126
 127   void initialize(cl::Option &O) {
 128     cl::parser<typename RegistryClass::FunctionPassCtor>::initialize(O);
 129
 130     // Add existing passes to option.
 131     for (RegistryClass *Node = RegistryClass::getList();
 132          Node; Node = Node->getNext()) {
 133       addLiteralOption(Node->getName(),
 134                       (typename RegistryClass::FunctionPassCtor)Node->getCtor(),
 135                       Node->getDescription());
 136     }
 137
 138     // Make sure we listen for list changes.
 139     RegistryClass::setListener(this);
 140   }
 141
 142   // Implement the MachinePassRegistryListener callbacks.
 143   //
 144   virtual void NotifyAdd(const char *N,
 145                          MachinePassCtor C,
 146                          const char *D) {
 147     this->addLiteralOption(N, (typename RegistryClass::FunctionPassCtor)C, D);
 148   }
 149   virtual void NotifyRemove(const char *N) {
 150     this->removeLiteralOption(N);
 151   }
 152 };
 153
 154
 155 } // end namespace llvm
 156
 157 #endif