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/Function.h"
  54 #include "llvm/Module.h"
  55
  56 namespace llvm {
  57
  58 // We operate on opaque instruction classes, so forward declare all instruction
  59 // types now...
  60 //
  61 #define HANDLE_INST(NUM, OPCODE, CLASS)   class CLASS;
  62 #include "llvm/Instruction.def"
  63
  64 // Forward declare the intermediate types...
  65 class TerminatorInst; class BinaryOperator;
  66 class AllocationInst;
  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(Module &M) {
  91     ((SubClass*)this)->visitModule(M);
  92     visit(M.begin(), M.end());
  93   }
  94   void visit(Function &F) {
  95     ((SubClass*)this)->visitFunction(F);
  96     visit(F.begin(), F.end());
  97   }
  98   void visit(BasicBlock &BB) {
  99     ((SubClass*)this)->visitBasicBlock(BB);
 100     visit(BB.begin(), BB.end());
 101   }
 102
 103   // Forwarding functions so that the user can visit with pointers AND refs.
 104   void visit(Module       *M)  { visit(*M); }
 105   void visit(Function     *F)  { visit(*F); }
 106   void visit(BasicBlock   *BB) { visit(*BB); }
 107   RetTy visit(Instruction *I)  { return visit(*I); }
 108
 109   // visit - Finally, code to visit an instruction...
 110   //
 111   RetTy visit(Instruction &I) {
 112     switch (I.getOpcode()) {
 113     default: assert(0 && "Unknown instruction type encountered!");
 114              abort();
 115       // Build the switch statement using the Instruction.def file...
 116 #define HANDLE_INST(NUM, OPCODE, CLASS) \
 117     case Instruction::OPCODE:return ((SubClass*)this)->visit##OPCODE((CLASS&)I);
 118 #include "llvm/Instruction.def"
 119     }
 120   }
 121
 122   //===--------------------------------------------------------------------===//
 123   // Visitation functions... these functions provide default fallbacks in case
 124   // the user does not specify what to do for a particular instruction type.
 125   // The default behavior is to generalize the instruction type to its subtype
 126   // and try visiting the subtype.  All of this should be inlined perfectly,
 127   // because there are no virtual functions to get in the way.
 128   //
 129
 130   // When visiting a module, function or basic block directly, these methods get
 131   // called to indicate when transitioning into a new unit.
 132   //
 133   void visitModule    (Module &M) {}
 134   void visitFunction  (Function &F) {}
 135   void visitBasicBlock(BasicBlock &BB) {}
 136
 137
 138   // Define instruction specific visitor functions that can be overridden to
 139   // handle SPECIFIC instructions.  These functions automatically define
 140   // visitMul to proxy to visitBinaryOperator for instance in case the user does
 141   // not need this generality.
 142   //
 143   // The one problem case we have to handle here though is that the PHINode
 144   // class and opcode name are the exact same.  Because of this, we cannot
 145   // define visitPHINode (the inst version) to forward to visitPHINode (the
 146   // generic version) without multiply defined symbols and recursion.  To handle
 147   // this, we do not autoexpand "Other" instructions, we do it manually.
 148   //
 149 #define HANDLE_INST(NUM, OPCODE, CLASS) \
 150     RetTy visit##OPCODE(CLASS &I) { DELEGATE(CLASS); }
 151 #include "llvm/Instruction.def"
 152
 153   // Specific Instruction type classes... note that all of the casts are
 154   // necessary because we use the instruction classes as opaque types...
 155   //
 156   RetTy visitReturnInst(ReturnInst &I)              { DELEGATE(TerminatorInst);}
 157   RetTy visitBranchInst(BranchInst &I)              { DELEGATE(TerminatorInst);}
 158   RetTy visitSwitchInst(SwitchInst &I)              { DELEGATE(TerminatorInst);}
 159   RetTy visitInvokeInst(InvokeInst &I)              { DELEGATE(TerminatorInst);}
 160   RetTy visitUnwindInst(UnwindInst &I)              { DELEGATE(TerminatorInst);}
 161   RetTy visitSetCondInst(SetCondInst &I)            { DELEGATE(BinaryOperator);}
 162   RetTy visitMallocInst(MallocInst &I)              { DELEGATE(AllocationInst);}
 163   RetTy visitAllocaInst(AllocaInst &I)              { DELEGATE(AllocationInst);}
 164   RetTy visitFreeInst(FreeInst     &I)              { DELEGATE(Instruction); }
 165   RetTy visitLoadInst(LoadInst     &I)              { DELEGATE(Instruction); }
 166   RetTy visitStoreInst(StoreInst   &I)              { DELEGATE(Instruction); }
 167   RetTy visitGetElementPtrInst(GetElementPtrInst &I){ DELEGATE(Instruction); }
 168   RetTy visitPHINode(PHINode       &I)              { DELEGATE(Instruction); }
 169   RetTy visitCastInst(CastInst     &I)              { DELEGATE(Instruction); }
 170   RetTy visitSelectInst(SelectInst &I)              { DELEGATE(Instruction); }
 171   RetTy visitCallInst(CallInst     &I)              { DELEGATE(Instruction); }
 172   RetTy visitShiftInst(ShiftInst   &I)              { DELEGATE(Instruction); }
 173   RetTy visitVANextInst(VANextInst &I)              { DELEGATE(Instruction); }
 174   RetTy visitVAArgInst(VAArgInst   &I)              { DELEGATE(Instruction); }
 175
 176   // Next level propagators... if the user does not overload a specific
 177   // instruction type, they can overload one of these to get the whole class
 178   // of instructions...
 179   //
 180   RetTy visitTerminatorInst(TerminatorInst &I) { DELEGATE(Instruction); }
 181   RetTy visitBinaryOperator(BinaryOperator &I) { DELEGATE(Instruction); }
 182   RetTy visitAllocationInst(AllocationInst &I) { DELEGATE(Instruction); }
 183
 184   // If the user wants a 'default' case, they can choose to override this
 185   // function.  If this function is not overloaded in the users subclass, then
 186   // this instruction just gets ignored.
 187   //
 188   // Note that you MUST override this function if your return type is not void.
 189   //
 190   void visitInstruction(Instruction &I) {}  // Ignore unhandled instructions
 191 };
 192
 193 #undef DELEGATE
 194
 195 } // End llvm namespace
 196
 197 #endif