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
  13 template<typename SC> struct ilist_traits;
  14 template<typename ValueSubClass, typename ItemParentClass, typename SymTabClass,
  15          typename SubClass> class SymbolTableListTraits;
  16
  17 class Instruction : public User {
  18   BasicBlock *Parent;
  19   Instruction *Prev, *Next; // Next and Prev links for our intrusive linked list
  20
  21   void setNext(Instruction *N) { Next = N; }
  22   void setPrev(Instruction *N) { Prev = N; }
  23
  24   friend class SymbolTableListTraits<Instruction, BasicBlock, Function,
  25                                      ilist_traits<Instruction> >;
  26   void setParent(BasicBlock *P);
  27 protected:
  28   unsigned iType;      // InstructionType: The opcode of the instruction
  29
  30   Instruction(const Type *Ty, unsigned iType, const std::string &Name = "",
  31               Instruction *InsertBefore = 0);
  32 public:
  33   virtual ~Instruction() {
  34     assert(Parent == 0 && "Instruction still embedded in basic block!");
  35   }
  36
  37   // Specialize setName to handle symbol table majik...
  38   virtual void setName(const std::string &name, SymbolTable *ST = 0);
  39
  40   /// clone() - Create a copy of 'this' instruction that is identical in all
  41   /// ways except the following:
  42   ///   * The instruction has no parent
  43   ///   * The instruction has no name
  44   ///
  45   virtual Instruction *clone() const = 0;
  46
  47   // Accessor methods...
  48   //
  49   inline const BasicBlock *getParent() const { return Parent; }
  50   inline       BasicBlock *getParent()       { return Parent; }
  51
  52   // getNext/Prev - Return the next or previous instruction in the list.  The
  53   // last node in the list is a terminator instruction.
  54         Instruction *getNext()       { return Next; }
  55   const Instruction *getNext() const { return Next; }
  56         Instruction *getPrev()       { return Prev; }
  57   const Instruction *getPrev() const { return Prev; }
  58
  59   /// mayWriteToMemory - Return true if this instruction may modify memory.
  60   ///
  61   virtual bool mayWriteToMemory() const { return false; }
  62
  63   // ---------------------------------------------------------------------------
  64   /// Subclass classification... getOpcode() returns a member of
  65   /// one of the enums that is coming soon (down below)...
  66   ///
  67   unsigned getOpcode() const { return iType; }
  68   virtual const char *getOpcodeName() const {
  69     return getOpcodeName(getOpcode());
  70   }
  71   static const char* getOpcodeName(unsigned OpCode);
  72
  73   inline bool isTerminator() const {   // Instance of TerminatorInst?
  74     return iType >= TermOpsBegin && iType < TermOpsEnd;
  75   }
  76   inline bool isBinaryOp() const {
  77     return iType >= BinaryOpsBegin && iType < BinaryOpsEnd;
  78   }
  79
  80   /// isAssociative - Return true if the instruction is associative:
  81   ///
  82   ///   Associative operators satisfy:  x op (y op z) === (x op y) op z
  83   ///
  84   /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative, when
  85   /// not applied to floating point types.
  86   ///
  87   bool isAssociative() const { return isAssociative(getOpcode(), getType()); }
  88   static bool isAssociative(unsigned op, const Type *Ty);
  89
  90   /// isCommutative - Return true if the instruction is commutative:
  91   ///
  92   ///   Commutative operators satisfy: (x op y) === (y op x)
  93   ///
  94   /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
  95   /// applied to any type.
  96   ///
  97   bool isCommutative() const { return isCommutative(getOpcode()); }
  98   static bool isCommutative(unsigned op);
  99
 100   /// isTrappingInstruction - Return true if the instruction may trap.
 101   ///
 102   bool isTrappingInstruction() const {
 103     return isTrappingInstruction(getOpcode());
 104   }
 105   static bool isTrappingInstruction(unsigned op);
 106
 107   virtual void print(std::ostream &OS) const;
 108
 109   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 110   static inline bool classof(const Instruction *I) { return true; }
 111   static inline bool classof(const Value *V) {
 112     return V->getValueType() == Value::InstructionVal;
 113   }
 114
 115   //----------------------------------------------------------------------
 116   // Exported enumerations...
 117   //
 118   enum TermOps {       // These terminate basic blocks
 119 #define  FIRST_TERM_INST(N)             TermOpsBegin = N,
 120 #define HANDLE_TERM_INST(N, OPC, CLASS) OPC = N,
 121 #define   LAST_TERM_INST(N)             TermOpsEnd = N+1,
 122 #include "llvm/Instruction.def"
 123   };
 124
 125   enum BinaryOps {
 126 #define  FIRST_BINARY_INST(N)             BinaryOpsBegin = N,
 127 #define HANDLE_BINARY_INST(N, OPC, CLASS) OPC = N,
 128 #define   LAST_BINARY_INST(N)             BinaryOpsEnd = N+1,
 129 #include "llvm/Instruction.def"
 130   };
 131
 132   enum MemoryOps {
 133 #define  FIRST_MEMORY_INST(N)             MemoryOpsBegin = N,
 134 #define HANDLE_MEMORY_INST(N, OPC, CLASS) OPC = N,
 135 #define   LAST_MEMORY_INST(N)             MemoryOpsEnd = N+1,
 136 #include "llvm/Instruction.def"
 137   };
 138
 139   enum OtherOps {
 140 #define  FIRST_OTHER_INST(N)             OtherOpsBegin = N,
 141 #define HANDLE_OTHER_INST(N, OPC, CLASS) OPC = N,
 142 #define   LAST_OTHER_INST(N)             OtherOpsEnd = N+1,
 143 #include "llvm/Instruction.def"
 144   };
 145 };
 146
 147 #endif