include/llvm/Instruction.h

   1 //===-- llvm/Instruction.h - Instruction class definition -------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // 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
  24 template<typename ValueSubClass, typename ItemParentClass>
  25   class SymbolTableListTraits;
  26
  27 class Instruction : public User {
  28   void operator=(const Instruction &);     // Do not implement
  29   Instruction(const Instruction &);        // Do not implement
  30
  31   BasicBlock *Parent;
  32   Instruction *Prev, *Next; // Next and Prev links for our intrusive linked list
  33
  34   void setNext(Instruction *N) { Next = N; }
  35   void setPrev(Instruction *N) { Prev = N; }
  36
  37   friend class SymbolTableListTraits<Instruction, BasicBlock>;
  38   void setParent(BasicBlock *P);
  39 protected:
  40   Instruction(const Type *Ty, unsigned iType, Use *Ops, unsigned NumOps,
  41               Instruction *InsertBefore = 0);
  42   Instruction(const Type *Ty, unsigned iType, Use *Ops, unsigned NumOps,
  43               BasicBlock *InsertAtEnd);
  44 public:
  45   // Out of line virtual method, so the vtable, etc has a home.
  46   ~Instruction();
  47
  48   /// mayWriteToMemory - Return true if this instruction may modify memory.
  49   ///
  50   bool mayWriteToMemory() const;
  51
  52   /// mayReadFromMemory - Return true if this instruction may read memory.
  53   ///
  54   bool mayReadFromMemory() const;
  55
  56   /// clone() - Create a copy of 'this' instruction that is identical in all
  57   /// ways except the following:
  58   ///   * The instruction has no parent
  59   ///   * The instruction has no name
  60   ///
  61   virtual Instruction *clone() const = 0;
  62
  63   /// isIdenticalTo - Return true if the specified instruction is exactly
  64   /// identical to the current one.  This means that all operands match and any
  65   /// extra information (e.g. load is volatile) agree.
  66   bool isIdenticalTo(Instruction *I) const;
  67
  68   /// This function determines if the specified instruction executes the same
  69   /// operation as the current one. This means that the opcodes, type, operand
  70   /// types and any other factors affecting the operation must be the same. This
  71   /// is similar to isIdenticalTo except the operands themselves don't have to
  72   /// be identical.
  73   /// @returns true if the specified instruction is the same operation as
  74   /// the current one.
  75   /// @brief Determine if one instruction is the same operation as another.
  76   bool isSameOperationAs(Instruction *I) const;
  77
  78   /// isUsedOutsideOfBlock - Return true if there are any uses of this
  79   /// instruction in blocks other than the specified block.  Note that PHI nodes
  80   /// are considered to evaluate their operands in the corresponding predecessor
  81   /// block.
  82   bool isUsedOutsideOfBlock(const BasicBlock *BB) const;
  83
  84
  85   /// use_back - Specialize the methods defined in Value, as we know that an
  86   /// instruction can only be used by other instructions.
  87   Instruction       *use_back()       { return cast<Instruction>(*use_begin());}
  88   const Instruction *use_back() const { return cast<Instruction>(*use_begin());}
  89
  90   // Accessor methods...
  91   //
  92   inline const BasicBlock *getParent() const { return Parent; }
  93   inline       BasicBlock *getParent()       { return Parent; }
  94
  95   /// removeFromParent - This method unlinks 'this' from the containing basic
  96   /// block, but does not delete it.
  97   ///
  98   void removeFromParent();
  99
 100   /// eraseFromParent - This method unlinks 'this' from the containing basic
 101   /// block and deletes it.
 102   ///
 103   void eraseFromParent();
 104
 105   /// insertBefore - Insert an unlinked instructions into a basic block
 106   /// immediately before the specified instruction.
 107   void insertBefore(Instruction *InsertPos);
 108
 109   /// moveBefore - Unlink this instruction from its current basic block and
 110   /// insert it into the basic block that MovePos lives in, right before
 111   /// MovePos.
 112   void moveBefore(Instruction *MovePos);
 113
 114   // ---------------------------------------------------------------------------
 115   /// Subclass classification... getOpcode() returns a member of
 116   /// one of the enums that is coming soon (down below)...
 117   ///
 118   unsigned getOpcode() const { return getValueID() - InstructionVal; }
 119   const char *getOpcodeName() const { return getOpcodeName(getOpcode()); }
 120   bool isTerminator() const { return isTerminator(getOpcode()); }
 121   bool isBinaryOp() const { return isBinaryOp(getOpcode()); }
 122   bool isShift() { return isShift(getOpcode()); }
 123   bool isCast() const { return isCast(getOpcode()); }
 124
 125
 126
 127   static const char* getOpcodeName(unsigned OpCode);
 128
 129   static inline bool isTerminator(unsigned OpCode) {
 130     return OpCode >= TermOpsBegin && OpCode < TermOpsEnd;
 131   }
 132
 133   static inline bool isBinaryOp(unsigned Opcode) {
 134     return Opcode >= BinaryOpsBegin && Opcode < BinaryOpsEnd;
 135   }
 136
 137   /// @brief Determine if the Opcode is one of the shift instructions.
 138   static inline bool isShift(unsigned Opcode) {
 139     return Opcode >= Shl && Opcode <= AShr;
 140   }
 141
 142   /// isLogicalShift - Return true if this is a logical shift left or a logical
 143   /// shift right.
 144   inline bool isLogicalShift() const {
 145     return getOpcode() == Shl || getOpcode() == LShr;
 146   }
 147
 148   /// isLogicalShift - Return true if this is a logical shift left or a logical
 149   /// shift right.
 150   inline bool isArithmeticShift() const {
 151     return getOpcode() == AShr;
 152   }
 153
 154   /// @brief Determine if the OpCode is one of the CastInst instructions.
 155   static inline bool isCast(unsigned OpCode) {
 156     return OpCode >= CastOpsBegin && OpCode < CastOpsEnd;
 157   }
 158
 159   /// isAssociative - Return true if the instruction is associative:
 160   ///
 161   ///   Associative operators satisfy:  x op (y op z) === (x op y) op z
 162   ///
 163   /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative, when
 164   /// not applied to floating point types.
 165   ///
 166   bool isAssociative() const { return isAssociative(getOpcode(), getType()); }
 167   static bool isAssociative(unsigned op, const Type *Ty);
 168
 169   /// isCommutative - Return true if the instruction is commutative:
 170   ///
 171   ///   Commutative operators satisfy: (x op y) === (y op x)
 172   ///
 173   /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
 174   /// applied to any type.
 175   ///
 176   bool isCommutative() const { return isCommutative(getOpcode()); }
 177   static bool isCommutative(unsigned op);
 178
 179   /// isTrappingInstruction - Return true if the instruction may trap.
 180   ///
 181   bool isTrapping() const {
 182     return isTrapping(getOpcode());
 183   }
 184   static bool isTrapping(unsigned op);
 185
 186   virtual void print(std::ostream &OS) const { print(OS, 0); }
 187   void print(std::ostream *OS) const { if (OS) print(*OS); }
 188   void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
 189
 190   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 191   static inline bool classof(const Instruction *) { return true; }
 192   static inline bool classof(const Value *V) {
 193     return V->getValueID() >= Value::InstructionVal;
 194   }
 195
 196   //----------------------------------------------------------------------
 197   // Exported enumerations...
 198   //
 199   enum TermOps {       // These terminate basic blocks
 200 #define  FIRST_TERM_INST(N)             TermOpsBegin = N,
 201 #define HANDLE_TERM_INST(N, OPC, CLASS) OPC = N,
 202 #define   LAST_TERM_INST(N)             TermOpsEnd = N+1
 203 #include "llvm/Instruction.def"
 204   };
 205
 206   enum BinaryOps {
 207 #define  FIRST_BINARY_INST(N)             BinaryOpsBegin = N,
 208 #define HANDLE_BINARY_INST(N, OPC, CLASS) OPC = N,
 209 #define   LAST_BINARY_INST(N)             BinaryOpsEnd = N+1
 210 #include "llvm/Instruction.def"
 211   };
 212
 213   enum MemoryOps {
 214 #define  FIRST_MEMORY_INST(N)             MemoryOpsBegin = N,
 215 #define HANDLE_MEMORY_INST(N, OPC, CLASS) OPC = N,
 216 #define   LAST_MEMORY_INST(N)             MemoryOpsEnd = N+1
 217 #include "llvm/Instruction.def"
 218   };
 219
 220   enum CastOps {
 221 #define  FIRST_CAST_INST(N)             CastOpsBegin = N,
 222 #define HANDLE_CAST_INST(N, OPC, CLASS) OPC = N,
 223 #define   LAST_CAST_INST(N)             CastOpsEnd = N+1
 224 #include "llvm/Instruction.def"
 225   };
 226
 227   enum OtherOps {
 228 #define  FIRST_OTHER_INST(N)             OtherOpsBegin = N,
 229 #define HANDLE_OTHER_INST(N, OPC, CLASS) OPC = N,
 230 #define   LAST_OTHER_INST(N)             OtherOpsEnd = N+1
 231 #include "llvm/Instruction.def"
 232   };
 233
 234 private:
 235   // getNext/Prev - Return the next or previous instruction in the list.  The
 236   // last node in the list is a terminator instruction.
 237   Instruction *getNext()             { return Next; }
 238   const Instruction *getNext() const { return Next; }
 239   Instruction *getPrev()             { return Prev; }
 240   const Instruction *getPrev() const { return Prev; }
 241 };
 242
 243 } // End llvm namespace
 244
 245 #endif