LLVM 19.0.0git
VectorBuilder.cpp
Go to the documentation of this file.
1//===- VectorBuilder.cpp - Builder for VP Intrinsics ----------------------===//
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// This file implements the VectorBuilder class, which is used as a convenient
10// way to create VP intrinsics as if they were LLVM instructions with a
11// consistent and simplified interface.
12//
13//===----------------------------------------------------------------------===//
14
16#include <llvm/IR/FPEnv.h>
19#include <llvm/IR/Intrinsics.h>
21
22namespace llvm {
23
24void VectorBuilder::handleError(const char *ErrorMsg) const {
25 if (ErrorHandling == Behavior::SilentlyReturnNone)
26 return;
27 report_fatal_error(ErrorMsg);
28}
29
31 return *Builder.GetInsertBlock()->getModule();
32}
33
35 return Builder.getAllOnesMask(StaticVectorLength);
36}
37
38Value &VectorBuilder::requestMask() {
39 if (Mask)
40 return *Mask;
41
42 return *getAllTrueMask();
43}
44
45Value &VectorBuilder::requestEVL() {
46 if (ExplicitVectorLength)
47 return *ExplicitVectorLength;
48
49 assert(!StaticVectorLength.isScalable() && "TODO vscale lowering");
50 auto *IntTy = Builder.getInt32Ty();
51 return *ConstantInt::get(IntTy, StaticVectorLength.getFixedValue());
52}
53
55 ArrayRef<Value *> InstOpArray,
56 const Twine &Name) {
57 auto VPID = VPIntrinsic::getForOpcode(Opcode);
58 if (VPID == Intrinsic::not_intrinsic)
59 return returnWithError<Value *>("No VPIntrinsic for this opcode");
60
61 auto MaskPosOpt = VPIntrinsic::getMaskParamPos(VPID);
62 auto VLenPosOpt = VPIntrinsic::getVectorLengthParamPos(VPID);
63 size_t NumInstParams = InstOpArray.size();
64 size_t NumVPParams =
65 NumInstParams + MaskPosOpt.has_value() + VLenPosOpt.has_value();
66
67 SmallVector<Value *, 6> IntrinParams;
68
69 // Whether the mask and vlen parameter are at the end of the parameter list.
70 bool TrailingMaskAndVLen =
71 std::min<size_t>(MaskPosOpt.value_or(NumInstParams),
72 VLenPosOpt.value_or(NumInstParams)) >= NumInstParams;
73
74 if (TrailingMaskAndVLen) {
75 // Fast path for trailing mask, vector length.
76 IntrinParams.append(InstOpArray.begin(), InstOpArray.end());
77 IntrinParams.resize(NumVPParams);
78 } else {
79 IntrinParams.resize(NumVPParams);
80 // Insert mask and evl operands in between the instruction operands.
81 for (size_t VPParamIdx = 0, ParamIdx = 0; VPParamIdx < NumVPParams;
82 ++VPParamIdx) {
83 if ((MaskPosOpt && MaskPosOpt.value_or(NumVPParams) == VPParamIdx) ||
84 (VLenPosOpt && VLenPosOpt.value_or(NumVPParams) == VPParamIdx))
85 continue;
86 assert(ParamIdx < NumInstParams);
87 IntrinParams[VPParamIdx] = InstOpArray[ParamIdx++];
88 }
89 }
90
91 if (MaskPosOpt)
92 IntrinParams[*MaskPosOpt] = &requestMask();
93 if (VLenPosOpt)
94 IntrinParams[*VLenPosOpt] = &requestEVL();
95
96 auto *VPDecl = VPIntrinsic::getDeclarationForParams(&getModule(), VPID,
97 ReturnTy, IntrinParams);
98 return Builder.CreateCall(VPDecl, IntrinParams, Name);
99}
100
101} // namespace llvm
std::string Name
This file contains the declarations of entities that describe floating point environment and related ...
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
This file defines the SmallVector class.
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: ArrayRef.h:41
iterator end() const
Definition: ArrayRef.h:154
size_t size() const
size - Get the array size.
Definition: ArrayRef.h:165
iterator begin() const
Definition: ArrayRef.h:153
const Module * getModule() const
Return the module owning the function this basic block belongs to, or nullptr if the function does no...
Definition: BasicBlock.cpp:336
IntegerType * getInt32Ty()
Fetch the type representing a 32-bit integer.
Definition: IRBuilder.h:520
BasicBlock * GetInsertBlock() const
Definition: IRBuilder.h:174
Value * getAllOnesMask(ElementCount NumElts)
Return an all true boolean vector (mask) with NumElts lanes.
Definition: IRBuilder.h:842
CallInst * CreateCall(FunctionType *FTy, Value *Callee, ArrayRef< Value * > Args=std::nullopt, const Twine &Name="", MDNode *FPMathTag=nullptr)
Definition: IRBuilder.h:2395
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
void append(ItTy in_start, ItTy in_end)
Add the specified range to the end of the SmallVector.
Definition: SmallVector.h:696
void resize(size_type N)
Definition: SmallVector.h:651
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1209
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:81
The instances of the Type class are immutable: once they are created, they are never changed.
Definition: Type.h:45
static Function * getDeclarationForParams(Module *M, Intrinsic::ID, Type *ReturnType, ArrayRef< Value * > Params)
Declares a llvm.vp.
static std::optional< unsigned > getMaskParamPos(Intrinsic::ID IntrinsicID)
static std::optional< unsigned > getVectorLengthParamPos(Intrinsic::ID IntrinsicID)
static Intrinsic::ID getForOpcode(unsigned OC)
The llvm.vp.* intrinsics for this instruction Opcode.
LLVM Value Representation.
Definition: Value.h:74
Module & getModule() const
Value * createVectorInstruction(unsigned Opcode, Type *ReturnTy, ArrayRef< Value * > VecOpArray, const Twine &Name=Twine())
constexpr ScalarTy getFixedValue() const
Definition: TypeSize.h:187
constexpr bool isScalable() const
Returns whether the quantity is scaled by a runtime quantity (vscale).
Definition: TypeSize.h:171
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
void report_fatal_error(Error Err, bool gen_crash_diag=true)
Report a serious error, calling any installed error handler.
Definition: Error.cpp:156