LLVM 17.0.0git
Classes | Typedefs | Enumerations | Functions | Variables
llvm::Intrinsic Namespace Reference

This namespace contains an enum with a value for every intrinsic/builtin function known by LLVM. More...

Classes

struct  IITDescriptor
 This is a type descriptor which explains the type requirements of an intrinsic. More...
 

Typedefs

typedef unsigned ID
 

Enumerations

enum  IndependentIntrinsics : unsigned { not_intrinsic = 0 }
 
enum  MatchIntrinsicTypesResult { MatchIntrinsicTypes_Match = 0 , MatchIntrinsicTypes_NoMatchRet = 1 , MatchIntrinsicTypes_NoMatchArg = 2 }
 

Functions

StringRef getName (ID id)
 Return the LLVM name for an intrinsic, such as "llvm.ppc.altivec.lvx".
 
StringRef getBaseName (ID id)
 Return the LLVM name for an intrinsic, without encoded types for overloading, such as "llvm.ssa.copy".
 
std::string getName (ID Id, ArrayRef< Type * > Tys, Module *M, FunctionType *FT=nullptr)
 Return the LLVM name for an intrinsic, such as "llvm.ppc.altivec.lvx" or "llvm.ssa.copy.p0s_s.1".
 
std::string getNameNoUnnamedTypes (ID Id, ArrayRef< Type * > Tys)
 Return the LLVM name for an intrinsic.
 
FunctionTypegetType (LLVMContext &Context, ID id, ArrayRef< Type * > Tys=std::nullopt)
 Return the function type for an intrinsic.
 
bool isOverloaded (ID id)
 Returns true if the intrinsic can be overloaded.
 
AttributeList getAttributes (LLVMContext &C, ID id)
 Return the attributes for an intrinsic.
 
FunctiongetDeclaration (Module *M, ID id, ArrayRef< Type * > Tys=std::nullopt)
 Create or insert an LLVM Function declaration for an intrinsic, and return it.
 
int lookupLLVMIntrinsicByName (ArrayRef< const char * > NameTable, StringRef Name)
 Looks up Name in NameTable via binary search.
 
ID getIntrinsicForClangBuiltin (const char *Prefix, StringRef BuiltinName)
 Map a Clang builtin name to an intrinsic ID.
 
ID getIntrinsicForMSBuiltin (const char *Prefix, StringRef BuiltinName)
 Map a MS builtin name to an intrinsic ID.
 
void getIntrinsicInfoTableEntries (ID id, SmallVectorImpl< IITDescriptor > &T)
 Return the IIT table descriptor for the specified intrinsic into an array of IITDescriptors.
 
MatchIntrinsicTypesResult matchIntrinsicSignature (FunctionType *FTy, ArrayRef< IITDescriptor > &Infos, SmallVectorImpl< Type * > &ArgTys)
 Match the specified function type with the type constraints specified by the .td file.
 
bool matchIntrinsicVarArg (bool isVarArg, ArrayRef< IITDescriptor > &Infos)
 Verify if the intrinsic has variable arguments.
 
bool getIntrinsicSignature (Function *F, SmallVectorImpl< Type * > &ArgTys)
 Gets the type arguments of an intrinsic call by matching type contraints specified by the .td file.
 
std::optional< Function * > remangleIntrinsicFunction (Function *F)
 

Variables

static const int NoAliasScopeDeclScopeArg = 0
 

Detailed Description

This namespace contains an enum with a value for every intrinsic/builtin function known by LLVM.

The enum values are returned by Function::getIntrinsicID().

Typedef Documentation

◆ ID

Definition at line 39 of file TargetTransformInfo.h.

Enumeration Type Documentation

◆ IndependentIntrinsics

Enumerator
not_intrinsic 

Definition at line 43 of file Intrinsics.h.

◆ MatchIntrinsicTypesResult

Enumerator
MatchIntrinsicTypes_Match 
MatchIntrinsicTypes_NoMatchRet 
MatchIntrinsicTypes_NoMatchArg 

Definition at line 214 of file Intrinsics.h.

Function Documentation

◆ getAttributes()

AttributeList llvm::Intrinsic::getAttributes ( LLVMContext C,
ID  id 
)

◆ getBaseName()

StringRef llvm::Intrinsic::getBaseName ( ID  id)

Return the LLVM name for an intrinsic, without encoded types for overloading, such as "llvm.ssa.copy".

Definition at line 970 of file Function.cpp.

References assert(), and IntrinsicNameTable.

Referenced by getIntrinsicNameImpl(), getName(), llvm::SDNode::getOperationName(), and llvm::MachineOperand::print().

◆ getDeclaration()

Function * llvm::Intrinsic::getDeclaration ( Module M,
ID  id,
ArrayRef< Type * >  Tys = std::nullopt 
)

Create or insert an LLVM Function declaration for an intrinsic, and return it.

The Tys parameter is for intrinsics with overloaded types (e.g., those using iAny, fAny, vAny, or iPTRAny). For a declaration of an overloaded intrinsic, Tys must provide exactly one type for each overloaded type in the intrinsic.

Definition at line 1502 of file Function.cpp.

References llvm::ArrayRef< T >::empty(), getName(), and getType().

Referenced by addAssumeNonNull(), addBoundsChecking(), callIntrinsic(), convertToRelLookupTable(), llvm::IRBuilderBase::CreateAssumption(), llvm::IRBuilderBase::CreateBinaryIntrinsic(), llvm::MatrixBuilder::CreateColumnMajorLoad(), llvm::MatrixBuilder::CreateColumnMajorStore(), createCoroSave(), llvm::IRBuilderBase::CreateElementUnorderedAtomicMemCpy(), llvm::IRBuilderBase::CreateElementUnorderedAtomicMemMove(), llvm::IRBuilderBase::CreateElementUnorderedAtomicMemSet(), llvm::IRBuilderBase::CreateFAddReduce(), createFFSIntrinsic(), llvm::IRBuilderBase::CreateFMulReduce(), llvm::IRBuilderBase::CreateGCGetPointerBase(), llvm::IRBuilderBase::CreateGCGetPointerOffset(), llvm::IRBuilderBase::CreateGCRelocate(), CreateGCRelocates(), llvm::IRBuilderBase::CreateGCResult(), CreateGCStatepointCallCommon(), CreateGCStatepointInvokeCommon(), llvm::IRBuilderBase::CreateIntrinsic(), llvm::IRBuilderBase::CreateInvariantStart(), llvm::IRBuilderBase::CreateLaunderInvariantGroup(), llvm::IRBuilderBase::CreateLifetimeEnd(), llvm::IRBuilderBase::CreateLifetimeStart(), llvm::MatrixBuilder::CreateMatrixMultiply(), llvm::MatrixBuilder::CreateMatrixTranspose(), llvm::IRBuilderBase::CreateMemCpyInline(), llvm::IRBuilderBase::CreateMemMove(), llvm::IRBuilderBase::CreateMemSet(), llvm::IRBuilderBase::CreateMemSetInline(), llvm::IRBuilderBase::CreateMemTransferInst(), llvm::IRBuilderBase::CreateNoAliasScopeDeclaration(), createPopcntIntrinsic(), createPowWithIntegerExponent(), llvm::IRBuilderBase::CreatePreserveArrayAccessIndex(), llvm::IRBuilderBase::CreatePreserveStructAccessIndex(), llvm::IRBuilderBase::CreatePreserveUnionAccessIndex(), CreatePrologue(), llvm::IRBuilderBase::CreateStripInvariantGroup(), createTblForTrunc(), llvm::IRBuilderBase::CreateUnaryIntrinsic(), llvm::IRBuilderBase::CreateVectorReverse(), llvm::IRBuilderBase::CreateVectorSplice(), llvm::IRBuilderBase::CreateVScale(), llvm::AArch64TargetLowering::emitAtomicCmpXchgNoStoreLLBalance(), llvm::ARMTargetLowering::emitAtomicCmpXchgNoStoreLLBalance(), llvm::AArch64TargetLowering::emitLoadLinked(), llvm::ARMTargetLowering::emitLoadLinked(), llvm::HexagonTargetLowering::emitLoadLinked(), llvm::LoongArchTargetLowering::emitMaskedAtomicCmpXchgIntrinsic(), llvm::PPCTargetLowering::emitMaskedAtomicCmpXchgIntrinsic(), llvm::RISCVTargetLowering::emitMaskedAtomicCmpXchgIntrinsic(), llvm::LoongArchTargetLowering::emitMaskedAtomicRMWIntrinsic(), llvm::PPCTargetLowering::emitMaskedAtomicRMWIntrinsic(), llvm::RISCVTargetLowering::emitMaskedAtomicRMWIntrinsic(), llvm::AArch64TargetLowering::emitStoreConditional(), llvm::ARMTargetLowering::emitStoreConditional(), llvm::HexagonTargetLowering::emitStoreConditional(), emitTPIDR2Save(), llvm::PPCTargetLowering::emitTrailingFence(), llvm::VPWidenCallRecipe::execute(), expandIToFP(), explicifyGuards(), factorizeMinMaxTree(), foldCtpop(), foldCttzCtlz(), foldGuardedFunnelShift(), llvm::InstCombinerImpl::foldMultiplicationOverflowCheck(), foldSqrt(), foldSubOfMinMax(), foldToUnsignedSaturatedAdd(), llvm::InstCombinerImpl::foldVectorBinop(), foldVectorCmp(), llvm::SCEVExpander::generateOverflowCheck(), generateUnsignedDivisionCode(), llvm::VPIntrinsic::getDeclarationForParams(), getDeclareIntrin(), getScalarIntrinsicDeclaration(), getSqrtCall(), getStackGuard(), llvm::InlineFunction(), inlineRetainOrClaimRVCalls(), insertCall(), llvm::DIBuilder::insertDbgAssign(), insertLifetimeMarkersSurroundingCall(), llvm::BPFCoreSharedInfo::insertPassThrough(), llvm::GCNTTIImpl::instCombineIntrinsic(), instrumentOneFunc(), llvm::SampleProfileProber::instrumentOneFunc(), LLVMGetIntrinsicDeclaration(), lowerGuardIntrinsic(), llvm::AArch64TargetLowering::lowerInterleavedLoad(), llvm::ARMTargetLowering::lowerInterleavedLoad(), llvm::AArch64TargetLowering::lowerInterleavedStore(), llvm::ARMTargetLowering::lowerInterleavedStore(), lowerLocalAllocas(), llvm::IntrinsicLowering::LowerToByteSwap(), llvm::ARMTargetLowering::makeDMB(), llvm::coro::LowererBase::makeSubFnCall(), matchFunnelShift(), matchOrConcat(), modifyIntrinsicCall(), optimizeDoubleFP(), optimizeWithFDivFast(), optimizeWithRcp(), processUGT_ADDCST_ADD(), processUMulZExtIdiom(), reassociateMinMaxWithConstantInOperand(), reassociateMinMaxWithConstants(), llvm::recognizeBSwapOrBitReverseIdiom(), remangleIntrinsicFunction(), RemovePreallocated(), replaceUnaryCall(), llvm::GCNTTIImpl::rewriteIntrinsicWithAddressSpace(), llvm::KCFIPass::run(), runImpl(), simplifyAMDGCNMemoryIntrinsicDemanded(), SimplifyBSwap(), llvm::InstCombinerImpl::SimplifyDemandedUseBits(), simplifyNvvmIntrinsic(), simplifyX86extrq(), simplifyX86insertq(), tryToFPToSat(), tryToRecognizePopCount(), llvm::updatePublicTypeTestCalls(), upgradeAbs(), llvm::UpgradeARCRuntime(), UpgradeARMIntrinsicCall(), upgradeAVX512MaskToSelect(), llvm::UpgradeIntrinsicCall(), UpgradeIntrinsicFunction1(), UpgradePTESTIntrinsic(), UpgradeX86BF16DPIntrinsic(), UpgradeX86BF16Intrinsic(), UpgradeX86BinaryIntrinsics(), upgradeX86ConcatShift(), UpgradeX86IntrinsicFunction(), UpgradeX86IntrinsicsWith8BitMask(), UpgradeX86MaskedFPCompare(), UpgradeX86MaskedShift(), upgradeX86Rotate(), UpgradeX86VPERMT2Intrinsics(), UseTlsOffset(), llvm::InstCombinerImpl::visitAllocSite(), llvm::InstCombinerImpl::visitBitCast(), llvm::InstCombinerImpl::visitCallInst(), llvm::InstCombinerImpl::visitFPTrunc(), and llvm::InstCombinerImpl::visitXor().

◆ getIntrinsicForClangBuiltin()

ID llvm::Intrinsic::getIntrinsicForClangBuiltin ( const char Prefix,
StringRef  BuiltinName 
)

Map a Clang builtin name to an intrinsic ID.

◆ getIntrinsicForMSBuiltin()

ID llvm::Intrinsic::getIntrinsicForMSBuiltin ( const char Prefix,
StringRef  BuiltinName 
)

Map a MS builtin name to an intrinsic ID.

◆ getIntrinsicInfoTableEntries()

void llvm::Intrinsic::getIntrinsicInfoTableEntries ( ID  id,
SmallVectorImpl< IITDescriptor > &  T 
)

Return the IIT table descriptor for the specified intrinsic into an array of IITDescriptors.

Definition at line 1332 of file Function.cpp.

References DecodeIITType(), IIT_Done, llvm::SmallVectorTemplateBase< T, bool >::push_back(), and llvm::ArrayRef< T >::size().

Referenced by llvm::IRBuilderBase::CreateIntrinsic(), getIntrinsicSignature(), and getType().

◆ getIntrinsicSignature()

bool llvm::Intrinsic::getIntrinsicSignature ( Function F,
SmallVectorImpl< Type * > &  ArgTys 
)

Gets the type arguments of an intrinsic call by matching type contraints specified by the .td file.

The overloaded types are pushed into the AgTys vector.

Returns false if the given function is not a valid intrinsic call.

Definition at line 1846 of file Function.cpp.

References F, getIntrinsicInfoTableEntries(), matchIntrinsicSignature(), MatchIntrinsicTypes_Match, and matchIntrinsicVarArg().

Referenced by modifyIntrinsicCall(), remangleIntrinsicFunction(), and simplifyAMDGCNMemoryIntrinsicDemanded().

◆ getName() [1/2]

StringRef llvm::Intrinsic::getName ( ID  id)

◆ getName() [2/2]

std::string llvm::Intrinsic::getName ( ID  Id,
ArrayRef< Type * >  Tys,
Module M,
FunctionType FT = nullptr 
)

Return the LLVM name for an intrinsic, such as "llvm.ppc.altivec.lvx" or "llvm.ssa.copy.p0s_s.1".

Note, this version of getName supports overloads. This is less efficient than the StringRef version of this function. If no overloads are required, it is safe to use this version, but better to use the StringRef version. If one of the types is based on an unnamed type, a function type will be computed. Providing FT will avoid this computation.

Definition at line 1009 of file Function.cpp.

References assert(), and getIntrinsicNameImpl().

◆ getNameNoUnnamedTypes()

std::string llvm::Intrinsic::getNameNoUnnamedTypes ( ID  Id,
ArrayRef< Type * >  Tys 
)

Return the LLVM name for an intrinsic.

This is a special version only to be used by LLVMIntrinsicCopyOverloadedName. It only supports overloads based on named types.

Definition at line 1015 of file Function.cpp.

References getIntrinsicNameImpl().

Referenced by LLVMIntrinsicCopyOverloadedName().

◆ getType()

FunctionType * llvm::Intrinsic::getType ( LLVMContext Context,
ID  id,
ArrayRef< Type * >  Tys = std::nullopt 
)

◆ isOverloaded()

bool llvm::Intrinsic::isOverloaded ( ID  id)

◆ lookupLLVMIntrinsicByName()

int llvm::Intrinsic::lookupLLVMIntrinsicByName ( ArrayRef< const char * >  NameTable,
StringRef  Name 
)

Looks up Name in NameTable via binary search.

NameTable must be sorted and all entries must start with "llvm.". If NameTable contains an exact match for Name or a prefix of Name followed by a dot, its index in NameTable is returned. Otherwise, -1 is returned.

Definition at line 231 of file IntrinsicInst.cpp.

References assert(), llvm::ArrayRef< T >::begin(), llvm::ArrayRef< T >::end(), High, LHS, llvm::Low, Name, llvm::StringRef::npos, RHS, and llvm::StringRef::size().

Referenced by isCoroutineIntrinsicName(), and llvm::Function::lookupIntrinsicID().

◆ matchIntrinsicSignature()

Intrinsic::MatchIntrinsicTypesResult llvm::Intrinsic::matchIntrinsicSignature ( FunctionType FTy,
ArrayRef< IITDescriptor > &  Infos,
SmallVectorImpl< Type * > &  ArgTys 
)

Match the specified function type with the type constraints specified by the .td file.

If the given type is an overloaded type it is pushed to the ArgTys vector.

Returns false if the given type matches with the constraints, true otherwise.

Definition at line 1801 of file Function.cpp.

References Check, E, llvm::FunctionType::getReturnType(), I, matchIntrinsicType(), MatchIntrinsicTypes_Match, MatchIntrinsicTypes_NoMatchArg, MatchIntrinsicTypes_NoMatchRet, llvm::FunctionType::params(), and llvm::SmallVectorBase< Size_T >::size().

Referenced by getIntrinsicSignature().

◆ matchIntrinsicVarArg()

bool llvm::Intrinsic::matchIntrinsicVarArg ( bool  isVarArg,
ArrayRef< IITDescriptor > &  Infos 
)

Verify if the intrinsic has variable arguments.

This method is intended to be called after all the fixed arguments have been matched first.

This method returns true on error.

Definition at line 1827 of file Function.cpp.

References D, llvm::ArrayRef< T >::empty(), llvm::ArrayRef< T >::front(), llvm::ArrayRef< T >::size(), and llvm::ArrayRef< T >::slice().

Referenced by getIntrinsicSignature().

◆ remangleIntrinsicFunction()

std::optional< Function * > llvm::Intrinsic::remangleIntrinsicFunction ( Function F)

Variable Documentation

◆ NoAliasScopeDeclScopeArg

const int llvm::Intrinsic::NoAliasScopeDeclScopeArg = 0
static