include/llvm/Support/InstVisitor.h

   1 //===- llvm/Support/InstVisitor.h - Define instruction visitors -*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This template class is used to define instruction visitors in a typesafe
  11 // manner without having to use lots of casts and a big switch statement (in
  12 // your code that is).  The win here is that if instructions are added in the
  13 // future, they will be added to the InstVisitor<T> class, allowing you to
  14 // automatically support them (if you handle on of their superclasses).
  15 //
  16 // Note that this library is specifically designed as a template to avoid
  17 // virtual function call overhead.  Defining and using an InstVisitor is just as
  18 // efficient as having your own switch statement over the instruction opcode.
  19 //
  20 // InstVisitor Usage:
  21 //   You define InstVisitors from inheriting from the InstVisitor base class
  22 // and "overriding" functions in your class.  I say "overriding" because this
  23 // class is defined in terms of statically resolved overloading, not virtual
  24 // functions.  As an example, here is a visitor that counts the number of malloc
  25 // instructions processed:
  26 //
  27 //  // Declare the class.  Note that we derive from InstVisitor instantiated
  28 //  // with _our new subclasses_ type.
  29 //  //
  30 //  struct CountMallocVisitor : public InstVisitor<CountMallocVisitor> {
  31 //    unsigned Count;
  32 //    CountMallocVisitor() : Count(0) {}
  33 //
  34 //    void visitMallocInst(MallocInst *MI) { ++Count; }
  35 //  };
  36 //
  37 //  And this class would be used like this:
  38 //    CountMallocVistor CMV;
  39 //    CMV.visit(function);
  40 //    NumMallocs = CMV.Count;
  41 //
  42 // Returning a value from the visitation function:
  43 //   The InstVisitor class takes an optional second template argument that
  44 // specifies what type the instruction visitation functions should return.  If
  45 // you specify this, you *MUST* provide an implementation of visitInstruction
  46 // though!.
  47 //
  48 //===----------------------------------------------------------------------===//
  49
  50 #ifndef LLVM_SUPPORT_INSTVISITOR_H
  51 #define LLVM_SUPPORT_INSTVISITOR_H
  52
  53 #include "llvm/Instruction.h"
  54
  55 class Module;
  56
  57 // We operate on opaque instruction classes, so forward declare all instruction
  58 // types now...
  59 //
  60 #define HANDLE_INST(NUM, OPCODE, CLASS)   class CLASS;
  61 #include "llvm/Instruction.def"
  62
  63 // Forward declare the intermediate types...
  64 class TerminatorInst; class BinaryOperator;
  65 class AllocationInst;
  66
  67
  68 #define DELEGATE(CLASS_TO_VISIT) \
  69   return ((SubClass*)this)->visit##CLASS_TO_VISIT((CLASS_TO_VISIT&)I)
  70
  71
  72 template<typename SubClass, typename RetTy=void>
  73 struct InstVisitor {
  74   virtual ~InstVisitor() {}           // We are meant to be derived from
  75
  76   //===--------------------------------------------------------------------===//
  77   // Interface code - This is the public interface of the InstVisitor that you
  78   // use to visit instructions...
  79   //
  80
  81   // Generic visit method - Allow visitation to all instructions in a range
  82   template<class Iterator>
  83   void visit(Iterator Start, Iterator End) {
  84     while (Start != End)
  85       ((SubClass*)this)->visit(*Start++);
  86   }
  87
  88   // Define visitors for functions and basic blocks...
  89   //
  90   void visit(Function &F) {
  91     ((SubClass*)this)->visitFunction(F);
  92     visit(F.begin(), F.end());
  93   }
  94   void visit(BasicBlock &BB) {
  95     ((SubClass*)this)->visitBasicBlock(BB);
  96     visit(BB.begin(), BB.end());
  97   }
  98
  99   // Forwarding functions so that the user can visit with pointers AND refs.
 100   void visit(Module       *M)  { visit(*M); }
 101   void visit(Function     *F)  { visit(*F); }
 102   void visit(BasicBlock   *BB) { visit(*BB); }
 103   RetTy visit(Instruction *I)  { return visit(*I); }
 104
 105   // visit - Finally, code to visit an instruction...
 106   //
 107   RetTy visit(Instruction &I) {
 108     switch (I.getOpcode()) {
 109     default: assert(0 && "Unknown instruction type encountered!");
 110              abort();
 111       // Build the switch statement using the Instruction.def file...
 112 #define HANDLE_INST(NUM, OPCODE, CLASS) \
 113     case Instruction::OPCODE:return ((SubClass*)this)->visit##OPCODE((CLASS&)I);
 114 #include "llvm/Instruction.def"
 115     }
 116   }
 117
 118   //===--------------------------------------------------------------------===//
 119   // Visitation functions... these functions provide default fallbacks in case
 120   // the user does not specify what to do for a particular instruction type.
 121   // The default behavior is to generalize the instruction type to its subtype
 122   // and try visiting the subtype.  All of this should be inlined perfectly,
 123   // because there are no virtual functions to get in the way.
 124   //
 125
 126   // When visiting a module, function or basic block directly, these methods get
 127   // called to indicate when transitioning into a new unit.
 128   //
 129   void visitFunction  (Function &F) {}
 130   void visitBasicBlock(BasicBlock &BB) {}
 131
 132
 133   // Define instruction specific visitor functions that can be overridden to
 134   // handle SPECIFIC instructions.  These functions automatically define
 135   // visitMul to proxy to visitBinaryOperator for instance in case the user does
 136   // not need this generality.
 137   //
 138   // The one problem case we have to handle here though is that the PHINode
 139   // class and opcode name are the exact same.  Because of this, we cannot
 140   // define visitPHINode (the inst version) to forward to visitPHINode (the
 141   // generic version) without multiply defined symbols and recursion.  To handle
 142   // this, we do not autoexpand "Other" instructions, we do it manually.
 143   //
 144 #define HANDLE_INST(NUM, OPCODE, CLASS) \
 145     RetTy visit##OPCODE(CLASS &I) { DELEGATE(CLASS); }
 146 #include "llvm/Instruction.def"
 147
 148   // Specific Instruction type classes... note that all of the casts are
 149   // necessary because we use the instruction classes as opaque types...
 150   //
 151   RetTy visitReturnInst(ReturnInst &I)              { DELEGATE(TerminatorInst);}
 152   RetTy visitBranchInst(BranchInst &I)              { DELEGATE(TerminatorInst);}
 153   RetTy visitSwitchInst(SwitchInst &I)              { DELEGATE(TerminatorInst);}
 154   RetTy visitInvokeInst(InvokeInst &I)              { DELEGATE(TerminatorInst);}
 155   RetTy visitUnwindInst(UnwindInst &I)              { DELEGATE(TerminatorInst);}
 156   RetTy visitSetCondInst(SetCondInst &I)            { DELEGATE(BinaryOperator);}
 157   RetTy visitMallocInst(MallocInst &I)              { DELEGATE(AllocationInst);}
 158   RetTy visitAllocaInst(AllocaInst &I)              { DELEGATE(AllocationInst);}
 159   RetTy visitFreeInst(FreeInst     &I)              { DELEGATE(Instruction); }
 160   RetTy visitLoadInst(LoadInst     &I)              { DELEGATE(Instruction); }
 161   RetTy visitStoreInst(StoreInst   &I)              { DELEGATE(Instruction); }
 162   RetTy visitGetElementPtrInst(GetElementPtrInst &I){ DELEGATE(Instruction); }
 163   RetTy visitPHINode(PHINode       &I)              { DELEGATE(Instruction); }
 164   RetTy visitCastInst(CastInst     &I)              { DELEGATE(Instruction); }
 165   RetTy visitCallInst(CallInst     &I)              { DELEGATE(Instruction); }
 166   RetTy visitShiftInst(ShiftInst   &I)              { DELEGATE(Instruction); }
 167   RetTy visitVANextInst(VANextInst &I)              { DELEGATE(Instruction); }
 168   RetTy visitVAArgInst(VAArgInst   &I)              { DELEGATE(Instruction); }
 169
 170   // Next level propagators... if the user does not overload a specific
 171   // instruction type, they can overload one of these to get the whole class
 172   // of instructions...
 173   //
 174   RetTy visitTerminatorInst(TerminatorInst &I) { DELEGATE(Instruction); }
 175   RetTy visitBinaryOperator(BinaryOperator &I) { DELEGATE(Instruction); }
 176   RetTy visitAllocationInst(AllocationInst &I) { DELEGATE(Instruction); }
 177
 178   // If the user wants a 'default' case, they can choose to override this
 179   // function.  If this function is not overloaded in the users subclass, then
 180   // this instruction just gets ignored.
 181   //
 182   // Note that you MUST override this function if your return type is not void.
 183   //
 184   void visitInstruction(Instruction &I) {}  // Ignore unhandled instructions
 185 };
 186
 187 #undef DELEGATE
 188
 189 #endif