include/llvm/Instruction.h

   1 //===-- llvm/Instruction.h - Instruction class definition -------*- 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 file contains the declaration of the Instruction class, which is the
  11 // base class for all of the LLVM instructions.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_INSTRUCTION_H
  16 #define LLVM_INSTRUCTION_H
  17
  18 #include "llvm/User.h"
  19
  20 namespace llvm {
  21
  22 struct AssemblyAnnotationWriter;
  23 class BinaryOperator;
  24
  25 template<typename SC> struct ilist_traits;
  26 template<typename ValueSubClass, typename ItemParentClass, typename SymTabClass,
  27          typename SubClass> class SymbolTableListTraits;
  28
  29 class Instruction : public User {
  30   BasicBlock *Parent;
  31   Instruction *Prev, *Next; // Next and Prev links for our intrusive linked list
  32
  33   void setNext(Instruction *N) { Next = N; }
  34   void setPrev(Instruction *N) { Prev = N; }
  35
  36   friend class SymbolTableListTraits<Instruction, BasicBlock, Function,
  37                                      ilist_traits<Instruction> >;
  38   void setParent(BasicBlock *P);
  39   void init();
  40
  41 private:
  42   // FIXME: This is a dirty hack.  Setcc instructions shouldn't encode the CC
  43   // into the opcode field.  When they don't, this will be unneeded.
  44   void setOpcode(unsigned NewOpcode);
  45   friend class BinaryOperator;
  46 protected:
  47   Instruction(const Type *Ty, unsigned iType, const std::string &Name = "",
  48               Instruction *InsertBefore = 0);
  49   Instruction(const Type *Ty, unsigned iType, const std::string &Name,
  50               BasicBlock *InsertAtEnd);
  51 public:
  52
  53   ~Instruction() {
  54     assert(Parent == 0 && "Instruction still linked in the program!");
  55   }
  56
  57   // Specialize setName to handle symbol table majik...
  58   virtual void setName(const std::string &name, SymbolTable *ST = 0);
  59
  60   /// mayWriteToMemory - Return true if this instruction may modify memory.
  61   ///
  62   virtual bool mayWriteToMemory() const { return false; }
  63
  64   /// clone() - Create a copy of 'this' instruction that is identical in all
  65   /// ways except the following:
  66   ///   * The instruction has no parent
  67   ///   * The instruction has no name
  68   ///
  69   virtual Instruction *clone() const = 0;
  70
  71   // Accessor methods...
  72   //
  73   inline const BasicBlock *getParent() const { return Parent; }
  74   inline       BasicBlock *getParent()       { return Parent; }
  75
  76   // getNext/Prev - Return the next or previous instruction in the list.  The
  77   // last node in the list is a terminator instruction.
  78         Instruction *getNext()       { return Next; }
  79   const Instruction *getNext() const { return Next; }
  80         Instruction *getPrev()       { return Prev; }
  81   const Instruction *getPrev() const { return Prev; }
  82
  83   /// removeFromParent - This method unlinks 'this' from the containing basic
  84   /// block, but does not delete it.
  85   ///
  86   void removeFromParent();
  87
  88   /// eraseFromParent - This method unlinks 'this' from the containing basic
  89   /// block and deletes it.
  90   ///
  91   void eraseFromParent();
  92
  93   // ---------------------------------------------------------------------------
  94   /// Subclass classification... getOpcode() returns a member of
  95   /// one of the enums that is coming soon (down below)...
  96   ///
  97   unsigned getOpcode() const { return getValueType() - InstructionVal; }
  98   virtual const char *getOpcodeName() const {
  99     return getOpcodeName(getOpcode());
 100   }
 101   static const char* getOpcodeName(unsigned OpCode);
 102
 103   static inline bool isTerminator(unsigned OpCode) {
 104     return OpCode >= TermOpsBegin && OpCode < TermOpsEnd;
 105   }
 106
 107   inline bool isTerminator() const {   // Instance of TerminatorInst?
 108     return isTerminator(getOpcode());
 109   }
 110
 111   inline bool isBinaryOp() const {
 112     return getOpcode() >= BinaryOpsBegin && getOpcode() < BinaryOpsEnd;
 113   }
 114
 115   /// isAssociative - Return true if the instruction is associative:
 116   ///
 117   ///   Associative operators satisfy:  x op (y op z) === (x op y) op z
 118   ///
 119   /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative, when
 120   /// not applied to floating point types.
 121   ///
 122   bool isAssociative() const { return isAssociative(getOpcode(), getType()); }
 123   static bool isAssociative(unsigned op, const Type *Ty);
 124
 125   /// isCommutative - Return true if the instruction is commutative:
 126   ///
 127   ///   Commutative operators satisfy: (x op y) === (y op x)
 128   ///
 129   /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
 130   /// applied to any type.
 131   ///
 132   bool isCommutative() const { return isCommutative(getOpcode()); }
 133   static bool isCommutative(unsigned op);
 134
 135   /// isRelational - Return true if the instruction is a Set* instruction:
 136   ///
 137   bool isRelational() const { return isRelational(getOpcode()); }
 138   static bool isRelational(unsigned op);
 139
 140
 141   /// isTrappingInstruction - Return true if the instruction may trap.
 142   ///
 143   bool isTrapping() const {
 144     return isTrapping(getOpcode());
 145   }
 146   static bool isTrapping(unsigned op);
 147
 148   virtual void print(std::ostream &OS) const { print(OS, 0); }
 149   void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
 150
 151   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 152   static inline bool classof(const Instruction *I) { return true; }
 153   static inline bool classof(const Value *V) {
 154     return V->getValueType() >= Value::InstructionVal;
 155   }
 156
 157   //----------------------------------------------------------------------
 158   // Exported enumerations...
 159   //
 160   enum TermOps {       // These terminate basic blocks
 161 #define  FIRST_TERM_INST(N)             TermOpsBegin = N,
 162 #define HANDLE_TERM_INST(N, OPC, CLASS) OPC = N,
 163 #define   LAST_TERM_INST(N)             TermOpsEnd = N+1,
 164 #include "llvm/Instruction.def"
 165   };
 166
 167   enum BinaryOps {
 168 #define  FIRST_BINARY_INST(N)             BinaryOpsBegin = N,
 169 #define HANDLE_BINARY_INST(N, OPC, CLASS) OPC = N,
 170 #define   LAST_BINARY_INST(N)             BinaryOpsEnd = N+1,
 171 #include "llvm/Instruction.def"
 172   };
 173
 174   enum MemoryOps {
 175 #define  FIRST_MEMORY_INST(N)             MemoryOpsBegin = N,
 176 #define HANDLE_MEMORY_INST(N, OPC, CLASS) OPC = N,
 177 #define   LAST_MEMORY_INST(N)             MemoryOpsEnd = N+1,
 178 #include "llvm/Instruction.def"
 179   };
 180
 181   enum OtherOps {
 182 #define  FIRST_OTHER_INST(N)             OtherOpsBegin = N,
 183 #define HANDLE_OTHER_INST(N, OPC, CLASS) OPC = N,
 184 #define   LAST_OTHER_INST(N)             OtherOpsEnd = N+1,
 185 #include "llvm/Instruction.def"
 186   };
 187 };
 188
 189 } // End llvm namespace
 190
 191 #endif