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