include/llvm/IR/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_IR_INSTRUCTION_H
  16 #define LLVM_IR_INSTRUCTION_H
  17
  18 #include "llvm/ADT/ArrayRef.h"
  19 #include "llvm/ADT/ilist_node.h"
  20 #include "llvm/IR/DebugLoc.h"
  21 #include "llvm/IR/SymbolTableListTraits.h"
  22 #include "llvm/IR/User.h"
  23
  24 namespace llvm {
  25
  26 class FastMathFlags;
  27 class LLVMContext;
  28 class MDNode;
  29 class BasicBlock;
  30 struct AAMDNodes;
  31
  32 template <>
  33 struct SymbolTableListSentinelTraits<Instruction>
  34     : public ilist_half_embedded_sentinel_traits<Instruction> {};
  35
  36 class Instruction : public User,
  37                     public ilist_node_with_parent<Instruction, BasicBlock> {
  38   void operator=(const Instruction &) = delete;
  39   Instruction(const Instruction &) = delete;
  40
  41   BasicBlock *Parent;
  42   DebugLoc DbgLoc;                         // 'dbg' Metadata cache.
  43
  44   enum {
  45     /// HasMetadataBit - This is a bit stored in the SubClassData field which
  46     /// indicates whether this instruction has metadata attached to it or not.
  47     HasMetadataBit = 1 << 15
  48   };
  49 public:
  50   // Out of line virtual method, so the vtable, etc has a home.
  51   ~Instruction() override;
  52
  53   /// user_back - Specialize the methods defined in Value, as we know that an
  54   /// instruction can only be used by other instructions.
  55   Instruction       *user_back()       { return cast<Instruction>(*user_begin());}
  56   const Instruction *user_back() const { return cast<Instruction>(*user_begin());}
  57
  58   inline const BasicBlock *getParent() const { return Parent; }
  59   inline       BasicBlock *getParent()       { return Parent; }
  60
  61   /// \brief Return the module owning the function this instruction belongs to
  62   /// or nullptr it the function does not have a module.
  63   ///
  64   /// Note: this is undefined behavior if the instruction does not have a
  65   /// parent, or the parent basic block does not have a parent function.
  66   const Module *getModule() const;
  67   Module *getModule();
  68
  69   /// \brief Return the function this instruction belongs to.
  70   ///
  71   /// Note: it is undefined behavior to call this on an instruction not
  72   /// currently inserted into a function.
  73   const Function *getFunction() const;
  74   Function *getFunction();
  75
  76   /// removeFromParent - This method unlinks 'this' from the containing basic
  77   /// block, but does not delete it.
  78   ///
  79   void removeFromParent();
  80
  81   /// eraseFromParent - This method unlinks 'this' from the containing basic
  82   /// block and deletes it.
  83   ///
  84   /// \returns an iterator pointing to the element after the erased one
  85   SymbolTableList<Instruction>::iterator eraseFromParent();
  86
  87   /// Insert an unlinked instruction into a basic block immediately before
  88   /// the specified instruction.
  89   void insertBefore(Instruction *InsertPos);
  90
  91   /// Insert an unlinked instruction into a basic block immediately after the
  92   /// specified instruction.
  93   void insertAfter(Instruction *InsertPos);
  94
  95   /// moveBefore - Unlink this instruction from its current basic block and
  96   /// insert it into the basic block that MovePos lives in, right before
  97   /// MovePos.
  98   void moveBefore(Instruction *MovePos);
  99
 100   //===--------------------------------------------------------------------===//
 101   // Subclass classification.
 102   //===--------------------------------------------------------------------===//
 103
 104   /// getOpcode() returns a member of one of the enums like Instruction::Add.
 105   unsigned getOpcode() const { return getValueID() - InstructionVal; }
 106
 107   const char *getOpcodeName() const { return getOpcodeName(getOpcode()); }
 108   bool isTerminator() const { return isTerminator(getOpcode()); }
 109   bool isBinaryOp() const { return isBinaryOp(getOpcode()); }
 110   bool isShift() { return isShift(getOpcode()); }
 111   bool isCast() const { return isCast(getOpcode()); }
 112   bool isFuncletPad() const { return isFuncletPad(getOpcode()); }
 113
 114   static const char* getOpcodeName(unsigned OpCode);
 115
 116   static inline bool isTerminator(unsigned OpCode) {
 117     return OpCode >= TermOpsBegin && OpCode < TermOpsEnd;
 118   }
 119
 120   static inline bool isBinaryOp(unsigned Opcode) {
 121     return Opcode >= BinaryOpsBegin && Opcode < BinaryOpsEnd;
 122   }
 123
 124   /// @brief Determine if the Opcode is one of the shift instructions.
 125   static inline bool isShift(unsigned Opcode) {
 126     return Opcode >= Shl && Opcode <= AShr;
 127   }
 128
 129   /// isLogicalShift - Return true if this is a logical shift left or a logical
 130   /// shift right.
 131   inline bool isLogicalShift() const {
 132     return getOpcode() == Shl || getOpcode() == LShr;
 133   }
 134
 135   /// isArithmeticShift - Return true if this is an arithmetic shift right.
 136   inline bool isArithmeticShift() const {
 137     return getOpcode() == AShr;
 138   }
 139
 140   /// @brief Determine if the OpCode is one of the CastInst instructions.
 141   static inline bool isCast(unsigned OpCode) {
 142     return OpCode >= CastOpsBegin && OpCode < CastOpsEnd;
 143   }
 144
 145   /// @brief Determine if the OpCode is one of the FuncletPadInst instructions.
 146   static inline bool isFuncletPad(unsigned OpCode) {
 147     return OpCode >= FuncletPadOpsBegin && OpCode < FuncletPadOpsEnd;
 148   }
 149
 150   //===--------------------------------------------------------------------===//
 151   // Metadata manipulation.
 152   //===--------------------------------------------------------------------===//
 153
 154   /// hasMetadata() - Return true if this instruction has any metadata attached
 155   /// to it.
 156   bool hasMetadata() const { return DbgLoc || hasMetadataHashEntry(); }
 157
 158   /// hasMetadataOtherThanDebugLoc - Return true if this instruction has
 159   /// metadata attached to it other than a debug location.
 160   bool hasMetadataOtherThanDebugLoc() const {
 161     return hasMetadataHashEntry();
 162   }
 163
 164   /// getMetadata - Get the metadata of given kind attached to this Instruction.
 165   /// If the metadata is not found then return null.
 166   MDNode *getMetadata(unsigned KindID) const {
 167     if (!hasMetadata()) return nullptr;
 168     return getMetadataImpl(KindID);
 169   }
 170
 171   /// getMetadata - Get the metadata of given kind attached to this Instruction.
 172   /// If the metadata is not found then return null.
 173   MDNode *getMetadata(StringRef Kind) const {
 174     if (!hasMetadata()) return nullptr;
 175     return getMetadataImpl(Kind);
 176   }
 177
 178   /// getAllMetadata - Get all metadata attached to this Instruction.  The first
 179   /// element of each pair returned is the KindID, the second element is the
 180   /// metadata value.  This list is returned sorted by the KindID.
 181   void
 182   getAllMetadata(SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs) const {
 183     if (hasMetadata())
 184       getAllMetadataImpl(MDs);
 185   }
 186
 187   /// getAllMetadataOtherThanDebugLoc - This does the same thing as
 188   /// getAllMetadata, except that it filters out the debug location.
 189   void getAllMetadataOtherThanDebugLoc(
 190       SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs) const {
 191     if (hasMetadataOtherThanDebugLoc())
 192       getAllMetadataOtherThanDebugLocImpl(MDs);
 193   }
 194
 195   /// getAAMetadata - Fills the AAMDNodes structure with AA metadata from
 196   /// this instruction. When Merge is true, the existing AA metadata is
 197   /// merged with that from this instruction providing the most-general result.
 198   void getAAMetadata(AAMDNodes &N, bool Merge = false) const;
 199
 200   /// setMetadata - Set the metadata of the specified kind to the specified
 201   /// node.  This updates/replaces metadata if already present, or removes it if
 202   /// Node is null.
 203   void setMetadata(unsigned KindID, MDNode *Node);
 204   void setMetadata(StringRef Kind, MDNode *Node);
 205
 206   /// Drop all unknown metadata except for debug locations.
 207   /// @{
 208   /// Passes are required to drop metadata they don't understand. This is a
 209   /// convenience method for passes to do so.
 210   void dropUnknownNonDebugMetadata(ArrayRef<unsigned> KnownIDs);
 211   void dropUnknownNonDebugMetadata() {
 212     return dropUnknownNonDebugMetadata(None);
 213   }
 214   void dropUnknownNonDebugMetadata(unsigned ID1) {
 215     return dropUnknownNonDebugMetadata(makeArrayRef(ID1));
 216   }
 217   void dropUnknownNonDebugMetadata(unsigned ID1, unsigned ID2) {
 218     unsigned IDs[] = {ID1, ID2};
 219     return dropUnknownNonDebugMetadata(IDs);
 220   }
 221   /// @}
 222
 223   /// setAAMetadata - Sets the metadata on this instruction from the
 224   /// AAMDNodes structure.
 225   void setAAMetadata(const AAMDNodes &N);
 226
 227   /// setDebugLoc - Set the debug location information for this instruction.
 228   void setDebugLoc(DebugLoc Loc) { DbgLoc = std::move(Loc); }
 229
 230   /// getDebugLoc - Return the debug location for this node as a DebugLoc.
 231   const DebugLoc &getDebugLoc() const { return DbgLoc; }
 232
 233   /// Set or clear the unsafe-algebra flag on this instruction, which must be an
 234   /// operator which supports this flag. See LangRef.html for the meaning of
 235   /// this flag.
 236   void setHasUnsafeAlgebra(bool B);
 237
 238   /// Set or clear the no-nans flag on this instruction, which must be an
 239   /// operator which supports this flag. See LangRef.html for the meaning of
 240   /// this flag.
 241   void setHasNoNaNs(bool B);
 242
 243   /// Set or clear the no-infs flag on this instruction, which must be an
 244   /// operator which supports this flag. See LangRef.html for the meaning of
 245   /// this flag.
 246   void setHasNoInfs(bool B);
 247
 248   /// Set or clear the no-signed-zeros flag on this instruction, which must be
 249   /// an operator which supports this flag. See LangRef.html for the meaning of
 250   /// this flag.
 251   void setHasNoSignedZeros(bool B);
 252
 253   /// Set or clear the allow-reciprocal flag on this instruction, which must be
 254   /// an operator which supports this flag. See LangRef.html for the meaning of
 255   /// this flag.
 256   void setHasAllowReciprocal(bool B);
 257
 258   /// Convenience function for setting multiple fast-math flags on this
 259   /// instruction, which must be an operator which supports these flags. See
 260   /// LangRef.html for the meaning of these flags.
 261   void setFastMathFlags(FastMathFlags FMF);
 262
 263   /// Convenience function for transferring all fast-math flag values to this
 264   /// instruction, which must be an operator which supports these flags. See
 265   /// LangRef.html for the meaning of these flags.
 266   void copyFastMathFlags(FastMathFlags FMF);
 267
 268   /// Determine whether the unsafe-algebra flag is set.
 269   bool hasUnsafeAlgebra() const;
 270
 271   /// Determine whether the no-NaNs flag is set.
 272   bool hasNoNaNs() const;
 273
 274   /// Determine whether the no-infs flag is set.
 275   bool hasNoInfs() const;
 276
 277   /// Determine whether the no-signed-zeros flag is set.
 278   bool hasNoSignedZeros() const;
 279
 280   /// Determine whether the allow-reciprocal flag is set.
 281   bool hasAllowReciprocal() const;
 282
 283   /// Convenience function for getting all the fast-math flags, which must be an
 284   /// operator which supports these flags. See LangRef.html for the meaning of
 285   /// these flags.
 286   FastMathFlags getFastMathFlags() const;
 287
 288   /// Copy I's fast-math flags
 289   void copyFastMathFlags(const Instruction *I);
 290
 291 private:
 292   /// hasMetadataHashEntry - Return true if we have an entry in the on-the-side
 293   /// metadata hash.
 294   bool hasMetadataHashEntry() const {
 295     return (getSubclassDataFromValue() & HasMetadataBit) != 0;
 296   }
 297
 298   // These are all implemented in Metadata.cpp.
 299   MDNode *getMetadataImpl(unsigned KindID) const;
 300   MDNode *getMetadataImpl(StringRef Kind) const;
 301   void
 302   getAllMetadataImpl(SmallVectorImpl<std::pair<unsigned, MDNode *>> &) const;
 303   void getAllMetadataOtherThanDebugLocImpl(
 304       SmallVectorImpl<std::pair<unsigned, MDNode *>> &) const;
 305   void clearMetadataHashEntries();
 306 public:
 307   //===--------------------------------------------------------------------===//
 308   // Predicates and helper methods.
 309   //===--------------------------------------------------------------------===//
 310
 311
 312   /// isAssociative - Return true if the instruction is associative:
 313   ///
 314   ///   Associative operators satisfy:  x op (y op z) === (x op y) op z
 315   ///
 316   /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative.
 317   ///
 318   bool isAssociative() const;
 319   static bool isAssociative(unsigned op);
 320
 321   /// isCommutative - Return true if the instruction is commutative:
 322   ///
 323   ///   Commutative operators satisfy: (x op y) === (y op x)
 324   ///
 325   /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
 326   /// applied to any type.
 327   ///
 328   bool isCommutative() const { return isCommutative(getOpcode()); }
 329   static bool isCommutative(unsigned op);
 330
 331   /// isIdempotent - Return true if the instruction is idempotent:
 332   ///
 333   ///   Idempotent operators satisfy:  x op x === x
 334   ///
 335   /// In LLVM, the And and Or operators are idempotent.
 336   ///
 337   bool isIdempotent() const { return isIdempotent(getOpcode()); }
 338   static bool isIdempotent(unsigned op);
 339
 340   /// isNilpotent - Return true if the instruction is nilpotent:
 341   ///
 342   ///   Nilpotent operators satisfy:  x op x === Id,
 343   ///
 344   ///   where Id is the identity for the operator, i.e. a constant such that
 345   ///     x op Id === x and Id op x === x for all x.
 346   ///
 347   /// In LLVM, the Xor operator is nilpotent.
 348   ///
 349   bool isNilpotent() const { return isNilpotent(getOpcode()); }
 350   static bool isNilpotent(unsigned op);
 351
 352   /// mayWriteToMemory - Return true if this instruction may modify memory.
 353   ///
 354   bool mayWriteToMemory() const;
 355
 356   /// mayReadFromMemory - Return true if this instruction may read memory.
 357   ///
 358   bool mayReadFromMemory() const;
 359
 360   /// mayReadOrWriteMemory - Return true if this instruction may read or
 361   /// write memory.
 362   ///
 363   bool mayReadOrWriteMemory() const {
 364     return mayReadFromMemory() || mayWriteToMemory();
 365   }
 366
 367   /// isAtomic - Return true if this instruction has an
 368   /// AtomicOrdering of unordered or higher.
 369   ///
 370   bool isAtomic() const;
 371
 372   /// mayThrow - Return true if this instruction may throw an exception.
 373   ///
 374   bool mayThrow() const;
 375
 376   /// mayReturn - Return true if this is a function that may return.
 377   /// this is true for all normal instructions. The only exception
 378   /// is functions that are marked with the 'noreturn' attribute.
 379   ///
 380   bool mayReturn() const;
 381
 382   /// mayHaveSideEffects - Return true if the instruction may have side effects.
 383   ///
 384   /// Note that this does not consider malloc and alloca to have side
 385   /// effects because the newly allocated memory is completely invisible to
 386   /// instructions which don't use the returned value.  For cases where this
 387   /// matters, isSafeToSpeculativelyExecute may be more appropriate.
 388   bool mayHaveSideEffects() const {
 389     return mayWriteToMemory() || mayThrow() || !mayReturn();
 390   }
 391
 392   /// \brief Return true if the instruction is a variety of EH-block.
 393   bool isEHPad() const {
 394     switch (getOpcode()) {
 395     case Instruction::CatchSwitch:
 396     case Instruction::CatchPad:
 397     case Instruction::CleanupPad:
 398     case Instruction::LandingPad:
 399     case Instruction::TerminatePad:
 400       return true;
 401     default:
 402       return false;
 403     }
 404   }
 405
 406   /// clone() - Create a copy of 'this' instruction that is identical in all
 407   /// ways except the following:
 408   ///   * The instruction has no parent
 409   ///   * The instruction has no name
 410   ///
 411   Instruction *clone() const;
 412
 413   /// isIdenticalTo - Return true if the specified instruction is exactly
 414   /// identical to the current one.  This means that all operands match and any
 415   /// extra information (e.g. load is volatile) agree.
 416   bool isIdenticalTo(const Instruction *I) const;
 417
 418   /// isIdenticalToWhenDefined - This is like isIdenticalTo, except that it
 419   /// ignores the SubclassOptionalData flags, which specify conditions
 420   /// under which the instruction's result is undefined.
 421   bool isIdenticalToWhenDefined(const Instruction *I) const;
 422
 423   /// When checking for operation equivalence (using isSameOperationAs) it is
 424   /// sometimes useful to ignore certain attributes.
 425   enum OperationEquivalenceFlags {
 426     /// Check for equivalence ignoring load/store alignment.
 427     CompareIgnoringAlignment = 1<<0,
 428     /// Check for equivalence treating a type and a vector of that type
 429     /// as equivalent.
 430     CompareUsingScalarTypes = 1<<1
 431   };
 432
 433   /// This function determines if the specified instruction executes the same
 434   /// operation as the current one. This means that the opcodes, type, operand
 435   /// types and any other factors affecting the operation must be the same. This
 436   /// is similar to isIdenticalTo except the operands themselves don't have to
 437   /// be identical.
 438   /// @returns true if the specified instruction is the same operation as
 439   /// the current one.
 440   /// @brief Determine if one instruction is the same operation as another.
 441   bool isSameOperationAs(const Instruction *I, unsigned flags = 0) const;
 442
 443   /// isUsedOutsideOfBlock - Return true if there are any uses of this
 444   /// instruction in blocks other than the specified block.  Note that PHI nodes
 445   /// are considered to evaluate their operands in the corresponding predecessor
 446   /// block.
 447   bool isUsedOutsideOfBlock(const BasicBlock *BB) const;
 448
 449
 450   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 451   static inline bool classof(const Value *V) {
 452     return V->getValueID() >= Value::InstructionVal;
 453   }
 454
 455   //----------------------------------------------------------------------
 456   // Exported enumerations.
 457   //
 458   enum TermOps {       // These terminate basic blocks
 459 #define  FIRST_TERM_INST(N)             TermOpsBegin = N,
 460 #define HANDLE_TERM_INST(N, OPC, CLASS) OPC = N,
 461 #define   LAST_TERM_INST(N)             TermOpsEnd = N+1
 462 #include "llvm/IR/Instruction.def"
 463   };
 464
 465   enum BinaryOps {
 466 #define  FIRST_BINARY_INST(N)             BinaryOpsBegin = N,
 467 #define HANDLE_BINARY_INST(N, OPC, CLASS) OPC = N,
 468 #define   LAST_BINARY_INST(N)             BinaryOpsEnd = N+1
 469 #include "llvm/IR/Instruction.def"
 470   };
 471
 472   enum MemoryOps {
 473 #define  FIRST_MEMORY_INST(N)             MemoryOpsBegin = N,
 474 #define HANDLE_MEMORY_INST(N, OPC, CLASS) OPC = N,
 475 #define   LAST_MEMORY_INST(N)             MemoryOpsEnd = N+1
 476 #include "llvm/IR/Instruction.def"
 477   };
 478
 479   enum CastOps {
 480 #define  FIRST_CAST_INST(N)             CastOpsBegin = N,
 481 #define HANDLE_CAST_INST(N, OPC, CLASS) OPC = N,
 482 #define   LAST_CAST_INST(N)             CastOpsEnd = N+1
 483 #include "llvm/IR/Instruction.def"
 484   };
 485
 486   enum FuncletPadOps {
 487 #define  FIRST_FUNCLETPAD_INST(N)             FuncletPadOpsBegin = N,
 488 #define HANDLE_FUNCLETPAD_INST(N, OPC, CLASS) OPC = N,
 489 #define   LAST_FUNCLETPAD_INST(N)             FuncletPadOpsEnd = N+1
 490 #include "llvm/IR/Instruction.def"
 491   };
 492
 493   enum OtherOps {
 494 #define  FIRST_OTHER_INST(N)             OtherOpsBegin = N,
 495 #define HANDLE_OTHER_INST(N, OPC, CLASS) OPC = N,
 496 #define   LAST_OTHER_INST(N)             OtherOpsEnd = N+1
 497 #include "llvm/IR/Instruction.def"
 498   };
 499 private:
 500   // Shadow Value::setValueSubclassData with a private forwarding method so that
 501   // subclasses cannot accidentally use it.
 502   void setValueSubclassData(unsigned short D) {
 503     Value::setValueSubclassData(D);
 504   }
 505   unsigned short getSubclassDataFromValue() const {
 506     return Value::getSubclassDataFromValue();
 507   }
 508
 509   void setHasMetadataHashEntry(bool V) {
 510     setValueSubclassData((getSubclassDataFromValue() & ~HasMetadataBit) |
 511                          (V ? HasMetadataBit : 0));
 512   }
 513
 514   friend class SymbolTableListTraits<Instruction>;
 515   void setParent(BasicBlock *P);
 516 protected:
 517   // Instruction subclasses can stick up to 15 bits of stuff into the
 518   // SubclassData field of instruction with these members.
 519
 520   // Verify that only the low 15 bits are used.
 521   void setInstructionSubclassData(unsigned short D) {
 522     assert((D & HasMetadataBit) == 0 && "Out of range value put into field");
 523     setValueSubclassData((getSubclassDataFromValue() & HasMetadataBit) | D);
 524   }
 525
 526   unsigned getSubclassDataFromInstruction() const {
 527     return getSubclassDataFromValue() & ~HasMetadataBit;
 528   }
 529
 530   Instruction(Type *Ty, unsigned iType, Use *Ops, unsigned NumOps,
 531               Instruction *InsertBefore = nullptr);
 532   Instruction(Type *Ty, unsigned iType, Use *Ops, unsigned NumOps,
 533               BasicBlock *InsertAtEnd);
 534
 535 private:
 536   /// Create a copy of this instruction.
 537   Instruction *cloneImpl() const;
 538 };
 539
 540 // Instruction* is only 4-byte aligned.
 541 template<>
 542 class PointerLikeTypeTraits<Instruction*> {
 543   typedef Instruction* PT;
 544 public:
 545   static inline void *getAsVoidPointer(PT P) { return P; }
 546   static inline PT getFromVoidPointer(void *P) {
 547     return static_cast<PT>(P);
 548   }
 549   enum { NumLowBitsAvailable = 2 };
 550 };
 551
 552 } // End llvm namespace
 553
 554 #endif