LLVM 20.0.0git
Public Member Functions | Protected Member Functions | List of all members
llvm::DbgVariableIntrinsic Class Reference

This is the common base class for debug info intrinsics for variables. More...

#include "llvm/IR/IntrinsicInst.h"

Inheritance diagram for llvm::DbgVariableIntrinsic:
Inheritance graph
[legend]

Public Member Functions

iterator_range< location_op_iteratorlocation_ops () const
 Get the locations corresponding to the variable referenced by the debug info intrinsic.
 
ValuegetVariableLocationOp (unsigned OpIdx) const
 
void replaceVariableLocationOp (Value *OldValue, Value *NewValue, bool AllowEmpty=false)
 
void replaceVariableLocationOp (unsigned OpIdx, Value *NewValue)
 
void addVariableLocationOps (ArrayRef< Value * > NewValues, DIExpression *NewExpr)
 Adding a new location operand will always result in this intrinsic using an ArgList, and must always be accompanied by a new expression that uses the new operand.
 
void setVariable (DILocalVariable *NewVar)
 
void setExpression (DIExpression *NewExpr)
 
unsigned getNumVariableLocationOps () const
 
bool hasArgList () const
 
bool isAddressOfVariable () const
 Does this describe the address of a local variable.
 
void setKillLocation ()
 
bool isKillLocation () const
 
DILocalVariablegetVariable () const
 
DIExpressiongetExpression () const
 
MetadatagetRawLocation () const
 
RawLocationWrapper getWrappedLocation () const
 
MetadatagetRawVariable () const
 
MetadatagetRawExpression () const
 
void setRawLocation (Metadata *Location)
 Use of this should generally be avoided; instead, replaceVariableLocationOp and addVariableLocationOps should be used where possible to avoid creating invalid state.
 
std::optional< uint64_tgetFragmentSizeInBits () const
 Get the size (in bits) of the variable, or fragment of the variable that is described.
 
std::optional< DIExpression::FragmentInfogetFragment () const
 Get the FragmentInfo for the variable.
 
DIExpression::FragmentInfo getFragmentOrEntireVariable () const
 Get the FragmentInfo for the variable if it exists, otherwise return a FragmentInfo that covers the entire variable if the variable size is known, otherwise return a zero-sized fragment.
 
- Public Member Functions inherited from llvm::IntrinsicInst
 IntrinsicInst ()=delete
 
 IntrinsicInst (const IntrinsicInst &)=delete
 
IntrinsicInstoperator= (const IntrinsicInst &)=delete
 
Intrinsic::ID getIntrinsicID () const
 Return the intrinsic ID of this intrinsic.
 
bool isAssociative () const
 
bool isCommutative () const
 Return true if swapping the first two arguments to the intrinsic produces the same result.
 
bool isAssumeLikeIntrinsic () const
 Checks if the intrinsic is an annotation.
 
- Public Member Functions inherited from llvm::CallInst
TailCallKind getTailCallKind () const
 
bool isTailCall () const
 
bool isMustTailCall () const
 
bool isNoTailCall () const
 
void setTailCallKind (TailCallKind TCK)
 
void setTailCall (bool IsTc=true)
 
bool canReturnTwice () const
 Return true if the call can return twice.
 
void setCanReturnTwice ()
 
bool isNonContinuableTrap () const
 Return true if the call is for a noreturn trap intrinsic.
 
void updateProfWeight (uint64_t S, uint64_t T)
 Updates profile metadata by scaling it by S / T.
 
- Public Member Functions inherited from llvm::CallBase
ValuegetConvergenceControlToken () const
 Return the convergence control token for this call, if it exists.
 
FunctionTypegetFunctionType () const
 
void mutateFunctionType (FunctionType *FTy)
 
 DECLARE_TRANSPARENT_OPERAND_ACCESSORS (Value)
 
User::op_iterator data_operands_begin ()
 data_operands_begin/data_operands_end - Return iterators iterating over the call / invoke argument list and bundle operands.
 
User::const_op_iterator data_operands_begin () const
 
User::op_iterator data_operands_end ()
 
User::const_op_iterator data_operands_end () const
 
iterator_range< User::op_iteratordata_ops ()
 
iterator_range< User::const_op_iteratordata_ops () const
 
bool data_operands_empty () const
 
unsigned data_operands_size () const
 
bool isDataOperand (const Use *U) const
 
bool isDataOperand (Value::const_user_iterator UI) const
 
unsigned getDataOperandNo (Value::const_user_iterator UI) const
 Given a value use iterator, return the data operand corresponding to it.
 
unsigned getDataOperandNo (const Use *U) const
 Given a use for a data operand, get the data operand number that corresponds to it.
 
User::op_iterator arg_begin ()
 Return the iterator pointing to the beginning of the argument list.
 
User::const_op_iterator arg_begin () const
 
User::op_iterator arg_end ()
 Return the iterator pointing to the end of the argument list.
 
User::const_op_iterator arg_end () const
 
iterator_range< User::op_iteratorargs ()
 Iteration adapter for range-for loops.
 
iterator_range< User::const_op_iteratorargs () const
 
bool arg_empty () const
 
unsigned arg_size () const
 
ValuegetArgOperand (unsigned i) const
 
void setArgOperand (unsigned i, Value *v)
 
const UsegetArgOperandUse (unsigned i) const
 Wrappers for getting the Use of a call argument.
 
UsegetArgOperandUse (unsigned i)
 
bool isArgOperand (const Use *U) const
 
bool isArgOperand (Value::const_user_iterator UI) const
 
unsigned getArgOperandNo (const Use *U) const
 Given a use for a arg operand, get the arg operand number that corresponds to it.
 
unsigned getArgOperandNo (Value::const_user_iterator UI) const
 Given a value use iterator, return the arg operand number corresponding to it.
 
bool hasArgument (const Value *V) const
 Returns true if this CallSite passes the given Value* as an argument to the called function.
 
ValuegetCalledOperand () const
 
const UsegetCalledOperandUse () const
 
UsegetCalledOperandUse ()
 
FunctiongetCalledFunction () const
 Returns the function called, or null if this is an indirect function invocation or the function signature does not match the call signature.
 
bool isIndirectCall () const
 Return true if the callsite is an indirect call.
 
bool isCallee (Value::const_user_iterator UI) const
 Determine whether the passed iterator points to the callee operand's Use.
 
bool isCallee (const Use *U) const
 Determine whether this Use is the callee operand's Use.
 
FunctiongetCaller ()
 Helper to get the caller (the parent function).
 
const FunctiongetCaller () const
 
bool isMustTailCall () const
 Tests if this call site must be tail call optimized.
 
bool isTailCall () const
 Tests if this call site is marked as a tail call.
 
Intrinsic::ID getIntrinsicID () const
 Returns the intrinsic ID of the intrinsic called or Intrinsic::not_intrinsic if the called function is not an intrinsic, or if this is an indirect call.
 
void setCalledOperand (Value *V)
 
void setCalledFunction (Function *Fn)
 Sets the function called, including updating the function type.
 
void setCalledFunction (FunctionCallee Fn)
 Sets the function called, including updating the function type.
 
void setCalledFunction (FunctionType *FTy, Value *Fn)
 Sets the function called, including updating to the specified function type.
 
CallingConv::ID getCallingConv () const
 
void setCallingConv (CallingConv::ID CC)
 
bool isInlineAsm () const
 Check if this call is an inline asm statement.
 
AttributeList getAttributes () const
 Return the parameter attributes for this call.
 
void setAttributes (AttributeList A)
 Set the parameter attributes for this call.
 
bool hasFnAttr (Attribute::AttrKind Kind) const
 Determine whether this call has the given attribute.
 
bool hasFnAttr (StringRef Kind) const
 Determine whether this call has the given attribute.
 
void addAttributeAtIndex (unsigned i, Attribute::AttrKind Kind)
 adds the attribute to the list of attributes.
 
void addAttributeAtIndex (unsigned i, Attribute Attr)
 adds the attribute to the list of attributes.
 
void addFnAttr (Attribute::AttrKind Kind)
 Adds the attribute to the function.
 
void addFnAttr (Attribute Attr)
 Adds the attribute to the function.
 
void addRetAttr (Attribute::AttrKind Kind)
 Adds the attribute to the return value.
 
void addRetAttr (Attribute Attr)
 Adds the attribute to the return value.
 
void addParamAttr (unsigned ArgNo, Attribute::AttrKind Kind)
 Adds the attribute to the indicated argument.
 
void addParamAttr (unsigned ArgNo, Attribute Attr)
 Adds the attribute to the indicated argument.
 
void removeAttributeAtIndex (unsigned i, Attribute::AttrKind Kind)
 removes the attribute from the list of attributes.
 
void removeAttributeAtIndex (unsigned i, StringRef Kind)
 removes the attribute from the list of attributes.
 
void removeFnAttrs (const AttributeMask &AttrsToRemove)
 Removes the attributes from the function.
 
void removeFnAttr (Attribute::AttrKind Kind)
 Removes the attribute from the function.
 
void removeFnAttr (StringRef Kind)
 Removes the attribute from the function.
 
void removeRetAttr (Attribute::AttrKind Kind)
 Removes the attribute from the return value.
 
void removeRetAttrs (const AttributeMask &AttrsToRemove)
 Removes the attributes from the return value.
 
void removeParamAttr (unsigned ArgNo, Attribute::AttrKind Kind)
 Removes the attribute from the given argument.
 
void removeParamAttr (unsigned ArgNo, StringRef Kind)
 Removes the attribute from the given argument.
 
void removeParamAttrs (unsigned ArgNo, const AttributeMask &AttrsToRemove)
 Removes the attributes from the given argument.
 
void addDereferenceableParamAttr (unsigned i, uint64_t Bytes)
 adds the dereferenceable attribute to the list of attributes.
 
void addDereferenceableRetAttr (uint64_t Bytes)
 adds the dereferenceable attribute to the list of attributes.
 
void addRangeRetAttr (const ConstantRange &CR)
 adds the range attribute to the list of attributes.
 
bool hasRetAttr (Attribute::AttrKind Kind) const
 Determine whether the return value has the given attribute.
 
bool hasRetAttr (StringRef Kind) const
 Determine whether the return value has the given attribute.
 
Attribute getRetAttr (Attribute::AttrKind Kind) const
 Return the attribute for the given attribute kind for the return value.
 
bool paramHasAttr (unsigned ArgNo, Attribute::AttrKind Kind) const
 Determine whether the argument or parameter has the given attribute.
 
Attribute getAttributeAtIndex (unsigned i, Attribute::AttrKind Kind) const
 Get the attribute of a given kind at a position.
 
Attribute getAttributeAtIndex (unsigned i, StringRef Kind) const
 Get the attribute of a given kind at a position.
 
Attribute getFnAttr (StringRef Kind) const
 Get the attribute of a given kind for the function.
 
Attribute getFnAttr (Attribute::AttrKind Kind) const
 Get the attribute of a given kind for the function.
 
Attribute getParamAttr (unsigned ArgNo, Attribute::AttrKind Kind) const
 Get the attribute of a given kind from a given arg.
 
Attribute getParamAttr (unsigned ArgNo, StringRef Kind) const
 Get the attribute of a given kind from a given arg.
 
bool dataOperandHasImpliedAttr (unsigned i, Attribute::AttrKind Kind) const
 Return true if the data operand at index i has the attribute A.
 
bool doesNotCapture (unsigned OpNo) const
 Determine whether this data operand is not captured.
 
bool isByValArgument (unsigned ArgNo) const
 Determine whether this argument is passed by value.
 
bool isInAllocaArgument (unsigned ArgNo) const
 Determine whether this argument is passed in an alloca.
 
bool isPassPointeeByValueArgument (unsigned ArgNo) const
 Determine whether this argument is passed by value, in an alloca, or is preallocated.
 
bool isPassingUndefUB (unsigned ArgNo) const
 Determine whether passing undef to this argument is undefined behavior.
 
bool hasInAllocaArgument () const
 Determine if there are is an inalloca argument.
 
bool doesNotAccessMemory (unsigned OpNo) const
 
bool onlyReadsMemory (unsigned OpNo) const
 
bool onlyWritesMemory (unsigned OpNo) const
 
MaybeAlign getRetAlign () const
 Extract the alignment of the return value.
 
MaybeAlign getParamAlign (unsigned ArgNo) const
 Extract the alignment for a call or parameter (0=unknown).
 
MaybeAlign getParamStackAlign (unsigned ArgNo) const
 
TypegetParamByRefType (unsigned ArgNo) const
 Extract the byref type for a call or parameter.
 
TypegetParamByValType (unsigned ArgNo) const
 Extract the byval type for a call or parameter.
 
TypegetParamPreallocatedType (unsigned ArgNo) const
 Extract the preallocated type for a call or parameter.
 
TypegetParamInAllocaType (unsigned ArgNo) const
 Extract the inalloca type for a call or parameter.
 
TypegetParamStructRetType (unsigned ArgNo) const
 Extract the sret type for a call or parameter.
 
TypegetParamElementType (unsigned ArgNo) const
 Extract the elementtype type for a parameter.
 
uint64_t getRetDereferenceableBytes () const
 Extract the number of dereferenceable bytes for a call or parameter (0=unknown).
 
uint64_t getParamDereferenceableBytes (unsigned i) const
 Extract the number of dereferenceable bytes for a call or parameter (0=unknown).
 
uint64_t getRetDereferenceableOrNullBytes () const
 Extract the number of dereferenceable_or_null bytes for a call (0=unknown).
 
uint64_t getParamDereferenceableOrNullBytes (unsigned i) const
 Extract the number of dereferenceable_or_null bytes for a parameter (0=unknown).
 
FPClassTest getRetNoFPClass () const
 Extract a test mask for disallowed floating-point value classes for the return value.
 
FPClassTest getParamNoFPClass (unsigned i) const
 Extract a test mask for disallowed floating-point value classes for the parameter.
 
std::optional< ConstantRangegetRange () const
 If this return value has a range attribute, return the value range of the argument.
 
bool isReturnNonNull () const
 Return true if the return value is known to be not null.
 
bool returnDoesNotAlias () const
 Determine if the return value is marked with NoAlias attribute.
 
ValuegetReturnedArgOperand () const
 If one of the arguments has the 'returned' attribute, returns its operand value.
 
ValuegetArgOperandWithAttribute (Attribute::AttrKind Kind) const
 If one of the arguments has the specified attribute, returns its operand value.
 
bool isNoBuiltin () const
 Return true if the call should not be treated as a call to a builtin.
 
bool isStrictFP () const
 Determine if the call requires strict floating point semantics.
 
bool isNoInline () const
 Return true if the call should not be inlined.
 
void setIsNoInline ()
 
MemoryEffects getMemoryEffects () const
 
void setMemoryEffects (MemoryEffects ME)
 
bool doesNotAccessMemory () const
 Determine if the call does not access memory.
 
void setDoesNotAccessMemory ()
 
bool onlyReadsMemory () const
 Determine if the call does not access or only reads memory.
 
void setOnlyReadsMemory ()
 
bool onlyWritesMemory () const
 Determine if the call does not access or only writes memory.
 
void setOnlyWritesMemory ()
 
bool onlyAccessesArgMemory () const
 Determine if the call can access memmory only using pointers based on its arguments.
 
void setOnlyAccessesArgMemory ()
 
bool onlyAccessesInaccessibleMemory () const
 Determine if the function may only access memory that is inaccessible from the IR.
 
void setOnlyAccessesInaccessibleMemory ()
 
bool onlyAccessesInaccessibleMemOrArgMem () const
 Determine if the function may only access memory that is either inaccessible from the IR or pointed to by its arguments.
 
void setOnlyAccessesInaccessibleMemOrArgMem ()
 
bool doesNotReturn () const
 Determine if the call cannot return.
 
void setDoesNotReturn ()
 
bool doesNoCfCheck () const
 Determine if the call should not perform indirect branch tracking.
 
bool doesNotThrow () const
 Determine if the call cannot unwind.
 
void setDoesNotThrow ()
 
bool cannotDuplicate () const
 Determine if the invoke cannot be duplicated.
 
void setCannotDuplicate ()
 
bool cannotMerge () const
 Determine if the call cannot be tail merged.
 
void setCannotMerge ()
 
bool isConvergent () const
 Determine if the invoke is convergent.
 
void setConvergent ()
 
void setNotConvergent ()
 
bool hasStructRetAttr () const
 Determine if the call returns a structure through first pointer argument.
 
bool hasByValArgument () const
 Determine if any call argument is an aggregate passed by value.
 
unsigned getNumOperandBundles () const
 Return the number of operand bundles associated with this User.
 
bool hasOperandBundles () const
 Return true if this User has any operand bundles.
 
unsigned getBundleOperandsStartIndex () const
 Return the index of the first bundle operand in the Use array.
 
unsigned getBundleOperandsEndIndex () const
 Return the index of the last bundle operand in the Use array.
 
bool isBundleOperand (unsigned Idx) const
 Return true if the operand at index Idx is a bundle operand.
 
bool isOperandBundleOfType (uint32_t ID, unsigned Idx) const
 Return true if the operand at index Idx is a bundle operand that has tag ID ID.
 
bool isBundleOperand (const Use *U) const
 Returns true if the use is a bundle operand.
 
bool isBundleOperand (Value::const_user_iterator UI) const
 
unsigned getNumTotalBundleOperands () const
 Return the total number operands (not operand bundles) used by every operand bundle in this OperandBundleUser.
 
OperandBundleUse getOperandBundleAt (unsigned Index) const
 Return the operand bundle at a specific index.
 
unsigned countOperandBundlesOfType (StringRef Name) const
 Return the number of operand bundles with the tag Name attached to this instruction.
 
unsigned countOperandBundlesOfType (uint32_t ID) const
 Return the number of operand bundles with the tag ID attached to this instruction.
 
std::optional< OperandBundleUsegetOperandBundle (StringRef Name) const
 Return an operand bundle by name, if present.
 
std::optional< OperandBundleUsegetOperandBundle (uint32_t ID) const
 Return an operand bundle by tag ID, if present.
 
void getOperandBundlesAsDefs (SmallVectorImpl< OperandBundleDef > &Defs) const
 Return the list of operand bundles attached to this instruction as a vector of OperandBundleDefs.
 
OperandBundleUse getOperandBundleForOperand (unsigned OpIdx) const
 Return the operand bundle for the operand at index OpIdx.
 
bool hasReadingOperandBundles () const
 Return true if this operand bundle user has operand bundles that may read from the heap.
 
bool hasClobberingOperandBundles () const
 Return true if this operand bundle user has operand bundles that may write to the heap.
 
bool bundleOperandHasAttr (unsigned OpIdx, Attribute::AttrKind A) const
 Return true if the bundle operand at index OpIdx has the attribute A.
 
bool hasIdenticalOperandBundleSchema (const CallBase &Other) const
 Return true if Other has the same sequence of operand bundle tags with the same number of operands on each one of them as this OperandBundleUser.
 
bool hasOperandBundlesOtherThan (ArrayRef< uint32_t > IDs) const
 Return true if this operand bundle user contains operand bundles with tags other than those specified in IDs.
 
OperandBundleUse operandBundleFromBundleOpInfo (const BundleOpInfo &BOI) const
 Simple helper function to map a BundleOpInfo to an OperandBundleUse.
 
bundle_op_iterator bundle_op_info_begin ()
 Return the start of the list of BundleOpInfo instances associated with this OperandBundleUser.
 
const_bundle_op_iterator bundle_op_info_begin () const
 Return the start of the list of BundleOpInfo instances associated with this OperandBundleUser.
 
bundle_op_iterator bundle_op_info_end ()
 Return the end of the list of BundleOpInfo instances associated with this OperandBundleUser.
 
const_bundle_op_iterator bundle_op_info_end () const
 Return the end of the list of BundleOpInfo instances associated with this OperandBundleUser.
 
iterator_range< bundle_op_iteratorbundle_op_infos ()
 Return the range [bundle_op_info_begin, bundle_op_info_end).
 
iterator_range< const_bundle_op_iteratorbundle_op_infos () const
 Return the range [bundle_op_info_begin, bundle_op_info_end).
 
op_iterator populateBundleOperandInfos (ArrayRef< OperandBundleDef > Bundles, const unsigned BeginIndex)
 Populate the BundleOpInfo instances and the Use& vector from Bundles.
 
bool hasDeoptState () const
 Return true if the call has deopt state bundle.
 
BundleOpInfogetBundleOpInfoForOperand (unsigned OpIdx)
 Return the BundleOpInfo for the operand at index OpIdx.
 
const BundleOpInfogetBundleOpInfoForOperand (unsigned OpIdx) const
 
- Public Member Functions inherited from llvm::Instruction
iterator_range< simple_ilist< DbgRecord >::iterator > cloneDebugInfoFrom (const Instruction *From, std::optional< simple_ilist< DbgRecord >::iterator > FromHere=std::nullopt, bool InsertAtHead=false)
 Clone any debug-info attached to From onto this instruction.
 
iterator_range< simple_ilist< DbgRecord >::iterator > getDbgRecordRange () const
 Return a range over the DbgRecords attached to this instruction.
 
std::optional< simple_ilist< DbgRecord >::iterator > getDbgReinsertionPosition ()
 Return an iterator to the position of the "Next" DbgRecord after this instruction, or std::nullopt.
 
bool hasDbgRecords () const
 Returns true if any DbgRecords are attached to this instruction.
 
void adoptDbgRecords (BasicBlock *BB, InstListType::iterator It, bool InsertAtHead)
 Transfer any DbgRecords on the position It onto this instruction, by simply adopting the sequence of DbgRecords (which is efficient) if possible, by merging two sequences otherwise.
 
void dropDbgRecords ()
 Erase any DbgRecords attached to this instruction.
 
void dropOneDbgRecord (DbgRecord *I)
 Erase a single DbgRecord I that is attached to this instruction.
 
void handleMarkerRemoval ()
 Handle the debug-info implications of this instruction being removed.
 
 Instruction (const Instruction &)=delete
 
Instructionoperator= (const Instruction &)=delete
 
Instructionuser_back ()
 Specialize the methods defined in Value, as we know that an instruction can only be used by other instructions.
 
const Instructionuser_back () const
 
const ModulegetModule () const
 Return the module owning the function this instruction belongs to or nullptr it the function does not have a module.
 
ModulegetModule ()
 
const FunctiongetFunction () const
 Return the function this instruction belongs to.
 
FunctiongetFunction ()
 
const DataLayoutgetDataLayout () const
 Get the data layout of the module this instruction belongs to.
 
void removeFromParent ()
 This method unlinks 'this' from the containing basic block, but does not delete it.
 
InstListType::iterator eraseFromParent ()
 This method unlinks 'this' from the containing basic block and deletes it.
 
void insertBefore (Instruction *InsertPos)
 Insert an unlinked instruction into a basic block immediately before the specified instruction.
 
void insertBefore (InstListType::iterator InsertPos)
 Insert an unlinked instruction into a basic block immediately before the specified instruction.
 
void insertAfter (Instruction *InsertPos)
 Insert an unlinked instruction into a basic block immediately after the specified instruction.
 
InstListType::iterator insertInto (BasicBlock *ParentBB, InstListType::iterator It)
 Inserts an unlinked instruction into ParentBB at position It and returns the iterator of the inserted instruction.
 
void insertBefore (BasicBlock &BB, InstListType::iterator InsertPos)
 
void moveBefore (Instruction *MovePos)
 Unlink this instruction from its current basic block and insert it into the basic block that MovePos lives in, right before MovePos.
 
void moveBeforePreserving (Instruction *MovePos)
 Perform a moveBefore operation, while signalling that the caller intends to preserve the original ordering of instructions.
 
void moveBefore (BasicBlock &BB, InstListType::iterator I)
 Unlink this instruction and insert into BB before I.
 
void moveBeforePreserving (BasicBlock &BB, InstListType::iterator I)
 (See other overload for moveBeforePreserving).
 
void moveAfter (Instruction *MovePos)
 Unlink this instruction from its current basic block and insert it into the basic block that MovePos lives in, right after MovePos.
 
void moveAfterPreserving (Instruction *MovePos)
 See moveBeforePreserving .
 
bool comesBefore (const Instruction *Other) const
 Given an instruction Other in the same basic block as this instruction, return true if this instruction comes before Other.
 
std::optional< InstListType::iteratorgetInsertionPointAfterDef ()
 Get the first insertion point at which the result of this instruction is defined.
 
unsigned getOpcode () const
 Returns a member of one of the enums like Instruction::Add.
 
const chargetOpcodeName () const
 
bool isTerminator () const
 
bool isUnaryOp () const
 
bool isBinaryOp () const
 
bool isIntDivRem () const
 
bool isShift () const
 
bool isCast () const
 
bool isFuncletPad () const
 
bool isSpecialTerminator () const
 
bool isOnlyUserOfAnyOperand ()
 It checks if this instruction is the only user of at least one of its operands.
 
bool isLogicalShift () const
 Return true if this is a logical shift left or a logical shift right.
 
bool isArithmeticShift () const
 Return true if this is an arithmetic shift right.
 
bool isBitwiseLogicOp () const
 Return true if this is and/or/xor.
 
bool hasMetadata () const
 Return true if this instruction has any metadata attached to it.
 
bool hasMetadataOtherThanDebugLoc () const
 Return true if this instruction has metadata attached to it other than a debug location.
 
bool hasMetadata (unsigned KindID) const
 Return true if this instruction has the given type of metadata attached.
 
bool hasMetadata (StringRef Kind) const
 Return true if this instruction has the given type of metadata attached.
 
MDNodegetMetadata (unsigned KindID) const
 Get the metadata of given kind attached to this Instruction.
 
MDNodegetMetadata (StringRef Kind) const
 Get the metadata of given kind attached to this Instruction.
 
void getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const
 Get all metadata attached to this Instruction.
 
void getAllMetadataOtherThanDebugLoc (SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const
 This does the same thing as getAllMetadata, except that it filters out the debug location.
 
void setMetadata (unsigned KindID, MDNode *Node)
 Set the metadata of the specified kind to the specified node.
 
void setMetadata (StringRef Kind, MDNode *Node)
 
void copyMetadata (const Instruction &SrcInst, ArrayRef< unsigned > WL=ArrayRef< unsigned >())
 Copy metadata from SrcInst to this instruction.
 
void eraseMetadataIf (function_ref< bool(unsigned, MDNode *)> Pred)
 Erase all metadata that matches the predicate.
 
void swapProfMetadata ()
 If the instruction has "branch_weights" MD_prof metadata and the MDNode has three operands (including name string), swap the order of the metadata.
 
void addAnnotationMetadata (StringRef Annotation)
 Adds an !annotation metadata node with Annotation to this instruction.
 
void addAnnotationMetadata (SmallVector< StringRef > Annotations)
 Adds an !annotation metadata node with an array of Annotations as a tuple to this instruction.
 
AAMDNodes getAAMetadata () const
 Returns the AA metadata for this instruction.
 
void setAAMetadata (const AAMDNodes &N)
 Sets the AA metadata on this instruction from the AAMDNodes structure.
 
void setNoSanitizeMetadata ()
 Sets the nosanitize metadata on this instruction.
 
bool extractProfTotalWeight (uint64_t &TotalVal) const
 Retrieve total raw weight values of a branch.
 
void setDebugLoc (DebugLoc Loc)
 Set the debug location information for this instruction.
 
const DebugLocgetDebugLoc () const
 Return the debug location for this node as a DebugLoc.
 
const DebugLocgetStableDebugLoc () const
 Fetch the debug location for this node, unless this is a debug intrinsic, in which case fetch the debug location of the next non-debug node.
 
void setHasNoUnsignedWrap (bool b=true)
 Set or clear the nuw flag on this instruction, which must be an operator which supports this flag.
 
void setHasNoSignedWrap (bool b=true)
 Set or clear the nsw flag on this instruction, which must be an operator which supports this flag.
 
void setIsExact (bool b=true)
 Set or clear the exact flag on this instruction, which must be an operator which supports this flag.
 
void setNonNeg (bool b=true)
 Set or clear the nneg flag on this instruction, which must be a zext instruction.
 
bool hasNoUnsignedWrap () const LLVM_READONLY
 Determine whether the no unsigned wrap flag is set.
 
bool hasNoSignedWrap () const LLVM_READONLY
 Determine whether the no signed wrap flag is set.
 
bool hasNonNeg () const LLVM_READONLY
 Determine whether the the nneg flag is set.
 
bool hasPoisonGeneratingFlags () const LLVM_READONLY
 Return true if this operator has flags which may cause this instruction to evaluate to poison despite having non-poison inputs.
 
void dropPoisonGeneratingFlags ()
 Drops flags that may cause this instruction to evaluate to poison despite having non-poison inputs.
 
bool hasPoisonGeneratingMetadata () const LLVM_READONLY
 Return true if this instruction has poison-generating metadata.
 
void dropPoisonGeneratingMetadata ()
 Drops metadata that may generate poison.
 
bool hasPoisonGeneratingReturnAttributes () const LLVM_READONLY
 Return true if this instruction has poison-generating attribute.
 
void dropPoisonGeneratingReturnAttributes ()
 Drops return attributes that may generate poison.
 
bool hasPoisonGeneratingAnnotations () const
 Return true if this instruction has poison-generating flags, return attributes or metadata.
 
void dropPoisonGeneratingAnnotations ()
 Drops flags, return attributes and metadata that may generate poison.
 
void dropUBImplyingAttrsAndUnknownMetadata (ArrayRef< unsigned > KnownIDs={})
 This function drops non-debug unknown metadata (through dropUnknownNonDebugMetadata).
 
void dropUBImplyingAttrsAndMetadata ()
 Drop any attributes or metadata that can cause immediate undefined behavior.
 
bool isExact () const LLVM_READONLY
 Determine whether the exact flag is set.
 
void setFast (bool B)
 Set or clear all fast-math-flags on this instruction, which must be an operator which supports this flag.
 
void setHasAllowReassoc (bool B)
 Set or clear the reassociation flag on this instruction, which must be an operator which supports this flag.
 
void setHasNoNaNs (bool B)
 Set or clear the no-nans flag on this instruction, which must be an operator which supports this flag.
 
void setHasNoInfs (bool B)
 Set or clear the no-infs flag on this instruction, which must be an operator which supports this flag.
 
void setHasNoSignedZeros (bool B)
 Set or clear the no-signed-zeros flag on this instruction, which must be an operator which supports this flag.
 
void setHasAllowReciprocal (bool B)
 Set or clear the allow-reciprocal flag on this instruction, which must be an operator which supports this flag.
 
void setHasAllowContract (bool B)
 Set or clear the allow-contract flag on this instruction, which must be an operator which supports this flag.
 
void setHasApproxFunc (bool B)
 Set or clear the approximate-math-functions flag on this instruction, which must be an operator which supports this flag.
 
void setFastMathFlags (FastMathFlags FMF)
 Convenience function for setting multiple fast-math flags on this instruction, which must be an operator which supports these flags.
 
void copyFastMathFlags (FastMathFlags FMF)
 Convenience function for transferring all fast-math flag values to this instruction, which must be an operator which supports these flags.
 
bool isFast () const LLVM_READONLY
 Determine whether all fast-math-flags are set.
 
bool hasAllowReassoc () const LLVM_READONLY
 Determine whether the allow-reassociation flag is set.
 
bool hasNoNaNs () const LLVM_READONLY
 Determine whether the no-NaNs flag is set.
 
bool hasNoInfs () const LLVM_READONLY
 Determine whether the no-infs flag is set.
 
bool hasNoSignedZeros () const LLVM_READONLY
 Determine whether the no-signed-zeros flag is set.
 
bool hasAllowReciprocal () const LLVM_READONLY
 Determine whether the allow-reciprocal flag is set.
 
bool hasAllowContract () const LLVM_READONLY
 Determine whether the allow-contract flag is set.
 
bool hasApproxFunc () const LLVM_READONLY
 Determine whether the approximate-math-functions flag is set.
 
FastMathFlags getFastMathFlags () const LLVM_READONLY
 Convenience function for getting all the fast-math flags, which must be an operator which supports these flags.
 
void copyFastMathFlags (const Instruction *I)
 Copy I's fast-math flags.
 
void copyIRFlags (const Value *V, bool IncludeWrapFlags=true)
 Convenience method to copy supported exact, fast-math, and (optionally) wrapping flags from V to this instruction.
 
void andIRFlags (const Value *V)
 Logical 'and' of any supported wrapping, exact, and fast-math flags of V and this instruction.
 
void applyMergedLocation (DILocation *LocA, DILocation *LocB)
 Merge 2 debug locations and apply it to the Instruction.
 
void updateLocationAfterHoist ()
 Updates the debug location given that the instruction has been hoisted from a block to a predecessor of that block.
 
void dropLocation ()
 Drop the instruction's debug location.
 
void mergeDIAssignID (ArrayRef< const Instruction * > SourceInstructions)
 Merge the DIAssignID metadata from this instruction and those attached to instructions in SourceInstructions.
 
bool isAssociative () const LLVM_READONLY
 Return true if the instruction is associative:
 
bool isCommutative () const LLVM_READONLY
 Return true if the instruction is commutative:
 
bool isIdempotent () const
 Return true if the instruction is idempotent:
 
bool isNilpotent () const
 Return true if the instruction is nilpotent:
 
bool mayWriteToMemory () const LLVM_READONLY
 Return true if this instruction may modify memory.
 
bool mayReadFromMemory () const LLVM_READONLY
 Return true if this instruction may read memory.
 
bool mayReadOrWriteMemory () const
 Return true if this instruction may read or write memory.
 
bool isAtomic () const LLVM_READONLY
 Return true if this instruction has an AtomicOrdering of unordered or higher.
 
bool hasAtomicLoad () const LLVM_READONLY
 Return true if this atomic instruction loads from memory.
 
bool hasAtomicStore () const LLVM_READONLY
 Return true if this atomic instruction stores to memory.
 
bool isVolatile () const LLVM_READONLY
 Return true if this instruction has a volatile memory access.
 
TypegetAccessType () const LLVM_READONLY
 Return the type this instruction accesses in memory, if any.
 
bool mayThrow (bool IncludePhaseOneUnwind=false) const LLVM_READONLY
 Return true if this instruction may throw an exception.
 
bool isFenceLike () const
 Return true if this instruction behaves like a memory fence: it can load or store to memory location without being given a memory location.
 
bool mayHaveSideEffects () const LLVM_READONLY
 Return true if the instruction may have side effects.
 
bool isSafeToRemove () const LLVM_READONLY
 Return true if the instruction can be removed if the result is unused.
 
bool willReturn () const LLVM_READONLY
 Return true if the instruction will return (unwinding is considered as a form of returning control flow here).
 
bool isEHPad () const
 Return true if the instruction is a variety of EH-block.
 
bool isLifetimeStartOrEnd () const LLVM_READONLY
 Return true if the instruction is a llvm.lifetime.start or llvm.lifetime.end marker.
 
bool isLaunderOrStripInvariantGroup () const LLVM_READONLY
 Return true if the instruction is a llvm.launder.invariant.group or llvm.strip.invariant.group.
 
bool isDebugOrPseudoInst () const LLVM_READONLY
 Return true if the instruction is a DbgInfoIntrinsic or PseudoProbeInst.
 
const InstructiongetNextNonDebugInstruction (bool SkipPseudoOp=false) const
 Return a pointer to the next non-debug instruction in the same basic block as 'this', or nullptr if no such instruction exists.
 
InstructiongetNextNonDebugInstruction (bool SkipPseudoOp=false)
 
const InstructiongetPrevNonDebugInstruction (bool SkipPseudoOp=false) const
 Return a pointer to the previous non-debug instruction in the same basic block as 'this', or nullptr if no such instruction exists.
 
InstructiongetPrevNonDebugInstruction (bool SkipPseudoOp=false)
 
Instructionclone () const
 Create a copy of 'this' instruction that is identical in all ways except the following:
 
bool isIdenticalTo (const Instruction *I) const LLVM_READONLY
 Return true if the specified instruction is exactly identical to the current one.
 
bool isIdenticalToWhenDefined (const Instruction *I) const LLVM_READONLY
 This is like isIdenticalTo, except that it ignores the SubclassOptionalData flags, which may specify conditions under which the instruction's result is undefined.
 
bool isSameOperationAs (const Instruction *I, unsigned flags=0) const LLVM_READONLY
 This function determines if the specified instruction executes the same operation as the current one.
 
bool hasSameSpecialState (const Instruction *I2, bool IgnoreAlignment=false) const LLVM_READONLY
 This function determines if the speficied instruction has the same "special" characteristics as the current one.
 
bool isUsedOutsideOfBlock (const BasicBlock *BB) const LLVM_READONLY
 Return true if there are any uses of this instruction in blocks other than the specified block.
 
unsigned getNumSuccessors () const LLVM_READONLY
 Return the number of successors that this instruction has.
 
BasicBlockgetSuccessor (unsigned Idx) const LLVM_READONLY
 Return the specified successor. This instruction must be a terminator.
 
void setSuccessor (unsigned Idx, BasicBlock *BB)
 Update the specified successor to point at the provided block.
 
void replaceSuccessorWith (BasicBlock *OldBB, BasicBlock *NewBB)
 Replace specified successor OldBB to point at the provided block.
 
void dropUnknownNonDebugMetadata (ArrayRef< unsigned > KnownIDs=std::nullopt)
 Drop all unknown metadata except for debug locations.
 
- Public Member Functions inherited from llvm::User
 User (const User &)=delete
 
void operator delete (void *Usr)
 Free memory allocated for User and Use objects.
 
void operator delete (void *Usr, unsigned)
 Placement delete - required by std, called if the ctor throws.
 
void operator delete (void *Usr, unsigned, unsigned)
 Placement delete - required by std, called if the ctor throws.
 
const UsegetOperandList () const
 
UsegetOperandList ()
 
ValuegetOperand (unsigned i) const
 
void setOperand (unsigned i, Value *Val)
 
const UsegetOperandUse (unsigned i) const
 
UsegetOperandUse (unsigned i)
 
unsigned getNumOperands () const
 
ArrayRef< const uint8_t > getDescriptor () const
 Returns the descriptor co-allocated with this User instance.
 
MutableArrayRef< uint8_t > getDescriptor ()
 Returns the descriptor co-allocated with this User instance.
 
void setGlobalVariableNumOperands (unsigned NumOps)
 Set the number of operands on a GlobalVariable.
 
void setNumHungOffUseOperands (unsigned NumOps)
 Subclasses with hung off uses need to manage the operand count themselves.
 
bool isDroppable () const
 A droppable user is a user for which uses can be dropped without affecting correctness and should be dropped rather than preventing a transformation from happening.
 
op_iterator op_begin ()
 
const_op_iterator op_begin () const
 
op_iterator op_end ()
 
const_op_iterator op_end () const
 
op_range operands ()
 
const_op_range operands () const
 
value_op_iterator value_op_begin ()
 
value_op_iterator value_op_end ()
 
iterator_range< value_op_iteratoroperand_values ()
 
const_value_op_iterator value_op_begin () const
 
const_value_op_iterator value_op_end () const
 
iterator_range< const_value_op_iteratoroperand_values () const
 
void dropAllReferences ()
 Drop all references to operands.
 
bool replaceUsesOfWith (Value *From, Value *To)
 Replace uses of one Value with another.
 
- Public Member Functions inherited from llvm::Value
 Value (const Value &)=delete
 
Valueoperator= (const Value &)=delete
 
void deleteValue ()
 Delete a pointer to a generic Value.
 
void dump () const
 Support for debugging, callable in GDB: V->dump()
 
TypegetType () const
 All values are typed, get the type of this value.
 
LLVMContextgetContext () const
 All values hold a context through their type.
 
bool hasName () const
 
ValueNamegetValueName () const
 
void setValueName (ValueName *VN)
 
StringRef getName () const
 Return a constant reference to the value's name.
 
void setName (const Twine &Name)
 Change the name of the value.
 
void takeName (Value *V)
 Transfer the name from V to this value.
 
std::string getNameOrAsOperand () const
 
void replaceAllUsesWith (Value *V)
 Change all uses of this to point to a new Value.
 
void replaceNonMetadataUsesWith (Value *V)
 Change non-metadata uses of this to point to a new Value.
 
void replaceUsesWithIf (Value *New, llvm::function_ref< bool(Use &U)> ShouldReplace)
 Go through the uses list for this definition and make each use point to "V" if the callback ShouldReplace returns true for the given Use.
 
void replaceUsesOutsideBlock (Value *V, BasicBlock *BB)
 replaceUsesOutsideBlock - Go through the uses list for this definition and make each use point to "V" instead of "this" when the use is outside the block.
 
void assertModuleIsMaterializedImpl () const
 
void assertModuleIsMaterialized () const
 
bool use_empty () const
 
bool materialized_use_empty () const
 
use_iterator materialized_use_begin ()
 
const_use_iterator materialized_use_begin () const
 
use_iterator use_begin ()
 
const_use_iterator use_begin () const
 
use_iterator use_end ()
 
const_use_iterator use_end () const
 
iterator_range< use_iteratormaterialized_uses ()
 
iterator_range< const_use_iteratormaterialized_uses () const
 
iterator_range< use_iteratoruses ()
 
iterator_range< const_use_iteratoruses () const
 
bool user_empty () const
 
user_iterator materialized_user_begin ()
 
const_user_iterator materialized_user_begin () const
 
user_iterator user_begin ()
 
const_user_iterator user_begin () const
 
user_iterator user_end ()
 
const_user_iterator user_end () const
 
Useruser_back ()
 
const Useruser_back () const
 
iterator_range< user_iteratormaterialized_users ()
 
iterator_range< const_user_iteratormaterialized_users () const
 
iterator_range< user_iteratorusers ()
 
iterator_range< const_user_iteratorusers () const
 
bool hasOneUse () const
 Return true if there is exactly one use of this value.
 
bool hasNUses (unsigned N) const
 Return true if this Value has exactly N uses.
 
bool hasNUsesOrMore (unsigned N) const
 Return true if this value has N uses or more.
 
bool hasOneUser () const
 Return true if there is exactly one user of this value.
 
UsegetSingleUndroppableUse ()
 Return true if there is exactly one use of this value that cannot be dropped.
 
const UsegetSingleUndroppableUse () const
 
UsergetUniqueUndroppableUser ()
 Return true if there is exactly one unique user of this value that cannot be dropped (that user can have multiple uses of this value).
 
const UsergetUniqueUndroppableUser () const
 
bool hasNUndroppableUses (unsigned N) const
 Return true if there this value.
 
bool hasNUndroppableUsesOrMore (unsigned N) const
 Return true if this value has N uses or more.
 
void dropDroppableUses (llvm::function_ref< bool(const Use *)> ShouldDrop=[](const Use *) { return true;})
 Remove every uses that can safely be removed.
 
void dropDroppableUsesIn (User &Usr)
 Remove every use of this value in User that can safely be removed.
 
bool isUsedInBasicBlock (const BasicBlock *BB) const
 Check if this value is used in the specified basic block.
 
unsigned getNumUses () const
 This method computes the number of uses of this Value.
 
void addUse (Use &U)
 This method should only be used by the Use class.
 
unsigned getValueID () const
 Return an ID for the concrete type of this object.
 
unsigned getRawSubclassOptionalData () const
 Return the raw optional flags value contained in this value.
 
void clearSubclassOptionalData ()
 Clear the optional flags contained in this value.
 
bool hasSameSubclassOptionalData (const Value *V) const
 Check the optional flags for equality.
 
bool hasValueHandle () const
 Return true if there is a value handle associated with this value.
 
bool isUsedByMetadata () const
 Return true if there is metadata referencing this value.
 
bool isSwiftError () const
 Return true if this value is a swifterror value.
 
const ValuestripPointerCasts () const
 Strip off pointer casts, all-zero GEPs and address space casts.
 
ValuestripPointerCasts ()
 
const ValuestripPointerCastsAndAliases () const
 Strip off pointer casts, all-zero GEPs, address space casts, and aliases.
 
ValuestripPointerCastsAndAliases ()
 
const ValuestripPointerCastsSameRepresentation () const
 Strip off pointer casts, all-zero GEPs and address space casts but ensures the representation of the result stays the same.
 
ValuestripPointerCastsSameRepresentation ()
 
const ValuestripPointerCastsForAliasAnalysis () const
 Strip off pointer casts, all-zero GEPs, single-argument phi nodes and invariant group info.
 
ValuestripPointerCastsForAliasAnalysis ()
 
const ValuestripInBoundsConstantOffsets () const
 Strip off pointer casts and all-constant inbounds GEPs.
 
ValuestripInBoundsConstantOffsets ()
 
const ValuestripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr) const
 Accumulate the constant offset this value has compared to a base pointer.
 
ValuestripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false)
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 This is a wrapper around stripAndAccumulateConstantOffsets with the in-bounds requirement set to false.
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 
const ValuestripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {}) const
 Strip off pointer casts and inbounds GEPs.
 
ValuestripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {})
 
std::optional< int64_t > getPointerOffsetFrom (const Value *Other, const DataLayout &DL) const
 If this ptr is provably equal to Other plus a constant offset, return that offset in bytes.
 
bool canBeFreed () const
 Return true if the memory object referred to by V can by freed in the scope for which the SSA value defining the allocation is statically defined.
 
uint64_t getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull, bool &CanBeFreed) const
 Returns the number of bytes known to be dereferenceable for the pointer value.
 
Align getPointerAlignment (const DataLayout &DL) const
 Returns an alignment of the pointer value.
 
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 Translate PHI node to its predecessor from the given basic block.
 
ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB)
 
void mutateType (Type *Ty)
 Mutate the type of this Value to be of the specified type.
 
template<class Compare >
void sortUseList (Compare Cmp)
 Sort the use-list.
 
void reverseUseList ()
 Reverse the use-list.
 
void print (raw_ostream &O, bool IsForDebug=false) const
 Implement operator<< on Value.
 
void print (raw_ostream &O, ModuleSlotTracker &MST, bool IsForDebug=false) const
 
void printAsOperand (raw_ostream &O, bool PrintType=true, const Module *M=nullptr) const
 Print the name of this Value out to the specified raw_ostream.
 
void printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const
 
- Public Member Functions inherited from llvm::ilist_node_with_parent< Instruction, BasicBlock, ilist_iterator_bits< true >, ilist_parent< BasicBlock > >
InstructiongetPrevNode ()
 
const InstructiongetPrevNode () const
 Get the previous node, or nullptr for the list head.
 
InstructiongetNextNode ()
 Get the next node, or nullptr for the list tail.
 
const InstructiongetNextNode () const
 Get the next node, or nullptr for the list tail.
 
- Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< T, Options... >::type >
self_iterator getIterator ()
 
const_self_iterator getIterator () const
 
reverse_self_iterator getReverseIterator ()
 
const_reverse_self_iterator getReverseIterator () const
 
bool isSentinel () const
 Check whether this is the sentinel node.
 
- Public Member Functions inherited from llvm::ilist_detail::node_parent_access< NodeTy, ParentTy >
const ParentTy * getParent () const
 
ParentTy * getParent ()
 
void setParent (ParentTy *Parent)
 

Static Public Member Functions

Casting methods
static bool classof (const IntrinsicInst *I)
 
static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::DbgInfoIntrinsic
static bool classof (const IntrinsicInst *I)
 
static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::IntrinsicInst
static bool mayLowerToFunctionCall (Intrinsic::ID IID)
 Check if the intrinsic might lower into a regular function call in the course of IR transformations.
 
static bool classof (const CallInst *I)
 Methods for support type inquiry through isa, cast, and dyn_cast:
 
static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::CallInst
static CallInstCreate (FunctionType *Ty, Value *F, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
 
static CallInstCreate (FunctionType *Ty, Value *Func, ArrayRef< Value * > Args, const Twine &NameStr, InsertPosition InsertBefore=nullptr)
 
static CallInstCreate (FunctionType *Ty, Value *Func, ArrayRef< Value * > Args, ArrayRef< OperandBundleDef > Bundles=std::nullopt, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
 
static CallInstCreate (FunctionCallee Func, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
 
static CallInstCreate (FunctionCallee Func, ArrayRef< Value * > Args, ArrayRef< OperandBundleDef > Bundles=std::nullopt, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
 
static CallInstCreate (FunctionCallee Func, ArrayRef< Value * > Args, const Twine &NameStr, InsertPosition InsertBefore=nullptr)
 
static CallInstCreate (CallInst *CI, ArrayRef< OperandBundleDef > Bundles, InsertPosition InsertPt=nullptr)
 Create a clone of CI with a different set of operand bundles and insert it before InsertBefore.
 
static bool classof (const Instruction *I)
 
static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::CallBase
static CallBaseCreate (CallBase *CB, ArrayRef< OperandBundleDef > Bundles, InsertPosition InsertPt=nullptr)
 Create a clone of CB with a different set of operand bundles and insert it before InsertPt.
 
static CallBaseCreate (CallBase *CB, OperandBundleDef Bundle, InsertPosition InsertPt=nullptr)
 Create a clone of CB with the operand bundle with the tag matching Bundle's tag replaced with Bundle, and insert it before InsertPt.
 
static CallBaseaddOperandBundle (CallBase *CB, uint32_t ID, OperandBundleDef OB, InsertPosition InsertPt=nullptr)
 Create a clone of CB with operand bundle OB added.
 
static CallBaseremoveOperandBundle (CallBase *CB, uint32_t ID, InsertPosition InsertPt=nullptr)
 Create a clone of CB with operand bundle ID removed.
 
static bool classof (const Instruction *I)
 
static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::Instruction
static const chargetOpcodeName (unsigned Opcode)
 
static bool isTerminator (unsigned Opcode)
 
static bool isUnaryOp (unsigned Opcode)
 
static bool isBinaryOp (unsigned Opcode)
 
static bool isIntDivRem (unsigned Opcode)
 
static bool isShift (unsigned Opcode)
 Determine if the Opcode is one of the shift instructions.
 
static bool isBitwiseLogicOp (unsigned Opcode)
 Determine if the Opcode is and/or/xor.
 
static bool isCast (unsigned Opcode)
 Determine if the Opcode is one of the CastInst instructions.
 
static bool isFuncletPad (unsigned Opcode)
 Determine if the Opcode is one of the FuncletPadInst instructions.
 
static bool isSpecialTerminator (unsigned Opcode)
 Returns true if the Opcode is a "special" terminator that does more than branch to a successor (e.g.
 
static bool isAssociative (unsigned Opcode)
 
static bool isCommutative (unsigned Opcode)
 
static bool isIdempotent (unsigned Opcode)
 
static bool isNilpotent (unsigned Opcode)
 
static bool classof (const Value *V)
 Methods for support type inquiry through isa, cast, and dyn_cast:
 
- Static Public Member Functions inherited from llvm::User
static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::Value
static void dropDroppableUse (Use &U)
 Remove the droppable use U.
 

Protected Member Functions

void setArgOperand (unsigned i, Value *v)
 
void setOperand (unsigned i, Value *v)
 
- Protected Member Functions inherited from llvm::CallInst
CallInstcloneImpl () const
 
- Protected Member Functions inherited from llvm::CallBase
template<class... ArgsTy>
 CallBase (AttributeList const &A, FunctionType *FT, ArgsTy &&... Args)
 
bool hasDescriptor () const
 
unsigned getNumSubclassExtraOperands () const
 
unsigned getNumSubclassExtraOperandsDynamic () const
 Get the number of extra operands for instructions that don't have a fixed number of extra operands.
 
 Instruction (const Instruction &)=delete
 
 Instruction (Type *Ty, unsigned iType, Use *Ops, unsigned NumOps, InsertPosition InsertBefore=nullptr)
 
- Protected Member Functions inherited from llvm::Instruction
 ~Instruction ()
 
template<typename BitfieldElement >
BitfieldElement::Type getSubclassData () const
 
template<typename BitfieldElement >
void setSubclassData (typename BitfieldElement::Type Value)
 
 Instruction (Type *Ty, unsigned iType, Use *Ops, unsigned NumOps, InsertPosition InsertBefore=nullptr)
 
- Protected Member Functions inherited from llvm::User
void * operator new (size_t Size)
 Allocate a User with an operand pointer co-allocated.
 
void * operator new (size_t Size, unsigned Us)
 Allocate a User with the operands co-allocated.
 
void * operator new (size_t Size, unsigned Us, unsigned DescBytes)
 Allocate a User with the operands co-allocated.
 
 User (Type *ty, unsigned vty, Use *, unsigned NumOps)
 
void allocHungoffUses (unsigned N, bool IsPhi=false)
 Allocate the array of Uses, followed by a pointer (with bottom bit set) to the User.
 
void growHungoffUses (unsigned N, bool IsPhi=false)
 Grow the number of hung off uses.
 
 ~User ()=default
 
template<int Idx>
UseOp ()
 
template<int Idx>
const UseOp () const
 
- Protected Member Functions inherited from llvm::Value
 Value (Type *Ty, unsigned scid)
 
 ~Value ()
 Value's destructor should be virtual by design, but that would require that Value and all of its subclasses have a vtable that effectively duplicates the information in the value ID.
 
void getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const
 Appends all metadata attached to this value to MDs, sorting by KindID.
 
bool hasMetadata () const
 Return true if this value has any metadata attached to it.
 
bool eraseMetadata (unsigned KindID)
 Erase all metadata attachments with the given kind.
 
void eraseMetadataIf (function_ref< bool(unsigned, MDNode *)> Pred)
 Erase all metadata attachments matching the given predicate.
 
void clearMetadata ()
 Erase all metadata attached to this Value.
 
MDNodegetMetadataImpl (unsigned KindID) const
 Get metadata for the given kind, if any.
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 
MDNodegetMetadata (unsigned KindID) const
 Get the current metadata attachments for the given kind, if any.
 
MDNodegetMetadata (StringRef Kind) const
 
void getMetadata (unsigned KindID, SmallVectorImpl< MDNode * > &MDs) const
 Appends all attachments with the given ID to MDs in insertion order.
 
void getMetadata (StringRef Kind, SmallVectorImpl< MDNode * > &MDs) const
 
bool hasMetadata (unsigned KindID) const
 Return true if this value has the given type of metadata attached.
 
bool hasMetadata (StringRef Kind) const
 
void setMetadata (unsigned KindID, MDNode *Node)
 Set a particular kind of metadata attachment.
 
void setMetadata (StringRef Kind, MDNode *Node)
 
void addMetadata (unsigned KindID, MDNode &MD)
 Add a metadata attachment.
 
void addMetadata (StringRef Kind, MDNode &MD)
 
- Protected Member Functions inherited from llvm::ilist_node_with_parent< Instruction, BasicBlock, ilist_iterator_bits< true >, ilist_parent< BasicBlock > >
 ilist_node_with_parent ()=default
 
- Protected Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< T, Options... >::type >
 ilist_node_impl ()=default
 

Additional Inherited Members

- Public Types inherited from llvm::CallInst
enum  TailCallKind : unsigned {
  TCK_None = 0 , TCK_Tail = 1 , TCK_MustTail = 2 , TCK_NoTail = 3 ,
  TCK_LAST = TCK_NoTail
}
 
using TailCallKindField = Bitfield::Element< TailCallKind, 0, 2, TCK_LAST >
 
- Public Types inherited from llvm::CallBase
using bundle_op_iterator = BundleOpInfo *
 
using const_bundle_op_iterator = const BundleOpInfo *
 
- Public Types inherited from llvm::Instruction
enum  OperationEquivalenceFlags { CompareIgnoringAlignment = 1<<0 , CompareUsingScalarTypes = 1<<1 }
 When checking for operation equivalence (using isSameOperationAs) it is sometimes useful to ignore certain attributes. More...
 
enum  TermOps
 
enum  UnaryOps
 
enum  BinaryOps
 
enum  MemoryOps
 
enum  CastOps
 
enum  FuncletPadOps
 
enum  OtherOps
 
using InstListType = SymbolTableList< Instruction, ilist_iterator_bits< true >, ilist_parent< BasicBlock > >
 
- Public Types inherited from llvm::User
using op_iterator = Use *
 
using const_op_iterator = const Use *
 
using op_range = iterator_range< op_iterator >
 
using const_op_range = iterator_range< const_op_iterator >
 
- Public Types inherited from llvm::Value
enum  ValueTy
 Concrete subclass of this. More...
 
using use_iterator = use_iterator_impl< Use >
 
using const_use_iterator = use_iterator_impl< const Use >
 
using user_iterator = user_iterator_impl< User >
 
using const_user_iterator = user_iterator_impl< const User >
 
- Public Attributes inherited from llvm::Instruction
DbgMarkerDebugMarker = nullptr
 Optional marker recording the position for debugging information that takes effect immediately before this instruction.
 
- Static Public Attributes inherited from llvm::Value
static constexpr unsigned MaxAlignmentExponent = 32
 The maximum alignment for instructions.
 
static constexpr uint64_t MaximumAlignment = 1ULL << MaxAlignmentExponent
 
- Protected Types inherited from llvm::CallBase
using CallInstReservedField = Bitfield::Element< unsigned, 0, 2 >
 
using CallingConvField = Bitfield::Element< CallingConv::ID, CallInstReservedField::NextBit, 10, CallingConv::MaxID >
 
- Protected Types inherited from llvm::Instruction
using OpaqueField = Bitfield::Element< uint16_t, 0, 15 >
 
template<unsigned Offset>
using AlignmentBitfieldElementT = typename Bitfield::Element< unsigned, Offset, 6, Value::MaxAlignmentExponent >
 
template<unsigned Offset>
using BoolBitfieldElementT = typename Bitfield::Element< bool, Offset, 1 >
 
template<unsigned Offset>
using AtomicOrderingBitfieldElementT = typename Bitfield::Element< AtomicOrdering, Offset, 3, AtomicOrdering::LAST >
 
- Protected Types inherited from llvm::Value
enum  : unsigned { NumUserOperandsBits = 27 }
 The number of operands in the subclass. More...
 
- Protected Types inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< T, Options... >::type >
using self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, false, false >::type
 
using const_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, false, true >::type
 
using reverse_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, true, false >::type
 
using const_reverse_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, true, true >::type
 
- Static Protected Member Functions inherited from llvm::CallBase
static unsigned CountBundleInputs (ArrayRef< OperandBundleDef > Bundles)
 Return the total number of values used in Bundles.
 
- Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U >
static UseOpFrom (const U *that)
 
- Protected Attributes inherited from llvm::CallBase
AttributeList Attrs
 parameter attributes for callable
 
FunctionTypeFTy
 
- Protected Attributes inherited from llvm::Value
unsigned char SubclassOptionalData: 7
 Hold subclass data that can be dropped.
 
unsigned NumUserOperands: NumUserOperandsBits
 
unsigned IsUsedByMD: 1
 
unsigned HasName: 1
 
unsigned HasMetadata: 1
 
unsigned HasHungOffUses: 1
 
unsigned HasDescriptor: 1
 
- Static Protected Attributes inherited from llvm::CallBase
static constexpr int CalledOperandOpEndIdx = -1
 The last operand is the called operand.
 

Detailed Description

This is the common base class for debug info intrinsics for variables.

Definition at line 308 of file IntrinsicInst.h.

Member Function Documentation

◆ addVariableLocationOps()

void DbgVariableIntrinsic::addVariableLocationOps ( ArrayRef< Value * >  NewValues,
DIExpression NewExpr 
)

Adding a new location operand will always result in this intrinsic using an ArgList, and must always be accompanied by a new expression that uses the new operand.

Definition at line 181 of file IntrinsicInst.cpp.

References assert(), llvm::DIArgList::get(), llvm::MetadataAsValue::get(), llvm::getAsMetadata(), llvm::Value::getContext(), getNumVariableLocationOps(), llvm::is_contained(), location_ops(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), setArgOperand(), and llvm::ArrayRef< T >::size().

◆ classof() [1/2]

static bool llvm::DbgVariableIntrinsic::classof ( const IntrinsicInst I)
inlinestatic

Definition at line 418 of file IntrinsicInst.h.

References I.

Referenced by classof().

◆ classof() [2/2]

static bool llvm::DbgVariableIntrinsic::classof ( const Value V)
inlinestatic

Definition at line 428 of file IntrinsicInst.h.

References classof().

◆ getExpression()

DIExpression * llvm::DbgVariableIntrinsic::getExpression ( ) const
inline

◆ getFragment()

std::optional< DIExpression::FragmentInfo > llvm::DbgVariableIntrinsic::getFragment ( ) const
inline

Get the FragmentInfo for the variable.

Definition at line 399 of file IntrinsicInst.h.

References getExpression(), and llvm::DIExpression::getFragmentInfo().

◆ getFragmentOrEntireVariable()

DIExpression::FragmentInfo llvm::DbgVariableIntrinsic::getFragmentOrEntireVariable ( ) const
inline

Get the FragmentInfo for the variable if it exists, otherwise return a FragmentInfo that covers the entire variable if the variable size is known, otherwise return a zero-sized fragment.

Definition at line 406 of file IntrinsicInst.h.

References getExpression(), getFragmentSizeInBits(), llvm::DbgVariableFragmentInfo::OffsetInBits, and llvm::DbgVariableFragmentInfo::SizeInBits.

◆ getFragmentSizeInBits()

std::optional< uint64_t > DbgVariableIntrinsic::getFragmentSizeInBits ( ) const

Get the size (in bits) of the variable, or fragment of the variable that is described.

Definition at line 198 of file IntrinsicInst.cpp.

References getExpression(), llvm::DIVariable::getSizeInBits(), and getVariable().

Referenced by getFragmentOrEntireVariable().

◆ getNumVariableLocationOps()

unsigned llvm::DbgVariableIntrinsic::getNumVariableLocationOps ( ) const
inline

◆ getRawExpression()

Metadata * llvm::DbgVariableIntrinsic::getRawExpression ( ) const
inline

Definition at line 383 of file IntrinsicInst.h.

References llvm::CallBase::getArgOperand().

Referenced by getExpression().

◆ getRawLocation()

Metadata * llvm::DbgVariableIntrinsic::getRawLocation ( ) const
inline

◆ getRawVariable()

Metadata * llvm::DbgVariableIntrinsic::getRawVariable ( ) const
inline

Definition at line 379 of file IntrinsicInst.h.

References llvm::CallBase::getArgOperand().

Referenced by getVariable().

◆ getVariable()

DILocalVariable * llvm::DbgVariableIntrinsic::getVariable ( ) const
inline

◆ getVariableLocationOp()

Value * DbgVariableIntrinsic::getVariableLocationOp ( unsigned  OpIdx) const

◆ getWrappedLocation()

RawLocationWrapper llvm::DbgVariableIntrinsic::getWrappedLocation ( ) const
inline

◆ hasArgList()

bool llvm::DbgVariableIntrinsic::hasArgList ( ) const
inline

◆ isAddressOfVariable()

bool llvm::DbgVariableIntrinsic::isAddressOfVariable ( ) const
inline

Does this describe the address of a local variable.

True for dbg.declare, but not dbg.value, which describes its value, or dbg.assign, which describes a combination of the variable's value and address.

Definition at line 343 of file IntrinsicInst.h.

References llvm::IntrinsicInst::getIntrinsicID().

Referenced by llvm::ConvertDebugDeclareToDebugValue(), and valueCoversEntireFragment().

◆ isKillLocation()

bool llvm::DbgVariableIntrinsic::isKillLocation ( ) const
inline

◆ location_ops()

iterator_range< location_op_iterator > DbgVariableIntrinsic::location_ops ( ) const

Get the locations corresponding to the variable referenced by the debug info intrinsic.

Depending on the intrinsic, this could be the variable's value or its address.

Definition at line 91 of file IntrinsicInst.cpp.

References getWrappedLocation(), and llvm::RawLocationWrapper::location_ops().

Referenced by addVariableLocationOps(), llvm::DbgValueInst::getValues(), llvm::insertDebugValuesForPHIs(), replaceVariableLocationOp(), and setKillLocation().

◆ replaceVariableLocationOp() [1/2]

void DbgVariableIntrinsic::replaceVariableLocationOp ( unsigned  OpIdx,
Value NewValue 
)

◆ replaceVariableLocationOp() [2/2]

void DbgVariableIntrinsic::replaceVariableLocationOp ( Value OldValue,
Value NewValue,
bool  AllowEmpty = false 
)

◆ setArgOperand()

void llvm::DbgVariableIntrinsic::setArgOperand ( unsigned  i,
Value v 
)
inlineprotected

◆ setExpression()

void llvm::DbgVariableIntrinsic::setExpression ( DIExpression NewExpr)
inline

◆ setKillLocation()

void llvm::DbgVariableIntrinsic::setKillLocation ( )
inline

◆ setOperand()

void llvm::DbgVariableIntrinsic::setOperand ( unsigned  i,
Value v 
)
inlineprotected

◆ setRawLocation()

void llvm::DbgVariableIntrinsic::setRawLocation ( Metadata Location)
inline

Use of this should generally be avoided; instead, replaceVariableLocationOp and addVariableLocationOps should be used where possible to avoid creating invalid state.

Definition at line 390 of file IntrinsicInst.h.

References llvm::MetadataAsValue::get(), llvm::Value::getContext(), and setArgOperand().

◆ setVariable()

void llvm::DbgVariableIntrinsic::setVariable ( DILocalVariable NewVar)
inline

The documentation for this class was generated from the following files: