LLVM 18.0.0git
TargetLibraryInfo.h
Go to the documentation of this file.
1//===-- TargetLibraryInfo.h - Library information ---------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLVM_ANALYSIS_TARGETLIBRARYINFO_H
10#define LLVM_ANALYSIS_TARGETLIBRARYINFO_H
11
12#include "llvm/ADT/BitVector.h"
13#include "llvm/ADT/DenseMap.h"
14#include "llvm/IR/InstrTypes.h"
15#include "llvm/IR/PassManager.h"
16#include "llvm/Pass.h"
18#include <optional>
19
20namespace llvm {
21
22template <typename T> class ArrayRef;
23class Function;
24class Module;
25class Triple;
26
27/// Provides info so a possible vectorization of a function can be
28/// computed. Function 'VectorFnName' is equivalent to 'ScalarFnName'
29/// vectorized by a factor 'VectorizationFactor'.
30/// The VABIPrefix string holds information about isa, mask, vlen,
31/// and vparams so a scalar-to-vector mapping of the form:
32/// _ZGV<isa><mask><vlen><vparams>_<scalarname>(<vectorname>)
33/// can be constructed where:
34///
35/// <isa> = "_LLVM_"
36/// <mask> = "M" if masked, "N" if no mask.
37/// <vlen> = Number of concurrent lanes, stored in the `VectorizationFactor`
38/// field of the `VecDesc` struct. If the number of lanes is scalable
39/// then 'x' is printed instead.
40/// <vparams> = "v", as many as are the numArgs.
41/// <scalarname> = the name of the scalar function.
42/// <vectorname> = the name of the vector function.
43class VecDesc {
44 StringRef ScalarFnName;
45 StringRef VectorFnName;
47 bool Masked;
48 StringRef VABIPrefix;
49
50public:
51 VecDesc() = delete;
52 VecDesc(StringRef ScalarFnName, StringRef VectorFnName,
53 ElementCount VectorizationFactor, bool Masked, StringRef VABIPrefix)
54 : ScalarFnName(ScalarFnName), VectorFnName(VectorFnName),
56 VABIPrefix(VABIPrefix) {}
57
58 StringRef getScalarFnName() const { return ScalarFnName; }
59 StringRef getVectorFnName() const { return VectorFnName; }
61 bool isMasked() const { return Masked; }
62 StringRef getVABIPrefix() const { return VABIPrefix; }
63
64 /// Returns a vector function ABI variant string on the form:
65 /// _ZGV<isa><mask><vlen><vparams>_<scalarname>(<vectorname>)
66 std::string getVectorFunctionABIVariantString() const;
67};
68
69 enum LibFunc : unsigned {
70#define TLI_DEFINE_ENUM
71#include "llvm/Analysis/TargetLibraryInfo.def"
72
75 };
76
77/// Implementation of the target library information.
78///
79/// This class constructs tables that hold the target library information and
80/// make it available. However, it is somewhat expensive to compute and only
81/// depends on the triple. So users typically interact with the \c
82/// TargetLibraryInfo wrapper below.
84 friend class TargetLibraryInfo;
85
86 unsigned char AvailableArray[(NumLibFuncs+3)/4];
88 static StringLiteral const StandardNames[NumLibFuncs];
89 bool ShouldExtI32Param, ShouldExtI32Return, ShouldSignExtI32Param, ShouldSignExtI32Return;
90 unsigned SizeOfInt;
91
92 enum AvailabilityState {
93 StandardName = 3, // (memset to all ones)
94 CustomName = 1,
95 Unavailable = 0 // (memset to all zeros)
96 };
97 void setState(LibFunc F, AvailabilityState State) {
98 AvailableArray[F/4] &= ~(3 << 2*(F&3));
99 AvailableArray[F/4] |= State << 2*(F&3);
100 }
101 AvailabilityState getState(LibFunc F) const {
102 return static_cast<AvailabilityState>((AvailableArray[F/4] >> 2*(F&3)) & 3);
103 }
104
105 /// Vectorization descriptors - sorted by ScalarFnName.
106 std::vector<VecDesc> VectorDescs;
107 /// Scalarization descriptors - same content as VectorDescs but sorted based
108 /// on VectorFnName rather than ScalarFnName.
109 std::vector<VecDesc> ScalarDescs;
110
111 /// Return true if the function type FTy is valid for the library function
112 /// F, regardless of whether the function is available.
113 bool isValidProtoForLibFunc(const FunctionType &FTy, LibFunc F,
114 const Module &M) const;
115
116public:
117 /// List of known vector-functions libraries.
118 ///
119 /// The vector-functions library defines, which functions are vectorizable
120 /// and with which factor. The library can be specified by either frontend,
121 /// or a commandline option, and then used by
122 /// addVectorizableFunctionsFromVecLib for filling up the tables of
123 /// vectorizable functions.
125 NoLibrary, // Don't use any vector library.
126 Accelerate, // Use Accelerate framework.
127 DarwinLibSystemM, // Use Darwin's libsystem_m.
128 LIBMVEC_X86, // GLIBC Vector Math library.
129 MASSV, // IBM MASS vector library.
130 SVML, // Intel short vector math library.
131 SLEEFGNUABI, // SLEEF - SIMD Library for Evaluating Elementary Functions.
132 ArmPL // Arm Performance Libraries.
133 };
134
136 explicit TargetLibraryInfoImpl(const Triple &T);
137
138 // Provide value semantics.
143
144 /// Searches for a particular function name.
145 ///
146 /// If it is one of the known library functions, return true and set F to the
147 /// corresponding value.
148 bool getLibFunc(StringRef funcName, LibFunc &F) const;
149
150 /// Searches for a particular function name, also checking that its type is
151 /// valid for the library function matching that name.
152 ///
153 /// If it is one of the known library functions, return true and set F to the
154 /// corresponding value.
155 ///
156 /// FDecl is assumed to have a parent Module when using this function.
157 bool getLibFunc(const Function &FDecl, LibFunc &F) const;
158
159 /// Forces a function to be marked as unavailable.
161 setState(F, Unavailable);
162 }
163
164 /// Forces a function to be marked as available.
166 setState(F, StandardName);
167 }
168
169 /// Forces a function to be marked as available and provide an alternate name
170 /// that must be used.
172 if (StandardNames[F] != Name) {
173 setState(F, CustomName);
174 CustomNames[F] = std::string(Name);
175 assert(CustomNames.contains(F));
176 } else {
177 setState(F, StandardName);
178 }
179 }
180
181 /// Disables all builtins.
182 ///
183 /// This can be used for options like -fno-builtin.
184 void disableAllFunctions();
185
186 /// Add a set of scalar -> vector mappings, queryable via
187 /// getVectorizedFunction and getScalarizedFunction.
189
190 /// Calls addVectorizableFunctions with a known preset of functions for the
191 /// given vector library.
193 const llvm::Triple &TargetTriple);
194
195 /// Return true if the function F has a vector equivalent with vectorization
196 /// factor VF.
198 return !(getVectorizedFunction(F, VF, false).empty() &&
199 getVectorizedFunction(F, VF, true).empty());
200 }
201
202 /// Return true if the function F has a vector equivalent with any
203 /// vectorization factor.
205
206 /// Return the name of the equivalent of F, vectorized with factor VF. If no
207 /// such mapping exists, return the empty string.
209 bool Masked) const;
210
211 /// Return a pointer to a VecDesc object holding all info for scalar to vector
212 /// mappings in TLI for the equivalent of F, vectorized with factor VF.
213 /// If no such mapping exists, return nullpointer.
215 bool Masked) const;
216
217 /// Set to true iff i32 parameters to library functions should have signext
218 /// or zeroext attributes if they correspond to C-level int or unsigned int,
219 /// respectively.
220 void setShouldExtI32Param(bool Val) {
221 ShouldExtI32Param = Val;
222 }
223
224 /// Set to true iff i32 results from library functions should have signext
225 /// or zeroext attributes if they correspond to C-level int or unsigned int,
226 /// respectively.
227 void setShouldExtI32Return(bool Val) {
228 ShouldExtI32Return = Val;
229 }
230
231 /// Set to true iff i32 parameters to library functions should have signext
232 /// attribute if they correspond to C-level int or unsigned int.
234 ShouldSignExtI32Param = Val;
235 }
236
237 /// Set to true iff i32 results from library functions should have signext
238 /// attribute if they correspond to C-level int or unsigned int.
240 ShouldSignExtI32Return = Val;
241 }
242
243 /// Returns the size of the wchar_t type in bytes or 0 if the size is unknown.
244 /// This queries the 'wchar_size' metadata.
245 unsigned getWCharSize(const Module &M) const;
246
247 /// Returns the size of the size_t type in bits.
248 unsigned getSizeTSize(const Module &M) const;
249
250 /// Get size of a C-level int or unsigned int, in bits.
251 unsigned getIntSize() const {
252 return SizeOfInt;
253 }
254
255 /// Initialize the C-level size of an integer.
256 void setIntSize(unsigned Bits) {
257 SizeOfInt = Bits;
258 }
259
260 /// Returns the largest vectorization factor used in the list of
261 /// vector functions.
262 void getWidestVF(StringRef ScalarF, ElementCount &FixedVF,
263 ElementCount &Scalable) const;
264
265 /// Returns true if call site / callee has cdecl-compatible calling
266 /// conventions.
267 static bool isCallingConvCCompatible(CallBase *CI);
268 static bool isCallingConvCCompatible(Function *Callee);
269};
270
271/// Provides information about what library functions are available for
272/// the current target.
273///
274/// This both allows optimizations to handle them specially and frontends to
275/// disable such optimizations through -fno-builtin etc.
279
280 /// The global (module level) TLI info.
281 const TargetLibraryInfoImpl *Impl;
282
283 /// Support for -fno-builtin* options as function attributes, overrides
284 /// information in global TargetLibraryInfoImpl.
285 BitVector OverrideAsUnavailable;
286
287public:
289 std::optional<const Function *> F = std::nullopt)
290 : Impl(&Impl), OverrideAsUnavailable(NumLibFuncs) {
291 if (!F)
292 return;
293 if ((*F)->hasFnAttribute("no-builtins"))
295 else {
296 // Disable individual libc/libm calls in TargetLibraryInfo.
297 LibFunc LF;
298 AttributeSet FnAttrs = (*F)->getAttributes().getFnAttrs();
299 for (const Attribute &Attr : FnAttrs) {
300 if (!Attr.isStringAttribute())
301 continue;
302 auto AttrStr = Attr.getKindAsString();
303 if (!AttrStr.consume_front("no-builtin-"))
304 continue;
305 if (getLibFunc(AttrStr, LF))
306 setUnavailable(LF);
307 }
308 }
309 }
310
311 // Provide value semantics.
314 : Impl(TLI.Impl), OverrideAsUnavailable(TLI.OverrideAsUnavailable) {}
317 Impl = TLI.Impl;
318 OverrideAsUnavailable = TLI.OverrideAsUnavailable;
319 return *this;
320 }
321
322 /// Determine whether a callee with the given TLI can be inlined into
323 /// caller with this TLI, based on 'nobuiltin' attributes. When requested,
324 /// allow inlining into a caller with a superset of the callee's nobuiltin
325 /// attributes, which is conservatively correct.
327 bool AllowCallerSuperset) const {
328 if (!AllowCallerSuperset)
329 return OverrideAsUnavailable == CalleeTLI.OverrideAsUnavailable;
330 BitVector B = OverrideAsUnavailable;
331 B |= CalleeTLI.OverrideAsUnavailable;
332 // We can inline if the union of the caller and callee's nobuiltin
333 // attributes is no stricter than the caller's nobuiltin attributes.
334 return B == OverrideAsUnavailable;
335 }
336
337 /// Return true if the function type FTy is valid for the library function
338 /// F, regardless of whether the function is available.
340 const Module &M) const {
341 return Impl->isValidProtoForLibFunc(FTy, F, M);
342 }
343
344 /// Searches for a particular function name.
345 ///
346 /// If it is one of the known library functions, return true and set F to the
347 /// corresponding value.
348 bool getLibFunc(StringRef funcName, LibFunc &F) const {
349 return Impl->getLibFunc(funcName, F);
350 }
351
352 bool getLibFunc(const Function &FDecl, LibFunc &F) const {
353 return Impl->getLibFunc(FDecl, F);
354 }
355
356 /// If a callbase does not have the 'nobuiltin' attribute, return if the
357 /// called function is a known library function and set F to that function.
358 bool getLibFunc(const CallBase &CB, LibFunc &F) const {
359 return !CB.isNoBuiltin() && CB.getCalledFunction() &&
361 }
362
363 /// Disables all builtins.
364 ///
365 /// This can be used for options like -fno-builtin.
367 OverrideAsUnavailable.set();
368 }
369
370 /// Forces a function to be marked as unavailable.
372 OverrideAsUnavailable.set(F);
373 }
374
375 TargetLibraryInfoImpl::AvailabilityState getState(LibFunc F) const {
376 if (OverrideAsUnavailable[F])
377 return TargetLibraryInfoImpl::Unavailable;
378 return Impl->getState(F);
379 }
380
381 /// Tests whether a library function is available.
382 bool has(LibFunc F) const {
383 return getState(F) != TargetLibraryInfoImpl::Unavailable;
384 }
386 return Impl->isFunctionVectorizable(F, VF);
387 }
389 return Impl->isFunctionVectorizable(F);
390 }
392 bool Masked = false) const {
393 return Impl->getVectorizedFunction(F, VF, Masked);
394 }
396 bool Masked) const {
397 return Impl->getVectorMappingInfo(F, VF, Masked);
398 }
399
400 /// Tests if the function is both available and a candidate for optimized code
401 /// generation.
403 if (getState(F) == TargetLibraryInfoImpl::Unavailable)
404 return false;
405 switch (F) {
406 default: break;
407 case LibFunc_copysign: case LibFunc_copysignf: case LibFunc_copysignl:
408 case LibFunc_fabs: case LibFunc_fabsf: case LibFunc_fabsl:
409 case LibFunc_sin: case LibFunc_sinf: case LibFunc_sinl:
410 case LibFunc_cos: case LibFunc_cosf: case LibFunc_cosl:
411 case LibFunc_sqrt: case LibFunc_sqrtf: case LibFunc_sqrtl:
412 case LibFunc_sqrt_finite: case LibFunc_sqrtf_finite:
413 case LibFunc_sqrtl_finite:
414 case LibFunc_fmax: case LibFunc_fmaxf: case LibFunc_fmaxl:
415 case LibFunc_fmin: case LibFunc_fminf: case LibFunc_fminl:
416 case LibFunc_floor: case LibFunc_floorf: case LibFunc_floorl:
417 case LibFunc_nearbyint: case LibFunc_nearbyintf: case LibFunc_nearbyintl:
418 case LibFunc_ceil: case LibFunc_ceilf: case LibFunc_ceill:
419 case LibFunc_rint: case LibFunc_rintf: case LibFunc_rintl:
420 case LibFunc_round: case LibFunc_roundf: case LibFunc_roundl:
421 case LibFunc_trunc: case LibFunc_truncf: case LibFunc_truncl:
422 case LibFunc_log2: case LibFunc_log2f: case LibFunc_log2l:
423 case LibFunc_exp2: case LibFunc_exp2f: case LibFunc_exp2l:
424 case LibFunc_ldexp: case LibFunc_ldexpf: case LibFunc_ldexpl:
425 case LibFunc_memcpy: case LibFunc_memset: case LibFunc_memmove:
426 case LibFunc_memcmp: case LibFunc_bcmp: case LibFunc_strcmp:
427 case LibFunc_strcpy: case LibFunc_stpcpy: case LibFunc_strlen:
428 case LibFunc_strnlen: case LibFunc_memchr: case LibFunc_mempcpy:
429 return true;
430 }
431 return false;
432 }
433
435 auto State = getState(F);
436 if (State == TargetLibraryInfoImpl::Unavailable)
437 return StringRef();
438 if (State == TargetLibraryInfoImpl::StandardName)
439 return Impl->StandardNames[F];
440 assert(State == TargetLibraryInfoImpl::CustomName);
441 return Impl->CustomNames.find(F)->second;
442 }
443
444 static void initExtensionsForTriple(bool &ShouldExtI32Param,
445 bool &ShouldExtI32Return,
446 bool &ShouldSignExtI32Param,
447 bool &ShouldSignExtI32Return,
448 const Triple &T) {
449 ShouldExtI32Param = ShouldExtI32Return = false;
450 ShouldSignExtI32Param = ShouldSignExtI32Return = false;
451
452 // PowerPC64, Sparc64, SystemZ need signext/zeroext on i32 parameters and
453 // returns corresponding to C-level ints and unsigned ints.
454 if (T.isPPC64() || T.getArch() == Triple::sparcv9 ||
455 T.getArch() == Triple::systemz) {
456 ShouldExtI32Param = true;
457 ShouldExtI32Return = true;
458 }
459 // LoongArch, Mips, and riscv64, on the other hand, need signext on i32
460 // parameters corresponding to both signed and unsigned ints.
461 if (T.isLoongArch() || T.isMIPS() || T.isRISCV64()) {
462 ShouldSignExtI32Param = true;
463 }
464 // LoongArch and riscv64 need signext on i32 returns corresponding to both
465 // signed and unsigned ints.
466 if (T.isLoongArch() || T.isRISCV64()) {
467 ShouldSignExtI32Return = true;
468 }
469 }
470
471 /// Returns extension attribute kind to be used for i32 parameters
472 /// corresponding to C-level int or unsigned int. May be zeroext, signext,
473 /// or none.
474private:
475 static Attribute::AttrKind getExtAttrForI32Param(bool ShouldExtI32Param_,
476 bool ShouldSignExtI32Param_,
477 bool Signed = true) {
478 if (ShouldExtI32Param_)
479 return Signed ? Attribute::SExt : Attribute::ZExt;
480 if (ShouldSignExtI32Param_)
481 return Attribute::SExt;
482 return Attribute::None;
483 }
484
485public:
487 bool Signed = true) {
488 bool ShouldExtI32Param, ShouldExtI32Return;
489 bool ShouldSignExtI32Param, ShouldSignExtI32Return;
490 initExtensionsForTriple(ShouldExtI32Param, ShouldExtI32Return,
491 ShouldSignExtI32Param, ShouldSignExtI32Return, T);
492 return getExtAttrForI32Param(ShouldExtI32Param, ShouldSignExtI32Param,
493 Signed);
494 }
495
497 return getExtAttrForI32Param(Impl->ShouldExtI32Param,
498 Impl->ShouldSignExtI32Param, Signed);
499 }
500
501 /// Returns extension attribute kind to be used for i32 return values
502 /// corresponding to C-level int or unsigned int. May be zeroext, signext,
503 /// or none.
504private:
505 static Attribute::AttrKind getExtAttrForI32Return(bool ShouldExtI32Return_,
506 bool ShouldSignExtI32Return_,
507 bool Signed) {
508 if (ShouldExtI32Return_)
509 return Signed ? Attribute::SExt : Attribute::ZExt;
510 if (ShouldSignExtI32Return_)
511 return Attribute::SExt;
512 return Attribute::None;
513 }
514
515public:
517 bool Signed = true) {
518 bool ShouldExtI32Param, ShouldExtI32Return;
519 bool ShouldSignExtI32Param, ShouldSignExtI32Return;
520 initExtensionsForTriple(ShouldExtI32Param, ShouldExtI32Return,
521 ShouldSignExtI32Param, ShouldSignExtI32Return, T);
522 return getExtAttrForI32Return(ShouldExtI32Return, ShouldSignExtI32Return,
523 Signed);
524 }
525
527 return getExtAttrForI32Return(Impl->ShouldExtI32Return,
528 Impl->ShouldSignExtI32Return, Signed);
529 }
530
531 // Helper to create an AttributeList for args (and ret val) which all have
532 // the same signedness. Attributes in AL may be passed in to include them
533 // as well in the returned AttributeList.
535 bool Signed, bool Ret = false,
536 AttributeList AL = AttributeList()) const {
537 if (auto AK = getExtAttrForI32Param(Signed))
538 for (auto ArgNo : ArgNos)
539 AL = AL.addParamAttribute(*C, ArgNo, AK);
540 if (Ret)
541 if (auto AK = getExtAttrForI32Return(Signed))
542 AL = AL.addRetAttribute(*C, AK);
543 return AL;
544 }
545
546 /// \copydoc TargetLibraryInfoImpl::getWCharSize()
547 unsigned getWCharSize(const Module &M) const {
548 return Impl->getWCharSize(M);
549 }
550
551 /// \copydoc TargetLibraryInfoImpl::getSizeTSize()
552 unsigned getSizeTSize(const Module &M) const { return Impl->getSizeTSize(M); }
553
554 /// \copydoc TargetLibraryInfoImpl::getIntSize()
555 unsigned getIntSize() const {
556 return Impl->getIntSize();
557 }
558
559 /// Handle invalidation from the pass manager.
560 ///
561 /// If we try to invalidate this info, just return false. It cannot become
562 /// invalid even if the module or function changes.
565 return false;
566 }
569 return false;
570 }
571 /// Returns the largest vectorization factor used in the list of
572 /// vector functions.
573 void getWidestVF(StringRef ScalarF, ElementCount &FixedVF,
574 ElementCount &ScalableVF) const {
575 Impl->getWidestVF(ScalarF, FixedVF, ScalableVF);
576 }
577
578 /// Check if the function "F" is listed in a library known to LLVM.
580 return this->isFunctionVectorizable(F);
581 }
582};
583
584/// Analysis pass providing the \c TargetLibraryInfo.
585///
586/// Note that this pass's result cannot be invalidated, it is immutable for the
587/// life of the module.
588class TargetLibraryAnalysis : public AnalysisInfoMixin<TargetLibraryAnalysis> {
589public:
591
592 /// Default construct the library analysis.
593 ///
594 /// This will use the module's triple to construct the library info for that
595 /// module.
597
598 /// Construct a library analysis with baseline Module-level info.
599 ///
600 /// This will be supplemented with Function-specific info in the Result.
602 : BaselineInfoImpl(std::move(BaselineInfoImpl)) {}
603
605
606private:
608 static AnalysisKey Key;
609
610 std::optional<TargetLibraryInfoImpl> BaselineInfoImpl;
611};
612
615 std::optional<TargetLibraryInfo> TLI;
616
617 virtual void anchor();
618
619public:
620 static char ID;
622 explicit TargetLibraryInfoWrapperPass(const Triple &T);
624
627 TLI = TLA.run(F, DummyFAM);
628 return *TLI;
629 }
630};
631
632} // end namespace llvm
633
634#endif
This file implements the BitVector class.
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
#define LLVM_ATTRIBUTE_UNUSED
Definition: Compiler.h:184
This file defines the DenseMap class.
std::string Name
AvailabilityState
Definition: GVN.cpp:808
@ Unavailable
We know the block is not fully available. This is a fixpoint.
#define F(x, y, z)
Definition: MD5.cpp:55
Machine Check Debug Module
This header defines various interfaces for pass management in LLVM.
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
API to communicate dependencies between analyses during invalidation.
Definition: PassManager.h:690
A container for analyses that lazily runs them and caches their results.
Definition: PassManager.h:649
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: ArrayRef.h:41
AttrKind
This enumeration lists the attributes that can be associated with parameters, function results,...
Definition: Attributes.h:84
@ None
No attributes have been set.
Definition: Attributes.h:86
BitVector & set()
Definition: BitVector.h:351
Base class for all callable instructions (InvokeInst and CallInst) Holds everything related to callin...
Definition: InstrTypes.h:1227
bool isNoBuiltin() const
Return true if the call should not be treated as a call to a builtin.
Definition: InstrTypes.h:1913
Function * getCalledFunction() const
Returns the function called, or null if this is an indirect function invocation or the function signa...
Definition: InstrTypes.h:1449
iterator find(const_arg_type_t< KeyT > Val)
Definition: DenseMap.h:155
Class to represent function types.
Definition: DerivedTypes.h:103
ImmutablePass class - This class is used to provide information that does not need to be run.
Definition: Pass.h:282
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:67
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
A set of analyses that are preserved following a run of a transformation pass.
Definition: PassManager.h:172
A wrapper around a string literal that serves as a proxy for constructing global tables of StringRefs...
Definition: StringRef.h:857
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
constexpr bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:134
Analysis pass providing the TargetLibraryInfo.
TargetLibraryAnalysis()=default
Default construct the library analysis.
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 ...
unsigned getWCharSize(const Module &M) const
Returns the size of the wchar_t type in bytes or 0 if the size is unknown.
bool getLibFunc(StringRef funcName, LibFunc &F) const
Searches for a particular function name.
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.
unsigned getIntSize() const
Get size of a C-level int or unsigned int, in bits.
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.
unsigned getSizeTSize(const Module &M) const
Returns the size of the size_t type in bits.
void addVectorizableFunctions(ArrayRef< VecDesc > Fns)
Add a set of scalar -> vector mappings, queryable via getVectorizedFunction and getScalarizedFunction...
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 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...
TargetLibraryInfoImpl & operator=(const TargetLibraryInfoImpl &TLI)
void disableAllFunctions()
Disables all builtins.
VectorLibrary
List of known vector-functions libraries.
void setUnavailable(LibFunc F)
Forces a function to be marked as unavailable.
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.
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
TargetLibraryInfo & operator=(TargetLibraryInfo &&TLI)
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.
TargetLibraryInfo(TargetLibraryInfo &&TLI)
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...
unsigned getWCharSize(const Module &M) const
Returns the size of the wchar_t type in bytes or 0 if the size is unknown.
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.
bool isFunctionVectorizable(StringRef F) const
bool has(LibFunc F) const
Tests whether a library function is available.
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
void disableAllFunctions() LLVM_ATTRIBUTE_UNUSED
Disables all builtins.
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.
void setUnavailable(LibFunc F) LLVM_ATTRIBUTE_UNUSED
Forces a function to be marked as unavailable.
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.
static void initExtensionsForTriple(bool &ShouldExtI32Param, bool &ShouldExtI32Return, bool &ShouldSignExtI32Param, bool &ShouldSignExtI32Return, const Triple &T)
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
unsigned getIntSize() const
Get size of a C-level int or unsigned int, in bits.
Attribute::AttrKind getExtAttrForI32Param(bool Signed=true) const
bool isFunctionVectorizable(StringRef F, const ElementCount &VF) const
Triple - Helper class for working with autoconf configuration names.
Definition: Triple.h:44
Provides info so a possible vectorization of a function can be computed.
StringRef getVABIPrefix() const
VecDesc()=delete
bool isMasked() const
std::string getVectorFunctionABIVariantString() const
Returns a vector function ABI variant string on the form: ZGV<isa><mask><vlen><vparams><scalarname>(<...
StringRef getScalarFnName() const
VecDesc(StringRef ScalarFnName, StringRef VectorFnName, ElementCount VectorizationFactor, bool Masked, StringRef VABIPrefix)
StringRef getVectorFnName() const
ElementCount getVectorizationFactor() const
@ C
The default llvm calling convention, compatible with C.
Definition: CallingConv.h:34
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
ArrayRef(const T &OneElt) -> ArrayRef< T >
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Definition: STLExtras.h:1853
Implement std::hash so that hash_code can be used in STL containers.
Definition: BitVector.h:858
A CRTP mix-in that provides informational APIs needed for analysis passes.
Definition: PassManager.h:414
A special type used by analysis passes to provide an address that identifies that particular analysis...
Definition: PassManager.h:89
TODO: The following VectorizationFactor was pulled out of LoopVectorizationCostModel class.