LLVM  8.0.1
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
llvm::CallBase Class Reference

Base class for all callable instructions (InvokeInst and CallInst) Holds everything related to calling a function. More...

#include "llvm/IR/InstrTypes.h"

Inheritance diagram for llvm::CallBase:
Inheritance graph
[legend]
Collaboration diagram for llvm::CallBase:
Collaboration graph
[legend]

Classes

struct  BundleOpInfo
 Used to keep track of an operand bundle. More...
 

Public Member Functions

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. More...
 
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
 
User::op_iterator arg_begin ()
 Return the iterator pointing to the beginning of the argument list. More...
 
User::const_op_iterator arg_begin () const
 
User::op_iterator arg_end ()
 Return the iterator pointing to the end of the argument list. More...
 
User::const_op_iterator arg_end () const
 
iterator_range< User::op_iteratorargs ()
 Iteration adapter for range-for loops. More...
 
iterator_range< User::const_op_iteratorargs () const
 
bool arg_empty () const
 
unsigned arg_size () const
 
iterator_range< User::op_iteratorarg_operands ()
 
iterator_range< User::const_op_iteratorarg_operands () const
 
unsigned getNumArgOperands () 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. More...
 
UsegetArgOperandUse (unsigned i)
 
bool isArgOperand (const Use *U) const
 
bool isArgOperand (Value::const_user_iterator UI) const
 
bool hasArgument (const Value *V) const
 Returns true if this CallSite passes the given Value* as an argument to the called function. More...
 
ValuegetCalledOperand () const
 
ValuegetCalledValue () const
 
const UsegetCalledOperandUse () const
 
UsegetCalledOperandUse ()
 
FunctiongetCalledFunction () const
 Returns the function called, or null if this is an indirect function invocation. More...
 
bool isIndirectCall () const
 Return true if the callsite is an indirect call. More...
 
bool isCallee (Value::const_user_iterator UI) const
 Determine whether the passed iterator points to the callee operand's Use. More...
 
bool isCallee (const Use *U) const
 Determine whether this Use is the callee operand's Use. More...
 
FunctiongetCaller ()
 Helper to get the caller (the parent function). More...
 
const FunctiongetCaller () const
 
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. More...
 
void setCalledOperand (Value *V)
 
void setCalledFunction (Value *Fn)
 Sets the function called, including updating the function type. More...
 
void setCalledFunction (FunctionType *FTy, Value *Fn)
 Sets the function called, including updating to the specified function type. More...
 
CallingConv::ID getCallingConv () const
 
void setCallingConv (CallingConv::ID CC)
 
Attribute API

These methods access and modify attributes on this call (including looking through to the attributes on the called function when necessary).

AttributeList getAttributes () const
 Return the parameter attributes for this call. More...
 
void setAttributes (AttributeList A)
 Set the parameter attributes for this call. More...
 
bool hasFnAttr (Attribute::AttrKind Kind) const
 Determine whether this call has the given attribute. More...
 
bool hasFnAttr (StringRef Kind) const
 Determine whether this call has the given attribute. More...
 
void addAttribute (unsigned i, Attribute::AttrKind Kind)
 adds the attribute to the list of attributes. More...
 
void addAttribute (unsigned i, Attribute Attr)
 adds the attribute to the list of attributes. More...
 
void addParamAttr (unsigned ArgNo, Attribute::AttrKind Kind)
 Adds the attribute to the indicated argument. More...
 
void addParamAttr (unsigned ArgNo, Attribute Attr)
 Adds the attribute to the indicated argument. More...
 
void removeAttribute (unsigned i, Attribute::AttrKind Kind)
 removes the attribute from the list of attributes. More...
 
void removeAttribute (unsigned i, StringRef Kind)
 removes the attribute from the list of attributes. More...
 
void removeParamAttr (unsigned ArgNo, Attribute::AttrKind Kind)
 Removes the attribute from the given argument. More...
 
void removeParamAttr (unsigned ArgNo, StringRef Kind)
 Removes the attribute from the given argument. More...
 
void addDereferenceableAttr (unsigned i, uint64_t Bytes)
 adds the dereferenceable attribute to the list of attributes. More...
 
void addDereferenceableOrNullAttr (unsigned i, uint64_t Bytes)
 adds the dereferenceable_or_null attribute to the list of attributes. More...
 
bool hasRetAttr (Attribute::AttrKind Kind) const
 Determine whether the return value has the given attribute. More...
 
bool paramHasAttr (unsigned ArgNo, Attribute::AttrKind Kind) const
 Determine whether the argument or parameter has the given attribute. More...
 
Attribute getAttribute (unsigned i, Attribute::AttrKind Kind) const
 Get the attribute of a given kind at a position. More...
 
Attribute getAttribute (unsigned i, StringRef Kind) const
 Get the attribute of a given kind at a position. More...
 
Attribute getParamAttr (unsigned ArgNo, Attribute::AttrKind Kind) const
 Get the attribute of a given kind from a given arg. More...
 
Attribute getParamAttr (unsigned ArgNo, StringRef Kind) const
 Get the attribute of a given kind from a given arg. More...
 
bool dataOperandHasImpliedAttr (unsigned i, Attribute::AttrKind Kind) const
 Return true if the data operand at index i has the attribute A. More...
 
bool doesNotCapture (unsigned OpNo) const
 Determine whether this data operand is not captured. More...
 
bool isByValArgument (unsigned ArgNo) const
 Determine whether this argument is passed by value. More...
 
bool isInAllocaArgument (unsigned ArgNo) const
 Determine whether this argument is passed in an alloca. More...
 
bool isByValOrInAllocaArgument (unsigned ArgNo) const
 Determine whether this argument is passed by value or in an alloca. More...
 
bool hasInAllocaArgument () const
 Determine if there are is an inalloca argument. More...
 
bool doesNotAccessMemory (unsigned OpNo) const
 
bool onlyReadsMemory (unsigned OpNo) const
 
bool doesNotReadMemory (unsigned OpNo) const
 
unsigned getRetAlignment () const
 Extract the alignment of the return value. More...
 
unsigned getParamAlignment (unsigned ArgNo) const
 Extract the alignment for a call or parameter (0=unknown). More...
 
uint64_t getDereferenceableBytes (unsigned i) const
 Extract the number of dereferenceable bytes for a call or parameter (0=unknown). More...
 
uint64_t getDereferenceableOrNullBytes (unsigned i) const
 Extract the number of dereferenceable_or_null bytes for a call or parameter (0=unknown). More...
 
bool isReturnNonNull () const
 Return true if the return value is known to be not null. More...
 
bool returnDoesNotAlias () const
 Determine if the return value is marked with NoAlias attribute. More...
 
ValuegetReturnedArgOperand () const
 If one of the arguments has the 'returned' attribute, returns its operand value. More...
 
bool isNoBuiltin () const
 Return true if the call should not be treated as a call to a builtin. More...
 
bool isStrictFP () const
 Determine if the call requires strict floating point semantics. More...
 
bool isNoInline () const
 Return true if the call should not be inlined. More...
 
void setIsNoInline ()
 
bool doesNotAccessMemory () const
 Determine if the call does not access memory. More...
 
void setDoesNotAccessMemory ()
 
bool onlyReadsMemory () const
 Determine if the call does not access or only reads memory. More...
 
void setOnlyReadsMemory ()
 
bool doesNotReadMemory () const
 Determine if the call does not access or only writes memory. More...
 
void setDoesNotReadMemory ()
 
bool onlyAccessesArgMemory () const
 Determine if the call can access memmory only using pointers based on its arguments. More...
 
void setOnlyAccessesArgMemory ()
 
bool onlyAccessesInaccessibleMemory () const
 Determine if the function may only access memory that is inaccessible from the IR. More...
 
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. More...
 
void setOnlyAccessesInaccessibleMemOrArgMem ()
 
bool doesNotReturn () const
 Determine if the call cannot return. More...
 
void setDoesNotReturn ()
 
bool doesNoCfCheck () const
 Determine if the call should not perform indirect branch tracking. More...
 
bool doesNotThrow () const
 Determine if the call cannot unwind. More...
 
void setDoesNotThrow ()
 
bool cannotDuplicate () const
 Determine if the invoke cannot be duplicated. More...
 
void setCannotDuplicate ()
 
bool isConvergent () const
 Determine if the invoke is convergent. More...
 
void setConvergent ()
 
void setNotConvergent ()
 
bool hasStructRetAttr () const
 Determine if the call returns a structure through first pointer argument. More...
 
bool hasByValArgument () const
 Determine if any call argument is an aggregate passed by value. More...
 
- Public Member Functions inherited from llvm::Instruction
 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. More...
 
const Instructionuser_back () const
 
const BasicBlockgetParent () const
 
BasicBlockgetParent ()
 
const ModulegetModule () const
 Return the module owning the function this instruction belongs to or nullptr it the function does not have a module. More...
 
ModulegetModule ()
 
const FunctiongetFunction () const
 Return the function this instruction belongs to. More...
 
FunctiongetFunction ()
 
void removeFromParent ()
 This method unlinks 'this' from the containing basic block, but does not delete it. More...
 
SymbolTableList< Instruction >::iterator eraseFromParent ()
 This method unlinks 'this' from the containing basic block and deletes it. More...
 
void insertBefore (Instruction *InsertPos)
 Insert an unlinked instruction into a basic block immediately before the specified instruction. More...
 
void insertAfter (Instruction *InsertPos)
 Insert an unlinked instruction into a basic block immediately after the specified instruction. More...
 
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. More...
 
void moveBefore (BasicBlock &BB, SymbolTableList< Instruction >::iterator I)
 Unlink this instruction and insert into BB before I. More...
 
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. More...
 
unsigned getOpcode () const
 Returns a member of one of the enums like Instruction::Add. More...
 
const chargetOpcodeName () const
 
bool isTerminator () const
 
bool isUnaryOp () const
 
bool isBinaryOp () const
 
bool isIntDivRem () const
 
bool isShift ()
 
bool isCast () const
 
bool isFuncletPad () const
 
bool isExceptionalTerminator () const
 
bool isLogicalShift () const
 Return true if this is a logical shift left or a logical shift right. More...
 
bool isArithmeticShift () const
 Return true if this is an arithmetic shift right. More...
 
bool isBitwiseLogicOp () const
 Return true if this is and/or/xor. More...
 
bool hasMetadata () const
 Return true if this instruction has any metadata attached to it. More...
 
bool hasMetadataOtherThanDebugLoc () const
 Return true if this instruction has metadata attached to it other than a debug location. More...
 
MDNodegetMetadata (unsigned KindID) const
 Get the metadata of given kind attached to this Instruction. More...
 
MDNodegetMetadata (StringRef Kind) const
 Get the metadata of given kind attached to this Instruction. More...
 
void getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode *>> &MDs) const
 Get all metadata attached to this Instruction. More...
 
void getAllMetadataOtherThanDebugLoc (SmallVectorImpl< std::pair< unsigned, MDNode *>> &MDs) const
 This does the same thing as getAllMetadata, except that it filters out the debug location. More...
 
void getAAMetadata (AAMDNodes &N, bool Merge=false) const
 Fills the AAMDNodes structure with AA metadata from this instruction. More...
 
void setMetadata (unsigned KindID, MDNode *Node)
 Set the metadata of the specified kind to the specified node. More...
 
void setMetadata (StringRef Kind, MDNode *Node)
 
void copyMetadata (const Instruction &SrcInst, ArrayRef< unsigned > WL=ArrayRef< unsigned >())
 Copy metadata from SrcInst to this instruction. More...
 
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. More...
 
void setAAMetadata (const AAMDNodes &N)
 Sets the metadata on this instruction from the AAMDNodes structure. More...
 
bool extractProfMetadata (uint64_t &TrueVal, uint64_t &FalseVal) const
 Retrieve the raw weight values of a conditional branch or select. More...
 
bool extractProfTotalWeight (uint64_t &TotalVal) const
 Retrieve total raw weight values of a branch. More...
 
void updateProfWeight (uint64_t S, uint64_t T)
 Updates branch_weights metadata by scaling it by S / T. More...
 
void setProfWeight (uint64_t W)
 Sets the branch_weights metadata to W for CallInst. More...
 
void setDebugLoc (DebugLoc Loc)
 Set the debug location information for this instruction. More...
 
const DebugLocgetDebugLoc () const
 Return the debug location for this node as a DebugLoc. More...
 
void setHasNoUnsignedWrap (bool b=true)
 Set or clear the nuw flag on this instruction, which must be an operator which supports this flag. More...
 
void setHasNoSignedWrap (bool b=true)
 Set or clear the nsw flag on this instruction, which must be an operator which supports this flag. More...
 
void setIsExact (bool b=true)
 Set or clear the exact flag on this instruction, which must be an operator which supports this flag. More...
 
bool hasNoUnsignedWrap () const
 Determine whether the no unsigned wrap flag is set. More...
 
bool hasNoSignedWrap () const
 Determine whether the no signed wrap flag is set. More...
 
void dropPoisonGeneratingFlags ()
 Drops flags that may cause this instruction to evaluate to poison despite having non-poison inputs. More...
 
bool isExact () const
 Determine whether the exact flag is set. More...
 
void setFast (bool B)
 Set or clear all fast-math-flags on this instruction, which must be an operator which supports this flag. More...
 
void setHasAllowReassoc (bool B)
 Set or clear the reassociation flag on this instruction, which must be an operator which supports this flag. More...
 
void setHasNoNaNs (bool B)
 Set or clear the no-nans flag on this instruction, which must be an operator which supports this flag. More...
 
void setHasNoInfs (bool B)
 Set or clear the no-infs flag on this instruction, which must be an operator which supports this flag. More...
 
void setHasNoSignedZeros (bool B)
 Set or clear the no-signed-zeros flag on this instruction, which must be an operator which supports this flag. More...
 
void setHasAllowReciprocal (bool B)
 Set or clear the allow-reciprocal flag on this instruction, which must be an operator which supports this flag. More...
 
void setHasApproxFunc (bool B)
 Set or clear the approximate-math-functions flag on this instruction, which must be an operator which supports this flag. More...
 
void setFastMathFlags (FastMathFlags FMF)
 Convenience function for setting multiple fast-math flags on this instruction, which must be an operator which supports these flags. More...
 
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. More...
 
bool isFast () const
 Determine whether all fast-math-flags are set. More...
 
bool hasAllowReassoc () const
 Determine whether the allow-reassociation flag is set. More...
 
bool hasNoNaNs () const
 Determine whether the no-NaNs flag is set. More...
 
bool hasNoInfs () const
 Determine whether the no-infs flag is set. More...
 
bool hasNoSignedZeros () const
 Determine whether the no-signed-zeros flag is set. More...
 
bool hasAllowReciprocal () const
 Determine whether the allow-reciprocal flag is set. More...
 
bool hasAllowContract () const
 Determine whether the allow-contract flag is set. More...
 
bool hasApproxFunc () const
 Determine whether the approximate-math-functions flag is set. More...
 
FastMathFlags getFastMathFlags () const
 Convenience function for getting all the fast-math flags, which must be an operator which supports these flags. More...
 
void copyFastMathFlags (const Instruction *I)
 Copy I's fast-math flags. More...
 
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. More...
 
void andIRFlags (const Value *V)
 Logical 'and' of any supported wrapping, exact, and fast-math flags of V and this instruction. More...
 
void applyMergedLocation (const DILocation *LocA, const DILocation *LocB)
 Merge 2 debug locations and apply it to the Instruction. More...
 
bool isAssociative () const LLVM_READONLY
 Return true if the instruction is associative: More...
 
bool isCommutative () const
 Return true if the instruction is commutative: More...
 
bool isIdempotent () const
 Return true if the instruction is idempotent: More...
 
bool isNilpotent () const
 Return true if the instruction is nilpotent: More...
 
bool mayWriteToMemory () const
 Return true if this instruction may modify memory. More...
 
bool mayReadFromMemory () const
 Return true if this instruction may read memory. More...
 
bool mayReadOrWriteMemory () const
 Return true if this instruction may read or write memory. More...
 
bool isAtomic () const
 Return true if this instruction has an AtomicOrdering of unordered or higher. More...
 
bool hasAtomicLoad () const
 Return true if this atomic instruction loads from memory. More...
 
bool hasAtomicStore () const
 Return true if this atomic instruction stores to memory. More...
 
bool mayThrow () const
 Return true if this instruction may throw an exception. More...
 
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. More...
 
bool mayHaveSideEffects () const
 Return true if the instruction may have side effects. More...
 
bool isSafeToRemove () const
 Return true if the instruction can be removed if the result is unused. More...
 
bool isEHPad () const
 Return true if the instruction is a variety of EH-block. More...
 
bool isLifetimeStartOrEnd () const
 Return true if the instruction is a llvm.lifetime.start or llvm.lifetime.end marker. More...
 
const InstructiongetNextNonDebugInstruction () const
 Return a pointer to the next non-debug instruction in the same basic block as 'this', or nullptr if no such instruction exists. More...
 
InstructiongetNextNonDebugInstruction ()
 
const InstructiongetPrevNonDebugInstruction () const
 Return a pointer to the previous non-debug instruction in the same basic block as 'this', or nullptr if no such instruction exists. More...
 
InstructiongetPrevNonDebugInstruction ()
 
Instructionclone () const
 Create a copy of 'this' instruction that is identical in all ways except the following: More...
 
bool isIdenticalTo (const Instruction *I) const
 Return true if the specified instruction is exactly identical to the current one. More...
 
bool isIdenticalToWhenDefined (const Instruction *I) const
 This is like isIdenticalTo, except that it ignores the SubclassOptionalData flags, which may specify conditions under which the instruction's result is undefined. More...
 
bool isSameOperationAs (const Instruction *I, unsigned flags=0) const
 This function determines if the specified instruction executes the same operation as the current one. More...
 
bool isUsedOutsideOfBlock (const BasicBlock *BB) const
 Return true if there are any uses of this instruction in blocks other than the specified block. More...
 
unsigned getNumSuccessors () const
 Return the number of successors that this instruction has. More...
 
BasicBlockgetSuccessor (unsigned Idx) const
 Return the specified successor. This instruction must be a terminator. More...
 
void setSuccessor (unsigned Idx, BasicBlock *BB)
 Update the specified successor to point at the provided block. More...
 
void dropUnknownNonDebugMetadata (ArrayRef< unsigned > KnownIDs)
 Drop all unknown metadata except for debug locations. More...
 
void dropUnknownNonDebugMetadata ()
 
void dropUnknownNonDebugMetadata (unsigned ID1)
 
void dropUnknownNonDebugMetadata (unsigned ID1, unsigned ID2)
 
- Public Member Functions inherited from llvm::User
 User (const User &)=delete
 
void operator delete (void *Usr)
 Free memory allocated for User and Use objects. More...
 
void operator delete (void *Usr, unsigned)
 Placement delete - required by std, called if the ctor throws. More...
 
void operator delete (void *Usr, unsigned, bool)
 Placement delete - required by std, called if the ctor throws. More...
 
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. More...
 
MutableArrayRef< uint8_t > getDescriptor ()
 Returns the descriptor co-allocated with this User instance. More...
 
void setGlobalVariableNumOperands (unsigned NumOps)
 Set the number of operands on a GlobalVariable. More...
 
void setNumHungOffUseOperands (unsigned NumOps)
 Subclasses with hung off uses need to manage the operand count themselves. More...
 
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. More...
 
void replaceUsesOfWith (Value *From, Value *To)
 Replace uses of one Value with another. More...
 
- Public Member Functions inherited from llvm::Value
 Value (const Value &)=delete
 
Valueoperator= (const Value &)=delete
 
void deleteValue ()
 Delete a pointer to a generic Value. More...
 
void dump () const
 Support for debugging, callable in GDB: V->dump() More...
 
TypegetType () const
 All values are typed, get the type of this value. More...
 
LLVMContextgetContext () const
 All values hold a context through their type. More...
 
bool hasName () const
 
ValueNamegetValueName () const
 
void setValueName (ValueName *VN)
 
StringRef getName () const
 Return a constant reference to the value's name. More...
 
void setName (const Twine &Name)
 Change the name of the value. More...
 
void takeName (Value *V)
 Transfer the name from V to this value. More...
 
void replaceAllUsesWith (Value *V)
 Change all uses of this to point to a new Value. More...
 
void replaceNonMetadataUsesWith (Value *V)
 Change non-metadata uses of this to point to a new Value. More...
 
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. More...
 
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 user of this value. More...
 
bool hasNUses (unsigned N) const
 Return true if this Value has exactly N users. More...
 
bool hasNUsesOrMore (unsigned N) const
 Return true if this value has N users or more. More...
 
bool isUsedInBasicBlock (const BasicBlock *BB) const
 Check if this value is used in the specified basic block. More...
 
unsigned getNumUses () const
 This method computes the number of uses of this Value. More...
 
void addUse (Use &U)
 This method should only be used by the Use class. More...
 
unsigned getValueID () const
 Return an ID for the concrete type of this object. More...
 
unsigned getRawSubclassOptionalData () const
 Return the raw optional flags value contained in this value. More...
 
void clearSubclassOptionalData ()
 Clear the optional flags contained in this value. More...
 
bool hasSameSubclassOptionalData (const Value *V) const
 Check the optional flags for equality. More...
 
bool hasValueHandle () const
 Return true if there is a value handle associated with this value. More...
 
bool isUsedByMetadata () const
 Return true if there is metadata referencing this value. More...
 
bool isSwiftError () const
 Return true if this value is a swifterror value. More...
 
const ValuestripPointerCasts () const
 Strip off pointer casts, all-zero GEPs, and aliases. More...
 
ValuestripPointerCasts ()
 
const ValuestripPointerCastsAndInvariantGroups () const
 Strip off pointer casts, all-zero GEPs, aliases and invariant group info. More...
 
ValuestripPointerCastsAndInvariantGroups ()
 
const ValuestripPointerCastsNoFollowAliases () const
 Strip off pointer casts and all-zero GEPs. More...
 
ValuestripPointerCastsNoFollowAliases ()
 
const ValuestripInBoundsConstantOffsets () const
 Strip off pointer casts and all-constant inbounds GEPs. More...
 
ValuestripInBoundsConstantOffsets ()
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 Accumulate offsets from stripInBoundsConstantOffsets(). More...
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 
const ValuestripInBoundsOffsets () const
 Strip off pointer casts and inbounds GEPs. More...
 
ValuestripInBoundsOffsets ()
 
uint64_t getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull) const
 Returns the number of bytes known to be dereferenceable for the pointer value. More...
 
unsigned getPointerAlignment (const DataLayout &DL) const
 Returns an alignment of the pointer value. More...
 
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 Translate PHI node to its predecessor from the given basic block. More...
 
ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB)
 
void mutateType (Type *Ty)
 Mutate the type of this Value to be of the specified type. More...
 
template<class Compare >
void sortUseList (Compare Cmp)
 Sort the use-list. More...
 
void reverseUseList ()
 Reverse the use-list. More...
 
void print (raw_ostream &O, bool IsForDebug=false) const
 Implement operator<< on Value. More...
 
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. More...
 
void printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const
 
- Public Member Functions inherited from llvm::ilist_node_with_parent< Instruction, BasicBlock >
InstructiongetPrevNode ()
 
const InstructiongetPrevNode () const
 Get the previous node, or nullptr for the list head. More...
 
InstructiongetNextNode ()
 Get the next node, or nullptr for the list tail. More...
 
const InstructiongetNextNode () const
 Get the next node, or nullptr for the list tail. More...
 
- Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< Instruction, 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. More...
 

Static Public Member Functions

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. More...
 
static bool isBitwiseLogicOp (unsigned Opcode)
 Determine if the Opcode is and/or/xor. More...
 
static bool isCast (unsigned OpCode)
 Determine if the OpCode is one of the CastInst instructions. More...
 
static bool isFuncletPad (unsigned OpCode)
 Determine if the OpCode is one of the FuncletPadInst instructions. More...
 
static bool isExceptionalTerminator (unsigned OpCode)
 Returns true if the OpCode is a terminator related to exception handling. More...
 
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: More...
 
- Static Public Member Functions inherited from llvm::User
static bool classof (const Value *V)
 

Protected Member Functions

template<class... ArgsTy>
 CallBase (AttributeList const &A, FunctionType *FT, ArgsTy &&... Args)
 
bool hasDescriptor () const
 
unsigned getNumSubclassExtraOperands () const
 
- Protected Member Functions inherited from llvm::Instruction
 ~Instruction ()
 
void setInstructionSubclassData (unsigned short D)
 
unsigned getSubclassDataFromInstruction () const
 
 Instruction (Type *Ty, unsigned iType, Use *Ops, unsigned NumOps, Instruction *InsertBefore=nullptr)
 
 Instruction (Type *Ty, unsigned iType, Use *Ops, unsigned NumOps, BasicBlock *InsertAtEnd)
 
- Protected Member Functions inherited from llvm::User
void * operator new (size_t Size)
 Allocate a User with an operand pointer co-allocated. More...
 
void * operator new (size_t Size, unsigned Us)
 Allocate a User with the operands co-allocated. More...
 
void * operator new (size_t Size, unsigned Us, unsigned DescBytes)
 Allocate a User with the operands co-allocated. More...
 
 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. More...
 
void growHungoffUses (unsigned N, bool IsPhi=false)
 Grow the number of hung off uses. More...
 
 ~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. More...
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 
- Protected Member Functions inherited from llvm::ilist_node_with_parent< Instruction, BasicBlock >
 ilist_node_with_parent ()=default
 
- Protected Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< Instruction, Options... >::type >
 ilist_node_impl ()=default
 

Protected Attributes

AttributeList Attrs
 parameter attributes for callable More...
 
FunctionTypeFTy
 
- Protected Attributes inherited from llvm::Value
unsigned char SubclassOptionalData: 7
 Hold subclass data that can be dropped. More...
 
unsigned NumUserOperands: NumUserOperandsBits
 
unsigned IsUsedByMD: 1
 
unsigned HasName: 1
 
unsigned HasHungOffUses: 1
 
unsigned HasDescriptor: 1
 

Static Protected Attributes

static constexpr int CalledOperandOpEndIdx = -1
 The last operand is the called operand. More...
 

Operand Bundle API

This group of methods provides the API to access and manipulate operand bundles on this call.

using bundle_op_iterator = BundleOpInfo *
 
using const_bundle_op_iterator = const BundleOpInfo *
 
unsigned getNumOperandBundles () const
 Return the number of operand bundles associated with this User. More...
 
bool hasOperandBundles () const
 Return true if this User has any operand bundles. More...
 
unsigned getBundleOperandsStartIndex () const
 Return the index of the first bundle operand in the Use array. More...
 
unsigned getBundleOperandsEndIndex () const
 Return the index of the last bundle operand in the Use array. More...
 
bool isBundleOperand (unsigned Idx) const
 Return true if the operand at index Idx is a bundle operand. More...
 
bool isBundleOperand (const Use *U) const
 Returns true if the use is a bundle operand. More...
 
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. More...
 
OperandBundleUse getOperandBundleAt (unsigned Index) const
 Return the operand bundle at a specific index. More...
 
unsigned countOperandBundlesOfType (StringRef Name) const
 Return the number of operand bundles with the tag Name attached to this instruction. More...
 
unsigned countOperandBundlesOfType (uint32_t ID) const
 Return the number of operand bundles with the tag ID attached to this instruction. More...
 
Optional< OperandBundleUsegetOperandBundle (StringRef Name) const
 Return an operand bundle by name, if present. More...
 
Optional< OperandBundleUsegetOperandBundle (uint32_t ID) const
 Return an operand bundle by tag ID, if present. More...
 
void getOperandBundlesAsDefs (SmallVectorImpl< OperandBundleDef > &Defs) const
 Return the list of operand bundles attached to this instruction as a vector of OperandBundleDefs. More...
 
OperandBundleUse getOperandBundleForOperand (unsigned OpIdx) const
 Return the operand bundle for the operand at index OpIdx. More...
 
bool hasReadingOperandBundles () const
 Return true if this operand bundle user has operand bundles that may read from the heap. More...
 
bool hasClobberingOperandBundles () const
 Return true if this operand bundle user has operand bundles that may write to the heap. More...
 
bool bundleOperandHasAttr (unsigned OpIdx, Attribute::AttrKind A) const
 Return true if the bundle operand at index OpIdx has the attribute A. More...
 
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. More...
 
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. More...
 
bool isFnAttrDisallowedByOpBundle (StringRef S) const
 Is the function attribute S disallowed by some operand bundle on this operand bundle user? More...
 
bool isFnAttrDisallowedByOpBundle (Attribute::AttrKind A) const
 Is the function attribute A disallowed by some operand bundle on this operand bundle user? More...
 
OperandBundleUse operandBundleFromBundleOpInfo (const BundleOpInfo &BOI) const
 Simple helper function to map a BundleOpInfo to an OperandBundleUse. More...
 
bundle_op_iterator bundle_op_info_begin ()
 Return the start of the list of BundleOpInfo instances associated with this OperandBundleUser. More...
 
const_bundle_op_iterator bundle_op_info_begin () const
 Return the start of the list of BundleOpInfo instances associated with this OperandBundleUser. More...
 
bundle_op_iterator bundle_op_info_end ()
 Return the end of the list of BundleOpInfo instances associated with this OperandBundleUser. More...
 
const_bundle_op_iterator bundle_op_info_end () const
 Return the end of the list of BundleOpInfo instances associated with this OperandBundleUser. More...
 
iterator_range< bundle_op_iteratorbundle_op_infos ()
 Return the range [bundle_op_info_begin, bundle_op_info_end). More...
 
iterator_range< const_bundle_op_iteratorbundle_op_infos () const
 Return the range [bundle_op_info_begin, bundle_op_info_end). More...
 
op_iterator populateBundleOperandInfos (ArrayRef< OperandBundleDef > Bundles, const unsigned BeginIndex)
 Populate the BundleOpInfo instances and the Use& vector from Bundles. More...
 
const BundleOpInfogetBundleOpInfoForOperand (unsigned OpIdx) const
 Return the BundleOpInfo for the operand at index OpIdx. More...
 
static unsigned CountBundleInputs (ArrayRef< OperandBundleDef > Bundles)
 Return the total number of values used in Bundles. More...
 

Additional Inherited Members

- 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
 
- 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 >
 
- Static Public Attributes inherited from llvm::Value
static const unsigned MaxAlignmentExponent = 29
 The maximum alignment for instructions. More...
 
static const unsigned MaximumAlignment = 1u << MaxAlignmentExponent
 
- Protected Types inherited from llvm::Value
enum  : unsigned { NumUserOperandsBits = 28 }
 The number of operands in the subclass. More...
 
- Protected Types inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< Instruction, Options... >::type >
using self_iterator = ilist_iterator< ilist_detail::compute_node_options< Instruction, Options... >::type, false, false >
 
using const_self_iterator = ilist_iterator< ilist_detail::compute_node_options< Instruction, Options... >::type, false, true >
 
using reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< Instruction, Options... >::type, true, false >
 
using const_reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< Instruction, Options... >::type, true, true >
 
- Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U >
static UseOpFrom (const U *that)
 

Detailed Description

Base class for all callable instructions (InvokeInst and CallInst) Holds everything related to calling a function.

All call-like instructions are required to use a common operand layout:

This allows this base class to easily access the called function and the start of the arguments without knowing how many other operands a particular subclass requires. Note that accessing the end of the argument list isn't as cheap as most other operations on the base class.

Definition at line 1014 of file InstrTypes.h.

Member Typedef Documentation

◆ bundle_op_iterator

Definition at line 1846 of file InstrTypes.h.

◆ const_bundle_op_iterator

Definition at line 1847 of file InstrTypes.h.

Constructor & Destructor Documentation

◆ CallBase()

template<class... ArgsTy>
llvm::CallBase::CallBase ( AttributeList const A,
FunctionType FT,
ArgsTy &&...  Args 
)
inlineprotected

Definition at line 1023 of file InstrTypes.h.

References llvm::Instruction::Instruction().

Member Function Documentation

◆ addAttribute() [1/2]

void llvm::CallBase::addAttribute ( unsigned  i,
Attribute::AttrKind  Kind 
)
inline

◆ addAttribute() [2/2]

void llvm::CallBase::addAttribute ( unsigned  i,
Attribute  Attr 
)
inline

adds the attribute to the list of attributes.

Definition at line 1268 of file InstrTypes.h.

References llvm::AttributeList::addAttribute(), and llvm::Intrinsic::getAttributes().

◆ addDereferenceableAttr()

void llvm::CallBase::addDereferenceableAttr ( unsigned  i,
uint64_t  Bytes 
)
inline

adds the dereferenceable attribute to the list of attributes.

Definition at line 1321 of file InstrTypes.h.

References llvm::AttributeList::addDereferenceableAttr(), and llvm::Intrinsic::getAttributes().

◆ addDereferenceableOrNullAttr()

void llvm::CallBase::addDereferenceableOrNullAttr ( unsigned  i,
uint64_t  Bytes 
)
inline

adds the dereferenceable_or_null attribute to the list of attributes.

Definition at line 1329 of file InstrTypes.h.

References llvm::AttributeList::addDereferenceableOrNullAttr(), llvm::Intrinsic::getAttributes(), and Kind.

◆ addParamAttr() [1/2]

void llvm::CallBase::addParamAttr ( unsigned  ArgNo,
Attribute::AttrKind  Kind 
)
inline

◆ addParamAttr() [2/2]

void llvm::CallBase::addParamAttr ( unsigned  ArgNo,
Attribute  Attr 
)
inline

Adds the attribute to the indicated argument.

Definition at line 1283 of file InstrTypes.h.

References llvm::AttributeList::addParamAttribute(), assert(), and llvm::Intrinsic::getAttributes().

◆ arg_begin() [1/2]

User::op_iterator llvm::CallBase::arg_begin ( )
inline

◆ arg_begin() [2/2]

User::const_op_iterator llvm::CallBase::arg_begin ( ) const
inline

Definition at line 1101 of file InstrTypes.h.

◆ arg_empty()

bool llvm::CallBase::arg_empty ( ) const
inline

Definition at line 1122 of file InstrTypes.h.

◆ arg_end() [1/2]

User::op_iterator llvm::CallBase::arg_end ( )
inline

◆ arg_end() [2/2]

User::const_op_iterator llvm::CallBase::arg_end ( ) const
inline

Definition at line 1111 of file InstrTypes.h.

◆ arg_operands() [1/2]

iterator_range<User::op_iterator> llvm::CallBase::arg_operands ( )
inline

◆ arg_operands() [2/2]

iterator_range<User::const_op_iterator> llvm::CallBase::arg_operands ( ) const
inline

Definition at line 1130 of file InstrTypes.h.

References llvm::make_range().

◆ arg_size()

unsigned llvm::CallBase::arg_size ( ) const
inline

Definition at line 1123 of file InstrTypes.h.

Referenced by getParentPad(), getSuccPad(), and isFuncOrArgAttr().

◆ args() [1/2]

iterator_range<User::op_iterator> llvm::CallBase::args ( )
inline

Iteration adapter for range-for loops.

Definition at line 1116 of file InstrTypes.h.

References llvm::make_range().

Referenced by llvm::GlobalsAAResult::alias(), and getParentPad().

◆ args() [2/2]

iterator_range<User::const_op_iterator> llvm::CallBase::args ( ) const
inline

Definition at line 1119 of file InstrTypes.h.

References llvm::make_range().

◆ bundle_op_info_begin() [1/2]

bundle_op_iterator llvm::CallBase::bundle_op_info_begin ( )
inline

Return the start of the list of BundleOpInfo instances associated with this OperandBundleUser.

OperandBundleUser uses the descriptor area co-allocated with the host User to store some meta information about which operands are "normal" operands, and which ones belong to some operand bundle.

The layout of an operand bundle user is

     +-----------uint32_t End-------------------------------------+
     |                                                            |
     |  +--------uint32_t Begin--------------------+              |
     |  |                                          |              |
     ^  ^                                          v              v

|---—|---—|-—|-—|-—|-—|-—|------—|-—|------—|-—|--— | BOI0 | BOI1 | .. | DU | U0 | U1 | .. | BOI0_U0 | .. | BOI1_U0 | .. | Un |---—|---—|-—|-—|-—|-—|-—|------—|-—|------—|-—|--— v v ^ ^ | | | | | +-----—uint32_t Begin---------—+ | | | +--------—uint32_t End--------------------------—+

BOI0, BOI1 ... are descriptions of operand bundles in this User's use list. These descriptions are installed and managed by this class, and they're all instances of OperandBundleUser<T>::BundleOpInfo.

DU is an additional descriptor installed by User's 'operator new' to keep track of the 'BOI0 ... BOIN' co-allocation. OperandBundleUser does not access or modify DU in any way, it's an implementation detail private to User.

The regular Use& vector for the User starts at U0. The operand bundle uses are part of the Use& vector, just like normal uses. In the diagram above, the operand bundle uses start at BOI0_U0. Each instance of BundleOpInfo has information about a contiguous set of uses constituting an operand bundle, and the total set of operand bundle uses themselves form a contiguous set of uses (i.e. there are no gaps between uses corresponding to individual operand bundles).

This class does not know the location of the set of operand bundle uses within the use list – that is decided by the User using this class via the BeginIdx argument in populateBundleOperandInfos.

Currently operand bundle users with hung-off operands are not supported.

Definition at line 1895 of file InstrTypes.h.

Referenced by bundle_op_info_begin(), llvm::CallInst::CreateFree(), hasIdenticalOperandBundleSchema(), and populateBundleOperandInfos().

◆ bundle_op_info_begin() [2/2]

const_bundle_op_iterator llvm::CallBase::bundle_op_info_begin ( ) const
inline

Return the start of the list of BundleOpInfo instances associated with this OperandBundleUser.

Definition at line 1905 of file InstrTypes.h.

References bundle_op_info_begin().

◆ bundle_op_info_end() [1/2]

bundle_op_iterator llvm::CallBase::bundle_op_info_end ( )
inline

Return the end of the list of BundleOpInfo instances associated with this OperandBundleUser.

Definition at line 1912 of file InstrTypes.h.

Referenced by bundle_op_info_end(), llvm::CallInst::CreateFree(), and populateBundleOperandInfos().

◆ bundle_op_info_end() [2/2]

const_bundle_op_iterator llvm::CallBase::bundle_op_info_end ( ) const
inline

Return the end of the list of BundleOpInfo instances associated with this OperandBundleUser.

Definition at line 1922 of file InstrTypes.h.

References bundle_op_info_end().

◆ bundle_op_infos() [1/2]

iterator_range<bundle_op_iterator> llvm::CallBase::bundle_op_infos ( )
inline

Return the range [bundle_op_info_begin, bundle_op_info_end).

Definition at line 1928 of file InstrTypes.h.

References llvm::make_range().

◆ bundle_op_infos() [2/2]

iterator_range<const_bundle_op_iterator> llvm::CallBase::bundle_op_infos ( ) const
inline

Return the range [bundle_op_info_begin, bundle_op_info_end).

Definition at line 1933 of file InstrTypes.h.

References llvm::make_range().

◆ bundleOperandHasAttr()

bool llvm::CallBase::bundleOperandHasAttr ( unsigned  OpIdx,
Attribute::AttrKind  A 
) const
inline

Return true if the bundle operand at index OpIdx has the attribute A.

Definition at line 1755 of file InstrTypes.h.

◆ cannotDuplicate()

bool llvm::CallBase::cannotDuplicate ( ) const
inline

Determine if the invoke cannot be duplicated.

Definition at line 1561 of file InstrTypes.h.

References llvm::Attribute::NoDuplicate.

Referenced by FoldCondBranchOnPHI().

◆ classof() [1/2]

static bool llvm::CallBase::classof ( const Instruction I)
inlinestatic

Definition at line 1043 of file InstrTypes.h.

References llvm::MCID::Call, and llvm::Instruction::getOpcode().

◆ classof() [2/2]

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

Definition at line 1047 of file InstrTypes.h.

◆ CountBundleInputs()

static unsigned llvm::CallBase::CountBundleInputs ( ArrayRef< OperandBundleDef Bundles)
inlinestaticprotected

Return the total number of values used in Bundles.

Definition at line 1960 of file InstrTypes.h.

References B, llvm::AttributeList::FunctionIndex, and llvm::AttributeList::hasAttribute().

◆ countOperandBundlesOfType() [1/2]

unsigned llvm::CallBase::countOperandBundlesOfType ( StringRef  Name) const
inline

Return the number of operand bundles with the tag Name attached to this instruction.

Definition at line 1656 of file InstrTypes.h.

Referenced by getMemCmpLoad(), getOffsetFromIndices(), getParentPad(), and llvm::SelectionDAGBuilder::visitBitTestCase().

◆ countOperandBundlesOfType() [2/2]

unsigned llvm::CallBase::countOperandBundlesOfType ( uint32_t  ID) const
inline

Return the number of operand bundles with the tag ID attached to this instruction.

Definition at line 1667 of file InstrTypes.h.

◆ data_operands_begin() [1/2]

User::op_iterator llvm::CallBase::data_operands_begin ( )
inline

data_operands_begin/data_operands_end - Return iterators iterating over the call / invoke argument list and bundle operands.

For invokes, this is the set of instruction operands except the invoke target and the two successor blocks; and for calls this is the set of instruction operands except the call target.

Definition at line 1065 of file InstrTypes.h.

Referenced by llvm::BasicAAResult::getModRefInfo().

◆ data_operands_begin() [2/2]

User::const_op_iterator llvm::CallBase::data_operands_begin ( ) const
inline

Definition at line 1066 of file InstrTypes.h.

◆ data_operands_empty()

bool llvm::CallBase::data_operands_empty ( ) const
inline

Definition at line 1083 of file InstrTypes.h.

◆ data_operands_end() [1/2]

User::op_iterator llvm::CallBase::data_operands_end ( )
inline

Definition at line 1069 of file InstrTypes.h.

Referenced by llvm::BasicAAResult::getModRefInfo().

◆ data_operands_end() [2/2]

User::const_op_iterator llvm::CallBase::data_operands_end ( ) const
inline

Definition at line 1074 of file InstrTypes.h.

◆ data_operands_size()

unsigned llvm::CallBase::data_operands_size ( ) const
inline

Definition at line 1086 of file InstrTypes.h.

◆ data_ops() [1/2]

iterator_range<User::op_iterator> llvm::CallBase::data_ops ( )
inline

Definition at line 1077 of file InstrTypes.h.

References llvm::make_range().

◆ data_ops() [2/2]

iterator_range<User::const_op_iterator> llvm::CallBase::data_ops ( ) const
inline

Definition at line 1080 of file InstrTypes.h.

References llvm::make_range().

◆ dataOperandHasImpliedAttr()

bool llvm::CallBase::dataOperandHasImpliedAttr ( unsigned  i,
Attribute::AttrKind  Kind 
) const
inline

Return true if the data operand at index i has the attribute A.

Data operands include call arguments and values used in operand bundles, but does not include the callee operand. This routine dispatches to the underlying AttributeList or the OperandBundleUser as appropriate.

The index i is interpreted as

i == Attribute::ReturnIndex -> the return value i in [1, arg_size + 1) -> argument number (i - 1) i in [arg_size + 1, data_operand_size + 1) -> bundle operand at index (i - 1) in the operand list.

Definition at line 1376 of file InstrTypes.h.

References assert(), and llvm::AttributeList::ReturnIndex.

◆ DECLARE_TRANSPARENT_OPERAND_ACCESSORS()

llvm::CallBase::DECLARE_TRANSPARENT_OPERAND_ACCESSORS ( Value  )

◆ doesNoCfCheck()

bool llvm::CallBase::doesNoCfCheck ( ) const
inline

Determine if the call should not perform indirect branch tracking.

Definition at line 1552 of file InstrTypes.h.

References llvm::Attribute::NoCfCheck.

Referenced by computeBytesPoppedByCalleeForSRet(), and getMOVL().

◆ doesNotAccessMemory() [1/2]

bool llvm::CallBase::doesNotAccessMemory ( unsigned  OpNo) const
inline

◆ doesNotAccessMemory() [2/2]

bool llvm::CallBase::doesNotAccessMemory ( ) const
inline

Determine if the call does not access memory.

Definition at line 1497 of file InstrTypes.h.

References llvm::Attribute::ReadNone.

◆ doesNotCapture()

bool llvm::CallBase::doesNotCapture ( unsigned  OpNo) const
inline

Determine whether this data operand is not captured.

Definition at line 1401 of file InstrTypes.h.

References llvm::Attribute::NoCapture.

Referenced by llvm::BasicAAResult::getModRefInfo().

◆ doesNotReadMemory() [1/2]

bool llvm::CallBase::doesNotReadMemory ( unsigned  OpNo) const
inline

◆ doesNotReadMemory() [2/2]

bool llvm::CallBase::doesNotReadMemory ( ) const
inline

Determine if the call does not access or only writes memory.

Definition at line 1511 of file InstrTypes.h.

References llvm::Attribute::WriteOnly.

◆ doesNotReturn()

bool llvm::CallBase::doesNotReturn ( ) const
inline

Determine if the call cannot return.

Definition at line 1546 of file InstrTypes.h.

References llvm::Attribute::NoReturn.

◆ doesNotThrow()

bool llvm::CallBase::doesNotThrow ( ) const
inline

Determine if the call cannot unwind.

Definition at line 1555 of file InstrTypes.h.

References llvm::Attribute::NoUnwind.

Referenced by HandleCallsInBlockInlinedThroughInvoke(), and llvm::InstCombiner::visitCallInst().

◆ getArgOperand()

Value* llvm::CallBase::getArgOperand ( unsigned  i) const
inline

Definition at line 1135 of file InstrTypes.h.

References assert().

Referenced by llvm::GVN::ValueTable::add(), addIntrinsicToSummary(), addStackMapLiveVars(), llvm::slpvectorizer::BoUpSLP::canMapToVector(), canonicalizeConstantArg0ToArg1(), canonicalizeSaturatedSubtract(), canTransformToMemCmp(), computeArraySize(), computeKnownBitsFromAssume(), ComputePostOrders(), llvm::computeUsesVAFloatArgument(), createCallInst(), llvm::createEfficiencySanitizerPass(), llvm::createObjCARCOptPass(), CreatePrologue(), despeculateCountZeros(), eliminateRecursiveTailCall(), emitSignedInt64(), llvm::AlignmentFromAssumptionsPass::extractAlignmentInfo(), llvm::findDevirtualizableCallsForTypeCheckedLoad(), llvm::findDevirtualizableCallsForTypeTest(), findInitTrampoline(), findMatchingInlineAsmOperand(), llvm::AMDGPULibCalls::fold(), foldCtpop(), foldCttzCtlz(), foldICmpShlOne(), llvm::SITargetLowering::getAddrModeArguments(), llvm::VAStartInst::getArgList(), llvm::VAEndInst::getArgList(), llvm::getArgumentAliasingToReturnedPointer(), llvm::VACopyInst::getDest(), llvm::ConstrainedFPIntrinsic::getExceptionBehavior(), llvm::MemoryLocation::getForArgument(), llvm::InstrProfIncrementInst::getHash(), llvm::InstrProfValueProfileInst::getHash(), llvm::InstrProfIncrementInst::getIndex(), llvm::InstrProfValueProfileInst::getIndex(), llvm::MemIntrinsicBase< AnyMemIntrinsic >::getLength(), getMemCmpLoad(), llvm::InstrProfIncrementInst::getName(), llvm::InstrProfValueProfileInst::getName(), llvm::DOTGraphTraits< BoUpSLP * >::getNodeAttributes(), llvm::InstrProfIncrementInst::getNumCounters(), getOffsetFromIndices(), llvm::AArch64TTIImpl::getOrCreateResultFromMemIntrinsic(), getParentPad(), getPointerOperands(), getPow(), llvm::MemIntrinsicBase< AnyMemIntrinsic >::getRawDest(), llvm::AtomicMemIntrinsic::getRawElementSizeInBytes(), llvm::DbgVariableIntrinsic::getRawExpression(), llvm::DbgLabelInst::getRawLabel(), llvm::DbgVariableIntrinsic::getRawVariable(), llvm::ConstrainedFPIntrinsic::getRoundingMode(), getSqrtCall(), llvm::VACopyInst::getSrc(), llvm::InstrProfIncrementInst::getStep(), getSubprogram(), getSuccPad(), llvm::InstrProfValueProfileInst::getTargetValue(), llvm::RISCVTargetLowering::getTgtMemIntrinsic(), llvm::HexagonTargetLowering::getTgtMemIntrinsic(), llvm::AArch64TTIImpl::getTgtMemIntrinsic(), llvm::GCNTTIImpl::getTgtMemIntrinsic(), llvm::SITargetLowering::getTgtMemIntrinsic(), llvm::AArch64TargetLowering::getTgtMemIntrinsic(), llvm::NVPTXTargetLowering::getTgtMemIntrinsic(), llvm::ARMTargetLowering::getTgtMemIntrinsic(), llvm::PPCTargetLowering::getTgtMemIntrinsic(), llvm::X86TargetLowering::getTgtMemIntrinsic(), getUnderlyingArgReg(), getUniformBase(), llvm::InstrProfValueProfileInst::getValueKind(), llvm::DbgVariableIntrinsic::getVariableLocation(), llvm::MemIntrinsic::getVolatileCst(), handleBrSelExpect(), handleFree(), handlePhiDef(), handleSwitchExpect(), hasOnlySelectUsers(), haveSameOperands(), INITIALIZE_PASS(), llvm::AMDGPULibCalls::initNativeFuncs(), InsertRootInitializers(), insertSinCosCall(), InTreeUserNeedToExtract(), inversePermutation(), isDynamicConstant(), isFuncOrArgAttr(), isKnownTypeIdMember(), isLoadInvariantInLoop(), IsNonLocalValue(), isReportingError(), llvm::LibCallSimplifier::LibCallSimplifier(), llvm::log2(), lowerExpectIntrinsic(), LowerFPToInt(), llvm::IntrinsicLowering::LowerIntrinsicCall(), llvm::lowerObjectSizeCall(), llvm::IntrinsicLowering::LowerToByteSwap(), llvm::makeGuardControlFlowExplicit(), llvm::gvn::AvailableValueInBlock::MaterializeAdjustedValue(), optimizeBinaryDoubleFP(), optimizeDoubleFP(), OptimizeEmptyGlobalCXXDtors(), optimizeTrigReflections(), false::LibCallsShrinkWrap::perform(), PerformHeapAllocSRoA(), RedzoneSizeForScale(), ReplaceFPIntrinsicWithCall(), replaceUnaryCall(), reportLoadElim(), llvm::returnTypeIsEligibleForTailCall(), scalarizeMaskedGather(), scalarizeMaskedLoad(), scalarizeMaskedScatter(), scalarizeMaskedStore(), llvm::FastISel::selectGetElementPtr(), llvm::FastISel::selectIntrinsicCall(), llvm::FastISel::selectPatchpoint(), llvm::FastISel::selectXRayCustomEvent(), llvm::FastISel::selectXRayTypedEvent(), ShrinkDemandedConstant(), simplifyInvariantGroupIntrinsic(), simplifyMaskedGather(), simplifyMaskedLoad(), simplifyMaskedScatter(), simplifyMaskedStore(), simplifyNeonTbl1(), simplifyNeonVld1(), SimplifyNVVMIntrinsic(), simplifyX86immShift(), simplifyX86insertps(), simplifyX86movmsk(), simplifyX86pack(), simplifyX86pshufb(), simplifyX86round(), simplifyX86varShift(), simplifyX86vpcom(), simplifyX86vpermilvar(), simplifyX86vpermv(), AllocaSlices::SliceBuilder::SliceBuilder(), StripSymbolNames(), llvm::JumpThreadingPass::ThreadGuard(), tryToMoveFreeBeforeNullTest(), tryToOptimizeStoreOfMallocToGlobal(), turnGuardIntoBranch(), TypeSizeToSizeIndex(), llvm::AssumptionCache::updateAffectedValues(), upgradeAbs(), upgradeAVX512MaskToSelect(), upgradeIntMinMax(), upgradeMaskedCompare(), upgradeMaskedMove(), UpgradeMaskToInt(), upgradePMULDQ(), upgradeX86ConcatShift(), UpgradeX86MaskedShift(), upgradeX86Rotate(), UpgradeX86VPERMT2Intrinsics(), llvm::AMDGPULibCalls::useNative(), llvm::sroa::AllocaSliceRewriter::visit(), llvm::InstCombiner::visitCallInst(), llvm::InstCombiner::visitFree(), and X86ChooseCmpImmediateOpcode().

◆ getArgOperandUse() [1/2]

const Use& llvm::CallBase::getArgOperandUse ( unsigned  i) const
inline

Wrappers for getting the Use of a call argument.

Definition at line 1146 of file InstrTypes.h.

References assert(), and llvm::User::getOperandUse().

Referenced by llvm::MemIntrinsicBase< AnyMemIntrinsic >::getLengthUse(), and llvm::MemIntrinsicBase< AnyMemIntrinsic >::getRawDestUse().

◆ getArgOperandUse() [2/2]

Use& llvm::CallBase::getArgOperandUse ( unsigned  i)
inline

Definition at line 1150 of file InstrTypes.h.

References assert(), and llvm::User::getOperandUse().

◆ getAttribute() [1/2]

Attribute llvm::CallBase::getAttribute ( unsigned  i,
Attribute::AttrKind  Kind 
) const
inline

Get the attribute of a given kind at a position.

Definition at line 1342 of file InstrTypes.h.

References llvm::AttributeList::getAttribute(), and llvm::Intrinsic::getAttributes().

◆ getAttribute() [2/2]

Attribute llvm::CallBase::getAttribute ( unsigned  i,
StringRef  Kind 
) const
inline

Get the attribute of a given kind at a position.

Definition at line 1347 of file InstrTypes.h.

References llvm::AttributeList::getAttribute(), and llvm::Intrinsic::getAttributes().

◆ getAttributes()

AttributeList llvm::CallBase::getAttributes ( ) const
inline

◆ getBundleOperandsEndIndex()

unsigned llvm::CallBase::getBundleOperandsEndIndex ( ) const
inline

Return the index of the last bundle operand in the Use array.

Definition at line 1614 of file InstrTypes.h.

References assert().

Referenced by llvm::DOTGraphTraits< BoUpSLP * >::getNodeAttributes().

◆ getBundleOperandsStartIndex()

unsigned llvm::CallBase::getBundleOperandsStartIndex ( ) const
inline

Return the index of the first bundle operand in the Use array.

Definition at line 1608 of file InstrTypes.h.

References assert().

Referenced by llvm::DOTGraphTraits< BoUpSLP * >::getNodeAttributes().

◆ getBundleOpInfoForOperand()

const BundleOpInfo& llvm::CallBase::getBundleOpInfoForOperand ( unsigned  OpIdx) const
inline

Return the BundleOpInfo for the operand at index OpIdx.

It is an error to call this with an OpIdx that does not correspond to an bundle operand.

Definition at line 1950 of file InstrTypes.h.

References llvm_unreachable.

◆ getCalledFunction()

Function* llvm::CallBase::getCalledFunction ( ) const
inline

Returns the function called, or null if this is an indirect function invocation.

Definition at line 1181 of file InstrTypes.h.

Referenced by addIntrinsicToSummary(), canTransformToMemCmp(), CC_MipsO32_FP64(), llvm::IntrinsicInst::classof(), combineADDToADDZE(), computeBytesPoppedByCalleeForSRet(), computeKnownBitsFromAssume(), despeculateCountZeros(), llvm::findDevirtualizableCallsForTypeCheckedLoad(), llvm::findDevirtualizableCallsForTypeTest(), findTRECandidate(), llvm::AMDGPULibCalls::fold(), llvm::objcarc::GetARCInstKind(), llvm::MemoryLocation::getForArgument(), llvm::IntrinsicInst::getIntrinsicID(), getMemCmpLoad(), llvm::BasicAAResult::getModRefBehavior(), llvm::GlobalsAAResult::getModRefBehavior(), llvm::GlobalsAAResult::getModRefInfo(), getMOVL(), llvm::DOTGraphTraits< BoUpSLP * >::getNodeAttributes(), getOffsetFromIndices(), getParameterABIAttributes(), getParentPad(), getPow(), getScalarIntrinsicDeclaration(), getSqrtCall(), getSuccPad(), llvm::HexagonTargetLowering::getTgtMemIntrinsic(), llvm::ARMTargetLowering::getTgtMemIntrinsic(), getUniformBase(), getVectorCallCost(), handleBrSelExpect(), HandleCallsInBlockInlinedThroughInvoke(), handleSwitchExpect(), INITIALIZE_PASS(), llvm::InlineFunction(), InsertRootInitializers(), insertSinCosCall(), inversePermutation(), isFuncOrArgAttr(), isLocallyOpenedFile(), isReportingError(), isSafeToEliminateVarargsCast(), isWriteOnlyParam(), llvm::LibCallSimplifier::LibCallSimplifier(), llvm::log2(), lowerExpectIntrinsic(), llvm::IntrinsicLowering::LowerIntrinsicCall(), llvm::maybeMarkSanitizerLibraryCallNoBuiltin(), moveUp(), llvm::FortifiedLibCallSimplifier::optimizeCall(), llvm::LibCallSimplifier::optimizeCall(), optimizeDoubleFP(), optimizeTrigReflections(), false::LibCallsShrinkWrap::perform(), llvm::returnTypeIsEligibleForTailCall(), runPartiallyInlineLibCalls(), llvm::FastISel::selectStackmap(), setFastFlags(), ShrinkDemandedConstant(), TypeSizeToSizeIndex(), llvm::UpgradeIntrinsicCall(), llvm::AMDGPULibCalls::useNative(), llvm::InstCombiner::visitCallInst(), llvm::InstVisitor< ObjectSizeOffsetVisitor, SizeOffsetType >::visitInstruction(), and X86ChooseCmpImmediateOpcode().

◆ getCalledOperand()

Value* llvm::CallBase::getCalledOperand ( ) const
inline

Definition at line 1170 of file InstrTypes.h.

◆ getCalledOperandUse() [1/2]

const Use& llvm::CallBase::getCalledOperandUse ( ) const
inline

Definition at line 1176 of file InstrTypes.h.

Referenced by getParentPad().

◆ getCalledOperandUse() [2/2]

Use& llvm::CallBase::getCalledOperandUse ( )
inline

Definition at line 1177 of file InstrTypes.h.

◆ getCalledValue()

Value* llvm::CallBase::getCalledValue ( ) const
inline

◆ getCaller() [1/2]

Function * CallBase::getCaller ( )

Helper to get the caller (the parent function).

Definition at line 258 of file Instructions.cpp.

References llvm::Instruction::getParent(), and llvm::BasicBlock::getParent().

Referenced by getParentPad().

◆ getCaller() [2/2]

const Function* llvm::CallBase::getCaller ( ) const
inline

Definition at line 1198 of file InstrTypes.h.

References getIntrinsicID().

◆ getCallingConv()

CallingConv::ID llvm::CallBase::getCallingConv ( ) const
inline

◆ getDereferenceableBytes()

uint64_t llvm::CallBase::getDereferenceableBytes ( unsigned  i) const
inline

Extract the number of dereferenceable bytes for a call or parameter (0=unknown).

Definition at line 1457 of file InstrTypes.h.

References llvm::AttributeList::getDereferenceableBytes().

◆ getDereferenceableOrNullBytes()

uint64_t llvm::CallBase::getDereferenceableOrNullBytes ( unsigned  i) const
inline

Extract the number of dereferenceable_or_null bytes for a call or parameter (0=unknown).

Definition at line 1463 of file InstrTypes.h.

References llvm::AttributeList::getDereferenceableOrNullBytes(), and isReturnNonNull().

◆ getFunctionType()

FunctionType* llvm::CallBase::getFunctionType ( ) const
inline

◆ getIntrinsicID()

Intrinsic::ID CallBase::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.

Definition at line 270 of file Instructions.cpp.

References F(), getCalledFunction(), and llvm::Intrinsic::not_intrinsic.

Referenced by llvm::isIntrinsicReturningPointerAliasingArgumentWithoutCapturing().

◆ getNumArgOperands()

unsigned llvm::CallBase::getNumArgOperands ( ) const
inline

◆ getNumOperandBundles()

unsigned llvm::CallBase::getNumOperandBundles ( ) const
inline

Return the number of operand bundles associated with this User.

Definition at line 1600 of file InstrTypes.h.

Referenced by llvm::createObjCARCOptPass(), getSuccPad(), and hasIdenticalOperandBundleSchema().

◆ getNumSubclassExtraOperands()

unsigned llvm::CallBase::getNumSubclassExtraOperands ( ) const
inlineprotected

◆ getNumTotalBundleOperands()

unsigned llvm::CallBase::getNumTotalBundleOperands ( ) const
inline

Return the total number operands (not operand bundles) used by every operand bundle in this OperandBundleUser.

Definition at line 1637 of file InstrTypes.h.

◆ getOperandBundle() [1/2]

Optional<OperandBundleUse> llvm::CallBase::getOperandBundle ( StringRef  Name) const
inline

Return an operand bundle by name, if present.

It is an error to call this for operand bundle types that may have multiple instances of them on the same instruction.

Definition at line 1680 of file InstrTypes.h.

References assert(), llvm::OperandBundleUse::getTagName(), Name, and llvm::None.

Referenced by getParentPad(), HandleCallsInBlockInlinedThroughInvoke(), and llvm::makeGuardControlFlowExplicit().

◆ getOperandBundle() [2/2]

Optional<OperandBundleUse> llvm::CallBase::getOperandBundle ( uint32_t  ID) const
inline

Return an operand bundle by tag ID, if present.

It is an error to call this for operand bundle types that may have multiple instances of them on the same instruction.

Definition at line 1696 of file InstrTypes.h.

References assert(), llvm::OperandBundleUse::getTagID(), and llvm::None.

◆ getOperandBundleAt()

OperandBundleUse llvm::CallBase::getOperandBundleAt ( unsigned  Index) const
inline

Return the operand bundle at a specific index.

Definition at line 1649 of file InstrTypes.h.

References assert().

Referenced by llvm::createObjCARCOptPass(), and getSuccPad().

◆ getOperandBundleForOperand()

OperandBundleUse llvm::CallBase::getOperandBundleForOperand ( unsigned  OpIdx) const
inline

Return the operand bundle for the operand at index OpIdx.

It is an error to call this with an OpIdx that does not correspond to an bundle operand.

Definition at line 1724 of file InstrTypes.h.

◆ getOperandBundlesAsDefs()

void llvm::CallBase::getOperandBundlesAsDefs ( SmallVectorImpl< OperandBundleDef > &  Defs) const
inline

Return the list of operand bundles attached to this instruction as a vector of OperandBundleDefs.

This function copies the OperandBundeUse instances associated with this OperandBundleUser to a vector of OperandBundleDefs. Note: OperandBundeUses and OperandBundleDefs are non-trivially different representations of operand bundles (see documentation above).

Definition at line 1715 of file InstrTypes.h.

References llvm::SmallVectorImpl< T >::emplace_back().

Referenced by changeToCall(), llvm::changeToInvokeAndSplitBasicBlock(), llvm::InlineFunction(), inversePermutation(), llvm::FortifiedLibCallSimplifier::optimizeCall(), llvm::LibCallSimplifier::optimizeCall(), PerformHeapAllocSRoA(), and tryToOptimizeStoreOfMallocToGlobal().

◆ getParamAlignment()

unsigned llvm::CallBase::getParamAlignment ( unsigned  ArgNo) const
inline

Extract the alignment for a call or parameter (0=unknown).

Definition at line 1451 of file InstrTypes.h.

References llvm::AttributeList::getParamAlignment().

Referenced by llvm::MemIntrinsicBase< AnyMemIntrinsic >::getDestAlignment().

◆ getParamAttr() [1/2]

Attribute llvm::CallBase::getParamAttr ( unsigned  ArgNo,
Attribute::AttrKind  Kind 
) const
inline

Get the attribute of a given kind from a given arg.

Definition at line 1352 of file InstrTypes.h.

References assert(), llvm::Intrinsic::getAttributes(), and llvm::AttributeList::getParamAttr().

◆ getParamAttr() [2/2]

Attribute llvm::CallBase::getParamAttr ( unsigned  ArgNo,
StringRef  Kind 
) const
inline

Get the attribute of a given kind from a given arg.

Definition at line 1358 of file InstrTypes.h.

References assert(), llvm::Intrinsic::getAttributes(), and llvm::AttributeList::getParamAttr().

◆ getRetAlignment()

unsigned llvm::CallBase::getRetAlignment ( ) const
inline

Extract the alignment of the return value.

Definition at line 1448 of file InstrTypes.h.

References llvm::AttributeList::getRetAlignment().

◆ getReturnedArgOperand()

Value * CallBase::getReturnedArgOperand ( ) const

If one of the arguments has the 'returned' attribute, returns its operand value.

Otherwise, return nullptr.

Definition at line 288 of file Instructions.cpp.

References llvm::AMDGPU::HSAMD::Kernel::Key::Attrs, F(), llvm::AttributeList::FirstArgIndex, getCalledFunction(), and llvm::Attribute::Returned.

Referenced by llvm::getArgumentAliasingToReturnedPointer().

◆ hasArgument()

bool llvm::CallBase::hasArgument ( const Value V) const
inline

Returns true if this CallSite passes the given Value* as an argument to the called function.

Definition at line 1166 of file InstrTypes.h.

References llvm::any_of(), and Arg.

◆ hasByValArgument()

bool llvm::CallBase::hasByValArgument ( ) const
inline

Determine if any call argument is an aggregate passed by value.

Definition at line 1586 of file InstrTypes.h.

References llvm::Attribute::ByVal, and llvm::AttributeList::hasAttrSomewhere().

◆ hasClobberingOperandBundles()

bool llvm::CallBase::hasClobberingOperandBundles ( ) const
inline

Return true if this operand bundle user has operand bundles that may write to the heap.

Definition at line 1739 of file InstrTypes.h.

References llvm::LLVMContext::OB_deopt, and llvm::LLVMContext::OB_funclet.

◆ hasDescriptor()

bool llvm::CallBase::hasDescriptor ( ) const
inlineprotected

Definition at line 1028 of file InstrTypes.h.

References llvm::Value::HasDescriptor.

◆ hasFnAttr() [1/2]

bool llvm::CallBase::hasFnAttr ( Attribute::AttrKind  Kind) const
inline

Determine whether this call has the given attribute.

Definition at line 1251 of file InstrTypes.h.

References assert(), and llvm::Attribute::NoBuiltin.

Referenced by computeBytesPoppedByCalleeForSRet(), despeculateCountZeros(), FindAllMemoryUses(), getMOVL(), insertSinCosCall(), and isTrigLibCall().

◆ hasFnAttr() [2/2]

bool llvm::CallBase::hasFnAttr ( StringRef  Kind) const
inline

Determine whether this call has the given attribute.

Definition at line 1258 of file InstrTypes.h.

◆ hasIdenticalOperandBundleSchema()

bool llvm::CallBase::hasIdenticalOperandBundleSchema ( const CallBase Other) const
inline

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.

Definition at line 1764 of file InstrTypes.h.

References bundle_op_info_begin(), llvm::lltok::equal, and getNumOperandBundles().

Referenced by llvm::DOTGraphTraits< BoUpSLP * >::getNodeAttributes().

◆ hasInAllocaArgument()

bool llvm::CallBase::hasInAllocaArgument ( ) const
inline

Determine if there are is an inalloca argument.

Only the last argument can have the inalloca attribute.

Definition at line 1423 of file InstrTypes.h.

References llvm::Attribute::InAlloca.

Referenced by getSuccPad().

◆ hasOperandBundles()

bool llvm::CallBase::hasOperandBundles ( ) const
inline

◆ hasOperandBundlesOtherThan()

bool llvm::CallBase::hasOperandBundlesOtherThan ( ArrayRef< uint32_t IDs) const
inline

Return true if this operand bundle user contains operand bundles with tags other than those specified in IDs.

Definition at line 1774 of file InstrTypes.h.

References llvm::is_contained().

Referenced by getMemCmpLoad(), and llvm::SelectionDAGBuilder::visitBitTestCase().

◆ hasReadingOperandBundles()

bool llvm::CallBase::hasReadingOperandBundles ( ) const
inline

Return true if this operand bundle user has operand bundles that may read from the heap.

Definition at line 1730 of file InstrTypes.h.

◆ hasRetAttr()

bool CallBase::hasRetAttr ( Attribute::AttrKind  Kind) const

Determine whether the return value has the given attribute.

Definition at line 301 of file Instructions.cpp.

References llvm::AMDGPU::HSAMD::Kernel::Key::Attrs, F(), getCalledFunction(), and llvm::AttributeList::ReturnIndex.

◆ hasStructRetAttr()

bool llvm::CallBase::hasStructRetAttr ( ) const
inline

Determine if the call returns a structure through first pointer argument.

Definition at line 1577 of file InstrTypes.h.

References llvm::Attribute::StructRet.

◆ isArgOperand() [1/2]

bool llvm::CallBase::isArgOperand ( const Use U) const
inline

Definition at line 1155 of file InstrTypes.h.

References assert().

◆ isArgOperand() [2/2]

bool llvm::CallBase::isArgOperand ( Value::const_user_iterator  UI) const
inline

Definition at line 1160 of file InstrTypes.h.

◆ isBundleOperand() [1/3]

bool llvm::CallBase::isBundleOperand ( unsigned  Idx) const
inline

Return true if the operand at index Idx is a bundle operand.

Definition at line 1620 of file InstrTypes.h.

◆ isBundleOperand() [2/3]

bool llvm::CallBase::isBundleOperand ( const Use U) const
inline

Returns true if the use is a bundle operand.

Definition at line 1626 of file InstrTypes.h.

References assert().

◆ isBundleOperand() [3/3]

bool llvm::CallBase::isBundleOperand ( Value::const_user_iterator  UI) const
inline

Definition at line 1631 of file InstrTypes.h.

◆ isByValArgument()

bool llvm::CallBase::isByValArgument ( unsigned  ArgNo) const
inline

Determine whether this argument is passed by value.

Definition at line 1406 of file InstrTypes.h.

References llvm::Attribute::ByVal.

Referenced by llvm::BasicAAResult::getModRefInfo().

◆ isByValOrInAllocaArgument()

bool llvm::CallBase::isByValOrInAllocaArgument ( unsigned  ArgNo) const
inline

Determine whether this argument is passed by value or in an alloca.

Definition at line 1416 of file InstrTypes.h.

References llvm::Attribute::ByVal, and llvm::Attribute::InAlloca.

◆ isCallee() [1/2]

bool llvm::CallBase::isCallee ( Value::const_user_iterator  UI) const
inline

Determine whether the passed iterator points to the callee operand's Use.

Definition at line 1189 of file InstrTypes.h.

Referenced by analyzeGlobalAux().

◆ isCallee() [2/2]

bool llvm::CallBase::isCallee ( const Use U) const
inline

Determine whether this Use is the callee operand's Use.

Definition at line 1194 of file InstrTypes.h.

◆ isConvergent()

bool llvm::CallBase::isConvergent ( ) const
inline

Determine if the invoke is convergent.

Definition at line 1567 of file InstrTypes.h.

References llvm::Attribute::Convergent.

Referenced by FoldCondBranchOnPHI().

◆ isDataOperand() [1/2]

bool llvm::CallBase::isDataOperand ( const Use U) const
inline

Definition at line 1090 of file InstrTypes.h.

References assert().

◆ isDataOperand() [2/2]

bool llvm::CallBase::isDataOperand ( Value::const_user_iterator  UI) const
inline

Definition at line 1095 of file InstrTypes.h.

◆ isFnAttrDisallowedByOpBundle() [1/2]

bool llvm::CallBase::isFnAttrDisallowedByOpBundle ( StringRef  S) const
inline

Is the function attribute S disallowed by some operand bundle on this operand bundle user?

Definition at line 1785 of file InstrTypes.h.

◆ isFnAttrDisallowedByOpBundle() [2/2]

bool llvm::CallBase::isFnAttrDisallowedByOpBundle ( Attribute::AttrKind  A) const
inline

Is the function attribute A disallowed by some operand bundle on this operand bundle user?

Definition at line 1793 of file InstrTypes.h.

References llvm::Attribute::ArgMemOnly, llvm::Attribute::InaccessibleMemOnly, llvm::Attribute::InaccessibleMemOrArgMemOnly, llvm_unreachable, llvm::Attribute::ReadNone, and llvm::Attribute::ReadOnly.

◆ isInAllocaArgument()

bool llvm::CallBase::isInAllocaArgument ( unsigned  ArgNo) const
inline

Determine whether this argument is passed in an alloca.

Definition at line 1411 of file InstrTypes.h.

References llvm::Attribute::InAlloca.

◆ isIndirectCall()

bool CallBase::isIndirectCall ( ) const

Return true if the callsite is an indirect call.

Definition at line 260 of file Instructions.cpp.

Referenced by llvm::PGOIndirectCallVisitor::visitCallBase().

◆ isNoBuiltin()

bool llvm::CallBase::isNoBuiltin ( ) const
inline

Return true if the call should not be treated as a call to a builtin.

Definition at line 1483 of file InstrTypes.h.

References llvm::Attribute::Builtin, and llvm::Attribute::NoBuiltin.

Referenced by getMemCmpLoad(), getVectorCallCost(), llvm::LibCallSimplifier::optimizeCall(), false::LibCallsShrinkWrap::perform(), and runPartiallyInlineLibCalls().

◆ isNoInline()

bool llvm::CallBase::isNoInline ( ) const
inline

Return true if the call should not be inlined.

Definition at line 1492 of file InstrTypes.h.

References llvm::Attribute::NoInline.

◆ isReturnNonNull()

bool CallBase::isReturnNonNull ( ) const

Return true if the return value is known to be not null.

This may be because it has the nonnull attribute, or because at least one byte is dereferenceable and the pointer is in addrspace(0).

Definition at line 276 of file Instructions.cpp.

References llvm::AllocaInst::getType(), llvm::Attribute::NonNull, llvm::NullPointerIsDefined(), and llvm::AttributeList::ReturnIndex.

◆ isStrictFP()

bool llvm::CallBase::isStrictFP ( ) const
inline

Determine if the call requires strict floating point semantics.

Definition at line 1489 of file InstrTypes.h.

References llvm::Attribute::StrictFP.

Referenced by getMemCmpLoad(), and isReportingError().

◆ mutateFunctionType()

void llvm::CallBase::mutateFunctionType ( FunctionType FTy)
inline

◆ onlyAccessesArgMemory()

bool llvm::CallBase::onlyAccessesArgMemory ( ) const
inline

Determine if the call can access memmory only using pointers based on its arguments.

Definition at line 1520 of file InstrTypes.h.

References llvm::Attribute::ArgMemOnly.

Referenced by llvm::BasicAAResult::getModRefBehavior(), and isFuncOrArgAttr().

◆ onlyAccessesInaccessibleMemOrArgMem()

bool llvm::CallBase::onlyAccessesInaccessibleMemOrArgMem ( ) const
inline

Determine if the function may only access memory that is either inaccessible from the IR or pointed to by its arguments.

Definition at line 1538 of file InstrTypes.h.

References llvm::Attribute::InaccessibleMemOrArgMemOnly.

Referenced by llvm::BasicAAResult::getModRefBehavior().

◆ onlyAccessesInaccessibleMemory()

bool llvm::CallBase::onlyAccessesInaccessibleMemory ( ) const
inline

Determine if the function may only access memory that is inaccessible from the IR.

Definition at line 1529 of file InstrTypes.h.

References llvm::Attribute::InaccessibleMemOnly.

Referenced by llvm::BasicAAResult::getModRefBehavior().

◆ onlyReadsMemory() [1/2]

bool llvm::CallBase::onlyReadsMemory ( unsigned  OpNo) const
inline

◆ onlyReadsMemory() [2/2]

bool llvm::CallBase::onlyReadsMemory ( ) const
inline

Determine if the call does not access or only reads memory.

Definition at line 1503 of file InstrTypes.h.

References llvm::Attribute::ReadOnly.

◆ operandBundleFromBundleOpInfo()

OperandBundleUse llvm::CallBase::operandBundleFromBundleOpInfo ( const BundleOpInfo BOI) const
inline

◆ paramHasAttr()

bool CallBase::paramHasAttr ( unsigned  ArgNo,
Attribute::AttrKind  Kind 
) const

Determine whether the argument or parameter has the given attribute.

Definition at line 312 of file Instructions.cpp.

References assert(), llvm::AMDGPU::HSAMD::Kernel::Key::Attrs, F(), llvm::AttributeList::FunctionIndex, getCalledFunction(), and Kind.

Referenced by llvm::BasicAAResult::getArgModRefInfo(), getSuccPad(), isContiguous(), and isWriteOnlyParam().

◆ populateBundleOperandInfos()

CallBase::op_iterator CallBase::populateBundleOperandInfos ( ArrayRef< OperandBundleDef Bundles,
const unsigned  BeginIndex 
)

◆ removeAttribute() [1/2]

void llvm::CallBase::removeAttribute ( unsigned  i,
Attribute::AttrKind  Kind 
)
inline

removes the attribute from the list of attributes.

Definition at line 1291 of file InstrTypes.h.

References llvm::Intrinsic::getAttributes(), and llvm::AttributeList::removeAttribute().

◆ removeAttribute() [2/2]

void llvm::CallBase::removeAttribute ( unsigned  i,
StringRef  Kind 
)
inline

removes the attribute from the list of attributes.

Definition at line 1298 of file InstrTypes.h.

References llvm::Intrinsic::getAttributes(), and llvm::AttributeList::removeAttribute().

◆ removeParamAttr() [1/2]

void llvm::CallBase::removeParamAttr ( unsigned  ArgNo,
Attribute::AttrKind  Kind 
)
inline

Removes the attribute from the given argument.

Definition at line 1305 of file InstrTypes.h.

References assert(), llvm::Intrinsic::getAttributes(), and llvm::AttributeList::removeParamAttribute().

Referenced by llvm::MemIntrinsicBase< AnyMemIntrinsic >::setDestAlignment().

◆ removeParamAttr() [2/2]

void llvm::CallBase::removeParamAttr ( unsigned  ArgNo,
StringRef  Kind 
)
inline

Removes the attribute from the given argument.

Definition at line 1313 of file InstrTypes.h.

References assert(), llvm::Intrinsic::getAttributes(), and llvm::AttributeList::removeParamAttribute().

◆ returnDoesNotAlias()

bool llvm::CallBase::returnDoesNotAlias ( ) const
inline

Determine if the return value is marked with NoAlias attribute.

Definition at line 1473 of file InstrTypes.h.

References llvm::AttributeList::hasAttribute(), llvm::Attribute::NoAlias, and llvm::AttributeList::ReturnIndex.

◆ setArgOperand()

void llvm::CallBase::setArgOperand ( unsigned  i,
Value v 
)
inline

◆ setAttributes()

void llvm::CallBase::setAttributes ( AttributeList  A)
inline

◆ setCalledFunction() [1/2]

void llvm::CallBase::setCalledFunction ( Value Fn)
inline

◆ setCalledFunction() [2/2]

void llvm::CallBase::setCalledFunction ( FunctionType FTy,
Value Fn 
)
inline

Sets the function called, including updating to the specified function type.

Definition at line 1218 of file InstrTypes.h.

References assert(), and llvm::Value::getType().

◆ setCalledOperand()

void llvm::CallBase::setCalledOperand ( Value V)
inline

Definition at line 1207 of file InstrTypes.h.

◆ setCallingConv()

void llvm::CallBase::setCallingConv ( CallingConv::ID  CC)
inline

◆ setCannotDuplicate()

void llvm::CallBase::setCannotDuplicate ( )
inline

◆ setConvergent()

void llvm::CallBase::setConvergent ( )
inline

◆ setDoesNotAccessMemory()

void llvm::CallBase::setDoesNotAccessMemory ( )
inline

Definition at line 1498 of file InstrTypes.h.

References llvm::AttributeList::FunctionIndex, and llvm::Attribute::ReadNone.

◆ setDoesNotReadMemory()

void llvm::CallBase::setDoesNotReadMemory ( )
inline

◆ setDoesNotReturn()

void llvm::CallBase::setDoesNotReturn ( )
inline

Definition at line 1547 of file InstrTypes.h.

References llvm::AttributeList::FunctionIndex, and llvm::Attribute::NoReturn.

Referenced by addBoundsChecking().

◆ setDoesNotThrow()

void llvm::CallBase::setDoesNotThrow ( )
inline

◆ setIsNoInline()

void llvm::CallBase::setIsNoInline ( )
inline

Definition at line 1493 of file InstrTypes.h.

References llvm::AttributeList::FunctionIndex, and llvm::Attribute::NoInline.

◆ setNotConvergent()

void llvm::CallBase::setNotConvergent ( )
inline

◆ setOnlyAccessesArgMemory()

void llvm::CallBase::setOnlyAccessesArgMemory ( )
inline

◆ setOnlyAccessesInaccessibleMemOrArgMem()

void llvm::CallBase::setOnlyAccessesInaccessibleMemOrArgMem ( )
inline

◆ setOnlyAccessesInaccessibleMemory()

void llvm::CallBase::setOnlyAccessesInaccessibleMemory ( )
inline

◆ setOnlyReadsMemory()

void llvm::CallBase::setOnlyReadsMemory ( )
inline

Definition at line 1506 of file InstrTypes.h.

References llvm::AttributeList::FunctionIndex, and llvm::Attribute::ReadOnly.

Member Data Documentation

◆ Attrs

AttributeList llvm::CallBase::Attrs
protected

parameter attributes for callable

Definition at line 1019 of file InstrTypes.h.

Referenced by llvm::CallInst::CreateFree(), and populateBundleOperandInfos().

◆ CalledOperandOpEndIdx

constexpr int llvm::CallBase::CalledOperandOpEndIdx = -1
staticprotected

The last operand is the called operand.

Definition at line 1017 of file InstrTypes.h.

◆ FTy

FunctionType* llvm::CallBase::FTy
protected

Definition at line 1020 of file InstrTypes.h.

Referenced by llvm::CallInst::CreateFree(), and populateBundleOperandInfos().


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