//===-- llvm/IntrinsicInst.h - Intrinsic Instruction Wrappers ---*- C++ -*-===// // // The LLVM Compiler Infrastructure // // This file is distributed under the University of Illinois Open Source // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// // // This file defines classes that make it really easy to deal with intrinsic // functions with the isa/dyncast family of functions. In particular, this // allows you to do things like: // // if (MemCpyInst *MCI = dyn_cast<MemCpyInst>(Inst)) // ... MCI->getDest() ... MCI->getSource() ... // // All intrinsic function calls are instances of the call instruction, so these // are all subclasses of the CallInst class. Note that none of these classes // has state or virtual methods, which is an important part of this gross/neat // hack working. // //===----------------------------------------------------------------------===// #ifndef LLVM_IR_INTRINSICINST_H #define LLVM_IR_INTRINSICINST_H #include "llvm/IR/Constants.h" #include "llvm/IR/DerivedTypes.h" #include "llvm/IR/Function.h" #include "llvm/IR/GlobalVariable.h" #include "llvm/IR/Instructions.h" #include "llvm/IR/Intrinsics.h" #include "llvm/IR/Metadata.h" #include "llvm/IR/Value.h" #include "llvm/Support/Casting.h" #include <cassert> #include <cstdint> namespace llvm { /// A wrapper class for inspecting calls to intrinsic functions. /// This allows the standard isa/dyncast/cast functionality to work with calls /// to intrinsic functions. class IntrinsicInst : public CallInst { public: IntrinsicInst() = delete; IntrinsicInst(const IntrinsicInst &) = delete; IntrinsicInst &operator=(const IntrinsicInst &) = delete; /// Return the intrinsic ID of this intrinsic. Intrinsic::ID getIntrinsicID() const { return getCalledFunction()->getIntrinsicID(); } // Methods for support type inquiry through isa, cast, and dyn_cast: static bool classof(const CallInst *I) { if (const Function *CF = I->getCalledFunction()) return CF->isIntrinsic(); return false; } static bool classof(const Value *V) { return isa<CallInst>(V) && classof(cast<CallInst>(V)); } }; /// This is the common base class for debug info intrinsics. class DbgInfoIntrinsic : public IntrinsicInst { public: /// Get the location corresponding to the variable referenced by the debug /// info intrinsic. Depending on the intrinsic, this could be the /// variable's value or its address. Value *getVariableLocation(bool AllowNullOp = true) const; /// Does this describe the address of a local variable. True for dbg.addr /// and dbg.declare, but not dbg.value, which describes its value. bool isAddressOfVariable() const { return getIntrinsicID() != Intrinsic::dbg_value; } DILocalVariable *getVariable() const { return cast<DILocalVariable>(getRawVariable()); } DIExpression *getExpression() const { return cast<DIExpression>(getRawExpression()); } Metadata *getRawVariable() const { return cast<MetadataAsValue>(getArgOperand(1))->getMetadata(); } Metadata *getRawExpression() const { return cast<MetadataAsValue>(getArgOperand(2))->getMetadata(); } /// \name Casting methods /// @{ static bool classof(const IntrinsicInst *I) { switch (I->getIntrinsicID()) { case Intrinsic::dbg_declare: case Intrinsic::dbg_value: case Intrinsic::dbg_addr: return true; default: return false; } } static bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } /// @} }; /// This represents the llvm.dbg.declare instruction. class DbgDeclareInst : public DbgInfoIntrinsic { public: Value *getAddress() const { return getVariableLocation(); } /// \name Casting methods /// @{ static bool classof(const IntrinsicInst *I) { return I->getIntrinsicID() == Intrinsic::dbg_declare; } static bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } /// @} }; /// This represents the llvm.dbg.addr instruction. class DbgAddrIntrinsic : public DbgInfoIntrinsic { public: Value *getAddress() const { return getVariableLocation(); } /// \name Casting methods /// @{ static bool classof(const IntrinsicInst *I) { return I->getIntrinsicID() == Intrinsic::dbg_addr; } static bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } }; /// This represents the llvm.dbg.value instruction. class DbgValueInst : public DbgInfoIntrinsic { public: Value *getValue() const { return getVariableLocation(/* AllowNullOp = */ false); } /// \name Casting methods /// @{ static bool classof(const IntrinsicInst *I) { return I->getIntrinsicID() == Intrinsic::dbg_value; } static bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } /// @} }; /// This is the common base class for constrained floating point intrinsics. class ConstrainedFPIntrinsic : public IntrinsicInst { public: enum RoundingMode { rmInvalid, rmDynamic, rmToNearest, rmDownward, rmUpward, rmTowardZero }; enum ExceptionBehavior { ebInvalid, ebIgnore, ebMayTrap, ebStrict }; bool isUnaryOp() const; bool isTernaryOp() const; RoundingMode getRoundingMode() const; ExceptionBehavior getExceptionBehavior() const; // Methods for support type inquiry through isa, cast, and dyn_cast: static bool classof(const IntrinsicInst *I) { switch (I->getIntrinsicID()) { case Intrinsic::experimental_constrained_fadd: case Intrinsic::experimental_constrained_fsub: case Intrinsic::experimental_constrained_fmul: case Intrinsic::experimental_constrained_fdiv: case Intrinsic::experimental_constrained_frem: case Intrinsic::experimental_constrained_fma: case Intrinsic::experimental_constrained_sqrt: case Intrinsic::experimental_constrained_pow: case Intrinsic::experimental_constrained_powi: case Intrinsic::experimental_constrained_sin: case Intrinsic::experimental_constrained_cos: case Intrinsic::experimental_constrained_exp: case Intrinsic::experimental_constrained_exp2: case Intrinsic::experimental_constrained_log: case Intrinsic::experimental_constrained_log10: case Intrinsic::experimental_constrained_log2: case Intrinsic::experimental_constrained_rint: case Intrinsic::experimental_constrained_nearbyint: return true; default: return false; } } static bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } }; /// This class represents atomic memcpy intrinsic /// TODO: Integrate this class into MemIntrinsic hierarchy; for now this is /// C&P of all methods from that hierarchy class ElementUnorderedAtomicMemCpyInst : public IntrinsicInst { private: enum { ARG_DEST = 0, ARG_SOURCE = 1, ARG_LENGTH = 2, ARG_ELEMENTSIZE = 3 }; public: Value *getRawDest() const { return const_cast<Value *>(getArgOperand(ARG_DEST)); } const Use &getRawDestUse() const { return getArgOperandUse(ARG_DEST); } Use &getRawDestUse() { return getArgOperandUse(ARG_DEST); } /// Return the arguments to the instruction. Value *getRawSource() const { return const_cast<Value *>(getArgOperand(ARG_SOURCE)); } const Use &getRawSourceUse() const { return getArgOperandUse(ARG_SOURCE); } Use &getRawSourceUse() { return getArgOperandUse(ARG_SOURCE); } Value *getLength() const { return const_cast<Value *>(getArgOperand(ARG_LENGTH)); } const Use &getLengthUse() const { return getArgOperandUse(ARG_LENGTH); } Use &getLengthUse() { return getArgOperandUse(ARG_LENGTH); } bool isVolatile() const { return false; } Value *getRawElementSizeInBytes() const { return const_cast<Value *>(getArgOperand(ARG_ELEMENTSIZE)); } ConstantInt *getElementSizeInBytesCst() const { return cast<ConstantInt>(getRawElementSizeInBytes()); } uint32_t getElementSizeInBytes() const { return getElementSizeInBytesCst()->getZExtValue(); } /// This is just like getRawDest, but it strips off any cast /// instructions that feed it, giving the original input. The returned /// value is guaranteed to be a pointer. Value *getDest() const { return getRawDest()->stripPointerCasts(); } /// This is just like getRawSource, but it strips off any cast /// instructions that feed it, giving the original input. The returned /// value is guaranteed to be a pointer. Value *getSource() const { return getRawSource()->stripPointerCasts(); } unsigned getDestAddressSpace() const { return cast<PointerType>(getRawDest()->getType())->getAddressSpace(); } unsigned getSourceAddressSpace() const { return cast<PointerType>(getRawSource()->getType())->getAddressSpace(); } /// Set the specified arguments of the instruction. void setDest(Value *Ptr) { assert(getRawDest()->getType() == Ptr->getType() && "setDest called with pointer of wrong type!"); setArgOperand(ARG_DEST, Ptr); } void setSource(Value *Ptr) { assert(getRawSource()->getType() == Ptr->getType() && "setSource called with pointer of wrong type!"); setArgOperand(ARG_SOURCE, Ptr); } void setLength(Value *L) { assert(getLength()->getType() == L->getType() && "setLength called with value of wrong type!"); setArgOperand(ARG_LENGTH, L); } void setElementSizeInBytes(Constant *V) { assert(V->getType() == Type::getInt8Ty(getContext()) && "setElementSizeInBytes called with value of wrong type!"); setArgOperand(ARG_ELEMENTSIZE, V); } static bool classof(const IntrinsicInst *I) { return I->getIntrinsicID() == Intrinsic::memcpy_element_unordered_atomic; } static bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } }; class ElementUnorderedAtomicMemMoveInst : public IntrinsicInst { private: enum { ARG_DEST = 0, ARG_SOURCE = 1, ARG_LENGTH = 2, ARG_ELEMENTSIZE = 3 }; public: Value *getRawDest() const { return const_cast<Value *>(getArgOperand(ARG_DEST)); } const Use &getRawDestUse() const { return getArgOperandUse(ARG_DEST); } Use &getRawDestUse() { return getArgOperandUse(ARG_DEST); } /// Return the arguments to the instruction. Value *getRawSource() const { return const_cast<Value *>(getArgOperand(ARG_SOURCE)); } const Use &getRawSourceUse() const { return getArgOperandUse(ARG_SOURCE); } Use &getRawSourceUse() { return getArgOperandUse(ARG_SOURCE); } Value *getLength() const { return const_cast<Value *>(getArgOperand(ARG_LENGTH)); } const Use &getLengthUse() const { return getArgOperandUse(ARG_LENGTH); } Use &getLengthUse() { return getArgOperandUse(ARG_LENGTH); } bool isVolatile() const { return false; } Value *getRawElementSizeInBytes() const { return const_cast<Value *>(getArgOperand(ARG_ELEMENTSIZE)); } ConstantInt *getElementSizeInBytesCst() const { return cast<ConstantInt>(getRawElementSizeInBytes()); } uint32_t getElementSizeInBytes() const { return getElementSizeInBytesCst()->getZExtValue(); } /// This is just like getRawDest, but it strips off any cast /// instructions that feed it, giving the original input. The returned /// value is guaranteed to be a pointer. Value *getDest() const { return getRawDest()->stripPointerCasts(); } /// This is just like getRawSource, but it strips off any cast /// instructions that feed it, giving the original input. The returned /// value is guaranteed to be a pointer. Value *getSource() const { return getRawSource()->stripPointerCasts(); } unsigned getDestAddressSpace() const { return cast<PointerType>(getRawDest()->getType())->getAddressSpace(); } unsigned getSourceAddressSpace() const { return cast<PointerType>(getRawSource()->getType())->getAddressSpace(); } /// Set the specified arguments of the instruction. void setDest(Value *Ptr) { assert(getRawDest()->getType() == Ptr->getType() && "setDest called with pointer of wrong type!"); setArgOperand(ARG_DEST, Ptr); } void setSource(Value *Ptr) { assert(getRawSource()->getType() == Ptr->getType() && "setSource called with pointer of wrong type!"); setArgOperand(ARG_SOURCE, Ptr); } void setLength(Value *L) { assert(getLength()->getType() == L->getType() && "setLength called with value of wrong type!"); setArgOperand(ARG_LENGTH, L); } void setElementSizeInBytes(Constant *V) { assert(V->getType() == Type::getInt8Ty(getContext()) && "setElementSizeInBytes called with value of wrong type!"); setArgOperand(ARG_ELEMENTSIZE, V); } static inline bool classof(const IntrinsicInst *I) { return I->getIntrinsicID() == Intrinsic::memmove_element_unordered_atomic; } static inline bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } }; /// This class represents atomic memset intrinsic /// TODO: Integrate this class into MemIntrinsic hierarchy; for now this is /// C&P of all methods from that hierarchy class ElementUnorderedAtomicMemSetInst : public IntrinsicInst { private: enum { ARG_DEST = 0, ARG_VALUE = 1, ARG_LENGTH = 2, ARG_ELEMENTSIZE = 3 }; public: Value *getRawDest() const { return const_cast<Value *>(getArgOperand(ARG_DEST)); } const Use &getRawDestUse() const { return getArgOperandUse(ARG_DEST); } Use &getRawDestUse() { return getArgOperandUse(ARG_DEST); } Value *getValue() const { return const_cast<Value*>(getArgOperand(ARG_VALUE)); } const Use &getValueUse() const { return getArgOperandUse(ARG_VALUE); } Use &getValueUse() { return getArgOperandUse(ARG_VALUE); } Value *getLength() const { return const_cast<Value *>(getArgOperand(ARG_LENGTH)); } const Use &getLengthUse() const { return getArgOperandUse(ARG_LENGTH); } Use &getLengthUse() { return getArgOperandUse(ARG_LENGTH); } bool isVolatile() const { return false; } Value *getRawElementSizeInBytes() const { return const_cast<Value *>(getArgOperand(ARG_ELEMENTSIZE)); } ConstantInt *getElementSizeInBytesCst() const { return cast<ConstantInt>(getRawElementSizeInBytes()); } uint32_t getElementSizeInBytes() const { return getElementSizeInBytesCst()->getZExtValue(); } /// This is just like getRawDest, but it strips off any cast /// instructions that feed it, giving the original input. The returned /// value is guaranteed to be a pointer. Value *getDest() const { return getRawDest()->stripPointerCasts(); } unsigned getDestAddressSpace() const { return cast<PointerType>(getRawDest()->getType())->getAddressSpace(); } /// Set the specified arguments of the instruction. void setDest(Value *Ptr) { assert(getRawDest()->getType() == Ptr->getType() && "setDest called with pointer of wrong type!"); setArgOperand(ARG_DEST, Ptr); } void setValue(Value *Val) { assert(getValue()->getType() == Val->getType() && "setValue called with value of wrong type!"); setArgOperand(ARG_VALUE, Val); } void setLength(Value *L) { assert(getLength()->getType() == L->getType() && "setLength called with value of wrong type!"); setArgOperand(ARG_LENGTH, L); } void setElementSizeInBytes(Constant *V) { assert(V->getType() == Type::getInt8Ty(getContext()) && "setElementSizeInBytes called with value of wrong type!"); setArgOperand(ARG_ELEMENTSIZE, V); } static inline bool classof(const IntrinsicInst *I) { return I->getIntrinsicID() == Intrinsic::memset_element_unordered_atomic; } static inline bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } }; /// This is the common base class for memset/memcpy/memmove. class MemIntrinsic : public IntrinsicInst { public: Value *getRawDest() const { return const_cast<Value*>(getArgOperand(0)); } const Use &getRawDestUse() const { return getArgOperandUse(0); } Use &getRawDestUse() { return getArgOperandUse(0); } Value *getLength() const { return const_cast<Value*>(getArgOperand(2)); } const Use &getLengthUse() const { return getArgOperandUse(2); } Use &getLengthUse() { return getArgOperandUse(2); } ConstantInt *getAlignmentCst() const { return cast<ConstantInt>(const_cast<Value*>(getArgOperand(3))); } unsigned getAlignment() const { return getAlignmentCst()->getZExtValue(); } ConstantInt *getVolatileCst() const { return cast<ConstantInt>(const_cast<Value*>(getArgOperand(4))); } bool isVolatile() const { return !getVolatileCst()->isZero(); } unsigned getDestAddressSpace() const { return cast<PointerType>(getRawDest()->getType())->getAddressSpace(); } /// This is just like getRawDest, but it strips off any cast /// instructions that feed it, giving the original input. The returned /// value is guaranteed to be a pointer. Value *getDest() const { return getRawDest()->stripPointerCasts(); } /// Set the specified arguments of the instruction. void setDest(Value *Ptr) { assert(getRawDest()->getType() == Ptr->getType() && "setDest called with pointer of wrong type!"); setArgOperand(0, Ptr); } void setLength(Value *L) { assert(getLength()->getType() == L->getType() && "setLength called with value of wrong type!"); setArgOperand(2, L); } void setAlignment(Constant* A) { setArgOperand(3, A); } void setVolatile(Constant* V) { setArgOperand(4, V); } Type *getAlignmentType() const { return getArgOperand(3)->getType(); } // Methods for support type inquiry through isa, cast, and dyn_cast: static bool classof(const IntrinsicInst *I) { switch (I->getIntrinsicID()) { case Intrinsic::memcpy: case Intrinsic::memmove: case Intrinsic::memset: return true; default: return false; } } static bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } }; /// This class wraps the llvm.memset intrinsic. class MemSetInst : public MemIntrinsic { public: /// Return the arguments to the instruction. Value *getValue() const { return const_cast<Value*>(getArgOperand(1)); } const Use &getValueUse() const { return getArgOperandUse(1); } Use &getValueUse() { return getArgOperandUse(1); } void setValue(Value *Val) { assert(getValue()->getType() == Val->getType() && "setValue called with value of wrong type!"); setArgOperand(1, Val); } // Methods for support type inquiry through isa, cast, and dyn_cast: static bool classof(const IntrinsicInst *I) { return I->getIntrinsicID() == Intrinsic::memset; } static bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } }; /// This class wraps the llvm.memcpy/memmove intrinsics. class MemTransferInst : public MemIntrinsic { public: /// Return the arguments to the instruction. Value *getRawSource() const { return const_cast<Value*>(getArgOperand(1)); } const Use &getRawSourceUse() const { return getArgOperandUse(1); } Use &getRawSourceUse() { return getArgOperandUse(1); } /// This is just like getRawSource, but it strips off any cast /// instructions that feed it, giving the original input. The returned /// value is guaranteed to be a pointer. Value *getSource() const { return getRawSource()->stripPointerCasts(); } unsigned getSourceAddressSpace() const { return cast<PointerType>(getRawSource()->getType())->getAddressSpace(); } void setSource(Value *Ptr) { assert(getRawSource()->getType() == Ptr->getType() && "setSource called with pointer of wrong type!"); setArgOperand(1, Ptr); } // Methods for support type inquiry through isa, cast, and dyn_cast: static bool classof(const IntrinsicInst *I) { return I->getIntrinsicID() == Intrinsic::memcpy || I->getIntrinsicID() == Intrinsic::memmove; } static bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } }; /// This class wraps the llvm.memcpy intrinsic. class MemCpyInst : public MemTransferInst { public: // Methods for support type inquiry through isa, cast, and dyn_cast: static bool classof(const IntrinsicInst *I) { return I->getIntrinsicID() == Intrinsic::memcpy; } static bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } }; /// This class wraps the llvm.memmove intrinsic. class MemMoveInst : public MemTransferInst { public: // Methods for support type inquiry through isa, cast, and dyn_cast: static bool classof(const IntrinsicInst *I) { return I->getIntrinsicID() == Intrinsic::memmove; } static bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } }; /// This represents the llvm.va_start intrinsic. class VAStartInst : public IntrinsicInst { public: static bool classof(const IntrinsicInst *I) { return I->getIntrinsicID() == Intrinsic::vastart; } static bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } Value *getArgList() const { return const_cast<Value*>(getArgOperand(0)); } }; /// This represents the llvm.va_end intrinsic. class VAEndInst : public IntrinsicInst { public: static bool classof(const IntrinsicInst *I) { return I->getIntrinsicID() == Intrinsic::vaend; } static bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } Value *getArgList() const { return const_cast<Value*>(getArgOperand(0)); } }; /// This represents the llvm.va_copy intrinsic. class VACopyInst : public IntrinsicInst { public: static bool classof(const IntrinsicInst *I) { return I->getIntrinsicID() == Intrinsic::vacopy; } static bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } Value *getDest() const { return const_cast<Value*>(getArgOperand(0)); } Value *getSrc() const { return const_cast<Value*>(getArgOperand(1)); } }; /// This represents the llvm.instrprof_increment intrinsic. class InstrProfIncrementInst : public IntrinsicInst { public: static bool classof(const IntrinsicInst *I) { return I->getIntrinsicID() == Intrinsic::instrprof_increment; } static bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } GlobalVariable *getName() const { return cast<GlobalVariable>( const_cast<Value *>(getArgOperand(0))->stripPointerCasts()); } ConstantInt *getHash() const { return cast<ConstantInt>(const_cast<Value *>(getArgOperand(1))); } ConstantInt *getNumCounters() const { return cast<ConstantInt>(const_cast<Value *>(getArgOperand(2))); } ConstantInt *getIndex() const { return cast<ConstantInt>(const_cast<Value *>(getArgOperand(3))); } Value *getStep() const; }; class InstrProfIncrementInstStep : public InstrProfIncrementInst { public: static bool classof(const IntrinsicInst *I) { return I->getIntrinsicID() == Intrinsic::instrprof_increment_step; } static bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } }; /// This represents the llvm.instrprof_value_profile intrinsic. class InstrProfValueProfileInst : public IntrinsicInst { public: static bool classof(const IntrinsicInst *I) { return I->getIntrinsicID() == Intrinsic::instrprof_value_profile; } static bool classof(const Value *V) { return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V)); } GlobalVariable *getName() const { return cast<GlobalVariable>( const_cast<Value *>(getArgOperand(0))->stripPointerCasts()); } ConstantInt *getHash() const { return cast<ConstantInt>(const_cast<Value *>(getArgOperand(1))); } Value *getTargetValue() const { return cast<Value>(const_cast<Value *>(getArgOperand(2))); } ConstantInt *getValueKind() const { return cast<ConstantInt>(const_cast<Value *>(getArgOperand(3))); } // Returns the value site index. ConstantInt *getIndex() const { return cast<ConstantInt>(const_cast<Value *>(getArgOperand(4))); } }; } // end namespace llvm #endif // LLVM_IR_INTRINSICINST_H