include/llvm/Instruction.h

   1 //===-- llvm/Instruction.h - Instruction class definition -------*- C++ -*-===//
   2 //
   3 // This file contains the declaration of the Instruction class, which is the
   4 // base class for all of the LLVM instructions.
   5 //
   6 //===----------------------------------------------------------------------===//
   7
   8 #ifndef LLVM_INSTRUCTION_H
   9 #define LLVM_INSTRUCTION_H
  10
  11 #include "llvm/User.h"
  12 template<typename SC> struct ilist_traits;
  13 template<typename ValueSubClass, typename ItemParentClass, typename SymTabClass,
  14          typename SubClass> class SymbolTableListTraits;
  15
  16 class Instruction : public User {
  17   BasicBlock *Parent;
  18   Instruction *Prev, *Next; // Next and Prev links for our intrusive linked list
  19
  20   void setNext(Instruction *N) { Next = N; }
  21   void setPrev(Instruction *N) { Prev = N; }
  22
  23   friend class SymbolTableListTraits<Instruction, BasicBlock, Function,
  24                                      ilist_traits<Instruction> >;
  25   void setParent(BasicBlock *P);
  26 protected:
  27   unsigned iType;      // InstructionType: The opcode of the instruction
  28
  29   Instruction(const Type *Ty, unsigned iType, const std::string &Name = "",
  30               Instruction *InsertBefore = 0);
  31 public:
  32   virtual ~Instruction() {
  33     assert(Parent == 0 && "Instruction still embedded in basic block!");
  34   }
  35
  36   // Specialize setName to handle symbol table majik...
  37   virtual void setName(const std::string &name, SymbolTable *ST = 0);
  38
  39   /// clone() - Create a copy of 'this' instruction that is identical in all
  40   /// ways except the following:
  41   ///   * The instruction has no parent
  42   ///   * The instruction has no name
  43   ///
  44   virtual Instruction *clone() const = 0;
  45
  46   // Accessor methods...
  47   //
  48   inline const BasicBlock *getParent() const { return Parent; }
  49   inline       BasicBlock *getParent()       { return Parent; }
  50
  51   // getNext/Prev - Return the next or previous instruction in the list.  The
  52   // last node in the list is a terminator instruction.
  53         Instruction *getNext()       { return Next; }
  54   const Instruction *getNext() const { return Next; }
  55         Instruction *getPrev()       { return Prev; }
  56   const Instruction *getPrev() const { return Prev; }
  57
  58   virtual bool hasSideEffects() const { return false; }  // Memory & Call insts
  59
  60   // ---------------------------------------------------------------------------
  61   /// Subclass classification... getOpcode() returns a member of
  62   /// one of the enums that is coming soon (down below)...
  63   ///
  64   unsigned getOpcode() const { return iType; }
  65   virtual const char *getOpcodeName() const {
  66     return getOpcodeName(getOpcode());
  67   }
  68   static const char* getOpcodeName(unsigned OpCode);
  69
  70   inline bool isTerminator() const {   // Instance of TerminatorInst?
  71     return iType >= FirstTermOp && iType < NumTermOps;
  72   }
  73   inline bool isBinaryOp() const {
  74     return iType >= FirstBinaryOp && iType < NumBinaryOps;
  75   }
  76
  77   virtual void print(std::ostream &OS) const;
  78
  79   /// Methods for support type inquiry through isa, cast, and dyn_cast:
  80   static inline bool classof(const Instruction *I) { return true; }
  81   static inline bool classof(const Value *V) {
  82     return V->getValueType() == Value::InstructionVal;
  83   }
  84
  85   //----------------------------------------------------------------------
  86   // Exported enumerations...
  87   //
  88   enum TermOps {       // These terminate basic blocks
  89 #define  FIRST_TERM_INST(N)             FirstTermOp = N,
  90 #define HANDLE_TERM_INST(N, OPC, CLASS) OPC = N,
  91 #define   LAST_TERM_INST(N)             NumTermOps = N+1,
  92 #include "llvm/Instruction.def"
  93   };
  94
  95   enum BinaryOps {
  96 #define  FIRST_BINARY_INST(N)             FirstBinaryOp = N,
  97 #define HANDLE_BINARY_INST(N, OPC, CLASS) OPC = N,
  98 #define   LAST_BINARY_INST(N)             NumBinaryOps = N+1,
  99 #include "llvm/Instruction.def"
 100   };
 101
 102   enum MemoryOps {
 103 #define  FIRST_MEMORY_INST(N)             FirstMemoryOp = N,
 104 #define HANDLE_MEMORY_INST(N, OPC, CLASS) OPC = N,
 105 #define   LAST_MEMORY_INST(N)             NumMemoryOps = N+1,
 106 #include "llvm/Instruction.def"
 107   };
 108
 109   enum OtherOps {
 110 #define  FIRST_OTHER_INST(N)             FirstOtherOp = N,
 111 #define HANDLE_OTHER_INST(N, OPC, CLASS) OPC = N,
 112 #define   LAST_OTHER_INST(N)             NumOtherOps = N+1,
 113 #include "llvm/Instruction.def"
 114   };
 115 };
 116
 117 #endif