LLVM 20.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
llvm::AttributeSet Class Reference

#include "llvm/IR/Attributes.h"

Public Types

using iterator = const Attribute *
 

Public Member Functions

 AttributeSet ()=default
 AttributeSet is a trivially copyable value type.
 
 AttributeSet (const AttributeSet &)=default
 
 ~AttributeSet ()=default
 
bool operator== (const AttributeSet &O) const
 
bool operator!= (const AttributeSet &O) const
 
AttributeSet addAttribute (LLVMContext &C, Attribute::AttrKind Kind) const
 Add an argument attribute.
 
AttributeSet addAttribute (LLVMContext &C, StringRef Kind, StringRef Value=StringRef()) const
 Add a target-dependent attribute.
 
AttributeSet addAttributes (LLVMContext &C, AttributeSet AS) const
 Add attributes to the attribute set.
 
AttributeSet removeAttribute (LLVMContext &C, Attribute::AttrKind Kind) const
 Remove the specified attribute from this set.
 
AttributeSet removeAttribute (LLVMContext &C, StringRef Kind) const
 Remove the specified attribute from this set.
 
AttributeSet removeAttributes (LLVMContext &C, const AttributeMask &AttrsToRemove) const
 Remove the specified attributes from this set.
 
std::optional< AttributeSet > intersectWith (LLVMContext &C, AttributeSet Other) const
 Try to intersect this AttributeSet with Other.
 
unsigned getNumAttributes () const
 Return the number of attributes in this set.
 
bool hasAttributes () const
 Return true if attributes exists in this set.
 
bool hasAttribute (Attribute::AttrKind Kind) const
 Return true if the attribute exists in this set.
 
bool hasAttribute (StringRef Kind) const
 Return true if the attribute exists in this set.
 
Attribute getAttribute (Attribute::AttrKind Kind) const
 Return the attribute object.
 
Attribute getAttribute (StringRef Kind) const
 Return the target-dependent attribute object.
 
MaybeAlign getAlignment () const
 
MaybeAlign getStackAlignment () const
 
uint64_t getDereferenceableBytes () const
 
uint64_t getDereferenceableOrNullBytes () const
 
Type * getByValType () const
 
Type * getStructRetType () const
 
Type * getByRefType () const
 
Type * getPreallocatedType () const
 
Type * getInAllocaType () const
 
Type * getElementType () const
 
std::optional< std::pair< unsigned, std::optional< unsigned > > > getAllocSizeArgs () const
 
unsigned getVScaleRangeMin () const
 
std::optional< unsigned > getVScaleRangeMax () const
 
UWTableKind getUWTableKind () const
 
AllocFnKind getAllocKind () const
 
MemoryEffects getMemoryEffects () const
 
CaptureInfo getCaptureInfo () const
 
FPClassTest getNoFPClass () const
 
std::string getAsString (bool InAttrGrp=false) const
 
bool hasParentContext (LLVMContext &C) const
 Return true if this attribute set belongs to the LLVMContext.
 
iterator begin () const
 
iterator end () const
 
void dump () const
 

Static Public Member Functions

static AttributeSet get (LLVMContext &C, const AttrBuilder &B)
 
static AttributeSet get (LLVMContext &C, ArrayRef< Attribute > Attrs)
 

Friends

template<typename Ty , typename Enable >
struct DenseMapInfo
 

Detailed Description

Definition at line 345 of file Attributes.h.

Member Typedef Documentation

◆ iterator

using llvm::AttributeSet::iterator = const Attribute *

Definition at line 449 of file Attributes.h.

Constructor & Destructor Documentation

◆ AttributeSet() [1/2]

llvm::AttributeSet::AttributeSet ( )
default

AttributeSet is a trivially copyable value type.

Referenced by get().

◆ AttributeSet() [2/2]

llvm::AttributeSet::AttributeSet ( const AttributeSet &  )
default

◆ ~AttributeSet()

llvm::AttributeSet::~AttributeSet ( )
default

Member Function Documentation

◆ addAttribute() [1/2]

AttributeSet AttributeSet::addAttribute ( LLVMContext &  C,
Attribute::AttrKind  Kind 
) const

Add an argument attribute.

Returns a new set because attribute sets are immutable.

Definition at line 918 of file Attributes.cpp.

References addAttributes(), B, llvm::CallingConv::C, get(), and hasAttribute().

Referenced by llvm::OpenMPIRBuilder::addAttributes().

◆ addAttribute() [2/2]

AttributeSet AttributeSet::addAttribute ( LLVMContext &  C,
StringRef  Kind,
StringRef  Value = StringRef() 
) const

Add a target-dependent attribute.

Returns a new set because attribute sets are immutable.

Definition at line 926 of file Attributes.cpp.

References addAttributes(), B, llvm::CallingConv::C, and get().

◆ addAttributes()

AttributeSet AttributeSet::addAttributes ( LLVMContext &  C,
AttributeSet  AS 
) const

Add attributes to the attribute set.

Returns a new set because attribute sets are immutable.

Definition at line 933 of file Attributes.cpp.

References B, llvm::CallingConv::C, get(), and hasAttributes().

Referenced by addAttribute(), and llvm::OpenMPIRBuilder::addAttributes().

◆ begin()

AttributeSet::iterator AttributeSet::begin ( ) const

Definition at line 1210 of file Attributes.cpp.

References llvm::AttributeSetNode::begin().

Referenced by intersectWith().

◆ dump()

LLVM_DUMP_METHOD void AttributeSet::dump ( ) const

Definition at line 1219 of file Attributes.cpp.

References llvm::dbgs(), and getAsString().

◆ end()

AttributeSet::iterator AttributeSet::end ( ) const

Definition at line 1214 of file Attributes.cpp.

References llvm::AttributeSetNode::end().

Referenced by intersectWith().

◆ get() [1/2]

AttributeSet AttributeSet::get ( LLVMContext &  C,
ArrayRef< Attribute >  Attrs 
)
static

Definition at line 914 of file Attributes.cpp.

References AttributeSet(), llvm::CallingConv::C, and llvm::AttributeSetNode::get().

◆ get() [2/2]

AttributeSet AttributeSet::get ( LLVMContext &  C,
const AttrBuilder &  B 
)
static

Definition at line 910 of file Attributes.cpp.

References AttributeSet(), B, llvm::CallingConv::C, and llvm::AttributeSetNode::get().

Referenced by addAttribute(), llvm::AttributeList::addAttributeAtIndex(), addAttributes(), llvm::AttributeList::addAttributesAtIndex(), AddParamAndFnBasicAttributes(), llvm::AttributeList::addParamAttribute(), llvm::AttributeList::get(), intersectWith(), llvm::promoteCall(), removeAttribute(), and removeAttributes().

◆ getAlignment()

MaybeAlign AttributeSet::getAlignment ( ) const

Definition at line 1123 of file Attributes.cpp.

References llvm::AttributeSetNode::getAlignment().

Referenced by llvm::AttributeList::getParamAlignment(), llvm::AttributeList::getRetAlignment(), and optimizeCallInst().

◆ getAllocKind()

AllocFnKind AttributeSet::getAllocKind ( ) const

Definition at line 1182 of file Attributes.cpp.

References llvm::AttributeSetNode::getAllocKind(), and llvm::Unknown.

Referenced by llvm::AttributeList::getAllocKind().

◆ getAllocSizeArgs()

std::optional< std::pair< unsigned, std::optional< unsigned > > > AttributeSet::getAllocSizeArgs ( ) const

Definition at line 1164 of file Attributes.cpp.

References llvm::AttributeSetNode::getAllocSizeArgs().

Referenced by doPromotion().

◆ getAsString()

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

Definition at line 1198 of file Attributes.cpp.

References llvm::AttributeSetNode::getAsString().

Referenced by dump(), and llvm::AttributeList::getAsString().

◆ getAttribute() [1/2]

Attribute AttributeSet::getAttribute ( Attribute::AttrKind  Kind) const

Return the attribute object.

Definition at line 1115 of file Attributes.cpp.

References llvm::AttributeSetNode::getAttribute().

Referenced by addIfNotExistent(), llvm::AttributeList::getAttributeAtIndex(), llvm::AttributeList::getParamRange(), intersectWith(), and llvm::AttributeFuncs::typeIncompatible().

◆ getAttribute() [2/2]

Attribute AttributeSet::getAttribute ( StringRef  Kind) const

Return the target-dependent attribute object.

Definition at line 1119 of file Attributes.cpp.

References llvm::AttributeSetNode::getAttribute().

◆ getByRefType()

Type * AttributeSet::getByRefType ( ) const

Definition at line 1139 of file Attributes.cpp.

References llvm::AttributeSetNode::getAttributeType().

Referenced by llvm::AttributeList::getParamByRefType().

◆ getByValType()

Type * AttributeSet::getByValType ( ) const

Definition at line 1143 of file Attributes.cpp.

References llvm::AttributeSetNode::getAttributeType().

Referenced by llvm::AttributeList::getParamByValType().

◆ getCaptureInfo()

CaptureInfo AttributeSet::getCaptureInfo ( ) const

Definition at line 1190 of file Attributes.cpp.

References llvm::CaptureInfo::all(), and llvm::AttributeSetNode::getCaptureInfo().

◆ getDereferenceableBytes()

uint64_t AttributeSet::getDereferenceableBytes ( ) const

Definition at line 1131 of file Attributes.cpp.

References llvm::AttributeSetNode::getDereferenceableBytes().

Referenced by llvm::AttributeList::getParamDereferenceableBytes(), and llvm::AttributeList::getRetDereferenceableBytes().

◆ getDereferenceableOrNullBytes()

uint64_t AttributeSet::getDereferenceableOrNullBytes ( ) const

Definition at line 1135 of file Attributes.cpp.

References llvm::AttributeSetNode::getDereferenceableOrNullBytes().

Referenced by llvm::AttributeList::getParamDereferenceableOrNullBytes(), and llvm::AttributeList::getRetDereferenceableOrNullBytes().

◆ getElementType()

Type * AttributeSet::getElementType ( ) const

Definition at line 1159 of file Attributes.cpp.

References llvm::AttributeSetNode::getAttributeType().

Referenced by llvm::AttributeList::getParamElementType().

◆ getInAllocaType()

Type * AttributeSet::getInAllocaType ( ) const

Definition at line 1155 of file Attributes.cpp.

References llvm::AttributeSetNode::getAttributeType().

Referenced by llvm::AttributeList::getParamInAllocaType().

◆ getMemoryEffects()

MemoryEffects AttributeSet::getMemoryEffects ( ) const

Definition at line 1186 of file Attributes.cpp.

References llvm::AttributeSetNode::getMemoryEffects(), and llvm::MemoryEffectsBase< LocationEnum >::unknown().

Referenced by addIfNotExistent(), and llvm::AttributeList::getMemoryEffects().

◆ getNoFPClass()

FPClassTest AttributeSet::getNoFPClass ( ) const

Definition at line 1194 of file Attributes.cpp.

References llvm::fcNone, and llvm::AttributeSetNode::getNoFPClass().

Referenced by llvm::AttributeList::getParamNoFPClass(), and llvm::AttributeList::getRetNoFPClass().

◆ getNumAttributes()

unsigned AttributeSet::getNumAttributes ( ) const

Return the number of attributes in this set.

Definition at line 1103 of file Attributes.cpp.

References llvm::AttributeSetNode::getNumAttributes().

◆ getPreallocatedType()

Type * AttributeSet::getPreallocatedType ( ) const

Definition at line 1151 of file Attributes.cpp.

References llvm::AttributeSetNode::getAttributeType().

Referenced by llvm::AttributeList::getParamPreallocatedType().

◆ getStackAlignment()

MaybeAlign AttributeSet::getStackAlignment ( ) const

Definition at line 1127 of file Attributes.cpp.

References llvm::AttributeSetNode::getStackAlignment().

Referenced by llvm::AttributeList::getFnStackAlignment(), llvm::AttributeList::getParamStackAlignment(), and llvm::AttributeList::getRetStackAlignment().

◆ getStructRetType()

Type * AttributeSet::getStructRetType ( ) const

Definition at line 1147 of file Attributes.cpp.

References llvm::AttributeSetNode::getAttributeType().

Referenced by llvm::AttributeList::getParamStructRetType().

◆ getUWTableKind()

UWTableKind AttributeSet::getUWTableKind ( ) const

Definition at line 1178 of file Attributes.cpp.

References llvm::AttributeSetNode::getUWTableKind(), and llvm::None.

Referenced by llvm::AttributeList::getUWTableKind().

◆ getVScaleRangeMax()

std::optional< unsigned > AttributeSet::getVScaleRangeMax ( ) const

Definition at line 1174 of file Attributes.cpp.

References llvm::AttributeSetNode::getVScaleRangeMax().

◆ getVScaleRangeMin()

unsigned AttributeSet::getVScaleRangeMin ( ) const

Definition at line 1170 of file Attributes.cpp.

References llvm::AttributeSetNode::getVScaleRangeMin().

◆ hasAttribute() [1/2]

bool AttributeSet::hasAttribute ( Attribute::AttrKind  Kind) const

Return true if the attribute exists in this set.

Definition at line 1107 of file Attributes.cpp.

References llvm::AttributeSetNode::hasAttribute().

Referenced by addAttribute(), addIfNotExistent(), llvm::AttributeList::hasAttributeAtIndex(), llvm::GlobalVariable::hasImplicitSection(), printFunctionArgExts(), and removeAttribute().

◆ hasAttribute() [2/2]

bool AttributeSet::hasAttribute ( StringRef  Kind) const

Return true if the attribute exists in this set.

Definition at line 1111 of file Attributes.cpp.

References llvm::AttributeSetNode::hasAttribute().

◆ hasAttributes()

bool llvm::AttributeSet::hasAttributes ( ) const
inline

Return true if attributes exists in this set.

Definition at line 411 of file Attributes.h.

Referenced by addAttributes(), llvm::AttributeList::get(), llvm::AttributeList::hasAttributesAtIndex(), and hasParentContext().

◆ hasParentContext()

bool AttributeSet::hasParentContext ( LLVMContext &  C) const

Return true if this attribute set belongs to the LLVMContext.

Definition at line 1202 of file Attributes.cpp.

References assert(), llvm::CallingConv::C, hasAttributes(), and llvm::AttributeSetNode::Profile().

◆ intersectWith()

std::optional< AttributeSet > AttributeSet::intersectWith ( LLVMContext &  C,
AttributeSet  Other 
) const

Try to intersect this AttributeSet with Other.

Returns std::nullopt if the two lists are inherently incompatible (imply different behavior, not just analysis).

Definition at line 974 of file Attributes.cpp.

References llvm::AttrBuilder::addAlignmentAttr(), llvm::AttrBuilder::addAttribute(), llvm::AttrBuilder::addCapturesAttr(), llvm::AttrBuilder::addMemoryAttr(), llvm::AttrBuilder::addNoFPClassAttr(), llvm::AttrBuilder::addRangeAttr(), llvm::AttrBuilder::addRawIntAttr(), assert(), begin(), llvm::CallingConv::C, end(), get(), llvm::Attribute::getAlignment(), getAttribute(), llvm::Attribute::getCaptureInfo(), llvm::Attribute::getKindAsEnum(), llvm::Attribute::getMemoryEffects(), llvm::Attribute::getNoFPClass(), llvm::Attribute::getRange(), llvm::Attribute::getValueAsInt(), llvm::Attribute::hasKindAsEnum(), llvm::Attribute::intersectMustPreserve(), llvm::Attribute::intersectWithAnd(), llvm::Attribute::intersectWithCustom(), llvm::Attribute::intersectWithMin(), llvm::Attribute::isEnumAttrKind(), llvm::ConstantRange::isFullSet(), llvm::Attribute::isIntAttrKind(), llvm::Attribute::isValid(), llvm_unreachable, llvm::Other, llvm::ConstantRange::unionWith(), and llvm::MaybeAlign::valueOrOne().

Referenced by llvm::AttributeList::intersectWith().

◆ operator!=()

bool llvm::AttributeSet::operator!= ( const AttributeSet &  O) const
inline

Definition at line 369 of file Attributes.h.

◆ operator==()

bool llvm::AttributeSet::operator== ( const AttributeSet &  O) const
inline

Definition at line 368 of file Attributes.h.

◆ removeAttribute() [1/2]

AttributeSet AttributeSet::removeAttribute ( LLVMContext &  C,
Attribute::AttrKind  Kind 
) const

Remove the specified attribute from this set.

Returns a new set because attribute sets are immutable.

Definition at line 946 of file Attributes.cpp.

References B, llvm::CallingConv::C, get(), and hasAttribute().

Referenced by AddParamAndFnBasicAttributes().

◆ removeAttribute() [2/2]

AttributeSet AttributeSet::removeAttribute ( LLVMContext &  C,
StringRef  Kind 
) const

Remove the specified attribute from this set.

Returns a new set because attribute sets are immutable.

Definition at line 954 of file Attributes.cpp.

References B, llvm::CallingConv::C, get(), and hasAttribute().

◆ removeAttributes()

AttributeSet AttributeSet::removeAttributes ( LLVMContext &  C,
const AttributeMask &  AttrsToRemove 
) const

Remove the specified attributes from this set.

Returns a new set because attribute sets are immutable.

Definition at line 962 of file Attributes.cpp.

References B, llvm::CallingConv::C, and get().

Referenced by moveFunctionAdaptingType().

Friends And Related Function Documentation

◆ DenseMapInfo

template<typename Ty , typename Enable >
friend struct DenseMapInfo
friend

Definition at line 347 of file Attributes.h.

The documentation for this class was generated from the following files:
Generated on Fri Jun 13 2025 23:30:41 for LLVM by doxygen 1.9.6