LLVM 24.0.0git
SPIRVCallLowering.cpp
Go to the documentation of this file.
1//===--- SPIRVCallLowering.cpp - Call lowering ------------------*- 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// This file implements the lowering of LLVM calls to machine code calls for
10// GlobalISel.
11//
12//===----------------------------------------------------------------------===//
13
14#include "SPIRVCallLowering.h"
16#include "SPIRV.h"
17#include "SPIRVBuiltins.h"
18#include "SPIRVGlobalRegistry.h"
19#include "SPIRVISelLowering.h"
20#include "SPIRVMetadata.h"
21#include "SPIRVRegisterInfo.h"
22#include "SPIRVSubtarget.h"
23#include "SPIRVUtils.h"
24#include "llvm/ADT/STLExtras.h"
27#include "llvm/IR/IntrinsicsSPIRV.h"
28#include "llvm/Support/ModRef.h"
29
30using namespace llvm;
31
35
37 const Value *Val, ArrayRef<Register> VRegs,
39 Register SwiftErrorVReg) const {
40 // Ignore if called from the internal service function
41 if (MIRBuilder.getMF()
44 .isValid())
45 return true;
46
47 // Currently all return types should use a single register.
48 // TODO: handle the case of multiple registers.
49 if (VRegs.size() > 1)
50 return false;
51
52 if (Val) {
53 const auto &STI = MIRBuilder.getMF().getSubtarget();
54 MIRBuilder.buildInstr(SPIRV::OpReturnValue)
55 .addUse(VRegs[0])
56 .constrainAllUses(MIRBuilder.getTII(), *STI.getRegisterInfo(),
57 *STI.getRegBankInfo());
58 return true;
59 }
60 MIRBuilder.buildInstr(SPIRV::OpReturn);
61 return true;
62}
63
64// Based on the LLVM function attributes, get a SPIR-V FunctionControl.
66 const SPIRVSubtarget *ST) {
67 MemoryEffects MemEffects = F.getMemoryEffects();
68
69 uint32_t FuncControl = static_cast<uint32_t>(SPIRV::FunctionControl::None);
70
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);
75
76 if (MemEffects.doesNotAccessMemory())
77 FuncControl |= static_cast<uint32_t>(SPIRV::FunctionControl::Pure);
78 else if (MemEffects.onlyReadsMemory())
79 FuncControl |= static_cast<uint32_t>(SPIRV::FunctionControl::Const);
80
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);
85
86 return FuncControl;
87}
88
89// If the function has pointer arguments, we are forced to re-create this
90// function type from the very beginning, changing PointerType by
91// TypedPointerType for each pointer argument. Otherwise, the same `Type*`
92// potentially corresponds to different SPIR-V function type, effectively
93// invalidating logic behind global registry and duplicates tracker.
94static FunctionType *
96 FunctionType *FTy, SPIRVTypeInst SRetTy,
97 const SmallVector<SPIRVTypeInst, 4> &SArgTys) {
98 bool hasArgPtrs = any_of(F.args(), [](const Argument &Arg) {
99 // check if it's an instance of a non-typed PointerType
100 return Arg.getType()->isPointerTy();
101 });
102 if (!hasArgPtrs) {
103 Type *RetTy = FTy->getReturnType();
104 // check if it's an instance of a non-typed PointerType
105 if (!RetTy->isPointerTy())
106 return FTy;
107 }
108
109 // re-create function type, using TypedPointerType instead of PointerType to
110 // properly trace argument types
111 const Type *RetTy = GR->getTypeForSPIRVType(SRetTy);
113 for (auto SArgTy : SArgTys)
114 ArgTys.push_back(const_cast<Type *>(GR->getTypeForSPIRVType(SArgTy)));
115 return FunctionType::get(const_cast<Type *>(RetTy), ArgTys, false);
116}
117
118static SPIRV::AccessQualifier::AccessQualifier
119getArgAccessQual(const Function &F, unsigned ArgIdx) {
120 if (F.getCallingConv() != CallingConv::SPIR_KERNEL)
121 return SPIRV::AccessQualifier::ReadWrite;
122
123 MDString *ArgAttribute = getOCLKernelArgAccessQual(F, ArgIdx);
124 if (!ArgAttribute)
125 return SPIRV::AccessQualifier::ReadWrite;
126
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;
132}
133
134static SPIRVTypeInst getArgSPIRVType(const Function &F, unsigned ArgIdx,
136 MachineIRBuilder &MIRBuilder,
137 const SPIRVSubtarget &ST) {
138 // Read argument's access qualifier from metadata or default.
139 SPIRV::AccessQualifier::AccessQualifier ArgAccessQual =
140 getArgAccessQual(F, ArgIdx);
141
142 Type *OriginalArgType =
144
145 // Vector of untyped pointers: build with the deduced pointee instead of
146 // the default i8 (mismatches typed uses downstream).
147 Argument *Arg = F.getArg(ArgIdx);
148 if (auto *VTy = dyn_cast<FixedVectorType>(OriginalArgType);
149 VTy && isUntypedPointerTy(VTy->getElementType()))
150 if (Type *ElemTy = GR->findDeducedElementType(Arg))
153 ElemTy, MIRBuilder,
155 getPointerAddressSpace(OriginalArgType), ST)),
156 VTy->getNumElements(), MIRBuilder, true);
157
158 // If OriginalArgType is non-pointer, use the OriginalArgType (the type cannot
159 // be legally reassigned later).
160 if (!isPointerTy(OriginalArgType))
161 return GR->getOrCreateSPIRVType(OriginalArgType, MIRBuilder, ArgAccessQual,
162 true);
163
164 Type *ArgType = Arg->getType();
165
166 // In case OriginalArgType is of untyped pointer type, there are three
167 // possibilities:
168 // 1) This is a pointer of an LLVM IR element type, passed byval/byref.
169 // 2) This is an OpenCL/SPIR-V builtin type if there is spv_assign_type
170 // intrinsic assigning a TargetExtType.
171 // 3) This is a pointer, try to retrieve pointer element type from a
172 // spv_assign_ptr_type intrinsic or otherwise use default pointer element
173 // type.
174 if (hasPointeeTypeAttr(Arg)) {
175 // byval/byref/sret carry the aggregate layout in the pointee type, so keep
176 // a typed pointer here. An untyped one drops the type and breaks the
177 // argument ABI on the way back from SPIR-V.
179 getPointeeTypeByAttr(Arg), MIRBuilder,
181 }
182
183 for (auto User : Arg->users()) {
185 // Check if this is spv_assign_type assigning OpenCL/SPIR-V builtin type.
186 if (II && II->getIntrinsicID() == Intrinsic::spv_assign_type) {
187 MetadataAsValue *VMD = cast<MetadataAsValue>(II->getOperand(1));
188 Type *BuiltinType =
189 cast<ConstantAsMetadata>(VMD->getMetadata())->getType();
190 assert(BuiltinType->isTargetExtTy() && "Expected TargetExtType");
191 return GR->getOrCreateSPIRVType(BuiltinType, MIRBuilder, ArgAccessQual,
192 true);
193 }
194
195 // Check if this is spv_assign_ptr_type assigning pointer element type.
196 if (!II || II->getIntrinsicID() != Intrinsic::spv_assign_ptr_type)
197 continue;
198
199 MetadataAsValue *VMD = cast<MetadataAsValue>(II->getOperand(1));
200 Type *ElementTy =
203 ElementTy, MIRBuilder,
205 cast<ConstantInt>(II->getOperand(2))->getZExtValue(), ST));
206 }
207
208 // Replace PointerType with TypedPointerType to be able to map SPIR-V types to
209 // LLVM types in a consistent manner
210 return GR->getOrCreateSPIRVType(toTypedPointer(OriginalArgType), MIRBuilder,
211 ArgAccessQual, true);
212}
213
214static SPIRV::ExecutionModel::ExecutionModel
217 "Environment must be resolved before lowering entry points.");
218
219 if (STI.isKernel())
220 return SPIRV::ExecutionModel::Kernel;
221
222 auto attribute = F.getFnAttribute("hlsl.shader");
223 if (!attribute.isValid()) {
225 "This entry point lacks mandatory hlsl.shader attribute.");
226 }
227
228 const auto value = attribute.getValueAsString();
229 if (value == "compute")
230 return SPIRV::ExecutionModel::GLCompute;
231 if (value == "vertex")
232 return SPIRV::ExecutionModel::Vertex;
233 if (value == "pixel")
234 return SPIRV::ExecutionModel::Fragment;
235
236 report_fatal_error("This HLSL entry point is not supported by this backend.");
237}
238
240 const Function &F,
242 FunctionLoweringInfo &FLI) const {
243 // Discard the internal service function
244 if (F.getFnAttribute(SPIRV_BACKEND_SERVICE_FUN_NAME).isValid())
245 return true;
246
247 assert(GR && "Must initialize the SPIRV type registry before lowering args.");
248 GR->setCurrentFunc(MIRBuilder.getMF());
249
250 // Get access to information about available extensions
251 const SPIRVSubtarget *ST =
252 static_cast<const SPIRVSubtarget *>(&MIRBuilder.getMF().getSubtarget());
253
254 // Assign types and names to all args, and store their types for later.
256 if (VRegs.size() > 0) {
257 unsigned i = 0;
258 for (const auto &Arg : F.args()) {
259 // Currently formal args should use single registers.
260 // TODO: handle the case of multiple registers.
261 if (VRegs[i].size() > 1)
262 return false;
263 SPIRVTypeInst SpirvTy = getArgSPIRVType(F, i, GR, MIRBuilder, *ST);
264 GR->assignSPIRVTypeToVReg(SpirvTy, VRegs[i][0], MIRBuilder.getMF());
265 ArgTypeVRegs.push_back(SpirvTy);
266
267 if (Arg.hasName())
268 buildOpName(VRegs[i][0], Arg.getName(), MIRBuilder);
269 if (isPointerTyOrWrapper(Arg.getType())) {
270 auto DerefBytes = static_cast<unsigned>(Arg.getDereferenceableBytes());
271 if (DerefBytes != 0)
272 buildOpDecorate(VRegs[i][0], MIRBuilder,
273 SPIRV::Decoration::MaxByteOffset, {DerefBytes});
274 }
275 if (Arg.hasAttribute(Attribute::Alignment) && !ST->isShader()) {
276 auto Alignment = static_cast<unsigned>(
277 Arg.getAttribute(Attribute::Alignment).getValueAsInt());
278 buildOpDecorate(VRegs[i][0], MIRBuilder, SPIRV::Decoration::Alignment,
279 {Alignment});
280 }
281 if (ST->isKernel()) {
282 if (Arg.hasAttribute(Attribute::ReadOnly)) {
283 auto Attr =
284 static_cast<unsigned>(SPIRV::FunctionParameterAttribute::NoWrite);
285 buildOpDecorate(VRegs[i][0], MIRBuilder,
286 SPIRV::Decoration::FuncParamAttr, {Attr});
287 }
288 if (Arg.hasAttribute(Attribute::ReadNone)) {
289 auto Attr = static_cast<unsigned>(
290 SPIRV::FunctionParameterAttribute::NoReadWrite);
291 buildOpDecorate(VRegs[i][0], MIRBuilder,
292 SPIRV::Decoration::FuncParamAttr, {Attr});
293 }
294 if (Arg.hasAttribute(Attribute::ZExt)) {
295 auto Attr =
296 static_cast<unsigned>(SPIRV::FunctionParameterAttribute::Zext);
297 buildOpDecorate(VRegs[i][0], MIRBuilder,
298 SPIRV::Decoration::FuncParamAttr, {Attr});
299 }
300 if (Arg.hasAttribute(Attribute::SExt)) {
301 auto Attr =
302 static_cast<unsigned>(SPIRV::FunctionParameterAttribute::Sext);
303 buildOpDecorate(VRegs[i][0], MIRBuilder,
304 SPIRV::Decoration::FuncParamAttr, {Attr});
305 }
306 if (Arg.hasAttribute(Attribute::NoAlias)) {
307 auto Attr =
308 static_cast<unsigned>(SPIRV::FunctionParameterAttribute::NoAlias);
309 buildOpDecorate(VRegs[i][0], MIRBuilder,
310 SPIRV::Decoration::FuncParamAttr, {Attr});
311 }
312 if (Arg.hasNoCaptureAttr()) {
313 auto Attr = static_cast<unsigned>(
314 SPIRV::FunctionParameterAttribute::NoCapture);
315 buildOpDecorate(VRegs[i][0], MIRBuilder,
316 SPIRV::Decoration::FuncParamAttr, {Attr});
317 }
318 // TODO: the AMDGPU BE only supports ByRef argument passing, thus for
319 // AMDGCN flavoured SPIRV we CodeGen for ByRef, but lower it to
320 // ByVal, handling the impedance mismatch during reverse
321 // translation from SPIRV to LLVM IR; the vendor check should be
322 // removed once / if SPIRV adds ByRef support.
323 if (Arg.hasAttribute(Attribute::ByVal) ||
324 (Arg.hasAttribute(Attribute::ByRef) &&
325 F.getParent()->getTargetTriple().getVendor() ==
327 auto Attr =
328 static_cast<unsigned>(SPIRV::FunctionParameterAttribute::ByVal);
329 buildOpDecorate(VRegs[i][0], MIRBuilder,
330 SPIRV::Decoration::FuncParamAttr, {Attr});
331 }
332 if (Arg.hasAttribute(Attribute::StructRet)) {
333 auto Attr =
334 static_cast<unsigned>(SPIRV::FunctionParameterAttribute::Sret);
335 buildOpDecorate(VRegs[i][0], MIRBuilder,
336 SPIRV::Decoration::FuncParamAttr, {Attr});
337 }
338 }
339
340 MDNode *Node = F.getMetadata("spirv.ParameterDecorations");
341 if (Node && i < Node->getNumOperands() &&
342 isa<MDNode>(Node->getOperand(i))) {
343 MDNode *MD = cast<MDNode>(Node->getOperand(i));
344 for (const MDOperand &MDOp : MD->operands()) {
345 MDNode *MD2 = dyn_cast<MDNode>(MDOp);
346 assert(MD2 && "Metadata operand is expected");
347 ConstantInt *Const = getMDOperandAsConstInt(MD2, 0);
348 assert(Const && "MDOperand should be ConstantInt");
349 auto Dec =
350 static_cast<SPIRV::Decoration::Decoration>(Const->getZExtValue());
351 std::vector<uint32_t> DecVec;
352 for (unsigned j = 1; j < MD2->getNumOperands(); j++) {
353 ConstantInt *Const = getMDOperandAsConstInt(MD2, j);
354 assert(Const && "MDOperand should be ConstantInt");
355 DecVec.push_back(static_cast<uint32_t>(Const->getZExtValue()));
356 }
357 buildOpDecorate(VRegs[i][0], MIRBuilder, Dec, DecVec);
358 }
359 }
360 ++i;
361 }
362 }
363
364 auto MRI = MIRBuilder.getMRI();
365 Register FuncVReg = MRI->createGenericVirtualRegister(LLT::scalar(64));
366 MRI->setRegClass(FuncVReg, &SPIRV::iIDRegClass);
368 Type *FRetTy = FTy->getReturnType();
369 if (isUntypedPointerTy(FRetTy)) {
370 if (Type *FRetElemTy = GR->findDeducedElementType(&F)) {
372 toTypedPointer(FRetElemTy), getPointerAddressSpace(FRetTy));
373 GR->addReturnType(&F, DerivedTy);
374 FRetTy = DerivedTy;
375 }
376 }
377 SPIRVTypeInst RetTy = GR->getOrCreateSPIRVType(
378 FRetTy, MIRBuilder, SPIRV::AccessQualifier::ReadWrite, true);
379 FTy = fixFunctionTypeIfPtrArgs(GR, F, FTy, RetTy, ArgTypeVRegs);
380 SPIRVTypeInst FuncTy = GR->getOrCreateOpTypeFunctionWithArgs(
381 FTy, RetTy, ArgTypeVRegs, MIRBuilder);
382 uint32_t FuncControl = getFunctionControl(F, ST);
383
384 // Add OpFunction instruction
385 MachineInstrBuilder MB = MIRBuilder.buildInstr(SPIRV::OpFunction)
386 .addDef(FuncVReg)
387 .addUse(GR->getSPIRVTypeID(RetTy))
388 .addImm(FuncControl)
389 .addUse(GR->getSPIRVTypeID(FuncTy));
390 GR->recordFunctionDefinition(&F, &MB.getInstr()->getOperand(0));
391 GR->addGlobalObject(&F, &MIRBuilder.getMF(), FuncVReg);
392 if (F.isDeclaration())
393 GR->add(&F, MB);
394
395 // Add OpFunctionParameter instructions
396 int i = 0;
397 for (const auto &Arg : F.args()) {
398 assert(VRegs[i].size() == 1 && "Formal arg has multiple vregs");
399 Register ArgReg = VRegs[i][0];
400 MRI->setRegClass(ArgReg, GR->getRegClass(ArgTypeVRegs[i]));
401 auto MIB = MIRBuilder.buildInstr(SPIRV::OpFunctionParameter)
402 .addDef(ArgReg)
403 .addUse(GR->getSPIRVTypeID(ArgTypeVRegs[i]));
404 if (F.isDeclaration())
405 GR->add(&Arg, MIB);
406 GR->addGlobalObject(&Arg, &MIRBuilder.getMF(), ArgReg);
407 i++;
408 }
409 if (!ST->isShader()) {
410 if (F.hasRetAttribute(Attribute::ZExt)) {
411 auto Attr =
412 static_cast<unsigned>(SPIRV::FunctionParameterAttribute::Zext);
413 buildOpDecorate(FuncVReg, MIRBuilder, SPIRV::Decoration::FuncParamAttr,
414 {Attr});
415 }
416 if (F.hasRetAttribute(Attribute::SExt)) {
417 auto Attr =
418 static_cast<unsigned>(SPIRV::FunctionParameterAttribute::Sext);
419 buildOpDecorate(FuncVReg, MIRBuilder, SPIRV::Decoration::FuncParamAttr,
420 {Attr});
421 }
422 }
423
424 // Name the function.
425 if (F.hasName())
426 buildOpName(FuncVReg, F.getName(), MIRBuilder);
427
428 // Handle entry points and function linkage.
429 if (isEntryPoint(F)) {
430 if (F.getName().empty())
431 report_fatal_error("SPIR-V entry point function must have a name");
432 auto MIB = MIRBuilder.buildInstr(SPIRV::OpEntryPoint)
433 .addImm(static_cast<uint32_t>(getExecutionModel(*ST, F)))
434 .addUse(FuncVReg);
435 addStringImm(F.getName(), MIB);
436 } else if (const auto LnkTy = getSpirvLinkageTypeFor(*ST, F);
437 LnkTy && !F.getName().empty()) {
438 buildOpDecorate(FuncVReg, MIRBuilder, SPIRV::Decoration::LinkageAttributes,
439 {static_cast<uint32_t>(*LnkTy)}, F.getName());
440 }
441
442 // Handle function pointers decoration
443 bool hasFunctionPointers =
444 ST->canUseExtension(SPIRV::Extension::SPV_INTEL_function_pointers);
445 if (hasFunctionPointers) {
446 if (F.hasFnAttribute("referenced-indirectly")) {
447 assert((F.getCallingConv() != CallingConv::SPIR_KERNEL) &&
448 "Unexpected 'referenced-indirectly' attribute of the kernel "
449 "function");
450 buildOpDecorate(FuncVReg, MIRBuilder,
451 SPIRV::Decoration::ReferencedIndirectlyINTEL, {});
452 }
453 }
454
455 return true;
456}
457
458// TODO:
459// - add a topological sort of IndirectCalls to ensure the best types knowledge
460// - we may need to fix function formal parameter types if they are opaque
461// pointers used as function pointers in these indirect calls
462// - defaulting to StorageClass::Function in the absence of the
463// SPV_INTEL_function_pointers extension seems wrong, as that might not be
464// able to hold a full width pointer to function, and it also does not model
465// the semantics of a pointer to function in a generic fashion.
466void SPIRVCallLowering::produceIndirectPtrType(
467 MachineIRBuilder &MIRBuilder,
468 const SPIRVCallLowering::SPIRVIndirectCall &IC) const {
469 // Create indirect call data type if any
470 MachineFunction &MF = MIRBuilder.getMF();
472 SPIRVTypeInst SpirvRetTy = GR->getOrCreateSPIRVType(
473 IC.RetTy, MIRBuilder, SPIRV::AccessQualifier::ReadWrite, true);
474 SmallVector<SPIRVTypeInst, 4> SpirvArgTypes;
475 for (size_t i = 0; i < IC.ArgTys.size(); ++i) {
477 IC.ArgTys[i], MIRBuilder, SPIRV::AccessQualifier::ReadWrite, true);
478 SpirvArgTypes.push_back(SPIRVTy);
479 if (!GR->getSPIRVTypeForVReg(IC.ArgRegs[i]))
480 GR->assignSPIRVTypeToVReg(SPIRVTy, IC.ArgRegs[i], MF);
481 }
482 // SPIR-V function type:
483 FunctionType *FTy =
484 FunctionType::get(const_cast<Type *>(IC.RetTy), IC.ArgTys, false);
486 FTy, SpirvRetTy, SpirvArgTypes, MIRBuilder);
487 // SPIR-V pointer to function type:
488 auto SC = ST.canUseExtension(SPIRV::Extension::SPV_INTEL_function_pointers)
489 ? SPIRV::StorageClass::CodeSectionINTEL
490 : SPIRV::StorageClass::Function;
491 SPIRVTypeInst IndirectFuncPtrTy =
492 GR->getOrCreateSPIRVPointerType(SpirvFuncTy, MIRBuilder, SC);
493 // Correct the Callee type
494 GR->assignSPIRVTypeToVReg(IndirectFuncPtrTy, IC.Callee, MF);
495}
496
498 CallLoweringInfo &Info) const {
499 // Currently call returns should have single vregs.
500 // TODO: handle the case of multiple registers.
501 if (Info.OrigRet.Regs.size() > 1)
502 return false;
503 MachineFunction &MF = MIRBuilder.getMF();
504 GR->setCurrentFunc(MF);
505 const Function *CF = nullptr;
506 std::string DemangledName;
507 const Type *OrigRetTy = Info.OrigRet.Ty;
508
509 // Emit a regular OpFunctionCall. If it's an externally declared function,
510 // be sure to emit its type and function declaration here. It will be hoisted
511 // globally later.
512 if (Info.Callee.isGlobal()) {
513 std::string FuncName = Info.Callee.getGlobal()->getName().str();
514 DemangledName = getOclOrSpirvBuiltinDemangledName(FuncName);
515 CF = dyn_cast_or_null<const Function>(Info.Callee.getGlobal());
516 // TODO: support constexpr casts and indirect calls.
517 if (CF == nullptr)
518 return false;
519
521 OrigRetTy = FTy->getReturnType();
522 if (isUntypedPointerTy(OrigRetTy)) {
523 if (auto *DerivedRetTy = GR->findReturnType(CF))
524 OrigRetTy = DerivedRetTy;
525 }
526 }
527
528 MachineRegisterInfo *MRI = MIRBuilder.getMRI();
529 Register ResVReg =
530 Info.OrigRet.Regs.empty() ? Register(0) : Info.OrigRet.Regs[0];
531 const auto *ST = static_cast<const SPIRVSubtarget *>(&MF.getSubtarget());
532
533 bool isFunctionDecl = CF && CF->isDeclaration();
534 if (isFunctionDecl && !DemangledName.empty()) {
535 if (ResVReg.isValid()) {
536 if (!GR->getSPIRVTypeForVReg(ResVReg)) {
537 const Type *RetTy = OrigRetTy;
538 if (auto *PtrRetTy = dyn_cast<PointerType>(OrigRetTy)) {
539 const Value *OrigValue = Info.OrigRet.OrigValue;
540 if (!OrigValue)
541 OrigValue = Info.CB;
542 if (OrigValue)
543 if (Type *ElemTy = GR->findDeducedElementType(OrigValue))
544 RetTy =
545 TypedPointerType::get(ElemTy, PtrRetTy->getAddressSpace());
546 }
547 setRegClassType(ResVReg, RetTy, GR, MIRBuilder,
548 SPIRV::AccessQualifier::ReadWrite, true);
549 }
550 } else {
551 ResVReg = createVirtualRegister(OrigRetTy, GR, MIRBuilder,
552 SPIRV::AccessQualifier::ReadWrite, true);
553 }
555 for (auto Arg : Info.OrigArgs) {
556 assert(Arg.Regs.size() == 1 && "Call arg has multiple VRegs");
557 Register ArgReg = Arg.Regs[0];
558 ArgVRegs.push_back(ArgReg);
559 SPIRVTypeInst SpvType = GR->getSPIRVTypeForVReg(ArgReg);
560 if (!SpvType) {
561 Type *ArgTy = nullptr;
562 if (auto *PtrArgTy = dyn_cast<PointerType>(Arg.Ty)) {
563 // If Arg.Ty is an untyped pointer (i.e., ptr [addrspace(...)]) and we
564 // don't have access to original value in LLVM IR or info about
565 // deduced pointee type, then we should wait with setting the type for
566 // the virtual register until pre-legalizer step when we access
567 // @llvm.spv.assign.ptr.type.p...(...)'s info.
568 if (Arg.OrigValue)
569 if (Type *ElemTy = GR->findDeducedElementType(Arg.OrigValue))
570 ArgTy =
571 TypedPointerType::get(ElemTy, PtrArgTy->getAddressSpace());
572 } else {
573 ArgTy = Arg.Ty;
574 }
575 if (ArgTy) {
576 SpvType = GR->getOrCreateSPIRVType(
577 ArgTy, MIRBuilder, SPIRV::AccessQualifier::ReadWrite, true);
578 GR->assignSPIRVTypeToVReg(SpvType, ArgReg, MF);
579 }
580 }
581 if (!MRI->getRegClassOrNull(ArgReg)) {
582 // Either we have SpvType created, or Arg.Ty is an untyped pointer and
583 // we know its virtual register's class and type even if we don't know
584 // pointee type.
585 MRI->setRegClass(ArgReg, SpvType ? GR->getRegClass(SpvType)
586 : &SPIRV::pIDRegClass);
587 MRI->setType(
588 ArgReg,
589 SpvType ? GR->getRegType(SpvType)
590 : LLT::pointer(cast<PointerType>(Arg.Ty)->getAddressSpace(),
591 GR->getPointerSize()));
592 }
593 }
594 if (auto Res = SPIRV::lowerBuiltin(
595 DemangledName, ST->getPreferredInstructionSet(), MIRBuilder,
596 ResVReg, OrigRetTy, ArgVRegs, GR, *Info.CB))
597 return *Res;
598 }
599
600 if (isFunctionDecl && !GR->find(CF, &MF).isValid()) {
601 // Emit the type info and forward function declaration to the first MBB
602 // to ensure VReg definition dependencies are valid across all MBBs.
603 MachineIRBuilder FirstBlockBuilder;
604 FirstBlockBuilder.setMF(MF);
605 FirstBlockBuilder.setMBB(*MF.getBlockNumbered(0));
606
609 for (const Argument &Arg : CF->args()) {
610 if (MIRBuilder.getDataLayout().getTypeStoreSize(Arg.getType()).isZero())
611 continue; // Don't handle zero sized types.
613 MRI->setRegClass(Reg, &SPIRV::iIDRegClass);
614 ToInsert.push_back({Reg});
615 VRegArgs.push_back(ToInsert.back());
616 }
617 // TODO: Reuse FunctionLoweringInfo
618 FunctionLoweringInfo FuncInfo;
619 lowerFormalArguments(FirstBlockBuilder, *CF, VRegArgs, FuncInfo);
620 }
621
622 // Ignore the call if it's called from the internal service function
623 if (MIRBuilder.getMF()
624 .getFunction()
626 .isValid()) {
627 // insert a no-op
628 MIRBuilder.buildTrap();
629 return true;
630 }
631
632 unsigned CallOp;
633 if (Info.CB && Info.CB->isIndirectCall()) {
634 if (!ST->canUseExtension(SPIRV::Extension::SPV_INTEL_function_pointers))
635 report_fatal_error("An indirect call is encountered but SPIR-V without "
636 "extensions does not support it",
637 false);
638 // Set instruction operation according to SPV_INTEL_function_pointers
639 CallOp = SPIRV::OpFunctionPointerCallINTEL;
640 // Collect information about the indirect call to create correct types.
641 Register CalleeReg = Info.Callee.getReg();
642 if (CalleeReg.isValid()) {
643 SPIRVCallLowering::SPIRVIndirectCall IndirectCall;
644 IndirectCall.Callee = CalleeReg;
646 IndirectCall.RetTy = OrigRetTy = FTy->getReturnType();
647 assert(FTy->getNumParams() == Info.OrigArgs.size() &&
648 "Function types mismatch");
649 for (unsigned I = 0; I != Info.OrigArgs.size(); ++I) {
650 assert(Info.OrigArgs[I].Regs.size() == 1 &&
651 "Call arg has multiple VRegs");
652 IndirectCall.ArgTys.push_back(FTy->getParamType(I));
653 IndirectCall.ArgRegs.push_back(Info.OrigArgs[I].Regs[0]);
654 }
655 produceIndirectPtrType(MIRBuilder, IndirectCall);
656 }
657 } else {
658 // Emit a regular OpFunctionCall
659 CallOp = SPIRV::OpFunctionCall;
660 }
661
662 // Make sure there's a valid return reg, even for functions returning void.
663 if (!ResVReg.isValid())
664 ResVReg = MIRBuilder.getMRI()->createVirtualRegister(&SPIRV::iIDRegClass);
665 SPIRVTypeInst RetType = GR->assignTypeToVReg(
666 OrigRetTy, ResVReg, MIRBuilder, SPIRV::AccessQualifier::ReadWrite, true);
667
668 // Emit the call instruction and its args.
669 auto MIB = MIRBuilder.buildInstr(CallOp)
670 .addDef(ResVReg)
671 .addUse(GR->getSPIRVTypeID(RetType))
672 .add(Info.Callee);
673
674 for (const auto &Arg : Info.OrigArgs) {
675 // Currently call args should have single vregs.
676 if (Arg.Regs.size() > 1)
677 return false;
678 MIB.addUse(Arg.Regs[0]);
679 }
680
681 if (Info.CB)
682 MIB.getInstr()->copyIRFlags(*Info.CB);
683
684 if (ST->canUseExtension(SPIRV::Extension::SPV_INTEL_memory_access_aliasing)) {
685 // Process aliasing metadata.
686 const CallBase *CI = Info.CB;
687 if (CI && CI->hasMetadata()) {
688 if (MDNode *MD = CI->getMetadata(LLVMContext::MD_alias_scope))
689 GR->buildMemAliasingOpDecorate(ResVReg, MIRBuilder,
690 SPIRV::Decoration::AliasScopeINTEL, MD);
691 if (MDNode *MD = CI->getMetadata(LLVMContext::MD_noalias))
692 GR->buildMemAliasingOpDecorate(ResVReg, MIRBuilder,
693 SPIRV::Decoration::NoAliasINTEL, MD);
694 }
695 }
696
697 MIB.constrainAllUses(MIRBuilder.getTII(), *ST->getRegisterInfo(),
698 *ST->getRegBankInfo());
699 return true;
700}
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
#define F(x, y, z)
Definition MD5.cpp:54
#define I(x, y, z)
Definition MD5.cpp:57
Promote Memory to Register
Definition Mem2Reg.cpp:110
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)
#define SPIRV_BACKEND_SERVICE_FUN_NAME
Definition SPIRVUtils.h:567
This file contains some templates that are useful if you are working with the STL at all.
This class represents an incoming formal argument to a Function.
Definition Argument.h:32
Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:40
size_t size() const
Get the array size.
Definition ArrayRef.h:141
bool isValid() const
Return true if the attribute is any kind of attribute.
Definition Attributes.h:266
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.
Definition Constants.h:87
TypeSize getTypeStoreSize(Type *Ty) const
Returns the maximum number of bytes that may be overwritten by storing the specified type.
Definition DataLayout.h:579
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()
Definition Function.h:877
Attribute getFnAttribute(Attribute::AttrKind Kind) const
Return the attribute for the given attribute kind.
Definition Function.cpp:765
LLVM_ABI bool isDeclaration() const
Return true if the primary definition of this global value is outside of the current translation unit...
Definition Globals.cpp:408
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.
Metadata node.
Definition Metadata.h:1081
ArrayRef< MDOperand > operands() const
Definition Metadata.h:1435
unsigned getNumOperands() const
Return number of MDNode operands.
Definition Metadata.h:1443
Tracking metadata reference owned by Metadata.
Definition Metadata.h:902
A single uniqued string.
Definition Metadata.h:733
LLVM_ABI StringRef getString() const
Definition Metadata.cpp:615
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.
LLVM_ABI void copyIRFlags(const Instruction &I)
Copy all flags to MachineInst MIFlags.
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.
Definition ModRef.h:246
bool onlyReadsMemory() const
Whether this function only (at most) reads memory.
Definition ModRef.h:249
Metadata wrapper in the Value hierarchy.
Definition Metadata.h:184
Metadata * getMetadata() const
Definition Metadata.h:202
Wrapper class representing virtual and physical registers.
Definition Register.h:20
constexpr bool isValid() const
Definition Register.h:112
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 getOrCreateSPIRVPointerType(const Type *BaseType, MachineIRBuilder &MIRBuilder, SPIRV::StorageClass::StorageClass SC, bool ForceTyped=false)
SPIRVTypeInst getOrCreateSPIRVTypedPointerType(const Type *BaseType, MachineIRBuilder &MIRBuilder, SPIRV::StorageClass::StorageClass SC)
SPIRVTypeInst getOrCreateSPIRVVectorType(SPIRVTypeInst BaseType, unsigned NumElements, MachineIRBuilder &MIRBuilder, bool EmitIR)
const Type * getTypeForSPIRVType(SPIRVTypeInst Ty) const
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.
Definition Type.h:46
bool isPointerTy() const
True if this is an instance of PointerType.
Definition Type.h:277
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.
Definition Value.h:75
Type * getType() const
All values are typed, get the type of this value.
Definition Value.h:257
iterator_range< user_iterator > users()
Definition Value.h:428
constexpr bool isZero() const
Definition TypeSize.h:153
@ 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.
Definition STLExtras.h:1685
void addStringImm(StringRef Str, MCInst &Inst)
unsigned getPointerAddressSpace(const Type *T)
Definition SPIRVUtils.h:395
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:643
Register createVirtualRegister(SPIRVTypeInst SpvType, SPIRVGlobalRegistry *GR, MachineRegisterInfo *MRI, const MachineFunction &MF)
MemoryEffectsBase< IRMemLocation > MemoryEffects
Summary of how a function affects memory in the program.
Definition ModRef.h:356
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)
auto dyn_cast_or_null(const Y &Val)
Definition Casting.h:753
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.
Definition STLExtras.h:1762
Type * toTypedPointer(Type *Ty)
Definition SPIRVUtils.h:479
ConstantInt * getMDOperandAsConstInt(const MDNode *N, unsigned I)
bool isPointerTy(const Type *T)
Definition SPIRVUtils.h:383
LLVM_ABI void report_fatal_error(Error Err, bool gen_crash_diag=true)
Definition Error.cpp:163
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...
Definition Casting.h:547
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)
Type * getPointeeTypeByAttr(Argument *Arg)
Definition SPIRVUtils.h:408
bool hasPointeeTypeAttr(Argument *Arg)
Definition SPIRVUtils.h:403
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:559
bool isPointerTyOrWrapper(const Type *Ty)
Definition SPIRVUtils.h:431
bool isUntypedPointerTy(const Type *T)
Definition SPIRVUtils.h:378