27#include "llvm/IR/IntrinsicsSPIRV.h"
41 if (MIRBuilder.
getMF()
57 *STI.getRegBankInfo());
71 if (
F.hasFnAttribute(Attribute::AttrKind::NoInline))
72 FuncControl |=
static_cast<uint32_t>(SPIRV::FunctionControl::DontInline);
73 else if (
F.hasFnAttribute(Attribute::AttrKind::AlwaysInline))
74 FuncControl |=
static_cast<uint32_t>(SPIRV::FunctionControl::Inline);
77 FuncControl |=
static_cast<uint32_t>(SPIRV::FunctionControl::Pure);
79 FuncControl |=
static_cast<uint32_t>(SPIRV::FunctionControl::Const);
81 if (ST->canUseExtension(SPIRV::Extension::SPV_INTEL_optnone) ||
82 ST->canUseExtension(SPIRV::Extension::SPV_EXT_optnone))
83 if (
F.hasFnAttribute(Attribute::OptimizeNone))
84 FuncControl |=
static_cast<uint32_t>(SPIRV::FunctionControl::OptNoneEXT);
100 return Arg.getType()->isPointerTy();
103 Type *RetTy = FTy->getReturnType();
113 for (
auto SArgTy : SArgTys)
118static SPIRV::AccessQualifier::AccessQualifier
121 return SPIRV::AccessQualifier::ReadWrite;
125 return SPIRV::AccessQualifier::ReadWrite;
127 if (ArgAttribute->
getString() ==
"read_only")
128 return SPIRV::AccessQualifier::ReadOnly;
129 if (ArgAttribute->
getString() ==
"write_only")
130 return SPIRV::AccessQualifier::WriteOnly;
131 return SPIRV::AccessQualifier::ReadWrite;
134static std::vector<SPIRV::Decoration::Decoration>
137 if (ArgAttribute && ArgAttribute->
getString() ==
"volatile")
138 return {SPIRV::Decoration::Volatile};
147 SPIRV::AccessQualifier::AccessQualifier ArgAccessQual =
150 Type *OriginalArgType =
164 VTy->getNumElements(), MIRBuilder,
true);
196 if (
II &&
II->getIntrinsicID() == Intrinsic::spv_assign_type) {
200 assert(BuiltinType->isTargetExtTy() &&
"Expected TargetExtType");
206 if (!
II ||
II->getIntrinsicID() != Intrinsic::spv_assign_ptr_type)
213 ElementTy, MIRBuilder,
221 ArgAccessQual,
true);
224static SPIRV::ExecutionModel::ExecutionModel
227 "Environment must be resolved before lowering entry points.");
230 return SPIRV::ExecutionModel::Kernel;
232 auto attribute =
F.getFnAttribute(
"hlsl.shader");
233 if (!attribute.isValid()) {
235 "This entry point lacks mandatory hlsl.shader attribute.");
238 const auto value = attribute.getValueAsString();
239 if (value ==
"compute")
240 return SPIRV::ExecutionModel::GLCompute;
241 if (value ==
"vertex")
242 return SPIRV::ExecutionModel::Vertex;
243 if (value ==
"pixel")
244 return SPIRV::ExecutionModel::Fragment;
257 assert(GR &&
"Must initialize the SPIRV type registry before lowering args.");
258 GR->setCurrentFunc(MIRBuilder.
getMF());
266 if (VRegs.size() > 0) {
268 for (
const auto &Arg :
F.args()) {
271 if (VRegs[i].
size() > 1)
274 GR->assignSPIRVTypeToVReg(SpirvTy, VRegs[i][0], MIRBuilder.
getMF());
278 buildOpName(VRegs[i][0], Arg.getName(), MIRBuilder);
280 auto DerefBytes =
static_cast<unsigned>(Arg.getDereferenceableBytes());
283 SPIRV::Decoration::MaxByteOffset, {DerefBytes});
285 if (Arg.hasAttribute(Attribute::Alignment) && !ST->isShader()) {
286 auto Alignment =
static_cast<unsigned>(
287 Arg.getAttribute(Attribute::Alignment).getValueAsInt());
291 if (!ST->isShader()) {
292 if (Arg.hasAttribute(Attribute::ReadOnly)) {
294 static_cast<unsigned>(SPIRV::FunctionParameterAttribute::NoWrite);
296 SPIRV::Decoration::FuncParamAttr, {Attr});
298 if (Arg.hasAttribute(Attribute::ZExt)) {
300 static_cast<unsigned>(SPIRV::FunctionParameterAttribute::Zext);
302 SPIRV::Decoration::FuncParamAttr, {Attr});
304 if (Arg.hasAttribute(Attribute::SExt)) {
306 static_cast<unsigned>(SPIRV::FunctionParameterAttribute::Sext);
308 SPIRV::Decoration::FuncParamAttr, {Attr});
310 if (Arg.hasAttribute(Attribute::NoAlias)) {
312 static_cast<unsigned>(SPIRV::FunctionParameterAttribute::NoAlias);
314 SPIRV::Decoration::FuncParamAttr, {Attr});
321 if (Arg.hasAttribute(Attribute::ByVal) ||
322 (Arg.hasAttribute(Attribute::ByRef) &&
323 F.getParent()->getTargetTriple().getVendor() ==
326 static_cast<unsigned>(SPIRV::FunctionParameterAttribute::ByVal);
328 SPIRV::Decoration::FuncParamAttr, {Attr});
330 if (Arg.hasAttribute(Attribute::StructRet)) {
332 static_cast<unsigned>(SPIRV::FunctionParameterAttribute::Sret);
334 SPIRV::Decoration::FuncParamAttr, {Attr});
339 std::vector<SPIRV::Decoration::Decoration> ArgTypeQualDecs =
341 for (SPIRV::Decoration::Decoration Decoration : ArgTypeQualDecs)
345 MDNode *
Node =
F.getMetadata(
"spirv.ParameterDecorations");
346 if (
Node && i < Node->getNumOperands() &&
351 assert(MD2 &&
"Metadata operand is expected");
353 assert(Const &&
"MDOperand should be ConstantInt");
355 static_cast<SPIRV::Decoration::Decoration
>(Const->getZExtValue());
356 std::vector<uint32_t> DecVec;
359 assert(Const &&
"MDOperand should be ConstantInt");
360 DecVec.push_back(
static_cast<uint32_t>(Const->getZExtValue()));
369 auto MRI = MIRBuilder.
getMRI();
371 MRI->setRegClass(FuncVReg, &SPIRV::iIDRegClass);
375 if (
Type *FRetElemTy = GR->findDeducedElementType(&
F)) {
378 GR->addReturnType(&
F, DerivedTy);
383 FRetTy, MIRBuilder, SPIRV::AccessQualifier::ReadWrite,
true);
385 SPIRVTypeInst FuncTy = GR->getOrCreateOpTypeFunctionWithArgs(
386 FTy, RetTy, ArgTypeVRegs, MIRBuilder);
392 .
addUse(GR->getSPIRVTypeID(RetTy))
394 .
addUse(GR->getSPIRVTypeID(FuncTy));
396 GR->addGlobalObject(&
F, &MIRBuilder.
getMF(), FuncVReg);
397 if (
F.isDeclaration())
402 for (
const auto &Arg :
F.args()) {
403 assert(VRegs[i].
size() == 1 &&
"Formal arg has multiple vregs");
405 MRI->setRegClass(ArgReg, GR->getRegClass(ArgTypeVRegs[i]));
406 auto MIB = MIRBuilder.
buildInstr(SPIRV::OpFunctionParameter)
408 .
addUse(GR->getSPIRVTypeID(ArgTypeVRegs[i]));
409 if (
F.isDeclaration())
411 GR->addGlobalObject(&Arg, &MIRBuilder.
getMF(), ArgReg);
420 if (
F.getName().empty())
422 auto MIB = MIRBuilder.
buildInstr(SPIRV::OpEntryPoint)
427 LnkTy && !
F.getName().empty()) {
428 buildOpDecorate(FuncVReg, MIRBuilder, SPIRV::Decoration::LinkageAttributes,
429 {
static_cast<uint32_t>(*LnkTy)},
F.getName());
433 bool hasFunctionPointers =
434 ST->canUseExtension(SPIRV::Extension::SPV_INTEL_function_pointers);
435 if (hasFunctionPointers) {
436 if (
F.hasFnAttribute(
"referenced-indirectly")) {
438 "Unexpected 'referenced-indirectly' attribute of the kernel "
441 SPIRV::Decoration::ReferencedIndirectlyINTEL, {});
456void SPIRVCallLowering::produceIndirectPtrType(
458 const SPIRVCallLowering::SPIRVIndirectCall &IC)
const {
463 IC.RetTy, MIRBuilder, SPIRV::AccessQualifier::ReadWrite,
true);
465 for (
size_t i = 0; i < IC.ArgTys.size(); ++i) {
467 IC.ArgTys[i], MIRBuilder, SPIRV::AccessQualifier::ReadWrite,
true);
476 FTy, SpirvRetTy, SpirvArgTypes, MIRBuilder);
478 auto SC = ST.canUseExtension(SPIRV::Extension::SPV_INTEL_function_pointers)
479 ? SPIRV::StorageClass::CodeSectionINTEL
480 : SPIRV::StorageClass::Function;
491 if (Info.OrigRet.Regs.size() > 1)
494 GR->setCurrentFunc(MF);
496 std::string DemangledName;
497 const Type *OrigRetTy = Info.OrigRet.Ty;
502 if (Info.Callee.isGlobal()) {
503 std::string FuncName = Info.Callee.getGlobal()->getName().str();
513 if (
auto *DerivedRetTy = GR->findReturnType(CF))
514 OrigRetTy = DerivedRetTy;
520 Info.OrigRet.Regs.empty() ?
Register(0) : Info.OrigRet.Regs[0];
524 if (isFunctionDecl && !DemangledName.empty()) {
526 if (!GR->getSPIRVTypeForVReg(ResVReg)) {
527 const Type *RetTy = OrigRetTy;
529 const Value *OrigValue = Info.OrigRet.OrigValue;
533 if (
Type *ElemTy = GR->findDeducedElementType(OrigValue))
538 SPIRV::AccessQualifier::ReadWrite,
true);
542 SPIRV::AccessQualifier::ReadWrite,
true);
545 for (
auto Arg : Info.OrigArgs) {
546 assert(Arg.Regs.size() == 1 &&
"Call arg has multiple VRegs");
551 Type *ArgTy =
nullptr;
559 if (
Type *ElemTy = GR->findDeducedElementType(Arg.OrigValue))
566 SpvType = GR->getOrCreateSPIRVType(
567 ArgTy, MIRBuilder, SPIRV::AccessQualifier::ReadWrite,
true);
568 GR->assignSPIRVTypeToVReg(SpvType, ArgReg, MF);
575 MRI->
setRegClass(ArgReg, SpvType ? GR->getRegClass(SpvType)
576 : &SPIRV::pIDRegClass);
579 SpvType ? GR->getRegType(SpvType)
581 GR->getPointerSize()));
585 DemangledName, ST->getPreferredInstructionSet(), MIRBuilder,
586 ResVReg, OrigRetTy, ArgVRegs, GR, *Info.CB))
590 if (isFunctionDecl && !GR->find(CF, &MF).isValid()) {
594 FirstBlockBuilder.
setMF(MF);
613 if (MIRBuilder.
getMF()
623 if (Info.CB->isIndirectCall()) {
624 if (!ST->canUseExtension(SPIRV::Extension::SPV_INTEL_function_pointers))
626 "extensions does not support it",
629 CallOp = SPIRV::OpFunctionPointerCallINTEL;
631 Register CalleeReg = Info.Callee.getReg();
638 "Function types mismatch");
639 for (
unsigned I = 0;
I != Info.OrigArgs.size(); ++
I) {
640 assert(Info.OrigArgs[
I].Regs.size() == 1 &&
641 "Call arg has multiple VRegs");
649 CallOp = SPIRV::OpFunctionCall;
656 OrigRetTy, ResVReg, MIRBuilder, SPIRV::AccessQualifier::ReadWrite,
true);
661 .
addUse(GR->getSPIRVTypeID(RetType))
664 for (
const auto &Arg : Info.OrigArgs) {
666 if (Arg.Regs.size() > 1)
668 MIB.addUse(Arg.Regs[0]);
671 if (ST->canUseExtension(SPIRV::Extension::SPV_INTEL_memory_access_aliasing)) {
676 GR->buildMemAliasingOpDecorate(ResVReg, MIRBuilder,
677 SPIRV::Decoration::AliasScopeINTEL, MD);
679 GR->buildMemAliasingOpDecorate(ResVReg, MIRBuilder,
680 SPIRV::Decoration::NoAliasINTEL, MD);
685 *ST->getRegBankInfo());
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
Promote Memory to Register
uint64_t IntrinsicInst * II
static SPIRVTypeInst getArgSPIRVType(const Function &F, unsigned ArgIdx, SPIRVGlobalRegistry *GR, MachineIRBuilder &MIRBuilder, const SPIRVSubtarget &ST)
static SPIRV::ExecutionModel::ExecutionModel getExecutionModel(const SPIRVSubtarget &STI, const Function &F)
static uint32_t getFunctionControl(const Function &F, const SPIRVSubtarget *ST)
static SPIRV::AccessQualifier::AccessQualifier getArgAccessQual(const Function &F, unsigned ArgIdx)
static FunctionType * fixFunctionTypeIfPtrArgs(SPIRVGlobalRegistry *GR, const Function &F, FunctionType *FTy, SPIRVTypeInst SRetTy, const SmallVector< SPIRVTypeInst, 4 > &SArgTys)
static std::vector< SPIRV::Decoration::Decoration > getKernelArgTypeQual(const Function &F, unsigned ArgIdx)
#define SPIRV_BACKEND_SERVICE_FUN_NAME
This class represents an incoming formal argument to a Function.
Represent a constant reference to an array (0 or more elements consecutively in memory),...
size_t size() const
Get the array size.
bool isValid() const
Return true if the attribute is any kind of attribute.
Base class for all callable instructions (InvokeInst and CallInst) Holds everything related to callin...
CallLowering(const TargetLowering *TLI)
This is the shared class of boolean and integer constants.
TypeSize getTypeStoreSize(Type *Ty) const
Returns the maximum number of bytes that may be overwritten by storing the specified type.
FunctionLoweringInfo - This contains information that is global to a function that is used when lower...
Class to represent function types.
unsigned getNumParams() const
Return the number of fixed parameters this function type requires.
Type * getParamType(unsigned i) const
Parameter type accessors.
Type * getReturnType() const
static LLVM_ABI FunctionType * get(Type *Result, ArrayRef< Type * > Params, bool isVarArg)
This static method is the primary way of constructing a FunctionType.
iterator_range< arg_iterator > args()
Attribute getFnAttribute(Attribute::AttrKind Kind) const
Return the attribute for the given attribute kind.
LLVM_ABI bool isDeclaration() const
Return true if the primary definition of this global value is outside of the current translation unit...
bool hasMetadata() const
Return true if this instruction has any metadata attached to it.
MDNode * getMetadata(unsigned KindID) const
Get the metadata of given kind attached to this Instruction.
static constexpr LLT scalar(unsigned SizeInBits)
Get a low-level scalar or aggregate "bag of bits".
static constexpr LLT pointer(unsigned AddressSpace, unsigned SizeInBits)
Get a low-level pointer in the given address space.
ArrayRef< MDOperand > operands() const
unsigned getNumOperands() const
Return number of MDNode operands.
Tracking metadata reference owned by Metadata.
LLVM_ABI StringRef getString() const
const TargetSubtargetInfo & getSubtarget() const
getSubtarget - Return the subtarget for which this machine code is being compiled.
MachineBasicBlock * getBlockNumbered(unsigned N) const
getBlockNumbered - MachineBasicBlocks are automatically numbered when they are inserted into the mach...
Function & getFunction()
Return the LLVM function that this machine code represents.
Helper class to build MachineInstr.
const TargetInstrInfo & getTII()
MachineInstrBuilder buildInstr(unsigned Opcode)
Build and insert <empty> = Opcode <empty>.
MachineFunction & getMF()
Getter for the function we currently build.
void setMBB(MachineBasicBlock &MBB)
Set the insertion point to the end of MBB.
MachineInstrBuilder buildTrap(bool Debug=false)
Build and insert G_TRAP or G_DEBUGTRAP.
MachineRegisterInfo * getMRI()
Getter for MRI.
const DataLayout & getDataLayout() const
void setMF(MachineFunction &MF)
void constrainAllUses(const TargetInstrInfo &TII, const TargetRegisterInfo &TRI, const RegisterBankInfo &RBI) const
const MachineInstrBuilder & addUse(Register RegNo, RegState Flags={}, unsigned SubReg=0) const
Add a virtual register use operand.
const MachineInstrBuilder & addImm(int64_t Val) const
Add a new immediate operand.
const MachineInstrBuilder & add(const MachineOperand &MO) const
const MachineInstrBuilder & addDef(Register RegNo, RegState Flags={}, unsigned SubReg=0) const
Add a virtual register definition operand.
MachineInstr * getInstr() const
If conversion operators fail, use this method to get the MachineInstr explicitly.
const MachineOperand & getOperand(unsigned i) const
MachineRegisterInfo - Keep track of information for virtual and physical registers,...
LLVM_ABI Register createVirtualRegister(const TargetRegisterClass *RegClass, StringRef Name="")
createVirtualRegister - Create and return a new virtual register in the function with the specified r...
LLVM_ABI void setType(Register VReg, LLT Ty)
Set the low-level type of VReg to Ty.
LLVM_ABI void setRegClass(Register Reg, const TargetRegisterClass *RC)
setRegClass - Set the register class of the specified virtual register.
LLVM_ABI Register createGenericVirtualRegister(LLT Ty, StringRef Name="")
Create and return a new generic virtual register with low-level type Ty.
const TargetRegisterClass * getRegClassOrNull(Register Reg) const
Return the register class of Reg, or null if Reg has not been assigned a register class yet.
bool doesNotAccessMemory() const
Whether this function accesses no memory.
bool onlyReadsMemory() const
Whether this function only (at most) reads memory.
Wrapper class representing virtual and physical registers.
constexpr bool isValid() const
bool lowerCall(MachineIRBuilder &MIRBuilder, CallLoweringInfo &Info) const override
This hook must be implemented to lower the given call instruction, including argument and return valu...
bool lowerReturn(MachineIRBuilder &MIRBuiler, const Value *Val, ArrayRef< Register > VRegs, FunctionLoweringInfo &FLI, Register SwiftErrorVReg) const override
This hook must be implemented to lower outgoing return values, described by Val, into the specified v...
SPIRVCallLowering(const SPIRVTargetLowering &TLI, SPIRVGlobalRegistry *GR)
bool lowerFormalArguments(MachineIRBuilder &MIRBuilder, const Function &F, ArrayRef< ArrayRef< Register > > VRegs, FunctionLoweringInfo &FLI) const override
This hook must be implemented to lower the incoming (formal) arguments, described by VRegs,...
void assignSPIRVTypeToVReg(SPIRVTypeInst Type, Register VReg, const MachineFunction &MF)
SPIRVTypeInst getOrCreateOpTypeFunctionWithArgs(const Type *Ty, SPIRVTypeInst RetType, const SmallVectorImpl< SPIRVTypeInst > &ArgTypes, MachineIRBuilder &MIRBuilder)
SPIRVTypeInst getOrCreateSPIRVVectorType(SPIRVTypeInst BaseType, unsigned NumElements, MachineIRBuilder &MIRBuilder, bool EmitIR)
const Type * getTypeForSPIRVType(SPIRVTypeInst Ty) const
SPIRVTypeInst getOrCreateSPIRVPointerType(const Type *BaseType, MachineIRBuilder &MIRBuilder, SPIRV::StorageClass::StorageClass SC)
SPIRVTypeInst getOrCreateSPIRVType(const Type *Type, MachineInstr &I, SPIRV::AccessQualifier::AccessQualifier AQ, bool EmitIR)
SPIRVTypeInst getSPIRVTypeForVReg(Register VReg, const MachineFunction *MF=nullptr) const
Type * findDeducedElementType(const Value *Val)
SPIRVEnvType getEnv() const
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
const TargetRegisterInfo & getRegisterInfo() const
The instances of the Type class are immutable: once they are created, they are never changed.
bool isPointerTy() const
True if this is an instance of PointerType.
A few GPU targets, such as DXIL and SPIR-V, have typed pointers.
static LLVM_ABI TypedPointerType * get(Type *ElementType, unsigned AddressSpace)
This constructs a pointer to an object of the specified type in a numbered address space.
LLVM Value Representation.
Type * getType() const
All values are typed, get the type of this value.
iterator_range< user_iterator > users()
constexpr bool isZero() const
@ SPIR_KERNEL
Used for SPIR kernel functions.
std::optional< bool > lowerBuiltin(StringRef DemangledCall, SPIRV::InstructionSet::InstructionSet Set, MachineIRBuilder &MIRBuilder, const Register OrigRet, const Type *OrigRetTy, const SmallVectorImpl< Register > &Args, SPIRVGlobalRegistry *GR, const CallBase &CB)
FunctionType * getOriginalFunctionType(const Function &F)
This is an optimization pass for GlobalISel generic memory operations.
auto size(R &&Range, std::enable_if_t< std::is_base_of< std::random_access_iterator_tag, typename std::iterator_traits< decltype(Range.begin())>::iterator_category >::value, void > *=nullptr)
Get the size of a range.
void addStringImm(StringRef Str, MCInst &Inst)
unsigned getPointerAddressSpace(const Type *T)
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Register createVirtualRegister(SPIRVTypeInst SpvType, SPIRVGlobalRegistry *GR, MachineRegisterInfo *MRI, const MachineFunction &MF)
MemoryEffectsBase< IRMemLocation > MemoryEffects
Summary of how a function affects memory in the program.
void buildOpDecorate(Register Reg, MachineIRBuilder &MIRBuilder, SPIRV::Decoration::Decoration Dec, ArrayRef< uint32_t > DecArgs, StringRef StrImm)
MDString * getOCLKernelArgAccessQual(const Function &F, unsigned ArgIdx)
std::string getOclOrSpirvBuiltinDemangledName(StringRef Name)
bool isTypedPointerTy(const Type *T)
auto dyn_cast_or_null(const Y &Val)
void buildOpName(Register Target, StringRef Name, MachineIRBuilder &MIRBuilder)
bool any_of(R &&range, UnaryPredicate P)
Provide wrappers to std::any_of which take ranges instead of having to pass begin/end explicitly.
Type * toTypedPointer(Type *Ty)
ConstantInt * getMDOperandAsConstInt(const MDNode *N, unsigned I)
bool isPointerTy(const Type *T)
LLVM_ABI void report_fatal_error(Error Err, bool gen_crash_diag=true)
void setRegClassType(Register Reg, SPIRVTypeInst SpvType, SPIRVGlobalRegistry *GR, MachineRegisterInfo *MRI, const MachineFunction &MF, bool Force)
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
std::optional< SPIRV::LinkageType::LinkageType > getSpirvLinkageTypeFor(const SPIRVSubtarget &ST, const GlobalValue &GV)
bool isEntryPoint(const Function &F)
SPIRV::StorageClass::StorageClass addressSpaceToStorageClass(unsigned AddrSpace, const SPIRVSubtarget &STI)
MDString * getOCLKernelArgTypeQual(const Function &F, unsigned ArgIdx)
Type * getPointeeTypeByAttr(Argument *Arg)
bool hasPointeeTypeAttr(Argument *Arg)
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
bool isPointerTyOrWrapper(const Type *Ty)
bool isUntypedPointerTy(const Type *T)