This class represents an incoming formal argument to a Function. More...
#include "llvm/IR/Argument.h"
Public Member Functions | |
| LLVM_ABI | Argument (Type *Ty, const Twine &Name="", Function *F=nullptr, unsigned ArgNo=0) |
| Argument constructor. | |
| const Function * | getParent () const |
| Function * | getParent () |
| unsigned | getArgNo () const |
| Return the index of this formal argument in its containing function. | |
| LLVM_ABI bool | hasNonNullAttr (bool AllowUndefOrPoison=true) const |
| Return true if this argument has the nonnull attribute. | |
| LLVM_ABI uint64_t | getDereferenceableBytes () const |
| If this argument has the dereferenceable attribute, return the number of bytes known to be dereferenceable. | |
| LLVM_ABI uint64_t | getDereferenceableOrNullBytes () const |
| If this argument has the dereferenceable_or_null attribute, return the number of bytes known to be dereferenceable. | |
| LLVM_ABI FPClassTest | getNoFPClass () const |
| If this argument has nofpclass attribute, return the mask representing disallowed floating-point values. | |
| LLVM_ABI std::optional< ConstantRange > | getRange () const |
| If this argument has a range attribute, return the value range of the argument. | |
| LLVM_ABI bool | hasByValAttr () const |
| Return true if this argument has the byval attribute. | |
| LLVM_ABI bool | hasDeadOnReturnAttr () const |
| Return true if this argument has the dead_on_return attribute. | |
| LLVM_ABI bool | hasByRefAttr () const |
| Return true if this argument has the byref attribute. | |
| LLVM_ABI bool | hasSwiftSelfAttr () const |
| Return true if this argument has the swiftself attribute. | |
| LLVM_ABI bool | hasSwiftErrorAttr () const |
| Return true if this argument has the swifterror attribute. | |
| LLVM_ABI bool | hasPassPointeeByValueCopyAttr () const |
| Return true if this argument has the byval, inalloca, or preallocated attribute. | |
| LLVM_ABI uint64_t | getPassPointeeByValueCopySize (const DataLayout &DL) const |
| If this argument satisfies has hasPassPointeeByValueAttr, return the in-memory ABI size copied to the stack for the call. | |
| LLVM_ABI bool | hasPointeeInMemoryValueAttr () const |
| Return true if this argument has the byval, sret, inalloca, preallocated, or byref attribute. | |
| LLVM_ABI Type * | getPointeeInMemoryValueType () const |
| If hasPointeeInMemoryValueAttr returns true, the in-memory ABI type is returned. | |
| LLVM_ABI | LLVM_DEPRECATED ("Use getParamAlign() instead", "getParamAlign") uint64_t getParamAlignment() const |
| If this is a byval or inalloca argument, return its alignment. | |
| LLVM_ABI MaybeAlign | getParamAlign () const |
| If this is a byval or inalloca argument, return its alignment. | |
| LLVM_ABI MaybeAlign | getParamStackAlign () const |
| LLVM_ABI Type * | getParamByValType () const |
| If this is a byval argument, return its type. | |
| LLVM_ABI Type * | getParamStructRetType () const |
| If this is an sret argument, return its type. | |
| LLVM_ABI Type * | getParamByRefType () const |
| If this is a byref argument, return its type. | |
| LLVM_ABI Type * | getParamInAllocaType () const |
| If this is an inalloca argument, return its type. | |
| LLVM_ABI bool | hasNestAttr () const |
| Return true if this argument has the nest attribute. | |
| LLVM_ABI bool | hasNoAliasAttr () const |
| Return true if this argument has the noalias attribute. | |
| LLVM_ABI bool | hasNoCaptureAttr () const |
| Return true if this argument has the nocapture attribute. | |
| LLVM_ABI bool | hasNoFreeAttr () const |
| Return true if this argument has the nofree attribute. | |
| LLVM_ABI bool | hasStructRetAttr () const |
| Return true if this argument has the sret attribute. | |
| LLVM_ABI bool | hasInRegAttr () const |
| Return true if this argument has the inreg attribute. | |
| LLVM_ABI bool | hasReturnedAttr () const |
| Return true if this argument has the returned attribute. | |
| LLVM_ABI bool | onlyReadsMemory () const |
| Return true if this argument has the readonly or readnone attribute. | |
| LLVM_ABI bool | hasInAllocaAttr () const |
| Return true if this argument has the inalloca attribute. | |
| LLVM_ABI bool | hasPreallocatedAttr () const |
| Return true if this argument has the preallocated attribute. | |
| LLVM_ABI bool | hasZExtAttr () const |
| Return true if this argument has the zext attribute. | |
| LLVM_ABI bool | hasSExtAttr () const |
| Return true if this argument has the sext attribute. | |
| LLVM_ABI void | addAttrs (AttrBuilder &B) |
| Add attributes to an argument. | |
| LLVM_ABI void | addAttr (Attribute::AttrKind Kind) |
| LLVM_ABI void | addAttr (Attribute Attr) |
| LLVM_ABI void | removeAttr (Attribute::AttrKind Kind) |
| Remove attributes from an argument. | |
| LLVM_ABI void | removeAttrs (const AttributeMask &AM) |
| LLVM_ABI bool | hasAttribute (Attribute::AttrKind Kind) const |
| Check if an argument has a given attribute. | |
| LLVM_ABI bool | hasAttribute (StringRef Kind) const |
| LLVM_ABI Attribute | getAttribute (Attribute::AttrKind Kind) const |
| LLVM_ABI AttributeSet | getAttributes () const |
| Public Member Functions inherited from llvm::Value | |
| Value (const Value &)=delete | |
| Value & | operator= (const Value &)=delete |
| LLVM_ABI void | deleteValue () |
| Delete a pointer to a generic Value. | |
| LLVM_ABI void | dump () const |
| Support for debugging, callable in GDB: V->dump() | |
| Type * | getType () const |
| All values are typed, get the type of this value. | |
| LLVM_ABI LLVMContext & | getContext () const |
| All values hold a context through their type. | |
| bool | hasName () const |
| LLVM_ABI ValueName * | getValueName () const |
| LLVM_ABI void | setValueName (ValueName *VN) |
| LLVM_ABI StringRef | getName () const |
| Return a constant reference to the value's name. | |
| LLVM_ABI void | setName (const Twine &Name) |
| Change the name of the value. | |
| LLVM_ABI void | takeName (Value *V) |
| Transfer the name from V to this value. | |
| LLVM_ABI std::string | getNameOrAsOperand () const |
| LLVM_ABI void | replaceAllUsesWith (Value *V) |
| Change all uses of this to point to a new Value. | |
| LLVM_ABI void | replaceNonMetadataUsesWith (Value *V) |
| Change non-metadata uses of this to point to a new Value. | |
| LLVM_ABI 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. | |
| LLVM_ABI 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. | |
| LLVM_ABI void | assertModuleIsMaterializedImpl () const |
| void | assertModuleIsMaterialized () const |
| bool | hasUseList () const |
| Check if this Value has a use-list. | |
| 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_iterator > | materialized_uses () |
| iterator_range< const_use_iterator > | materialized_uses () const |
| iterator_range< use_iterator > | uses () |
| iterator_range< const_use_iterator > | uses () 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 |
| User * | user_back () |
| const User * | user_back () const |
| iterator_range< user_iterator > | materialized_users () |
| iterator_range< const_user_iterator > | materialized_users () const |
| iterator_range< user_iterator > | users () |
| iterator_range< const_user_iterator > | users () const |
| bool | hasOneUse () const |
| Return true if there is exactly one use of this value. | |
| LLVM_ABI bool | hasNUses (unsigned N) const |
| Return true if this Value has exactly N uses. | |
| LLVM_ABI bool | hasNUsesOrMore (unsigned N) const |
| Return true if this value has N uses or more. | |
| LLVM_ABI bool | hasOneUser () const |
| Return true if there is exactly one user of this value. | |
| LLVM_ABI Use * | getSingleUndroppableUse () |
| Return true if there is exactly one use of this value that cannot be dropped. | |
| const Use * | getSingleUndroppableUse () const |
| LLVM_ABI User * | getUniqueUndroppableUser () |
| 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 User * | getUniqueUndroppableUser () const |
| LLVM_ABI bool | hasNUndroppableUses (unsigned N) const |
| Return true if there this value. | |
| LLVM_ABI bool | hasNUndroppableUsesOrMore (unsigned N) const |
| Return true if this value has N uses or more. | |
| LLVM_ABI void | dropDroppableUses (llvm::function_ref< bool(const Use *)> ShouldDrop=[](const Use *) { return true;}) |
| Remove every uses that can safely be removed. | |
| LLVM_ABI void | dropDroppableUsesIn (User &Usr) |
Remove every use of this value in User that can safely be removed. | |
| LLVM_ABI bool | isUsedInBasicBlock (const BasicBlock *BB) const |
| Check if this value is used in the specified basic block. | |
| LLVM_ABI 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. | |
| LLVM_ABI bool | isSwiftError () const |
| Return true if this value is a swifterror value. | |
| LLVM_ABI const Value * | stripPointerCasts () const |
| Strip off pointer casts, all-zero GEPs and address space casts. | |
| Value * | stripPointerCasts () |
| LLVM_ABI const Value * | stripPointerCastsAndAliases () const |
| Strip off pointer casts, all-zero GEPs, address space casts, and aliases. | |
| Value * | stripPointerCastsAndAliases () |
| LLVM_ABI const Value * | stripPointerCastsSameRepresentation () const |
| Strip off pointer casts, all-zero GEPs and address space casts but ensures the representation of the result stays the same. | |
| Value * | stripPointerCastsSameRepresentation () |
| LLVM_ABI const Value * | stripPointerCastsForAliasAnalysis () const |
| Strip off pointer casts, all-zero GEPs, single-argument phi nodes and invariant group info. | |
| Value * | stripPointerCastsForAliasAnalysis () |
| LLVM_ABI const Value * | stripInBoundsConstantOffsets () const |
| Strip off pointer casts and all-constant inbounds GEPs. | |
| Value * | stripInBoundsConstantOffsets () |
| LLVM_ABI const Value * | stripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr, bool LookThroughIntToPtr=false) const |
| Accumulate the constant offset this value has compared to a base pointer. | |
| Value * | stripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr, bool LookThroughIntToPtr=false) |
| const Value * | stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const |
| This is a wrapper around stripAndAccumulateConstantOffsets with the in-bounds requirement set to false. | |
| Value * | stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) |
| LLVM_ABI const Value * | stripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {}) const |
| Strip off pointer casts and inbounds GEPs. | |
| Value * | stripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {}) |
| LLVM_ABI 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. | |
| LLVM_ABI 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. | |
| LLVM_ABI uint64_t | getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull, bool &CanBeFreed) const |
| Returns the number of bytes known to be dereferenceable for the pointer value. | |
| LLVM_ABI Align | getPointerAlignment (const DataLayout &DL) const |
| Returns an alignment of the pointer value. | |
| LLVM_ABI const Value * | DoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const |
| Translate PHI node to its predecessor from the given basic block. | |
| Value * | DoPHITranslation (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. | |
| LLVM_ABI void | reverseUseList () |
| Reverse the use-list. | |
| LLVM_ABI void | print (raw_ostream &O, bool IsForDebug=false) const |
| Implement operator<< on Value. | |
| LLVM_ABI void | print (raw_ostream &O, ModuleSlotTracker &MST, bool IsForDebug=false) const |
| LLVM_ABI 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. | |
| LLVM_ABI void | printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const |
Static Public Member Functions | |
| static bool | classof (const Value *V) |
| Method for support type inquiry through isa, cast, and dyn_cast. | |
| Static Public Member Functions inherited from llvm::Value | |
| static LLVM_ABI void | dropDroppableUse (Use &U) |
Remove the droppable use U. | |
Friends | |
| class | Function |
Additional Inherited Members | |
| 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 constexpr unsigned | MaxAlignmentExponent = 32 |
| The maximum alignment for instructions. | |
| static constexpr uint64_t | MaximumAlignment = 1ULL << MaxAlignmentExponent |
| Protected Types inherited from llvm::Value | |
| enum | : unsigned { NumUserOperandsBits = 27 } |
| The number of operands in the subclass. More... | |
| Protected Member Functions inherited from llvm::Value | |
| LLVM_ABI | Value (Type *Ty, unsigned scid) |
| LLVM_ABI | ~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. | |
| LLVM_ABI 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. | |
| LLVM_ABI bool | eraseMetadata (unsigned KindID) |
| Erase all metadata attachments with the given kind. | |
| LLVM_ABI void | eraseMetadataIf (function_ref< bool(unsigned, MDNode *)> Pred) |
| Erase all metadata attachments matching the given predicate. | |
| LLVM_ABI void | clearMetadata () |
| Erase all metadata attached to this Value. | |
| LLVM_ABI MDNode * | getMetadataImpl (unsigned KindID) const |
| Get metadata for the given kind, if any. | |
| unsigned short | getSubclassDataFromValue () const |
| void | setValueSubclassData (unsigned short D) |
| MDNode * | getMetadata (unsigned KindID) const |
| Get the current metadata attachments for the given kind, if any. | |
| LLVM_ABI MDNode * | getMetadata (StringRef Kind) const |
| LLVM_ABI void | getMetadata (unsigned KindID, SmallVectorImpl< MDNode * > &MDs) const |
Appends all attachments with the given ID to MDs in insertion order. | |
| LLVM_ABI 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 |
| LLVM_ABI void | setMetadata (unsigned KindID, MDNode *Node) |
| Set a particular kind of metadata attachment. | |
| LLVM_ABI void | setMetadata (StringRef Kind, MDNode *Node) |
| LLVM_ABI void | addMetadata (unsigned KindID, MDNode &MD) |
| Add a metadata attachment. | |
| LLVM_ABI void | addMetadata (StringRef Kind, MDNode &MD) |
| 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 |
Detailed Description
This class represents an incoming formal argument to a Function.
A formal argument, since it is `‘formal’', does not contain an actual value but instead represents the type, argument number, and attributes of an argument for a specific function. When used in the body of said function, the argument of course represents the value of the actual argument that the function was called with.
Definition at line 32 of file Argument.h.
Constructor & Destructor Documentation
◆ Argument()
|
explicit |
Argument constructor.
Definition at line 106 of file Function.cpp.
Member Function Documentation
◆ addAttr() [1/2]
| void Argument::addAttr | ( | Attribute | Attr | ) |
Definition at line 325 of file Function.cpp.
◆ addAttr() [2/2]
| void Argument::addAttr | ( | Attribute::AttrKind | Kind | ) |
Definition at line 321 of file Function.cpp.
Referenced by adjustByValArgAlignment(), and LLVM_DEPRECATED().
◆ addAttrs()
| void Argument::addAttrs | ( | AttrBuilder & | B | ) |
Add attributes to an argument.
Definition at line 315 of file Function.cpp.
Referenced by LLVM_DEPRECATED().
◆ classof()
Method for support type inquiry through isa, cast, and dyn_cast.
Definition at line 192 of file Argument.h.
References classof(), const, and llvm::Value::Value().
Referenced by classof().
◆ getArgNo()
|
inline |
Return the index of this formal argument in its containing function.
For example in "void foo(int a, float b)" a is 0 and b is 1.
Definition at line 50 of file Argument.h.
References assert().
Referenced by AddParamAndFnBasicAttributes(), createOutlinedFunction(), llvm::AMDGPU::HSAMD::MetadataStreamerMsgPackV4::emitKernelArg(), findArgParts(), llvm::AbstractCallSite::getCallArgOperand(), llvm::AbstractCallSite::getCallArgOperandNo(), isArgUnmodifiedByAllCalls(), and llvm::Attributor::registerFunctionSignatureRewrite().
◆ getAttribute()
| Attribute Argument::getAttribute | ( | Attribute::AttrKind | Kind | ) | const |
Definition at line 347 of file Function.cpp.
Referenced by LLVM_DEPRECATED().
◆ getAttributes()
| AttributeSet Argument::getAttributes | ( | ) | const |
Definition at line 351 of file Function.cpp.
Referenced by llvm::isParamGridConstant(), and LLVM_DEPRECATED().
◆ getDereferenceableBytes()
| uint64_t Argument::getDereferenceableBytes | ( | ) | const |
If this argument has the dereferenceable attribute, return the number of bytes known to be dereferenceable.
Otherwise, zero is returned.
Definition at line 245 of file Function.cpp.
◆ getDereferenceableOrNullBytes()
| uint64_t Argument::getDereferenceableOrNullBytes | ( | ) | const |
If this argument has the dereferenceable_or_null attribute, return the number of bytes known to be dereferenceable.
Otherwise, zero is returned.
Definition at line 251 of file Function.cpp.
◆ getNoFPClass()
| FPClassTest Argument::getNoFPClass | ( | ) | const |
If this argument has nofpclass attribute, return the mask representing disallowed floating-point values.
Otherwise, fcNone is returned.
Definition at line 257 of file Function.cpp.
◆ getParamAlign()
| MaybeAlign Argument::getParamAlign | ( | ) | const |
If this is a byval or inalloca argument, return its alignment.
Definition at line 216 of file Function.cpp.
Referenced by adjustByValArgAlignment(), createNVVMInternalAddrspaceWrap(), llvm::AMDGPU::HSAMD::MetadataStreamerMsgPackV4::emitKernelArg(), findArgParts(), getArgumentTypeAlign(), and LLVM_DEPRECATED().
◆ getParamByRefType()
| Type * Argument::getParamByRefType | ( | ) | const |
If this is a byref argument, return its type.
Definition at line 235 of file Function.cpp.
Referenced by llvm::AMDGPU::HSAMD::MetadataStreamerMsgPackV4::emitKernelArg(), getArgumentTypeAlign(), llvm::getPointeeTypeByAttr(), and LLVM_DEPRECATED().
◆ getParamByValType()
| Type * Argument::getParamByValType | ( | ) | const |
If this is a byval argument, return its type.
Definition at line 225 of file Function.cpp.
Referenced by adjustByValArgAlignment(), findArgParts(), llvm::getPointeeTypeByAttr(), handleByValParam(), and LLVM_DEPRECATED().
◆ getParamInAllocaType()
| Type * Argument::getParamInAllocaType | ( | ) | const |
If this is an inalloca argument, return its type.
Definition at line 240 of file Function.cpp.
Referenced by LLVM_DEPRECATED().
◆ getParamStackAlign()
| MaybeAlign Argument::getParamStackAlign | ( | ) | const |
Definition at line 221 of file Function.cpp.
Referenced by LLVM_DEPRECATED().
◆ getParamStructRetType()
| Type * Argument::getParamStructRetType | ( | ) | const |
If this is an sret argument, return its type.
Definition at line 230 of file Function.cpp.
Referenced by llvm::getPointeeTypeByAttr(), and LLVM_DEPRECATED().
◆ getParent() [1/2]
|
inline |
Definition at line 45 of file Argument.h.
References Function.
◆ getParent() [2/2]
Definition at line 44 of file Argument.h.
References Function.
Referenced by adjustByValArgAlignment(), allCallersPassValidPointerForArgument(), llvm::AMDGPU::HSAMD::MetadataStreamerMsgPackV4::emitKernelArg(), findArgParts(), handleByValParam(), isArgUnmodifiedByAllCalls(), llvm::InformationCache::isInvolvedInMustTailCall(), llvm::isParamGridConstant(), llvm::Attributor::isValidFunctionSignatureRewrite(), llvm::SITargetLowering::LowerFormalArguments(), markPointerAsAS(), and llvm::Attributor::registerFunctionSignatureRewrite().
◆ getPassPointeeByValueCopySize()
| uint64_t Argument::getPassPointeeByValueCopySize | ( | const DataLayout & | DL | ) | const |
If this argument satisfies has hasPassPointeeByValueAttr, return the in-memory ABI size copied to the stack for the call.
Otherwise, return 0.
Definition at line 202 of file Function.cpp.
◆ getPointeeInMemoryValueType()
| Type * Argument::getPointeeInMemoryValueType | ( | ) | const |
If hasPointeeInMemoryValueAttr returns true, the in-memory ABI type is returned.
Otherwise, nullptr.
Definition at line 210 of file Function.cpp.
◆ getRange()
| std::optional< ConstantRange > Argument::getRange | ( | ) | const |
If this argument has a range attribute, return the value range of the argument.
Otherwise, std::nullopt is returned.
Definition at line 261 of file Function.cpp.
◆ hasAttribute() [1/2]
| bool Argument::hasAttribute | ( | Attribute::AttrKind | Kind | ) | const |
Check if an argument has a given attribute.
Definition at line 339 of file Function.cpp.
Referenced by llvm::AMDGPU::HSAMD::MetadataStreamerMsgPackV4::emitKernelArg(), llvm::isParamGridConstant(), LLVM_DEPRECATED(), and llvm::SITargetLowering::LowerFormalArguments().
◆ hasAttribute() [2/2]
Definition at line 343 of file Function.cpp.
◆ hasByRefAttr()
| bool Argument::hasByRefAttr | ( | ) | const |
Return true if this argument has the byref attribute.
Definition at line 139 of file Function.cpp.
Referenced by llvm::AMDGPU::HSAMD::MetadataStreamerMsgPackV4::emitKernelArg(), getArgumentTypeAlign(), llvm::getPointeeTypeByAttr(), and llvm::hasPointeeTypeAttr().
◆ hasByValAttr()
| bool Argument::hasByValAttr | ( | ) | const |
Return true if this argument has the byval attribute.
Definition at line 128 of file Function.cpp.
Referenced by copyFunctionByValArgs(), llvm::getPointeeTypeByAttr(), llvm::hasPointeeTypeAttr(), llvm::isParamGridConstant(), runOnDeviceFunction(), and runOnKernelFunction().
◆ hasDeadOnReturnAttr()
| bool Argument::hasDeadOnReturnAttr | ( | ) | const |
Return true if this argument has the dead_on_return attribute.
Definition at line 133 of file Function.cpp.
◆ hasInAllocaAttr()
| bool Argument::hasInAllocaAttr | ( | ) | const |
Return true if this argument has the inalloca attribute.
Definition at line 153 of file Function.cpp.
Referenced by LLVM_DEPRECATED().
◆ hasInRegAttr()
| bool Argument::hasInRegAttr | ( | ) | const |
Return true if this argument has the inreg attribute.
Definition at line 293 of file Function.cpp.
Referenced by LLVM_DEPRECATED().
◆ hasNestAttr()
| bool Argument::hasNestAttr | ( | ) | const |
Return true if this argument has the nest attribute.
Definition at line 268 of file Function.cpp.
Referenced by LLVM_DEPRECATED().
◆ hasNoAliasAttr()
| bool Argument::hasNoAliasAttr | ( | ) | const |
Return true if this argument has the noalias attribute.
Definition at line 273 of file Function.cpp.
Referenced by llvm::AMDGPU::HSAMD::MetadataStreamerMsgPackV4::emitKernelArg(), and LLVM_DEPRECATED().
◆ hasNoCaptureAttr()
| bool Argument::hasNoCaptureAttr | ( | ) | const |
Return true if this argument has the nocapture attribute.
Definition at line 278 of file Function.cpp.
Referenced by LLVM_DEPRECATED().
◆ hasNoFreeAttr()
| bool Argument::hasNoFreeAttr | ( | ) | const |
Return true if this argument has the nofree attribute.
Definition at line 283 of file Function.cpp.
Referenced by LLVM_DEPRECATED().
◆ hasNonNullAttr()
Return true if this argument has the nonnull attribute.
Also returns true if at least one byte is known to be dereferenceable and the pointer is in addrspace(0). If AllowUndefOrPoison is true, respect the semantics of nonnull attribute and return true even if the argument can be undef or poison.
Definition at line 115 of file Function.cpp.
◆ hasPassPointeeByValueCopyAttr()
| bool Argument::hasPassPointeeByValueCopyAttr | ( | ) | const |
Return true if this argument has the byval, inalloca, or preallocated attribute.
These attributes represent arguments being passed by value, with an associated copy between the caller and callee
Definition at line 164 of file Function.cpp.
◆ hasPointeeInMemoryValueAttr()
| bool Argument::hasPointeeInMemoryValueAttr | ( | ) | const |
Return true if this argument has the byval, sret, inalloca, preallocated, or byref attribute.
These attributes represent arguments being passed by value (which may or may not involve a stack copy)
Definition at line 172 of file Function.cpp.
◆ hasPreallocatedAttr()
| bool Argument::hasPreallocatedAttr | ( | ) | const |
Return true if this argument has the preallocated attribute.
Definition at line 158 of file Function.cpp.
Referenced by LLVM_DEPRECATED().
◆ hasReturnedAttr()
| bool Argument::hasReturnedAttr | ( | ) | const |
Return true if this argument has the returned attribute.
Definition at line 297 of file Function.cpp.
Referenced by LLVM_DEPRECATED().
◆ hasSExtAttr()
| bool Argument::hasSExtAttr | ( | ) | const |
Return true if this argument has the sext attribute.
Definition at line 305 of file Function.cpp.
Referenced by LLVM_DEPRECATED().
◆ hasStructRetAttr()
| bool Argument::hasStructRetAttr | ( | ) | const |
Return true if this argument has the sret attribute.
Definition at line 288 of file Function.cpp.
Referenced by llvm::getPointeeTypeByAttr(), llvm::hasPointeeTypeAttr(), and LLVM_DEPRECATED().
◆ hasSwiftErrorAttr()
| bool Argument::hasSwiftErrorAttr | ( | ) | const |
Return true if this argument has the swifterror attribute.
Definition at line 149 of file Function.cpp.
◆ hasSwiftSelfAttr()
| bool Argument::hasSwiftSelfAttr | ( | ) | const |
Return true if this argument has the swiftself attribute.
Definition at line 145 of file Function.cpp.
◆ hasZExtAttr()
| bool Argument::hasZExtAttr | ( | ) | const |
Return true if this argument has the zext attribute.
Definition at line 301 of file Function.cpp.
Referenced by LLVM_DEPRECATED().
◆ LLVM_DEPRECATED()
| LLVM_ABI llvm::Argument::LLVM_DEPRECATED | ( | "Use getParamAlign() instead" | , |
| "getParamAlign" | ) const |
If this is a byval or inalloca argument, return its alignment.
FIXME: Remove this function once transition to Align is over. Use getParamAlign() instead.
References addAttr(), addAttrs(), B(), const, getAttribute(), getAttributes(), getParamAlign(), getParamByRefType(), getParamByValType(), getParamInAllocaType(), getParamStackAlign(), getParamStructRetType(), hasAttribute(), hasInAllocaAttr(), hasInRegAttr(), hasNestAttr(), hasNoAliasAttr(), hasNoCaptureAttr(), hasNoFreeAttr(), hasPreallocatedAttr(), hasReturnedAttr(), hasSExtAttr(), hasStructRetAttr(), hasZExtAttr(), LLVM_ABI, onlyReadsMemory(), removeAttr(), and removeAttrs().
◆ onlyReadsMemory()
| bool Argument::onlyReadsMemory | ( | ) | const |
Return true if this argument has the readonly or readnone attribute.
Definition at line 309 of file Function.cpp.
Referenced by llvm::AMDGPU::HSAMD::MetadataStreamerMsgPackV4::emitKernelArg(), llvm::isParamGridConstant(), and LLVM_DEPRECATED().
◆ removeAttr()
| void Argument::removeAttr | ( | Attribute::AttrKind | Kind | ) |
Remove attributes from an argument.
Definition at line 329 of file Function.cpp.
Referenced by adjustByValArgAlignment(), and LLVM_DEPRECATED().
◆ removeAttrs()
| void Argument::removeAttrs | ( | const AttributeMask & | AM | ) |
Definition at line 333 of file Function.cpp.
Referenced by LLVM_DEPRECATED().
Friends And Related Symbol Documentation
◆ Function
|
friend |
Definition at line 36 of file Argument.h.
References F, Function, and LLVM_ABI.
Referenced by Function, getParent(), and getParent().
The documentation for this class was generated from the following files:
- include/llvm/IR/Argument.h
- lib/SandboxIR/Function.cpp
Generated on for LLVM by
1.14.0