LLVM 18.0.0git
Go to the documentation of this file.
1//===- InjectTLIMAppings.cpp - TLI to VFABI attribute injection ----------===//
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
9// Populates the VFABI attribute with the scalar-to-vector mappings
10// from the TargetLibraryInfo.
15#include "llvm/ADT/Statistic.h"
24using namespace llvm;
26#define DEBUG_TYPE "inject-tli-mappings"
29 "Number of calls in which the mappings have been injected.");
32 "Number of function declarations that have been added.");
34 "Number of `@llvm.compiler.used` operands that have been added.");
36/// A helper function that adds the vector function declaration that
37/// vectorizes the CallInst CI with a vectorization factor of VF
38/// lanes. The TLI assumes that all parameters and the return type of
39/// CI (other than void) need to be widened to a VectorType of VF
40/// lanes.
41static void addVariantDeclaration(CallInst &CI, const ElementCount &VF,
42 bool Predicate, const StringRef VFName) {
43 Module *M = CI.getModule();
45 // Add function declaration.
46 Type *RetTy = ToVectorTy(CI.getType(), VF);
48 for (Value *ArgOperand : CI.args())
49 Tys.push_back(ToVectorTy(ArgOperand->getType(), VF));
51 "VarArg functions are not supported.");
52 if (Predicate)
53 Tys.push_back(ToVectorTy(Type::getInt1Ty(RetTy->getContext()), VF));
54 FunctionType *FTy = FunctionType::get(RetTy, Tys, /*isVarArg=*/false);
55 Function *VectorF =
56 Function::Create(FTy, Function::ExternalLinkage, VFName, M);
58 ++NumVFDeclAdded;
59 LLVM_DEBUG(dbgs() << DEBUG_TYPE << ": Added to the module: `" << VFName
60 << "` of type " << *(VectorF->getType()) << "\n");
62 // Make function declaration (without a body) "sticky" in the IR by
63 // listing it in the @llvm.compiler.used intrinsic.
64 assert(!VectorF->size() && "VFABI attribute requires `@llvm.compiler.used` "
65 "only on declarations.");
66 appendToCompilerUsed(*M, {VectorF});
67 LLVM_DEBUG(dbgs() << DEBUG_TYPE << ": Adding `" << VFName
68 << "` to `@llvm.compiler.used`.\n");
69 ++NumCompUsedAdded;
72static void addMappingsFromTLI(const TargetLibraryInfo &TLI, CallInst &CI) {
73 // This is needed to make sure we don't query the TLI for calls to
74 // bitcast of function pointers, like `%call = call i32 (i32*, ...)
75 // bitcast (i32 (...)* @goo to i32 (i32*, ...)*)(i32* nonnull %i)`,
76 // as such calls make the `isFunctionVectorizable` raise an
77 // exception.
78 if (CI.isNoBuiltin() || !CI.getCalledFunction())
79 return;
81 StringRef ScalarName = CI.getCalledFunction()->getName();
83 // Nothing to be done if the TLI thinks the function is not
84 // vectorizable.
85 if (!TLI.isFunctionVectorizable(ScalarName))
86 return;
88 VFABI::getVectorVariantNames(CI, Mappings);
89 Module *M = CI.getModule();
90 const SetVector<StringRef> OriginalSetOfMappings(Mappings.begin(),
91 Mappings.end());
93 auto AddVariantDecl = [&](const ElementCount &VF, bool Predicate) {
94 const VecDesc *VD = TLI.getVectorMappingInfo(ScalarName, VF, Predicate);
95 if (VD && !VD->getVectorFnName().empty()) {
96 std::string MangledName = VD->getVectorFunctionABIVariantString();
97 if (!OriginalSetOfMappings.count(MangledName)) {
98 Mappings.push_back(MangledName);
99 ++NumCallInjected;
100 }
101 Function *VariantF = M->getFunction(VD->getVectorFnName());
102 if (!VariantF)
103 addVariantDeclaration(CI, VF, Predicate, VD->getVectorFnName());
104 }
105 };
107 // All VFs in the TLI are powers of 2.
108 ElementCount WidestFixedVF, WidestScalableVF;
109 TLI.getWidestVF(ScalarName, WidestFixedVF, WidestScalableVF);
111 for (bool Predicated : {false, true}) {
113 ElementCount::isKnownLE(VF, WidestFixedVF); VF *= 2)
114 AddVariantDecl(VF, Predicated);
117 ElementCount::isKnownLE(VF, WidestScalableVF); VF *= 2)
118 AddVariantDecl(VF, Predicated);
119 }
121 VFABI::setVectorVariantNames(&CI, Mappings);
124static bool runImpl(const TargetLibraryInfo &TLI, Function &F) {
125 for (auto &I : instructions(F))
126 if (auto CI = dyn_cast<CallInst>(&I))
127 addMappingsFromTLI(TLI, *CI);
128 // Even if the pass adds IR attributes, the analyses are preserved.
129 return false;
133// New pass manager implementation.
138 runImpl(TLI, F);
139 // Even if the pass adds IR attributes, the analyses are preserved.
140 return PreservedAnalyses::all();
return RetTy
#define LLVM_DEBUG(X)
Definition: Debug.h:101
static bool runImpl(Function &F, const TargetLowering &TLI)
This is the interface for a simple mod/ref and alias analysis over globals.
static void addMappingsFromTLI(const TargetLibraryInfo &TLI, CallInst &CI)
static void addVariantDeclaration(CallInst &CI, const ElementCount &VF, bool Predicate, const StringRef VFName)
A helper function that adds the vector function declaration that vectorizes the CallInst CI with a ve...
static bool runImpl(const TargetLibraryInfo &TLI, Function &F)
#define DEBUG_TYPE
Select target instructions out of generic instructions
#define F(x, y, z)
Definition: MD5.cpp:55
#define I(x, y, z)
Definition: MD5.cpp:58
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
This file defines the 'Statistic' class, which is designed to be an easy way to expose various metric...
Definition: Statistic.h:167
A container for analyses that lazily runs them and caches their results.
Definition: PassManager.h:649
PassT::Result & getResult(IRUnitT &IR, ExtraArgTs... ExtraArgs)
Get the result of an analysis pass for a given IR unit.
Definition: PassManager.h:803
bool isNoBuiltin() const
Return true if the call should not be treated as a call to a builtin.
Definition: InstrTypes.h:1945
Function * getCalledFunction() const
Returns the function called, or null if this is an indirect function invocation or the function signa...
Definition: InstrTypes.h:1481
FunctionType * getFunctionType() const
Definition: InstrTypes.h:1339
iterator_range< User::op_iterator > args()
Iteration adapter for range-for loops.
Definition: InstrTypes.h:1417
This class represents a function call, abstracting a target machine's calling convention.
static constexpr ElementCount getScalable(ScalarTy MinVal)
Definition: TypeSize.h:299
static constexpr ElementCount getFixed(ScalarTy MinVal)
Definition: TypeSize.h:296
bool isVarArg() const
Definition: DerivedTypes.h:123
static Function * Create(FunctionType *Ty, LinkageTypes Linkage, unsigned AddrSpace, const Twine &N="", Module *M=nullptr)
Definition: Function.h:162
size_t size() const
Definition: Function.h:799
void copyAttributesFrom(const Function *Src)
copyAttributesFrom - copy all additional attributes (those not needed to create a Function) from the ...
Definition: Function.cpp:778
PointerType * getType() const
Global values are always pointers.
Definition: GlobalValue.h:290
PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM)
const Module * getModule() const
Return the module owning the function this instruction belongs to or nullptr it the function does not...
Definition: Instruction.cpp:71
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
static PreservedAnalyses all()
Construct a special preserved set that preserves all passes.
Definition: PassManager.h:178
A vector that has set insertion semantics.
Definition: SetVector.h:57
size_type count(const key_type &key) const
Count the number of elements of a given key in the SetVector.
Definition: SetVector.h:264
void push_back(const T &Elt)
Definition: SmallVector.h:416
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1200
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.
Provides information about what library functions are available for the current target.
void getWidestVF(StringRef ScalarF, ElementCount &FixedVF, ElementCount &ScalableVF) const
Returns the largest vectorization factor used in the list of vector functions.
const VecDesc * getVectorMappingInfo(StringRef F, const ElementCount &VF, bool Masked) const
bool isFunctionVectorizable(StringRef F, const ElementCount &VF) const
The instances of the Type class are immutable: once they are created, they are never changed.
Definition: Type.h:45
static IntegerType * getInt1Ty(LLVMContext &C)
LLVM Value Representation.
Definition: Value.h:74
Type * getType() const
All values are typed, get the type of this value.
Definition: Value.h:255
StringRef getName() const
Return a constant reference to the value's name.
Definition: Value.cpp:309
Provides info so a possible vectorization of a function can be computed.
std::string getVectorFunctionABIVariantString() const
Returns a vector function ABI variant string on the form: ZGV<isa><mask><vlen><vparams><scalarname>(<...
StringRef getVectorFnName() const
void getVectorVariantNames(const CallInst &CI, SmallVectorImpl< std::string > &VariantMappings)
Populates a set of strings representing the Vector Function ABI variants associated to the CallInst C...
void setVectorVariantNames(CallInst *CI, ArrayRef< std::string > VariantMappings)
Overwrite the Vector Function ABI variants attribute with the names provide in VariantMappings.
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:163
Type * ToVectorTy(Type *Scalar, ElementCount EC)
A helper function for converting Scalar types to vector types.
Definition: VectorUtils.h:308
void appendToCompilerUsed(Module &M, ArrayRef< GlobalValue * > Values)
Adds global values to the llvm.compiler.used list.