#include "llvm/IR/Attributes.h"

Public Types
enum	AttrKind { None, EndAttrKinds }
	This enumeration lists the attributes that can be associated with parameters, function results, or the function itself. More...

Public Member Functions
	Attribute ()=default

bool	isEnumAttribute () const
	Return true if the attribute is an Attribute::AttrKind type. More...

bool	isIntAttribute () const
	Return true if the attribute is an integer attribute. More...

bool	isStringAttribute () const
	Return true if the attribute is a string (target-dependent) attribute. More...

bool	hasAttribute (AttrKind Val) const
	Return true if the attribute is present. More...

bool	hasAttribute (StringRef Val) const
	Return true if the target-dependent attribute is present. More...

Attribute::AttrKind	getKindAsEnum () const
	Return the attribute's kind as an enum (Attribute::AttrKind). More...

uint64_t	getValueAsInt () const
	Return the attribute's value as an integer. More...

StringRef	getKindAsString () const
	Return the attribute's kind as a string. More...

StringRef	getValueAsString () const
	Return the attribute's value as a string. More...

unsigned	getAlignment () const
	Returns the alignment field of an attribute as a byte alignment value. More...

unsigned	getStackAlignment () const
	Returns the stack alignment field of an attribute as a byte alignment value. More...

uint64_t	getDereferenceableBytes () const
	Returns the number of dereferenceable bytes from the dereferenceable attribute. More...

uint64_t	getDereferenceableOrNullBytes () const
	Returns the number of dereferenceable_or_null bytes from the dereferenceable_or_null attribute. More...

std::pair< unsigned, Optional< unsigned > >	getAllocSizeArgs () const
	Returns the argument numbers for the allocsize attribute (or pair(0, 0) if not known). More...

std::string	getAsString (bool InAttrGrp=false) const
	The Attribute is converted to a string of equivalent mnemonic. More...

bool	operator== (Attribute A) const
	Equality and non-equality operators. More...

bool	operator!= (Attribute A) const

bool	operator< (Attribute A) const
	Less-than operator. Useful for sorting the attributes list. More...

void	Profile (FoldingSetNodeID &ID) const

void *	getRawPointer () const
	Return a raw pointer that uniquely identifies this attribute. More...

Static Public Member Functions
static Attribute	get (LLVMContext &Context, AttrKind Kind, uint64_t Val=0)
	Return a uniquified Attribute object. More...

static Attribute	get (LLVMContext &Context, StringRef Kind, StringRef Val=StringRef())

static Attribute	getWithAlignment (LLVMContext &Context, uint64_t Align)
	Return a uniquified Attribute object that has the specific alignment set. More...

static Attribute	getWithStackAlignment (LLVMContext &Context, uint64_t Align)

static Attribute	getWithDereferenceableBytes (LLVMContext &Context, uint64_t Bytes)

static Attribute	getWithDereferenceableOrNullBytes (LLVMContext &Context, uint64_t Bytes)

static Attribute	getWithAllocSizeArgs (LLVMContext &Context, unsigned ElemSizeArg, const Optional< unsigned > &NumElemsArg)

static Attribute	fromRawPointer (void *RawPtr)
	Get an attribute from a raw pointer created by getRawPointer. More...

Detailed Description

Definition at line 50 of file Attributes.h.

Member Enumeration Documentation

◆ AttrKind

enum llvm::Attribute::AttrKind

This enumeration lists the attributes that can be associated with parameters, function results, or the function itself.

Note: The `uwtable' attribute is about the ABI or the user mandating an entry in the unwind table. The `nounwind' attribute is about an exception passing by the function.

In a theoretical system that uses tables for profiling and SjLj for exceptions, they would be fully independent. In a normal system that uses tables for both, the semantics are:

nil = Needs an entry because an exception might pass by. nounwind = No need for an entry uwtable = Needs an entry because the ABI says so and because an exception might pass by. uwtable + nounwind = Needs an entry because the ABI says so.

Enumerator
None	No attributes have been set.
EndAttrKinds	Sentinal value useful for loops.

Definition at line 69 of file Attributes.h.

Constructor & Destructor Documentation

◆ Attribute()

llvm::Attribute::Attribute ( )

default

Referenced by fromRawPointer(), get(), and llvm::AttributeSet::getAttribute().

Member Function Documentation

◆ fromRawPointer()

static Attribute llvm::Attribute::fromRawPointer ( void * RawPtr )

inlinestatic

Get an attribute from a raw pointer created by getRawPointer.

Definition at line 183 of file Attributes.h.

References Attribute().

Referenced by llvm::unwrap().

◆ get() [1/2]

Attribute Attribute::get	(	LLVMContext &	Context,
		Attribute::AttrKind	Kind,
		uint64_t	Val = `0`
	)

static

Return a uniquified Attribute object.

Definition at line 80 of file Attributes.cpp.

References llvm::FoldingSetNodeID::AddInteger(), Attribute(), llvm::LLVMContextImpl::AttrsSet, and llvm::LLVMContext::pImpl.

Referenced by llvm::Function::addFnAttr(), findInitTrampoline(), llvm::AttributeSetNode::get(), llvm::AttributeList::get(), LLVMAddTargetDependentFunctionAttr(), LLVMCreateEnumAttribute(), LLVMCreateStringAttribute(), LLVMRemarkParserGetErrorMessage(), LLVMRemarkParserHasError(), processCallSite(), RemoveNonValidAttrAtIndex(), llvm::WholeProgramDevirtPass::run(), and setInlineRemark().

◆ get() [2/2]

Attribute Attribute::get	(	LLVMContext &	Context,
		StringRef	Kind,
		StringRef	Val = `StringRef()`
	)

static

Definition at line 104 of file Attributes.cpp.

References llvm::FoldingSetNodeID::AddString(), Attribute(), llvm::LLVMContextImpl::AttrsSet, llvm::StringRef::empty(), and llvm::LLVMContext::pImpl.

◆ getAlignment()

unsigned Attribute::getAlignment ( ) const

Returns the alignment field of an attribute as a byte alignment value.

Definition at line 210 of file Attributes.cpp.

References assert(), llvm::AttributeImpl::getValueAsInt(), and hasAttribute().

Referenced by llvm::AttrBuilder::addAttribute(), and llvm::AttributeSet::hasAttributes().

◆ getAllocSizeArgs()

std::pair< unsigned, Optional< unsigned > > Attribute::getAllocSizeArgs ( ) const

Returns the argument numbers for the allocsize attribute (or pair(0, 0) if not known).

Definition at line 236 of file Attributes.cpp.

References assert(), llvm::AttributeImpl::getValueAsInt(), hasAttribute(), and unpackAllocSizeArgs().

Referenced by getAllocationSize(), getAsString(), llvm::AttrBuilder::getDereferenceableOrNullBytes(), llvm::AttributeList::getParamDereferenceableOrNullBytes(), and llvm::AttributeSet::hasAttributes().

◆ getAsString()

std::string Attribute::getAsString ( bool InAttrGrp = false ) const

The Attribute is converted to a string of equivalent mnemonic.

This is, presumably, for writing out the mnemonics for the assembly writer.

Definition at line 242 of file Attributes.cpp.

References llvm::CallingConv::Cold, llvm::MCID::Convergent, getAllocSizeArgs(), getKindAsString(), getValueAsInt(), llvm::AttributeImpl::getValueAsString(), hasAttribute(), llvm::Optional< T >::hasValue(), isStringAttribute(), llvm::ISD::JumpTable, llvm_unreachable, Name, llvm::NoAlias, llvm::printEscapedString(), and llvm::utostr().

Referenced by llvm::AttributeSet::dump(), llvm::AttributeList::getParamDereferenceableOrNullBytes(), and llvm::AttributeSet::hasAttributes().

◆ getDereferenceableBytes()

uint64_t Attribute::getDereferenceableBytes ( ) const

Returns the number of dereferenceable bytes from the dereferenceable attribute.

Definition at line 222 of file Attributes.cpp.

References assert(), llvm::AttributeImpl::getValueAsInt(), and hasAttribute().

Referenced by llvm::AttrBuilder::addAttribute(), llvm::AttributeList::getParamAttr(), llvm::AttributeList::getParamDereferenceableBytes(), and llvm::AttributeSet::hasAttributes().

◆ getDereferenceableOrNullBytes()

uint64_t Attribute::getDereferenceableOrNullBytes ( ) const

Returns the number of dereferenceable_or_null bytes from the dereferenceable_or_null attribute.

Definition at line 229 of file Attributes.cpp.

References assert(), llvm::AttributeImpl::getValueAsInt(), and hasAttribute().

Referenced by llvm::AttrBuilder::addAttribute(), llvm::AttributeList::getParamDereferenceableBytes(), llvm::AttributeList::getParamDereferenceableOrNullBytes(), and llvm::AttributeSet::hasAttributes().

◆ getKindAsEnum()

Attribute::AttrKind Attribute::getKindAsEnum ( ) const

Return the attribute's kind as an enum (Attribute::AttrKind).

This requires the attribute to be an enum or integer attribute.

Definition at line 173 of file Attributes.cpp.

References assert(), llvm::AttributeImpl::getKindAsEnum(), isEnumAttribute(), isIntAttribute(), and None.

Referenced by llvm::AttrBuilder::addAttribute(), llvm::AttributeImpl::hasAttribute(), LLVMGetEnumAttributeKind(), and llvm::AttributeImpl::operator<().

◆ getKindAsString()

StringRef Attribute::getKindAsString ( ) const

Return the attribute's kind as a string.

This requires the attribute to be a string attribute.

Definition at line 187 of file Attributes.cpp.

References assert(), llvm::AttributeImpl::getKindAsString(), and isStringAttribute().

Referenced by llvm::AttrBuilder::addAttribute(), getAsString(), llvm::AttributeImpl::hasAttribute(), LLVMGetStringAttributeKind(), and llvm::AttributeImpl::operator<().

◆ getRawPointer()

void* llvm::Attribute::getRawPointer ( ) const

inline

Return a raw pointer that uniquely identifies this attribute.

Definition at line 178 of file Attributes.h.

Referenced by llvm::wrap().

◆ getStackAlignment()

unsigned Attribute::getStackAlignment ( ) const

Returns the stack alignment field of an attribute as a byte alignment value.

Definition at line 216 of file Attributes.cpp.

References assert(), llvm::AttributeImpl::getValueAsInt(), and hasAttribute().

Referenced by llvm::AttrBuilder::addAttribute(), llvm::AttributeList::getParamAttr(), and llvm::AttributeSet::hasAttributes().

◆ getValueAsInt()

uint64_t Attribute::getValueAsInt ( ) const

Return the attribute's value as an integer.

This requires that the attribute be an integer attribute.

Definition at line 180 of file Attributes.cpp.

References assert(), llvm::AttributeImpl::getValueAsInt(), and isIntAttribute().

Referenced by llvm::AttrBuilder::addAttribute(), getAsString(), and llvm::AttributeImpl::operator<().

◆ getValueAsString()

StringRef Attribute::getValueAsString ( ) const

Return the attribute's value as a string.

This requires the attribute to be a string attribute.

Definition at line 194 of file Attributes.cpp.

References assert(), llvm::AttributeImpl::getValueAsString(), and isStringAttribute().

Referenced by llvm::AttrBuilder::addAttribute(), adjustCallerStackProbeSize(), adjustMinLegalVectorWidth(), llvm::NVPTXTargetLowering::allowUnsafeFPMath(), llvm::TargetLoweringBase::areJTsAllowed(), checkFunctionsAttributeConsistency(), CheckMACMemory(), llvm::TargetOptions::DisableFramePointerElim(), doesNotGeneratecode(), eliminateTailRecursion(), llvm::AMDGPU::HSAMD::MetadataStreamerV2::emitKernel(), llvm::MipsSEFrameLowering::emitPrologue(), llvm::X86FrameLowering::emitPrologue(), FixedPointIntrinsicToOpcode(), foldFPToIntToFP(), llvm::ARMBaseRegisterInfo::getCalleeSavedRegs(), llvm::sampleprof::FunctionSamples::getCanonicalFnName(), getDeoptLowering(), llvm::TargetLoweringObjectFileELF::getExplicitSectionGlobal(), llvm::AMDGPUTargetMachine::getFeatureString(), llvm::AMDGPUTargetMachine::getGPUName(), llvm::AMDGPU::getIntegerAttribute(), llvm::AMDGPU::getIntegerPairAttribute(), getRecipEstimateForFunc(), llvm::X86TargetLowering::getStackProbeSymbolName(), getSubOpcode(), llvm::HexagonTargetMachine::getSubtargetImpl(), llvm::SparcTargetMachine::getSubtargetImpl(), llvm::AArch64TargetMachine::getSubtargetImpl(), llvm::WebAssemblyTargetMachine::getSubtargetImpl(), llvm::X86TargetMachine::getSubtargetImpl(), llvm::PPCTargetMachine::getSubtargetImpl(), llvm::ARMBaseTargetMachine::getSubtargetImpl(), llvm::MipsTargetMachine::getSubtargetImpl(), hasUnsafeFPMath(), llvm::RecurrenceDescriptor::isReductionPHI(), isThumbFunction(), llvm::LoopVectorizationLegality::isUniform(), llvm::AMDGPULibCalls::isUnsafeMath(), LLVMGetStringAttributeValue(), LowerInterruptReturn(), llvm::AttributeImpl::operator<(), llvm::parseStatepointDirectivesFromAttrs(), llvm::TargetMachine::resetTargetOptions(), RetagMask(), llvm::WholeProgramDevirtPass::run(), runOnFunction(), llvm::StackProtector::runOnFunction(), ShouldSignReturnAddress(), ShouldSignWithAKey(), llvm::SIMachineFunctionInfo::SIMachineFunctionInfo(), llvm::AMDGPU::SIModeRegisterDefaults::SIModeRegisterDefaults(), SimplifyNVVMIntrinsic(), unpackF64OnRV32DSoftABI(), llvm::NVPTXTargetLowering::useF32FTZ(), WindowsRequiresStackProbe(), and windowsRequiresStackProbe().

◆ getWithAlignment()

Attribute Attribute::getWithAlignment	(	LLVMContext &	Context,
		uint64_t	Align
	)

static

Return a uniquified Attribute object that has the specific alignment set.

Definition at line 124 of file Attributes.cpp.

References llvm::AMDGPU::HSAMD::Kernel::Arg::Key::Align, assert(), Context, and llvm::isPowerOf2_32().

Referenced by llvm::IRBuilderBase::CreateElementUnorderedAtomicMemMove(), llvm::AttributeSetNode::get(), LLVMSetInstrParamAlignment(), LLVMSetParamAlignment(), llvm::MemIntrinsicBase< AnyMemIntrinsic >::setDestAlignment(), and llvm::MemTransferBase< AnyMemIntrinsic >::setSourceAlignment().

◆ getWithAllocSizeArgs()

Attribute Attribute::getWithAllocSizeArgs	(	LLVMContext &	Context,
		unsigned	ElemSizeArg,
		const Optional< unsigned > &	NumElemsArg
	)

static

Definition at line 150 of file Attributes.cpp.

References assert(), Context, and packAllocSizeArgs().

Referenced by llvm::AttributeSetNode::get().

◆ getWithDereferenceableBytes()

Attribute Attribute::getWithDereferenceableBytes	(	LLVMContext &	Context,
		uint64_t	Bytes
	)

static

Definition at line 137 of file Attributes.cpp.

References assert(), and Context.

Referenced by llvm::AttributeSetNode::get().

◆ getWithDereferenceableOrNullBytes()

Attribute Attribute::getWithDereferenceableOrNullBytes	(	LLVMContext &	Context,
		uint64_t	Bytes
	)

static

Definition at line 143 of file Attributes.cpp.

References assert(), and Context.

Referenced by llvm::AttributeSetNode::get().

◆ getWithStackAlignment()

Attribute Attribute::getWithStackAlignment	(	LLVMContext &	Context,
		uint64_t	Align
	)

static

Definition at line 130 of file Attributes.cpp.

References llvm::AMDGPU::HSAMD::Kernel::Arg::Key::Align, assert(), Context, and llvm::isPowerOf2_32().

Referenced by llvm::AttributeSetNode::get().

◆ hasAttribute() [1/2]

bool Attribute::hasAttribute ( AttrKind Val ) const

Return true if the attribute is present.

Definition at line 201 of file Attributes.cpp.

References llvm::AttributeImpl::hasAttribute(), and None.

◆ hasAttribute() [2/2]

bool Attribute::hasAttribute ( StringRef Val ) const

Return true if the target-dependent attribute is present.

Definition at line 205 of file Attributes.cpp.

References llvm::AttributeImpl::hasAttribute(), and isStringAttribute().

◆ isEnumAttribute()

bool Attribute::isEnumAttribute ( ) const

Return true if the attribute is an Attribute::AttrKind type.

Definition at line 161 of file Attributes.cpp.

References llvm::AttributeImpl::isEnumAttribute().

Referenced by llvm::AttributeImpl::getKindAsEnum(), getKindAsEnum(), and llvm::AttributeImpl::operator<().

◆ isIntAttribute()

bool Attribute::isIntAttribute ( ) const

Return true if the attribute is an integer attribute.

Definition at line 165 of file Attributes.cpp.

References llvm::AttributeImpl::isIntAttribute().

Referenced by llvm::AttributeImpl::getKindAsEnum(), getKindAsEnum(), llvm::AttributeImpl::getValueAsInt(), getValueAsInt(), and llvm::AttributeImpl::operator<().

◆ isStringAttribute()

bool Attribute::isStringAttribute ( ) const

Return true if the attribute is a string (target-dependent) attribute.

Definition at line 169 of file Attributes.cpp.

References llvm::AttributeImpl::isStringAttribute().

Referenced by llvm::AttrBuilder::addAttribute(), getAsString(), llvm::AMDGPU::getIntegerAttribute(), llvm::AMDGPU::getIntegerPairAttribute(), llvm::AttributeImpl::getKindAsString(), getKindAsString(), llvm::AttributeImpl::getValueAsString(), getValueAsString(), llvm::AttributeImpl::hasAttribute(), hasAttribute(), LLVMIsStringAttribute(), llvm::parseStatepointDirectivesFromAttrs(), and llvm::StackProtector::runOnFunction().

◆ operator!=()

bool llvm::Attribute::operator!= ( Attribute A ) const

inline

Definition at line 168 of file Attributes.h.

References operator<().

◆ operator<()

bool Attribute::operator< ( Attribute A ) const

Less-than operator. Useful for sorting the attributes list.

Definition at line 434 of file Attributes.cpp.

References llvm::AttributeImpl::~AttributeImpl().

Referenced by operator!=().

◆ operator==()

bool llvm::Attribute::operator== ( Attribute A ) const

inline

Equality and non-equality operators.

Definition at line 167 of file Attributes.h.

Referenced by llvm::AttrBuilder::td_empty().

◆ Profile()

void llvm::Attribute::Profile ( FoldingSetNodeID & ID ) const

inline

Definition at line 173 of file Attributes.h.

References llvm::FoldingSetNodeID::AddPointer().

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

include/llvm/IR/Attributes.h
lib/IR/Attributes.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ AttrKind

Constructor & Destructor Documentation

◆ Attribute()

Member Function Documentation

◆ fromRawPointer()

◆ get() [1/2]

◆ get() [2/2]

◆ getAlignment()

◆ getAllocSizeArgs()

◆ getAsString()

◆ getDereferenceableBytes()

◆ getDereferenceableOrNullBytes()

◆ getKindAsEnum()

◆ getKindAsString()

◆ getRawPointer()

◆ getStackAlignment()

◆ getValueAsInt()

◆ getValueAsString()

◆ getWithAlignment()

◆ getWithAllocSizeArgs()

◆ getWithDereferenceableBytes()

◆ getWithDereferenceableOrNullBytes()

◆ getWithStackAlignment()

◆ hasAttribute() [1/2]

◆ hasAttribute() [2/2]

◆ isEnumAttribute()

◆ isIntAttribute()

◆ isStringAttribute()

◆ operator!=()

◆ operator<()

◆ operator==()

◆ Profile()