9#ifndef LLVM_ANALYSIS_TARGETLIBRARYINFO_H
10#define LLVM_ANALYSIS_TARGETLIBRARYINFO_H
49 std::optional<CallingConv::ID> CC;
55 std::optional<CallingConv::ID> Conv)
56 : ScalarFnName(ScalarFnName), VectorFnName(VectorFnName),
57 VectorizationFactor(VectorizationFactor), Masked(Masked),
58 VABIPrefix(VABIPrefix), CC(Conv) {}
73#define TLI_DEFINE_ENUM
74#include "llvm/Analysis/TargetLibraryInfo.def"
92 bool ShouldExtI32Param, ShouldExtI32Return, ShouldSignExtI32Param, ShouldSignExtI32Return;
95 enum AvailabilityState {
101 AvailableArray[
F/4] &= ~(3 << 2*(
F&3));
102 AvailableArray[
F/4] |= State << 2*(
F&3);
109 std::vector<VecDesc> VectorDescs;
112 std::vector<VecDesc> ScalarDescs;
169 setState(
F, Unavailable);
174 setState(
F, StandardName);
180 if (StandardNames[
F] != Name) {
181 setState(
F, CustomName);
182 CustomNames[
F] = std::string(Name);
183 assert(CustomNames.contains(
F));
185 setState(
F, StandardName);
230 ShouldExtI32Param = Val;
237 ShouldExtI32Return = Val;
243 ShouldSignExtI32Param = Val;
249 ShouldSignExtI32Return = Val;
294 std::bitset<NumLibFuncs> OverrideAsUnavailable;
300 std::optional<const Function *>
F = std::nullopt)
304 if ((*F)->hasFnAttribute(
"no-builtins"))
309 AttributeSet FnAttrs = (*F)->getAttributes().getFnAttrs();
311 if (!Attr.isStringAttribute())
313 auto AttrStr = Attr.getKindAsString();
314 if (!AttrStr.consume_front(
"no-builtin-"))
333 bool AllowCallerSuperset)
const {
334 if (!AllowCallerSuperset)
335 return OverrideAsUnavailable == CalleeTLI.OverrideAsUnavailable;
338 return (CalleeTLI.OverrideAsUnavailable & ~OverrideAsUnavailable).none();
345 return Impl->isValidProtoForLibFunc(FTy,
F, M);
353 return Impl->getLibFunc(funcName,
F);
357 return Impl->getLibFunc(FDecl,
F);
370 return Impl->getLibFunc(Opcode, Ty,
F);
380 assert(
F < OverrideAsUnavailable.size() &&
"out-of-bounds LibFunc");
381 OverrideAsUnavailable.set(
F);
385 assert(
F < OverrideAsUnavailable.size() &&
"out-of-bounds LibFunc");
386 if (OverrideAsUnavailable[
F])
387 return TargetLibraryInfoImpl::Unavailable;
388 return Impl->getState(
F);
393 return getState(
F) != TargetLibraryInfoImpl::Unavailable;
396 return Impl->isFunctionVectorizable(
F, VF);
399 return Impl->isFunctionVectorizable(
F);
402 bool Masked =
false)
const {
403 return Impl->getVectorizedFunction(
F, VF,
Masked);
407 return Impl->getVectorMappingInfo(
F, VF,
Masked);
413 if (
getState(
F) == TargetLibraryInfoImpl::Unavailable)
418 case LibFunc_acos:
case LibFunc_acosf:
case LibFunc_acosl:
419 case LibFunc_asin:
case LibFunc_asinf:
case LibFunc_asinl:
420 case LibFunc_atan2:
case LibFunc_atan2f:
case LibFunc_atan2l:
421 case LibFunc_atan:
case LibFunc_atanf:
case LibFunc_atanl:
422 case LibFunc_ceil:
case LibFunc_ceilf:
case LibFunc_ceill:
423 case LibFunc_copysign:
case LibFunc_copysignf:
case LibFunc_copysignl:
424 case LibFunc_cos:
case LibFunc_cosf:
case LibFunc_cosl:
425 case LibFunc_cosh:
case LibFunc_coshf:
case LibFunc_coshl:
426 case LibFunc_exp2:
case LibFunc_exp2f:
case LibFunc_exp2l:
427 case LibFunc_exp10:
case LibFunc_exp10f:
case LibFunc_exp10l:
428 case LibFunc_fabs:
case LibFunc_fabsf:
case LibFunc_fabsl:
429 case LibFunc_floor:
case LibFunc_floorf:
case LibFunc_floorl:
430 case LibFunc_fmax:
case LibFunc_fmaxf:
case LibFunc_fmaxl:
431 case LibFunc_fmin:
case LibFunc_fminf:
case LibFunc_fminl:
432 case LibFunc_ldexp:
case LibFunc_ldexpf:
case LibFunc_ldexpl:
433 case LibFunc_log2:
case LibFunc_log2f:
case LibFunc_log2l:
434 case LibFunc_memcmp:
case LibFunc_bcmp:
case LibFunc_strcmp:
435 case LibFunc_memcpy:
case LibFunc_memset:
case LibFunc_memmove:
436 case LibFunc_nearbyint:
case LibFunc_nearbyintf:
case LibFunc_nearbyintl:
437 case LibFunc_rint:
case LibFunc_rintf:
case LibFunc_rintl:
438 case LibFunc_round:
case LibFunc_roundf:
case LibFunc_roundl:
439 case LibFunc_sin:
case LibFunc_sinf:
case LibFunc_sinl:
440 case LibFunc_sinh:
case LibFunc_sinhf:
case LibFunc_sinhl:
441 case LibFunc_sqrt:
case LibFunc_sqrtf:
case LibFunc_sqrtl:
442 case LibFunc_sqrt_finite:
case LibFunc_sqrtf_finite:
443 case LibFunc_sqrtl_finite:
444 case LibFunc_strcpy:
case LibFunc_stpcpy:
case LibFunc_strlen:
445 case LibFunc_strnlen:
case LibFunc_memchr:
case LibFunc_mempcpy:
446 case LibFunc_tan:
case LibFunc_tanf:
case LibFunc_tanl:
447 case LibFunc_tanh:
case LibFunc_tanhf:
case LibFunc_tanhl:
448 case LibFunc_trunc:
case LibFunc_truncf:
case LibFunc_truncl:
458 return TargetLibraryInfoImpl::StandardNames[
F];
463 if (State == TargetLibraryInfoImpl::Unavailable)
465 if (State == TargetLibraryInfoImpl::StandardName)
466 return Impl->StandardNames[
F];
467 assert(State == TargetLibraryInfoImpl::CustomName);
468 return Impl->CustomNames.find(
F)->second;
472 bool &ShouldExtI32Return,
473 bool &ShouldSignExtI32Param,
474 bool &ShouldSignExtI32Return,
476 ShouldExtI32Param = ShouldExtI32Return =
false;
477 ShouldSignExtI32Param = ShouldSignExtI32Return =
false;
483 ShouldExtI32Param =
true;
484 ShouldExtI32Return =
true;
488 if (
T.isLoongArch() ||
T.isMIPS() ||
T.isRISCV64()) {
489 ShouldSignExtI32Param =
true;
493 if (
T.isLoongArch() ||
T.isRISCV64()) {
494 ShouldSignExtI32Return =
true;
503 bool ShouldSignExtI32Param_,
505 if (ShouldExtI32Param_)
506 return Signed ? Attribute::SExt : Attribute::ZExt;
507 if (ShouldSignExtI32Param_)
508 return Attribute::SExt;
515 bool ShouldExtI32Param, ShouldExtI32Return;
516 bool ShouldSignExtI32Param, ShouldSignExtI32Return;
518 ShouldSignExtI32Param, ShouldSignExtI32Return,
T);
519 return getExtAttrForI32Param(ShouldExtI32Param, ShouldSignExtI32Param,
524 return getExtAttrForI32Param(Impl->ShouldExtI32Param,
525 Impl->ShouldSignExtI32Param,
Signed);
533 bool ShouldSignExtI32Return_,
535 if (ShouldExtI32Return_)
536 return Signed ? Attribute::SExt : Attribute::ZExt;
537 if (ShouldSignExtI32Return_)
538 return Attribute::SExt;
545 bool ShouldExtI32Param, ShouldExtI32Return;
546 bool ShouldSignExtI32Param, ShouldSignExtI32Return;
548 ShouldSignExtI32Param, ShouldSignExtI32Return,
T);
549 return getExtAttrForI32Return(ShouldExtI32Return, ShouldSignExtI32Return,
554 return getExtAttrForI32Return(Impl->ShouldExtI32Return,
555 Impl->ShouldSignExtI32Return,
Signed);
562 bool Signed,
bool Ret =
false,
563 AttributeList AL = AttributeList())
const {
564 if (
auto AK = getExtAttrForI32Param(
Signed))
565 for (
auto ArgNo : ArgNos)
566 AL = AL.addParamAttribute(*
C, ArgNo, AK);
568 if (
auto AK = getExtAttrForI32Return(
Signed))
569 AL = AL.addRetAttribute(*
C, AK);
575 return Impl->getWCharSize(M);
593 return Impl->getIntSize();
601 ModuleAnalysisManager::Invalidator &) {
605 FunctionAnalysisManager::Invalidator &) {
612 Impl->getWidestVF(ScalarF, FixedVF, ScalableVF);
639 : BaselineInfoImpl(
std::
move(BaselineInfoImpl)) {}
647 std::optional<TargetLibraryInfoImpl> BaselineInfoImpl;
652 std::optional<TargetLibraryInfo> TLI;
654 virtual void anchor();
672 TLI = TLA.run(
F, DummyFAM);
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
This file contains the declarations for the subclasses of Constant, which represent the different fla...
This file defines the DenseMap class.
Module.h This file contains the declarations for the Module class.
This header defines various interfaces for pass management in LLVM.
Machine Check Debug Module
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
This class holds the attributes for a particular argument, parameter, function, or return value.
Functions, function parameters, and return types can have attributes to indicate how they should be t...
AttrKind
This enumeration lists the attributes that can be associated with parameters, function results,...
@ None
No attributes have been set.
Base class for all callable instructions (InvokeInst and CallInst) Holds everything related to callin...
bool isNoBuiltin() const
Return true if the call should not be treated as a call to a builtin.
Function * getCalledFunction() const
Returns the function called, or null if this is an indirect function invocation or the function signa...
This is the shared class of boolean and integer constants.
Class to represent function types.
Class to represent integer types.
static LLVM_ABI IntegerType * get(LLVMContext &C, unsigned NumBits)
This static method is the primary way of constructing an IntegerType.
This is an important class for using LLVM in a threaded context.
A Module instance is used to store all the information related to an LLVM module.
A set of analyses that are preserved following a run of a transformation pass.
A wrapper around a string literal that serves as a proxy for constructing global tables of StringRefs...
StringRef - Represent a constant reference to a string, i.e.
constexpr bool empty() const
empty - Check if the string is empty.
Analysis pass providing the TargetLibraryInfo.
TargetLibraryAnalysis()=default
Default construct the library analysis.
LLVM_ABI TargetLibraryInfo run(const Function &F, FunctionAnalysisManager &)
TargetLibraryAnalysis(TargetLibraryInfoImpl BaselineInfoImpl)
Construct a library analysis with baseline Module-level info.
Implementation of the target library information.
void setShouldExtI32Param(bool Val)
Set to true iff i32 parameters to library functions should have signext or zeroext attributes if they...
void setShouldExtI32Return(bool Val)
Set to true iff i32 results from library functions should have signext or zeroext attributes if they ...
LLVM_ABI unsigned getWCharSize(const Module &M) const
Returns the size of the wchar_t type in bytes or 0 if the size is unknown.
LLVM_ABI bool getLibFunc(StringRef funcName, LibFunc &F) const
Searches for a particular function name.
friend class TargetLibraryInfo
LLVM_ABI void getWidestVF(StringRef ScalarF, ElementCount &FixedVF, ElementCount &Scalable) const
Returns the largest vectorization factor used in the list of vector functions.
bool isFunctionVectorizable(StringRef F, const ElementCount &VF) const
Return true if the function F has a vector equivalent with vectorization factor VF.
void setShouldSignExtI32Param(bool Val)
Set to true iff i32 parameters to library functions should have signext attribute if they correspond ...
void setAvailableWithName(LibFunc F, StringRef Name)
Forces a function to be marked as available and provide an alternate name that must be used.
TargetLibraryInfoImpl()=delete
unsigned getIntSize() const
Get size of a C-level int or unsigned int, in bits.
LLVM_ABI void addVectorizableFunctionsFromVecLib(enum VectorLibrary VecLib, const llvm::Triple &TargetTriple)
Calls addVectorizableFunctions with a known preset of functions for the given vector library.
void setIntSize(unsigned Bits)
Initialize the C-level size of an integer.
LLVM_ABI unsigned getSizeTSize(const Module &M) const
Returns the size of the size_t type in bits.
LLVM_ABI void addVectorizableFunctions(ArrayRef< VecDesc > Fns)
Add a set of scalar -> vector mappings, queryable via getVectorizedFunction and getScalarizedFunction...
LLVM_ABI const VecDesc * getVectorMappingInfo(StringRef F, const ElementCount &VF, bool Masked) const
Return a pointer to a VecDesc object holding all info for scalar to vector mappings in TLI for the eq...
static LLVM_ABI bool isCallingConvCCompatible(CallBase *CI)
Returns true if call site / callee has cdecl-compatible calling conventions.
void setShouldSignExtI32Return(bool Val)
Set to true iff i32 results from library functions should have signext attribute if they correspond t...
LLVM_ABI TargetLibraryInfoImpl & operator=(const TargetLibraryInfoImpl &TLI)
LLVM_ABI void disableAllFunctions()
Disables all builtins.
VectorLibrary
List of known vector-functions libraries.
void setUnavailable(LibFunc F)
Forces a function to be marked as unavailable.
LLVM_ABI StringRef getVectorizedFunction(StringRef F, const ElementCount &VF, bool Masked) const
Return the name of the equivalent of F, vectorized with factor VF.
void setAvailable(LibFunc F)
Forces a function to be marked as available.
TargetLibraryInfoWrapperPass()
The default constructor should not be used and is only for pass manager initialization purposes.
TargetLibraryInfo & getTLI(const Function &F)
Provides information about what library functions are available for the current target.
AttributeList getAttrList(LLVMContext *C, ArrayRef< unsigned > ArgNos, bool Signed, bool Ret=false, AttributeList AL=AttributeList()) const
static Attribute::AttrKind getExtAttrForI32Param(const Triple &T, bool Signed=true)
bool areInlineCompatible(const TargetLibraryInfo &CalleeTLI, bool AllowCallerSuperset) const
Determine whether a callee with the given TLI can be inlined into caller with this TLI,...
bool getLibFunc(const CallBase &CB, LibFunc &F) const
If a callbase does not have the 'nobuiltin' attribute, return if the called function is a known libra...
bool invalidate(Module &, const PreservedAnalyses &, ModuleAnalysisManager::Invalidator &)
Handle invalidation from the pass manager.
bool isValidProtoForLibFunc(const FunctionType &FTy, LibFunc F, const Module &M) const
Return true if the function type FTy is valid for the library function F, regardless of whether the f...
TargetLibraryInfo()=delete
unsigned getWCharSize(const Module &M) const
Returns the size of the wchar_t type in bytes or 0 if the size is unknown.
ConstantInt * getAsSizeT(uint64_t V, const Module &M) const
Returns a constant materialized as a size_t type.
bool hasOptimizedCodeGen(LibFunc F) const
Tests if the function is both available and a candidate for optimized code generation.
Attribute::AttrKind getExtAttrForI32Return(bool Signed=true) const
bool invalidate(Function &, const PreservedAnalyses &, FunctionAnalysisManager::Invalidator &)
bool isKnownVectorFunctionInLibrary(StringRef F) const
Check if the function "F" is listed in a library known to LLVM.
static StringRef getStandardName(LibFunc F)
Return the canonical name for a LibFunc.
bool isFunctionVectorizable(StringRef F) const
bool has(LibFunc F) const
Tests whether a library function is available.
void disableAllFunctions()
Disables all builtins.
unsigned getSizeTSize(const Module &M) const
Returns the size of the size_t type in bits.
TargetLibraryInfoImpl::AvailabilityState getState(LibFunc F) const
TargetLibraryInfo & operator=(const TargetLibraryInfo &TLI)=default
TargetLibraryInfo(const TargetLibraryInfo &TLI)=default
void getWidestVF(StringRef ScalarF, ElementCount &FixedVF, ElementCount &ScalableVF) const
Returns the largest vectorization factor used in the list of vector functions.
TargetLibraryInfo(const TargetLibraryInfoImpl &Impl, std::optional< const Function * > F=std::nullopt)
static Attribute::AttrKind getExtAttrForI32Return(const Triple &T, bool Signed=true)
bool getLibFunc(const Function &FDecl, LibFunc &F) const
bool getLibFunc(StringRef funcName, LibFunc &F) const
Searches for a particular function name.
IntegerType * getSizeTType(const Module &M) const
Returns an IntegerType corresponding to size_t.
static void initExtensionsForTriple(bool &ShouldExtI32Param, bool &ShouldExtI32Return, bool &ShouldSignExtI32Param, bool &ShouldSignExtI32Return, const Triple &T)
bool getLibFunc(unsigned int Opcode, Type *Ty, LibFunc &F) const
Searches for a function name using an Instruction Opcode.
StringRef getVectorizedFunction(StringRef F, const ElementCount &VF, bool Masked=false) const
StringRef getName(LibFunc F) const
const VecDesc * getVectorMappingInfo(StringRef F, const ElementCount &VF, bool Masked) const
TargetLibraryInfo & operator=(TargetLibraryInfo &&TLI)=default
unsigned getIntSize() const
Get size of a C-level int or unsigned int, in bits.
friend class TargetLibraryInfoWrapperPass
TargetLibraryInfo(TargetLibraryInfo &&TLI)=default
friend class TargetLibraryAnalysis
void setUnavailable(LibFunc F)
Forces a function to be marked as unavailable.
Attribute::AttrKind getExtAttrForI32Param(bool Signed=true) const
bool isFunctionVectorizable(StringRef F, const ElementCount &VF) const
Triple - Helper class for working with autoconf configuration names.
The instances of the Type class are immutable: once they are created, they are never changed.
Provides info so a possible vectorization of a function can be computed.
StringRef getVABIPrefix() const
std::optional< CallingConv::ID > getCallingConv() const
LLVM_ABI std::string getVectorFunctionABIVariantString() const
Returns a vector function ABI variant string on the form: ZGV<isa><mask><vlen><vparams><scalarname>(<...
StringRef getScalarFnName() const
StringRef getVectorFnName() const
ElementCount getVectorizationFactor() const
VecDesc(StringRef ScalarFnName, StringRef VectorFnName, ElementCount VectorizationFactor, bool Masked, StringRef VABIPrefix, std::optional< CallingConv::ID > Conv)
@ C
The default llvm calling convention, compatible with C.
This is an optimization pass for GlobalISel generic memory operations.
LLVM_ATTRIBUTE_VISIBILITY_DEFAULT AnalysisKey InnerAnalysisManagerProxy< AnalysisManagerT, IRUnitT, ExtraArgTs... >::Key
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
AnalysisManager< Function > FunctionAnalysisManager
Convenience typedef for the Function analysis manager.
Implement std::hash so that hash_code can be used in STL containers.
A CRTP mix-in that provides informational APIs needed for analysis passes.
A special type used by analysis passes to provide an address that identifies that particular analysis...