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 #include "llvm/ADT/ilist_node.h"
  20 #include "llvm/Support/DebugLoc.h"
  21
  22 namespace llvm {
  23
  24 class LLVMContext;
  25 class MDNode;
  26
  27 template<typename ValueSubClass, typename ItemParentClass>
  28   class SymbolTableListTraits;
  29
  30 class Instruction : public User, public ilist_node<Instruction> {
  31   void operator=(const Instruction &);     // Do not implement
  32   Instruction(const Instruction &);        // Do not implement
  33
  34   BasicBlock *Parent;
  35   DebugLoc DbgLoc;                         // 'dbg' Metadata cache.
  36
  37   enum {
  38     /// HasMetadataBit - This is a bit stored in the SubClassData field which
  39     /// indicates whether this instruction has metadata attached to it or not.
  40     HasMetadataBit = 1 << 15
  41   };
  42 public:
  43   // Out of line virtual method, so the vtable, etc has a home.
  44   ~Instruction();
  45
  46   /// use_back - Specialize the methods defined in Value, as we know that an
  47   /// instruction can only be used by other instructions.
  48   Instruction       *use_back()       { return cast<Instruction>(*use_begin());}
  49   const Instruction *use_back() const { return cast<Instruction>(*use_begin());}
  50
  51   inline const BasicBlock *getParent() const { return Parent; }
  52   inline       BasicBlock *getParent()       { return Parent; }
  53
  54   /// removeFromParent - This method unlinks 'this' from the containing basic
  55   /// block, but does not delete it.
  56   ///
  57   void removeFromParent();
  58
  59   /// eraseFromParent - This method unlinks 'this' from the containing basic
  60   /// block and deletes it.
  61   ///
  62   void eraseFromParent();
  63
  64   /// insertBefore - Insert an unlinked instructions into a basic block
  65   /// immediately before the specified instruction.
  66   void insertBefore(Instruction *InsertPos);
  67
  68   /// insertAfter - Insert an unlinked instructions into a basic block
  69   /// immediately after the specified instruction.
  70   void insertAfter(Instruction *InsertPos);
  71
  72   /// moveBefore - Unlink this instruction from its current basic block and
  73   /// insert it into the basic block that MovePos lives in, right before
  74   /// MovePos.
  75   void moveBefore(Instruction *MovePos);
  76
  77   //===--------------------------------------------------------------------===//
  78   // Subclass classification.
  79   //===--------------------------------------------------------------------===//
  80
  81   /// getOpcode() returns a member of one of the enums like Instruction::Add.
  82   unsigned getOpcode() const { return getValueID() - InstructionVal; }
  83
  84   const char *getOpcodeName() const { return getOpcodeName(getOpcode()); }
  85   bool isTerminator() const { return isTerminator(getOpcode()); }
  86   bool isBinaryOp() const { return isBinaryOp(getOpcode()); }
  87   bool isShift() { return isShift(getOpcode()); }
  88   bool isCast() const { return isCast(getOpcode()); }
  89
  90   static const char* getOpcodeName(unsigned OpCode);
  91
  92   static inline bool isTerminator(unsigned OpCode) {
  93     return OpCode >= TermOpsBegin && OpCode < TermOpsEnd;
  94   }
  95
  96   static inline bool isBinaryOp(unsigned Opcode) {
  97     return Opcode >= BinaryOpsBegin && Opcode < BinaryOpsEnd;
  98   }
  99
 100   /// @brief Determine if the Opcode is one of the shift instructions.
 101   static inline bool isShift(unsigned Opcode) {
 102     return Opcode >= Shl && Opcode <= AShr;
 103   }
 104
 105   /// isLogicalShift - Return true if this is a logical shift left or a logical
 106   /// shift right.
 107   inline bool isLogicalShift() const {
 108     return getOpcode() == Shl || getOpcode() == LShr;
 109   }
 110
 111   /// isArithmeticShift - Return true if this is an arithmetic shift right.
 112   inline bool isArithmeticShift() const {
 113     return getOpcode() == AShr;
 114   }
 115
 116   /// @brief Determine if the OpCode is one of the CastInst instructions.
 117   static inline bool isCast(unsigned OpCode) {
 118     return OpCode >= CastOpsBegin && OpCode < CastOpsEnd;
 119   }
 120
 121   //===--------------------------------------------------------------------===//
 122   // Metadata manipulation.
 123   //===--------------------------------------------------------------------===//
 124
 125   /// hasMetadata() - Return true if this instruction has any metadata attached
 126   /// to it.
 127   bool hasMetadata() const {
 128     return !DbgLoc.isUnknown() || hasMetadataHashEntry();
 129   }
 130
 131   /// hasMetadataOtherThanDebugLoc - Return true if this instruction has
 132   /// metadata attached to it other than a debug location.
 133   bool hasMetadataOtherThanDebugLoc() const {
 134     return hasMetadataHashEntry();
 135   }
 136
 137   /// getMetadata - Get the metadata of given kind attached to this Instruction.
 138   /// If the metadata is not found then return null.
 139   MDNode *getMetadata(unsigned KindID) const {
 140     if (!hasMetadata()) return 0;
 141     return getMetadataImpl(KindID);
 142   }
 143
 144   /// getMetadata - Get the metadata of given kind attached to this Instruction.
 145   /// If the metadata is not found then return null.
 146   MDNode *getMetadata(const char *Kind) const {
 147     if (!hasMetadata()) return 0;
 148     return getMetadataImpl(Kind);
 149   }
 150
 151   /// getAllMetadata - Get all metadata attached to this Instruction.  The first
 152   /// element of each pair returned is the KindID, the second element is the
 153   /// metadata value.  This list is returned sorted by the KindID.
 154   void getAllMetadata(SmallVectorImpl<std::pair<unsigned, MDNode*> > &MDs)const{
 155     if (hasMetadata())
 156       getAllMetadataImpl(MDs);
 157   }
 158
 159   /// getAllMetadataOtherThanDebugLoc - This does the same thing as
 160   /// getAllMetadata, except that it filters out the debug location.
 161   void getAllMetadataOtherThanDebugLoc(SmallVectorImpl<std::pair<unsigned,
 162                                        MDNode*> > &MDs) const {
 163     if (hasMetadataOtherThanDebugLoc())
 164       getAllMetadataOtherThanDebugLocImpl(MDs);
 165   }
 166
 167   /// setMetadata - Set the metadata of the specified kind to the specified
 168   /// node.  This updates/replaces metadata if already present, or removes it if
 169   /// Node is null.
 170   void setMetadata(unsigned KindID, MDNode *Node);
 171   void setMetadata(const char *Kind, MDNode *Node);
 172
 173   /// setDbgMetadata - This is just an optimized helper function that is
 174   /// equivalent to setMetadata("dbg", Node);
 175   void setDbgMetadata(MDNode *Node);
 176
 177   /// getDbgMetadata - This is just an optimized helper function that is
 178   /// equivalent to calling getMetadata("dbg").
 179   MDNode *getDbgMetadata() const {
 180     return DbgLoc.getAsMDNode(getContext());
 181   }
 182
 183   /// setDebugLoc - Set the debug location information for this instruction.
 184   void setDebugLoc(const DebugLoc &Loc) { DbgLoc = Loc; }
 185
 186   /// getDebugLoc - Return the debug location for this node as a DebugLoc.
 187   const DebugLoc &getDebugLoc() const { return DbgLoc; }
 188
 189 private:
 190   /// hasMetadataHashEntry - Return true if we have an entry in the on-the-side
 191   /// metadata hash.
 192   bool hasMetadataHashEntry() const {
 193     return (getSubclassDataFromValue() & HasMetadataBit) != 0;
 194   }
 195
 196   // These are all implemented in Metadata.cpp.
 197   MDNode *getMetadataImpl(unsigned KindID) const;
 198   MDNode *getMetadataImpl(const char *Kind) const;
 199   void getAllMetadataImpl(SmallVectorImpl<std::pair<unsigned,MDNode*> > &)const;
 200   void getAllMetadataOtherThanDebugLocImpl(SmallVectorImpl<std::pair<unsigned,
 201                                            MDNode*> > &) const;
 202   void removeAllMetadata();
 203 public:
 204   //===--------------------------------------------------------------------===//
 205   // Predicates and helper methods.
 206   //===--------------------------------------------------------------------===//
 207
 208
 209   /// isAssociative - Return true if the instruction is associative:
 210   ///
 211   ///   Associative operators satisfy:  x op (y op z) === (x op y) op z
 212   ///
 213   /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative, when
 214   /// not applied to floating point types.
 215   ///
 216   bool isAssociative() const { return isAssociative(getOpcode(), getType()); }
 217   static bool isAssociative(unsigned op, const Type *Ty);
 218
 219   /// isCommutative - Return true if the instruction is commutative:
 220   ///
 221   ///   Commutative operators satisfy: (x op y) === (y op x)
 222   ///
 223   /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
 224   /// applied to any type.
 225   ///
 226   bool isCommutative() const { return isCommutative(getOpcode()); }
 227   static bool isCommutative(unsigned op);
 228
 229   /// mayWriteToMemory - Return true if this instruction may modify memory.
 230   ///
 231   bool mayWriteToMemory() const;
 232
 233   /// mayReadFromMemory - Return true if this instruction may read memory.
 234   ///
 235   bool mayReadFromMemory() const;
 236
 237   /// mayThrow - Return true if this instruction may throw an exception.
 238   ///
 239   bool mayThrow() const;
 240
 241   /// mayHaveSideEffects - Return true if the instruction may have side effects.
 242   ///
 243   /// Note that this does not consider malloc and alloca to have side
 244   /// effects because the newly allocated memory is completely invisible to
 245   /// instructions which don't used the returned value.  For cases where this
 246   /// matters, isSafeToSpeculativelyExecute may be more appropriate.
 247   bool mayHaveSideEffects() const {
 248     return mayWriteToMemory() || mayThrow();
 249   }
 250
 251   /// isSafeToSpeculativelyExecute - Return true if the instruction does not
 252   /// have any effects besides calculating the result and does not have
 253   /// undefined behavior.
 254   ///
 255   /// This method never returns true for an instruction that returns true for
 256   /// mayHaveSideEffects; however, this method also does some other checks in
 257   /// addition. It checks for undefined behavior, like dividing by zero or
 258   /// loading from an invalid pointer (but not for undefined results, like a
 259   /// shift with a shift amount larger than the width of the result). It checks
 260   /// for malloc and alloca because speculatively executing them might cause a
 261   /// memory leak. It also returns false for instructions related to control
 262   /// flow, specifically terminators and PHI nodes.
 263   ///
 264   /// This method only looks at the instruction itself and its operands, so if
 265   /// this method returns true, it is safe to move the instruction as long as
 266   /// the correct dominance relationships for the operands and users hold.
 267   /// However, this method can return true for instructions that read memory;
 268   /// for such instructions, moving them may change the resulting value.
 269   bool isSafeToSpeculativelyExecute() const;
 270
 271   /// clone() - Create a copy of 'this' instruction that is identical in all
 272   /// ways except the following:
 273   ///   * The instruction has no parent
 274   ///   * The instruction has no name
 275   ///
 276   Instruction *clone() const;
 277
 278   /// isIdenticalTo - Return true if the specified instruction is exactly
 279   /// identical to the current one.  This means that all operands match and any
 280   /// extra information (e.g. load is volatile) agree.
 281   bool isIdenticalTo(const Instruction *I) const;
 282
 283   /// isIdenticalToWhenDefined - This is like isIdenticalTo, except that it
 284   /// ignores the SubclassOptionalData flags, which specify conditions
 285   /// under which the instruction's result is undefined.
 286   bool isIdenticalToWhenDefined(const Instruction *I) const;
 287
 288   /// This function determines if the specified instruction executes the same
 289   /// operation as the current one. This means that the opcodes, type, operand
 290   /// types and any other factors affecting the operation must be the same. This
 291   /// is similar to isIdenticalTo except the operands themselves don't have to
 292   /// be identical.
 293   /// @returns true if the specified instruction is the same operation as
 294   /// the current one.
 295   /// @brief Determine if one instruction is the same operation as another.
 296   bool isSameOperationAs(const Instruction *I) const;
 297
 298   /// isUsedOutsideOfBlock - Return true if there are any uses of this
 299   /// instruction in blocks other than the specified block.  Note that PHI nodes
 300   /// are considered to evaluate their operands in the corresponding predecessor
 301   /// block.
 302   bool isUsedOutsideOfBlock(const BasicBlock *BB) const;
 303
 304
 305   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 306   static inline bool classof(const Instruction *) { return true; }
 307   static inline bool classof(const Value *V) {
 308     return V->getValueID() >= Value::InstructionVal;
 309   }
 310
 311   //----------------------------------------------------------------------
 312   // Exported enumerations.
 313   //
 314   enum TermOps {       // These terminate basic blocks
 315 #define  FIRST_TERM_INST(N)             TermOpsBegin = N,
 316 #define HANDLE_TERM_INST(N, OPC, CLASS) OPC = N,
 317 #define   LAST_TERM_INST(N)             TermOpsEnd = N+1
 318 #include "llvm/Instruction.def"
 319   };
 320
 321   enum BinaryOps {
 322 #define  FIRST_BINARY_INST(N)             BinaryOpsBegin = N,
 323 #define HANDLE_BINARY_INST(N, OPC, CLASS) OPC = N,
 324 #define   LAST_BINARY_INST(N)             BinaryOpsEnd = N+1
 325 #include "llvm/Instruction.def"
 326   };
 327
 328   enum MemoryOps {
 329 #define  FIRST_MEMORY_INST(N)             MemoryOpsBegin = N,
 330 #define HANDLE_MEMORY_INST(N, OPC, CLASS) OPC = N,
 331 #define   LAST_MEMORY_INST(N)             MemoryOpsEnd = N+1
 332 #include "llvm/Instruction.def"
 333   };
 334
 335   enum CastOps {
 336 #define  FIRST_CAST_INST(N)             CastOpsBegin = N,
 337 #define HANDLE_CAST_INST(N, OPC, CLASS) OPC = N,
 338 #define   LAST_CAST_INST(N)             CastOpsEnd = N+1
 339 #include "llvm/Instruction.def"
 340   };
 341
 342   enum OtherOps {
 343 #define  FIRST_OTHER_INST(N)             OtherOpsBegin = N,
 344 #define HANDLE_OTHER_INST(N, OPC, CLASS) OPC = N,
 345 #define   LAST_OTHER_INST(N)             OtherOpsEnd = N+1
 346 #include "llvm/Instruction.def"
 347   };
 348 private:
 349   // Shadow Value::setValueSubclassData with a private forwarding method so that
 350   // subclasses cannot accidentally use it.
 351   void setValueSubclassData(unsigned short D) {
 352     Value::setValueSubclassData(D);
 353   }
 354   unsigned short getSubclassDataFromValue() const {
 355     return Value::getSubclassDataFromValue();
 356   }
 357
 358   void setHasMetadataHashEntry(bool V) {
 359     setValueSubclassData((getSubclassDataFromValue() & ~HasMetadataBit) |
 360                          (V ? HasMetadataBit : 0));
 361   }
 362
 363   friend class SymbolTableListTraits<Instruction, BasicBlock>;
 364   void setParent(BasicBlock *P);
 365 protected:
 366   // Instruction subclasses can stick up to 15 bits of stuff into the
 367   // SubclassData field of instruction with these members.
 368
 369   // Verify that only the low 15 bits are used.
 370   void setInstructionSubclassData(unsigned short D) {
 371     assert((D & HasMetadataBit) == 0 && "Out of range value put into field");
 372     setValueSubclassData((getSubclassDataFromValue() & HasMetadataBit) | D);
 373   }
 374
 375   unsigned getSubclassDataFromInstruction() const {
 376     return getSubclassDataFromValue() & ~HasMetadataBit;
 377   }
 378
 379   Instruction(const Type *Ty, unsigned iType, Use *Ops, unsigned NumOps,
 380               Instruction *InsertBefore = 0);
 381   Instruction(const Type *Ty, unsigned iType, Use *Ops, unsigned NumOps,
 382               BasicBlock *InsertAtEnd);
 383   virtual Instruction *clone_impl() const = 0;
 384
 385 };
 386
 387 // Instruction* is only 4-byte aligned.
 388 template<>
 389 class PointerLikeTypeTraits<Instruction*> {
 390   typedef Instruction* PT;
 391 public:
 392   static inline void *getAsVoidPointer(PT P) { return P; }
 393   static inline PT getFromVoidPointer(void *P) {
 394     return static_cast<PT>(P);
 395   }
 396   enum { NumLowBitsAvailable = 2 };
 397 };
 398
 399 } // End llvm namespace
 400
 401 #endif