LLVM 23.0.0git
SPIRVModuleAnalysis.cpp
Go to the documentation of this file.
1//===- SPIRVModuleAnalysis.cpp - analysis of global instrs & regs - 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// The analysis collects instructions that should be output at the module level
10// and performs the global register numbering.
11//
12// The results of this analysis are used in AsmPrinter to rename registers
13// globally and to output required instructions at the module level.
14//
15//===----------------------------------------------------------------------===//
16
17// TODO: uses or report_fatal_error (which is also deprecated) /
18// ReportFatalUsageError in this file should be refactored, as per LLVM
19// best practices, to rely on the Diagnostic infrastructure.
20
21#include "SPIRVModuleAnalysis.h"
24#include "SPIRV.h"
25#include "SPIRVSubtarget.h"
26#include "SPIRVTargetMachine.h"
27#include "SPIRVUtils.h"
28#include "llvm/ADT/STLExtras.h"
31
32using namespace llvm;
33
34#define DEBUG_TYPE "spirv-module-analysis"
35
36static cl::opt<bool>
37 SPVDumpDeps("spv-dump-deps",
38 cl::desc("Dump MIR with SPIR-V dependencies info"),
39 cl::Optional, cl::init(false));
40
42 AvoidCapabilities("avoid-spirv-capabilities",
43 cl::desc("SPIR-V capabilities to avoid if there are "
44 "other options enabling a feature"),
46 cl::values(clEnumValN(SPIRV::Capability::Shader, "Shader",
47 "SPIR-V Shader capability")));
48// Use sets instead of cl::list to check "if contains" condition
53
55
56INITIALIZE_PASS(SPIRVModuleAnalysis, DEBUG_TYPE, "SPIRV module analysis", true,
57 true)
58
59// Retrieve an unsigned from an MDNode with a list of them as operands.
60static unsigned getMetadataUInt(MDNode *MdNode, unsigned OpIndex,
61 unsigned DefaultVal = 0) {
62 if (MdNode && OpIndex < MdNode->getNumOperands()) {
63 const auto &Op = MdNode->getOperand(OpIndex);
64 return mdconst::extract<ConstantInt>(Op)->getZExtValue();
65 }
66 return DefaultVal;
67}
68
70getSymbolicOperandRequirements(SPIRV::OperandCategory::OperandCategory Category,
71 unsigned i, const SPIRVSubtarget &ST,
73 // A set of capabilities to avoid if there is another option.
74 AvoidCapabilitiesSet AvoidCaps;
75 if (!ST.isShader())
76 AvoidCaps.S.insert(SPIRV::Capability::Shader);
77 else
78 AvoidCaps.S.insert(SPIRV::Capability::Kernel);
79
80 VersionTuple ReqMinVer = getSymbolicOperandMinVersion(Category, i);
81 VersionTuple ReqMaxVer = getSymbolicOperandMaxVersion(Category, i);
82 VersionTuple SPIRVVersion = ST.getSPIRVVersion();
83 bool MinVerOK = SPIRVVersion.empty() || SPIRVVersion >= ReqMinVer;
84 bool MaxVerOK =
85 ReqMaxVer.empty() || SPIRVVersion.empty() || SPIRVVersion <= ReqMaxVer;
87 ExtensionList ReqExts = getSymbolicOperandExtensions(Category, i);
88 if (ReqCaps.empty()) {
89 if (ReqExts.empty()) {
90 if (MinVerOK && MaxVerOK)
91 return {true, {}, {}, ReqMinVer, ReqMaxVer};
92 return {false, {}, {}, VersionTuple(), VersionTuple()};
93 }
94 } else if (MinVerOK && MaxVerOK) {
95 if (ReqCaps.size() == 1) {
96 auto Cap = ReqCaps[0];
97 if (Reqs.isCapabilityAvailable(Cap)) {
99 SPIRV::OperandCategory::CapabilityOperand, Cap));
100 return {true, {Cap}, std::move(ReqExts), ReqMinVer, ReqMaxVer};
101 }
102 } else {
103 // By SPIR-V specification: "If an instruction, enumerant, or other
104 // feature specifies multiple enabling capabilities, only one such
105 // capability needs to be declared to use the feature." However, one
106 // capability may be preferred over another. We use command line
107 // argument(s) and AvoidCapabilities to avoid selection of certain
108 // capabilities if there are other options.
109 CapabilityList UseCaps;
110 for (auto Cap : ReqCaps)
111 if (Reqs.isCapabilityAvailable(Cap))
112 UseCaps.push_back(Cap);
113 for (size_t i = 0, Sz = UseCaps.size(); i < Sz; ++i) {
114 auto Cap = UseCaps[i];
115 if (i == Sz - 1 || !AvoidCaps.S.contains(Cap)) {
117 SPIRV::OperandCategory::CapabilityOperand, Cap));
118 return {true, {Cap}, std::move(ReqExts), ReqMinVer, ReqMaxVer};
119 }
120 }
121 }
122 }
123 // If there are no capabilities, or we can't satisfy the version or
124 // capability requirements, use the list of extensions (if the subtarget
125 // can handle them all).
126 if (llvm::all_of(ReqExts, [&ST](const SPIRV::Extension::Extension &Ext) {
127 return ST.canUseExtension(Ext);
128 })) {
129 return {true,
130 {},
131 std::move(ReqExts),
132 VersionTuple(),
133 VersionTuple()}; // TODO: add versions to extensions.
134 }
135 return {false, {}, {}, VersionTuple(), VersionTuple()};
136}
137
138void SPIRVModuleAnalysis::setBaseInfo(const Module &M) {
139 MAI.MaxID = 0;
140 for (int i = 0; i < SPIRV::NUM_MODULE_SECTIONS; i++)
141 MAI.MS[i].clear();
142 MAI.RegisterAliasTable.clear();
143 MAI.InstrsToDelete.clear();
144 MAI.GlobalObjMap.clear();
145 MAI.GlobalVarList.clear();
146 MAI.ExtInstSetMap.clear();
147 MAI.Reqs.clear();
148 MAI.Reqs.initAvailableCapabilities(*ST);
149
150 // TODO: determine memory model and source language from the configuratoin.
151 if (auto MemModel = M.getNamedMetadata("spirv.MemoryModel")) {
152 auto MemMD = MemModel->getOperand(0);
153 MAI.Addr = static_cast<SPIRV::AddressingModel::AddressingModel>(
154 getMetadataUInt(MemMD, 0));
155 MAI.Mem =
156 static_cast<SPIRV::MemoryModel::MemoryModel>(getMetadataUInt(MemMD, 1));
157 } else {
158 // TODO: Add support for VulkanMemoryModel.
159 MAI.Mem = ST->isShader() ? SPIRV::MemoryModel::GLSL450
160 : SPIRV::MemoryModel::OpenCL;
161 if (MAI.Mem == SPIRV::MemoryModel::OpenCL) {
162 unsigned PtrSize = ST->getPointerSize();
163 MAI.Addr = PtrSize == 32 ? SPIRV::AddressingModel::Physical32
164 : PtrSize == 64 ? SPIRV::AddressingModel::Physical64
165 : SPIRV::AddressingModel::Logical;
166 } else {
167 // TODO: Add support for PhysicalStorageBufferAddress.
168 MAI.Addr = SPIRV::AddressingModel::Logical;
169 }
170 }
171 // Get the OpenCL version number from metadata.
172 // TODO: support other source languages.
173 if (auto VerNode = M.getNamedMetadata("opencl.ocl.version")) {
174 MAI.SrcLang = SPIRV::SourceLanguage::OpenCL_C;
175 // Construct version literal in accordance with SPIRV-LLVM-Translator.
176 // TODO: support multiple OCL version metadata.
177 assert(VerNode->getNumOperands() > 0 && "Invalid SPIR");
178 auto VersionMD = VerNode->getOperand(0);
179 unsigned MajorNum = getMetadataUInt(VersionMD, 0, 2);
180 unsigned MinorNum = getMetadataUInt(VersionMD, 1);
181 unsigned RevNum = getMetadataUInt(VersionMD, 2);
182 // Prevent Major part of OpenCL version to be 0
183 MAI.SrcLangVersion =
184 (std::max(1U, MajorNum) * 100 + MinorNum) * 1000 + RevNum;
185 // When opencl.cxx.version is also present, validate compatibility
186 // and use C++ for OpenCL as source language with the C++ version.
187 if (auto *CxxVerNode = M.getNamedMetadata("opencl.cxx.version")) {
188 assert(CxxVerNode->getNumOperands() > 0 && "Invalid SPIR");
189 auto *CxxMD = CxxVerNode->getOperand(0);
190 unsigned CxxVer =
191 (getMetadataUInt(CxxMD, 0) * 100 + getMetadataUInt(CxxMD, 1)) * 1000 +
192 getMetadataUInt(CxxMD, 2);
193 if ((MAI.SrcLangVersion == 200000 && CxxVer == 100000) ||
194 (MAI.SrcLangVersion == 300000 && CxxVer == 202100000)) {
195 MAI.SrcLang = SPIRV::SourceLanguage::CPP_for_OpenCL;
196 MAI.SrcLangVersion = CxxVer;
197 } else {
199 "opencl cxx version is not compatible with opencl c version!");
200 }
201 }
202 } else {
203 // If there is no information about OpenCL version we are forced to generate
204 // OpenCL 1.0 by default for the OpenCL environment to avoid puzzling
205 // run-times with Unknown/0.0 version output. For a reference, LLVM-SPIRV
206 // Translator avoids potential issues with run-times in a similar manner.
207 if (!ST->isShader()) {
208 MAI.SrcLang = SPIRV::SourceLanguage::OpenCL_CPP;
209 MAI.SrcLangVersion = 100000;
210 } else {
211 MAI.SrcLang = SPIRV::SourceLanguage::Unknown;
212 MAI.SrcLangVersion = 0;
213 }
214 }
215
216 if (auto ExtNode = M.getNamedMetadata("opencl.used.extensions")) {
217 for (unsigned I = 0, E = ExtNode->getNumOperands(); I != E; ++I) {
218 MDNode *MD = ExtNode->getOperand(I);
219 if (!MD || MD->getNumOperands() == 0)
220 continue;
221 for (unsigned J = 0, N = MD->getNumOperands(); J != N; ++J)
222 MAI.SrcExt.insert(cast<MDString>(MD->getOperand(J))->getString());
223 }
224 }
225
226 // Update required capabilities for this memory model, addressing model and
227 // source language.
228 MAI.Reqs.getAndAddRequirements(SPIRV::OperandCategory::MemoryModelOperand,
229 MAI.Mem, *ST);
230 MAI.Reqs.getAndAddRequirements(SPIRV::OperandCategory::SourceLanguageOperand,
231 MAI.SrcLang, *ST);
232 MAI.Reqs.getAndAddRequirements(SPIRV::OperandCategory::AddressingModelOperand,
233 MAI.Addr, *ST);
234
235 if (MAI.Mem == SPIRV::MemoryModel::VulkanKHR)
236 MAI.Reqs.addExtension(SPIRV::Extension::SPV_KHR_vulkan_memory_model);
237
238 if (!ST->isShader()) {
239 // TODO: check if it's required by default.
240 MAI.ExtInstSetMap[static_cast<unsigned>(
241 SPIRV::InstructionSet::OpenCL_std)] = MAI.getNextIDRegister();
242 }
243}
244
245// Appends the signature of the decoration instructions that decorate R to
246// Signature.
247static void appendDecorationsForReg(const MachineRegisterInfo &MRI, Register R,
248 InstrSignature &Signature) {
249 for (MachineInstr &UseMI : MRI.use_instructions(R)) {
250 // We don't handle OpDecorateId because getting the register alias for the
251 // ID can cause problems, and we do not need it for now.
252 if (UseMI.getOpcode() != SPIRV::OpDecorate &&
253 UseMI.getOpcode() != SPIRV::OpMemberDecorate)
254 continue;
255
256 for (unsigned I = 0; I < UseMI.getNumOperands(); ++I) {
257 const MachineOperand &MO = UseMI.getOperand(I);
258 if (MO.isReg())
259 continue;
260 Signature.push_back(hash_value(MO));
261 }
262 }
263}
264
265// Returns a representation of an instruction as a vector of MachineOperand
266// hash values, see llvm::hash_value(const MachineOperand &MO) for details.
267// This creates a signature of the instruction with the same content
268// that MachineOperand::isIdenticalTo uses for comparison.
269static InstrSignature instrToSignature(const MachineInstr &MI,
271 bool UseDefReg) {
272 Register DefReg;
273 InstrSignature Signature{MI.getOpcode()};
274 for (unsigned i = 0; i < MI.getNumOperands(); ++i) {
275 // The only decorations that can be applied more than once to a given <id>
276 // or structure member are FuncParamAttr (38), UserSemantic (5635),
277 // CacheControlLoadINTEL (6442), and CacheControlStoreINTEL (6443). For all
278 // the rest of decorations, we will only add to the signature the Opcode,
279 // the id to which it applies, and the decoration id, disregarding any
280 // decoration flags. This will ensure that any subsequent decoration with
281 // the same id will be deemed as a duplicate. Then, at the call site, we
282 // will be able to handle duplicates in the best way.
283 unsigned Opcode = MI.getOpcode();
284 if ((Opcode == SPIRV::OpDecorate) && i >= 2) {
285 unsigned DecorationID = MI.getOperand(1).getImm();
286 if (DecorationID != SPIRV::Decoration::FuncParamAttr &&
287 DecorationID != SPIRV::Decoration::UserSemantic &&
288 DecorationID != SPIRV::Decoration::CacheControlLoadINTEL &&
289 DecorationID != SPIRV::Decoration::CacheControlStoreINTEL)
290 continue;
291 }
292 const MachineOperand &MO = MI.getOperand(i);
293 size_t h;
294 if (MO.isReg()) {
295 if (!UseDefReg && MO.isDef()) {
296 assert(!DefReg.isValid() && "Multiple def registers.");
297 DefReg = MO.getReg();
298 continue;
299 }
300 Register RegAlias = MAI.getRegisterAlias(MI.getMF(), MO.getReg());
301 if (!RegAlias.isValid()) {
302 LLVM_DEBUG({
303 dbgs() << "Unexpectedly, no global id found for the operand ";
304 MO.print(dbgs());
305 dbgs() << "\nInstruction: ";
306 MI.print(dbgs());
307 dbgs() << "\n";
308 });
309 report_fatal_error("All v-regs must have been mapped to global id's");
310 }
311 // mimic llvm::hash_value(const MachineOperand &MO)
312 h = hash_combine(MO.getType(), (unsigned)RegAlias, MO.getSubReg(),
313 MO.isDef());
314 } else {
315 h = hash_value(MO);
316 }
317 Signature.push_back(h);
318 }
319
320 if (DefReg.isValid()) {
321 // Decorations change the semantics of the current instruction. So two
322 // identical instruction with different decorations cannot be merged. That
323 // is why we add the decorations to the signature.
324 appendDecorationsForReg(MI.getMF()->getRegInfo(), DefReg, Signature);
325 }
326 return Signature;
327}
328
329bool SPIRVModuleAnalysis::isDeclSection(const MachineRegisterInfo &MRI,
330 const MachineInstr &MI) {
331 unsigned Opcode = MI.getOpcode();
332 switch (Opcode) {
333 case SPIRV::OpTypeForwardPointer:
334 // omit now, collect later
335 return false;
336 case SPIRV::OpVariable:
337 return static_cast<SPIRV::StorageClass::StorageClass>(
338 MI.getOperand(2).getImm()) != SPIRV::StorageClass::Function;
339 case SPIRV::OpFunction:
340 case SPIRV::OpFunctionParameter:
341 return true;
342 }
343 if (GR->hasConstFunPtr() && Opcode == SPIRV::OpUndef) {
344 // The OpUndef may be a placeholder for a function reference recorded by
345 // selectGlobalValue. Skip emitting it if any user consumes it as a
346 // function-pointer-like operand (OpConstantFunctionPointerINTEL operand 2,
347 // or OpEnqueueKernel's Invoke operand at index 8). The rewrite happens
348 // in visitFunPtrUse, which aliases the OpUndef's vreg to the function's
349 // global <id>.
350 Register DefReg = MI.getOperand(0).getReg();
351 if (GR->getFunctionDefinitionByUse(&MI.getOperand(0))) {
352 for (MachineInstr &UseMI : MRI.use_instructions(DefReg)) {
353 unsigned UseOp = UseMI.getOpcode();
354 if (UseOp == SPIRV::OpConstantFunctionPointerINTEL ||
355 UseOp == SPIRV::OpEnqueueKernel) {
356 MAI.setSkipEmission(&MI);
357 return false;
358 }
359 }
360 }
361 for (MachineInstr &UseMI : MRI.use_instructions(DefReg)) {
362 if (UseMI.getOpcode() != SPIRV::OpConstantFunctionPointerINTEL)
363 continue;
364 // it's a dummy definition, FP constant refers to a function,
365 // and this is resolved in another way; let's skip this definition
366 assert(UseMI.getOperand(2).isReg() &&
367 UseMI.getOperand(2).getReg() == DefReg);
368 MAI.setSkipEmission(&MI);
369 return false;
370 }
371 }
372 return TII->isTypeDeclInstr(MI) || TII->isConstantInstr(MI) ||
373 TII->isInlineAsmDefInstr(MI);
374}
375
376// This is a special case of a function pointer referring to a possibly
377// forward function declaration. The operand is a dummy OpUndef that
378// requires a special treatment.
379// FunPtrOp is the MachineOperand previously recorded via
380// SPIRVGlobalRegistry::recordFunctionPointer, identifying which Function
381// this placeholder refers to.
382void SPIRVModuleAnalysis::visitFunPtrUse(
383 Register OpReg, const MachineOperand *FunPtrOp,
384 InstrGRegsMap &SignatureToGReg,
385 std::map<const Value *, unsigned> &GlobalToGReg,
386 const MachineFunction *MF) {
387 const MachineOperand *OpFunDef = GR->getFunctionDefinitionByUse(FunPtrOp);
388 assert(OpFunDef && OpFunDef->isReg());
389 // find the actual function definition and number it globally in advance
390 const MachineInstr *OpDefMI = OpFunDef->getParent();
391 assert(OpDefMI && OpDefMI->getOpcode() == SPIRV::OpFunction);
392 const MachineFunction *FunDefMF = OpDefMI->getParent()->getParent();
393 const MachineRegisterInfo &FunDefMRI = FunDefMF->getRegInfo();
394 do {
395 visitDecl(FunDefMRI, SignatureToGReg, GlobalToGReg, FunDefMF, *OpDefMI);
396 OpDefMI = OpDefMI->getNextNode();
397 } while (OpDefMI && (OpDefMI->getOpcode() == SPIRV::OpFunction ||
398 OpDefMI->getOpcode() == SPIRV::OpFunctionParameter));
399 // associate the function pointer with the newly assigned global number
400 MCRegister GlobalFunDefReg =
401 MAI.getRegisterAlias(FunDefMF, OpFunDef->getReg());
402 assert(GlobalFunDefReg.isValid() &&
403 "Function definition must refer to a global register");
404 MAI.setRegisterAlias(MF, OpReg, GlobalFunDefReg);
405}
406
407// Depth first recursive traversal of dependencies. Repeated visits are guarded
408// by MAI.hasRegisterAlias().
409void SPIRVModuleAnalysis::visitDecl(
410 const MachineRegisterInfo &MRI, InstrGRegsMap &SignatureToGReg,
411 std::map<const Value *, unsigned> &GlobalToGReg, const MachineFunction *MF,
412 const MachineInstr &MI) {
413 unsigned Opcode = MI.getOpcode();
414
415 // Process each operand of the instruction to resolve dependencies
416 for (const MachineOperand &MO : MI.operands()) {
417 if (!MO.isReg() || MO.isDef())
418 continue;
419 Register OpReg = MO.getReg();
420 // Handle function pointers special case
421 if (Opcode == SPIRV::OpConstantFunctionPointerINTEL &&
422 MRI.getRegClass(OpReg) == &SPIRV::pIDRegClass) {
423 visitFunPtrUse(OpReg, &MI.getOperand(2), SignatureToGReg, GlobalToGReg,
424 MF);
425 continue;
426 }
427 // Skip already processed instructions
428 if (MAI.hasRegisterAlias(MF, MO.getReg()))
429 continue;
430 // Recursively visit dependencies
431 if (const MachineInstr *OpDefMI = MRI.getUniqueVRegDef(OpReg)) {
432 if (isDeclSection(MRI, *OpDefMI))
433 visitDecl(MRI, SignatureToGReg, GlobalToGReg, MF, *OpDefMI);
434 continue;
435 }
436 // Handle the unexpected case of no unique definition for the SPIR-V
437 // instruction
438 LLVM_DEBUG({
439 dbgs() << "Unexpectedly, no unique definition for the operand ";
440 MO.print(dbgs());
441 dbgs() << "\nInstruction: ";
442 MI.print(dbgs());
443 dbgs() << "\n";
444 });
446 "No unique definition is found for the virtual register");
447 }
448
449 MCRegister GReg;
450 bool IsFunDef = false;
451 if (TII->isSpecConstantInstr(MI)) {
452 GReg = MAI.getNextIDRegister();
453 MAI.MS[SPIRV::MB_TypeConstVars].push_back(&MI);
454 } else if (Opcode == SPIRV::OpFunction ||
455 Opcode == SPIRV::OpFunctionParameter) {
456 GReg = handleFunctionOrParameter(MF, MI, GlobalToGReg, IsFunDef);
457 } else if (Opcode == SPIRV::OpTypeStruct ||
458 Opcode == SPIRV::OpConstantComposite) {
459 GReg = handleTypeDeclOrConstant(MI, SignatureToGReg);
460 const MachineInstr *NextInstr = MI.getNextNode();
461 while (NextInstr &&
462 ((Opcode == SPIRV::OpTypeStruct &&
463 NextInstr->getOpcode() == SPIRV::OpTypeStructContinuedINTEL) ||
464 (Opcode == SPIRV::OpConstantComposite &&
465 NextInstr->getOpcode() ==
466 SPIRV::OpConstantCompositeContinuedINTEL))) {
467 MCRegister Tmp = handleTypeDeclOrConstant(*NextInstr, SignatureToGReg);
468 MAI.setRegisterAlias(MF, NextInstr->getOperand(0).getReg(), Tmp);
469 MAI.setSkipEmission(NextInstr);
470 NextInstr = NextInstr->getNextNode();
471 }
472 } else if (TII->isTypeDeclInstr(MI) || TII->isConstantInstr(MI) ||
473 TII->isInlineAsmDefInstr(MI)) {
474 GReg = handleTypeDeclOrConstant(MI, SignatureToGReg);
475 } else if (Opcode == SPIRV::OpVariable) {
476 GReg = handleVariable(MF, MI, GlobalToGReg);
477 } else {
478 LLVM_DEBUG({
479 dbgs() << "\nInstruction: ";
480 MI.print(dbgs());
481 dbgs() << "\n";
482 });
483 llvm_unreachable("Unexpected instruction is visited");
484 }
485 MAI.setRegisterAlias(MF, MI.getOperand(0).getReg(), GReg);
486 if (!IsFunDef)
487 MAI.setSkipEmission(&MI);
488}
489
490MCRegister SPIRVModuleAnalysis::handleFunctionOrParameter(
491 const MachineFunction *MF, const MachineInstr &MI,
492 std::map<const Value *, unsigned> &GlobalToGReg, bool &IsFunDef) {
493 const Value *GObj = GR->getGlobalObject(MF, MI.getOperand(0).getReg());
494 assert(GObj && "Unregistered global definition");
495 const Function *F = dyn_cast<Function>(GObj);
496 if (!F)
497 F = dyn_cast<Argument>(GObj)->getParent();
498 assert(F && "Expected a reference to a function or an argument");
499 IsFunDef = !F->isDeclaration();
500 auto [It, Inserted] = GlobalToGReg.try_emplace(GObj);
501 if (!Inserted)
502 return It->second;
503 MCRegister GReg = MAI.getNextIDRegister();
504 It->second = GReg;
505 if (!IsFunDef)
506 MAI.MS[SPIRV::MB_ExtFuncDecls].push_back(&MI);
507 return GReg;
508}
509
511SPIRVModuleAnalysis::handleTypeDeclOrConstant(const MachineInstr &MI,
512 InstrGRegsMap &SignatureToGReg) {
513 InstrSignature MISign = instrToSignature(MI, MAI, false);
514 auto [It, Inserted] = SignatureToGReg.try_emplace(MISign);
515 if (!Inserted)
516 return It->second;
517 MCRegister GReg = MAI.getNextIDRegister();
518 It->second = GReg;
519 MAI.MS[SPIRV::MB_TypeConstVars].push_back(&MI);
520 return GReg;
521}
522
523MCRegister SPIRVModuleAnalysis::handleVariable(
524 const MachineFunction *MF, const MachineInstr &MI,
525 std::map<const Value *, unsigned> &GlobalToGReg) {
526 MAI.GlobalVarList.push_back(&MI);
527 const Value *GObj = GR->getGlobalObject(MF, MI.getOperand(0).getReg());
528 assert(GObj && "Unregistered global definition");
529 auto [It, Inserted] = GlobalToGReg.try_emplace(GObj);
530 if (!Inserted)
531 return It->second;
532 MCRegister GReg = MAI.getNextIDRegister();
533 It->second = GReg;
534 MAI.MS[SPIRV::MB_TypeConstVars].push_back(&MI);
535 if (const auto *GV = dyn_cast<GlobalVariable>(GObj))
536 MAI.GlobalObjMap[GV] = GReg;
537 return GReg;
538}
539
540void SPIRVModuleAnalysis::collectDeclarations(const Module &M) {
541 InstrGRegsMap SignatureToGReg;
542 std::map<const Value *, unsigned> GlobalToGReg;
543 for (const Function &F : M) {
544 MachineFunction *MF = MMI->getMachineFunction(F);
545 if (!MF)
546 continue;
547 const MachineRegisterInfo &MRI = MF->getRegInfo();
548 unsigned PastHeader = 0;
549 for (MachineBasicBlock &MBB : *MF) {
550 for (MachineInstr &MI : MBB) {
551 if (MI.getNumOperands() == 0)
552 continue;
553 unsigned Opcode = MI.getOpcode();
554 if (Opcode == SPIRV::OpFunction) {
555 if (PastHeader == 0) {
556 PastHeader = 1;
557 continue;
558 }
559 } else if (Opcode == SPIRV::OpFunctionParameter) {
560 if (PastHeader < 2)
561 continue;
562 } else if (PastHeader > 0) {
563 PastHeader = 2;
564 }
565
566 const MachineOperand &DefMO = MI.getOperand(0);
567 switch (Opcode) {
568 case SPIRV::OpExtension:
569 MAI.Reqs.addExtension(SPIRV::Extension::Extension(DefMO.getImm()));
570 MAI.setSkipEmission(&MI);
571 break;
572 case SPIRV::OpCapability:
573 MAI.Reqs.addCapability(SPIRV::Capability::Capability(DefMO.getImm()));
574 MAI.setSkipEmission(&MI);
575 if (PastHeader > 0)
576 PastHeader = 2;
577 break;
578 default:
579 if (DefMO.isReg() && isDeclSection(MRI, MI) &&
580 !MAI.hasRegisterAlias(MF, DefMO.getReg()))
581 visitDecl(MRI, SignatureToGReg, GlobalToGReg, MF, MI);
582 // OpEnqueueKernel is not a decl, but its Invoke operand may be a
583 // function-pointer placeholder OpUndef recorded by selectGlobalValue.
584 // Resolve it to the OpFunction's global <id> via visitFunPtrUse.
585 if (Opcode == SPIRV::OpEnqueueKernel && MI.getNumOperands() > 8) {
586 const MachineOperand &InvokeMO = MI.getOperand(8);
587 if (InvokeMO.isReg()) {
588 Register InvokeReg = InvokeMO.getReg();
589 if (!MAI.hasRegisterAlias(MF, InvokeReg)) {
590 if (const MachineInstr *DefMI =
591 MRI.getUniqueVRegDef(InvokeReg)) {
592 if (DefMI->getOpcode() == SPIRV::OpUndef) {
593 const MachineOperand *FunPtrOp = &DefMI->getOperand(0);
594 if (GR->getFunctionDefinitionByUse(FunPtrOp))
595 visitFunPtrUse(InvokeReg, FunPtrOp, SignatureToGReg,
596 GlobalToGReg, MF);
597 }
598 }
599 }
600 }
601 }
602 }
603 }
604 }
605 }
606}
607
608// Look for IDs declared with Import linkage, and map the corresponding function
609// to the register defining that variable (which will usually be the result of
610// an OpFunction). This lets us call externally imported functions using
611// the correct ID registers.
612void SPIRVModuleAnalysis::collectFuncNames(MachineInstr &MI,
613 const Function *F) {
614 if (MI.getOpcode() == SPIRV::OpDecorate) {
615 // If it's got Import linkage.
616 auto Dec = MI.getOperand(1).getImm();
617 if (Dec == SPIRV::Decoration::LinkageAttributes) {
618 auto Lnk = MI.getOperand(MI.getNumOperands() - 1).getImm();
619 if (Lnk == SPIRV::LinkageType::Import) {
620 // Map imported function name to function ID register.
621 const Function *ImportedFunc =
622 F->getParent()->getFunction(getStringImm(MI, 2));
623 Register Target = MI.getOperand(0).getReg();
624 MAI.GlobalObjMap[ImportedFunc] =
625 MAI.getRegisterAlias(MI.getMF(), Target);
626 }
627 }
628 } else if (MI.getOpcode() == SPIRV::OpFunction) {
629 // Record all internal OpFunction declarations.
630 Register Reg = MI.defs().begin()->getReg();
631 MCRegister GlobalReg = MAI.getRegisterAlias(MI.getMF(), Reg);
632 assert(GlobalReg.isValid());
633 MAI.GlobalObjMap[F] = GlobalReg;
634 }
635}
636
637// Collect the given instruction in the specified MS. We assume global register
638// numbering has already occurred by this point. We can directly compare reg
639// arguments when detecting duplicates.
640static void collectOtherInstr(MachineInstr &MI, SPIRV::ModuleAnalysisInfo &MAI,
642 bool Append = true) {
643 MAI.setSkipEmission(&MI);
644 InstrSignature MISign = instrToSignature(MI, MAI, true);
645 auto FoundMI = IS.insert(std::move(MISign));
646 if (!FoundMI.second) {
647 if (MI.getOpcode() == SPIRV::OpDecorate) {
648 assert(MI.getNumOperands() >= 2 &&
649 "Decoration instructions must have at least 2 operands");
650 assert(MSType == SPIRV::MB_Annotations &&
651 "Only OpDecorate instructions can be duplicates");
652 // For FPFastMathMode decoration, we need to merge the flags of the
653 // duplicate decoration with the original one, so we need to find the
654 // original instruction that has the same signature. For the rest of
655 // instructions, we will simply skip the duplicate.
656 if (MI.getOperand(1).getImm() != SPIRV::Decoration::FPFastMathMode)
657 return; // Skip duplicates of other decorations.
658
659 const SPIRV::InstrList &Decorations = MAI.MS[MSType];
660 for (const MachineInstr *OrigMI : Decorations) {
661 if (instrToSignature(*OrigMI, MAI, true) == MISign) {
662 assert(OrigMI->getNumOperands() == MI.getNumOperands() &&
663 "Original instruction must have the same number of operands");
664 assert(
665 OrigMI->getNumOperands() == 3 &&
666 "FPFastMathMode decoration must have 3 operands for OpDecorate");
667 unsigned OrigFlags = OrigMI->getOperand(2).getImm();
668 unsigned NewFlags = MI.getOperand(2).getImm();
669 if (OrigFlags == NewFlags)
670 return; // No need to merge, the flags are the same.
671
672 // Emit warning about possible conflict between flags.
673 unsigned FinalFlags = OrigFlags | NewFlags;
674 llvm::errs()
675 << "Warning: Conflicting FPFastMathMode decoration flags "
676 "in instruction: "
677 << *OrigMI << "Original flags: " << OrigFlags
678 << ", new flags: " << NewFlags
679 << ". They will be merged on a best effort basis, but not "
680 "validated. Final flags: "
681 << FinalFlags << "\n";
682 MachineInstr *OrigMINonConst = const_cast<MachineInstr *>(OrigMI);
683 MachineOperand &OrigFlagsOp = OrigMINonConst->getOperand(2);
684 OrigFlagsOp = MachineOperand::CreateImm(FinalFlags);
685 return; // Merge done, so we found a duplicate; don't add it to MAI.MS
686 }
687 }
688 assert(false && "No original instruction found for the duplicate "
689 "OpDecorate, but we found one in IS.");
690 }
691 return; // insert failed, so we found a duplicate; don't add it to MAI.MS
692 }
693 // No duplicates, so add it.
694 if (Append)
695 MAI.MS[MSType].push_back(&MI);
696 else
697 MAI.MS[MSType].insert(MAI.MS[MSType].begin(), &MI);
698}
699
700// Some global instructions make reference to function-local ID regs, so cannot
701// be correctly collected until these registers are globally numbered.
702void SPIRVModuleAnalysis::processOtherInstrs(const Module &M) {
703 InstrTraces IS;
704 for (const Function &F : M) {
705 if (F.isDeclaration())
706 continue;
707 MachineFunction *MF = MMI->getMachineFunction(F);
708 assert(MF);
709
710 for (MachineBasicBlock &MBB : *MF)
711 for (MachineInstr &MI : MBB) {
712 if (MAI.getSkipEmission(&MI))
713 continue;
714 const unsigned OpCode = MI.getOpcode();
715 if (OpCode == SPIRV::OpString) {
716 collectOtherInstr(MI, MAI, SPIRV::MB_DebugStrings, IS);
717 } else if (OpCode == SPIRV::OpExtInst && MI.getOperand(2).isImm() &&
718 MI.getOperand(2).getImm() ==
719 SPIRV::InstructionSet::
720 NonSemantic_Shader_DebugInfo_100) {
721 // TODO: This branch is dead. SPIRVNonSemanticDebugHandler emits NSDI
722 // instructions directly as MCInsts at print time; no
723 // MachineInstructions with the NSDI ext set are created anymore.
724 // Remove this block and
725 // MB_NonSemanticGlobalDI once per-function NSDI emission is confirmed
726 // not to need MIR routing.
727 MachineOperand Ins = MI.getOperand(3);
728 namespace NS = SPIRV::NonSemanticExtInst;
729 static constexpr int64_t GlobalNonSemanticDITy[] = {
730 NS::DebugSource, NS::DebugCompilationUnit, NS::DebugInfoNone,
731 NS::DebugTypeBasic, NS::DebugTypePointer};
732 bool IsGlobalDI = false;
733 for (unsigned Idx = 0; Idx < std::size(GlobalNonSemanticDITy); ++Idx)
734 IsGlobalDI |= Ins.getImm() == GlobalNonSemanticDITy[Idx];
735 if (IsGlobalDI)
736 collectOtherInstr(MI, MAI, SPIRV::MB_NonSemanticGlobalDI, IS);
737 } else if (OpCode == SPIRV::OpName || OpCode == SPIRV::OpMemberName) {
738 collectOtherInstr(MI, MAI, SPIRV::MB_DebugNames, IS);
739 } else if (OpCode == SPIRV::OpEntryPoint) {
740 collectOtherInstr(MI, MAI, SPIRV::MB_EntryPoints, IS);
741 } else if (TII->isAliasingInstr(MI)) {
742 collectOtherInstr(MI, MAI, SPIRV::MB_AliasingInsts, IS);
743 } else if (TII->isDecorationInstr(MI)) {
744 collectOtherInstr(MI, MAI, SPIRV::MB_Annotations, IS);
745 collectFuncNames(MI, &F);
746 } else if (TII->isConstantInstr(MI)) {
747 // Now OpSpecConstant*s are not in DT,
748 // but they need to be collected anyway.
749 collectOtherInstr(MI, MAI, SPIRV::MB_TypeConstVars, IS);
750 } else if (OpCode == SPIRV::OpFunction) {
751 collectFuncNames(MI, &F);
752 } else if (OpCode == SPIRV::OpTypeForwardPointer) {
753 collectOtherInstr(MI, MAI, SPIRV::MB_TypeConstVars, IS, false);
754 }
755 }
756 }
757}
758
759// Number registers in all functions globally from 0 onwards and store
760// the result in global register alias table. Some registers are already
761// numbered.
762void SPIRVModuleAnalysis::numberRegistersGlobally(const Module &M) {
763 for (const Function &F : M) {
764 if (F.isDeclaration())
765 continue;
766 MachineFunction *MF = MMI->getMachineFunction(F);
767 assert(MF);
768 for (MachineBasicBlock &MBB : *MF) {
769 for (MachineInstr &MI : MBB) {
770 for (MachineOperand &Op : MI.operands()) {
771 if (!Op.isReg())
772 continue;
773 Register Reg = Op.getReg();
774 if (MAI.hasRegisterAlias(MF, Reg))
775 continue;
776 MCRegister NewReg = MAI.getNextIDRegister();
777 MAI.setRegisterAlias(MF, Reg, NewReg);
778 }
779 if (MI.getOpcode() != SPIRV::OpExtInst)
780 continue;
781 auto Set = MI.getOperand(2).getImm();
782 auto [It, Inserted] = MAI.ExtInstSetMap.try_emplace(Set);
783 if (Inserted)
784 It->second = MAI.getNextIDRegister();
785 }
786 }
787 }
788}
789
790// RequirementHandler implementations.
792 SPIRV::OperandCategory::OperandCategory Category, uint32_t i,
793 const SPIRVSubtarget &ST) {
794 addRequirements(getSymbolicOperandRequirements(Category, i, ST, *this));
795}
796
797void SPIRV::RequirementHandler::recursiveAddCapabilities(
798 const CapabilityList &ToPrune) {
799 for (const auto &Cap : ToPrune) {
800 AllCaps.insert(Cap);
801 CapabilityList ImplicitDecls =
802 getSymbolicOperandCapabilities(OperandCategory::CapabilityOperand, Cap);
803 recursiveAddCapabilities(ImplicitDecls);
804 }
805}
806
808 for (const auto &Cap : ToAdd) {
809 bool IsNewlyInserted = AllCaps.insert(Cap).second;
810 if (!IsNewlyInserted) // Don't re-add if it's already been declared.
811 continue;
812 CapabilityList ImplicitDecls =
813 getSymbolicOperandCapabilities(OperandCategory::CapabilityOperand, Cap);
814 recursiveAddCapabilities(ImplicitDecls);
815 MinimalCaps.push_back(Cap);
816 }
817}
818
820 const SPIRV::Requirements &Req) {
821 if (!Req.IsSatisfiable)
822 report_fatal_error("Adding SPIR-V requirements this target can't satisfy.");
823
824 if (Req.Cap.has_value())
825 addCapabilities({Req.Cap.value()});
826
827 addExtensions(Req.Exts);
828
829 if (!Req.MinVer.empty()) {
830 if (!MaxVersion.empty() && Req.MinVer > MaxVersion) {
831 LLVM_DEBUG(dbgs() << "Conflicting version requirements: >= " << Req.MinVer
832 << " and <= " << MaxVersion << "\n");
833 report_fatal_error("Adding SPIR-V requirements that can't be satisfied.");
834 }
835
836 if (MinVersion.empty() || Req.MinVer > MinVersion)
837 MinVersion = Req.MinVer;
838 }
839
840 if (!Req.MaxVer.empty()) {
841 if (!MinVersion.empty() && Req.MaxVer < MinVersion) {
842 LLVM_DEBUG(dbgs() << "Conflicting version requirements: <= " << Req.MaxVer
843 << " and >= " << MinVersion << "\n");
844 report_fatal_error("Adding SPIR-V requirements that can't be satisfied.");
845 }
846
847 if (MaxVersion.empty() || Req.MaxVer < MaxVersion)
848 MaxVersion = Req.MaxVer;
849 }
850}
851
853 const SPIRVSubtarget &ST) const {
854 // Report as many errors as possible before aborting the compilation.
855 bool IsSatisfiable = true;
856 auto TargetVer = ST.getSPIRVVersion();
857
858 if (!MaxVersion.empty() && !TargetVer.empty() && MaxVersion < TargetVer) {
860 dbgs() << "Target SPIR-V version too high for required features\n"
861 << "Required max version: " << MaxVersion << " target version "
862 << TargetVer << "\n");
863 IsSatisfiable = false;
864 }
865
866 if (!MinVersion.empty() && !TargetVer.empty() && MinVersion > TargetVer) {
867 LLVM_DEBUG(dbgs() << "Target SPIR-V version too low for required features\n"
868 << "Required min version: " << MinVersion
869 << " target version " << TargetVer << "\n");
870 IsSatisfiable = false;
871 }
872
873 if (!MinVersion.empty() && !MaxVersion.empty() && MinVersion > MaxVersion) {
875 dbgs()
876 << "Version is too low for some features and too high for others.\n"
877 << "Required SPIR-V min version: " << MinVersion
878 << " required SPIR-V max version " << MaxVersion << "\n");
879 IsSatisfiable = false;
880 }
881
882 AvoidCapabilitiesSet AvoidCaps;
883 if (!ST.isShader())
884 AvoidCaps.S.insert(SPIRV::Capability::Shader);
885 else
886 AvoidCaps.S.insert(SPIRV::Capability::Kernel);
887
888 for (auto Cap : MinimalCaps) {
889 if (AvailableCaps.contains(Cap) && !AvoidCaps.S.contains(Cap))
890 continue;
891 LLVM_DEBUG(dbgs() << "Capability not supported: "
893 OperandCategory::CapabilityOperand, Cap)
894 << "\n");
895 IsSatisfiable = false;
896 }
897
898 for (auto Ext : AllExtensions) {
899 if (ST.canUseExtension(Ext))
900 continue;
901 LLVM_DEBUG(dbgs() << "Extension not supported: "
903 OperandCategory::ExtensionOperand, Ext)
904 << "\n");
905 IsSatisfiable = false;
906 }
907
908 if (!IsSatisfiable)
909 report_fatal_error("Unable to meet SPIR-V requirements for this target.");
910}
911
912// Add the given capabilities and all their implicitly defined capabilities too.
914 for (const auto Cap : ToAdd)
915 if (AvailableCaps.insert(Cap).second)
916 addAvailableCaps(getSymbolicOperandCapabilities(
917 SPIRV::OperandCategory::CapabilityOperand, Cap));
918}
919
921 const Capability::Capability ToRemove,
922 const Capability::Capability IfPresent) {
923 if (AllCaps.contains(IfPresent))
924 AllCaps.erase(ToRemove);
925}
926
927namespace llvm {
928namespace SPIRV {
929void RequirementHandler::initAvailableCapabilities(const SPIRVSubtarget &ST) {
930 // Provided by both all supported Vulkan versions and OpenCl.
931 addAvailableCaps({Capability::Shader, Capability::Linkage, Capability::Int8,
932 Capability::Int16});
933
934 if (ST.isAtLeastSPIRVVer(VersionTuple(1, 3)))
935 addAvailableCaps({Capability::GroupNonUniform,
936 Capability::GroupNonUniformVote,
937 Capability::GroupNonUniformArithmetic,
938 Capability::GroupNonUniformBallot,
939 Capability::GroupNonUniformClustered,
940 Capability::GroupNonUniformShuffle,
941 Capability::GroupNonUniformShuffleRelative,
942 Capability::GroupNonUniformQuad});
943
944 if (ST.isAtLeastSPIRVVer(VersionTuple(1, 6)))
945 addAvailableCaps({Capability::DotProduct, Capability::DotProductInputAll,
946 Capability::DotProductInput4x8Bit,
947 Capability::DotProductInput4x8BitPacked,
948 Capability::DemoteToHelperInvocation});
949
950 // Add capabilities enabled by extensions.
951 for (auto Extension : ST.getAllAvailableExtensions()) {
952 CapabilityList EnabledCapabilities =
954 addAvailableCaps(EnabledCapabilities);
955 }
956
957 if (!ST.isShader()) {
958 initAvailableCapabilitiesForOpenCL(ST);
959 return;
960 }
961
962 if (ST.isShader()) {
963 initAvailableCapabilitiesForVulkan(ST);
964 return;
965 }
966
967 report_fatal_error("Unimplemented environment for SPIR-V generation.");
968}
969
970void RequirementHandler::initAvailableCapabilitiesForOpenCL(
971 const SPIRVSubtarget &ST) {
972 // Add the min requirements for different OpenCL and SPIR-V versions.
973 addAvailableCaps({Capability::Addresses, Capability::Float16Buffer,
974 Capability::Kernel, Capability::Vector16,
975 Capability::Groups, Capability::GenericPointer,
976 Capability::StorageImageWriteWithoutFormat,
977 Capability::StorageImageReadWithoutFormat});
978 if (ST.hasOpenCLFullProfile())
979 addAvailableCaps({Capability::Int64, Capability::Int64Atomics});
980 if (ST.hasOpenCLImageSupport()) {
981 addAvailableCaps({Capability::ImageBasic, Capability::LiteralSampler,
982 Capability::Image1D, Capability::SampledBuffer,
983 Capability::ImageBuffer});
984 if (ST.isAtLeastOpenCLVer(VersionTuple(2, 0)))
985 addAvailableCaps({Capability::ImageReadWrite});
986 }
987 if (ST.isAtLeastSPIRVVer(VersionTuple(1, 1)) &&
988 ST.isAtLeastOpenCLVer(VersionTuple(2, 2)))
989 addAvailableCaps({Capability::SubgroupDispatch, Capability::PipeStorage});
990 if (ST.isAtLeastSPIRVVer(VersionTuple(1, 4)))
991 addAvailableCaps({Capability::DenormPreserve, Capability::DenormFlushToZero,
992 Capability::SignedZeroInfNanPreserve,
993 Capability::RoundingModeRTE,
994 Capability::RoundingModeRTZ});
995 // TODO: verify if this needs some checks.
996 addAvailableCaps({Capability::Float16, Capability::Float64});
997
998 // TODO: add OpenCL extensions.
999}
1000
1001void RequirementHandler::initAvailableCapabilitiesForVulkan(
1002 const SPIRVSubtarget &ST) {
1003
1004 // Core in Vulkan 1.1 and earlier.
1005 addAvailableCaps({Capability::Int64,
1006 Capability::Float16,
1007 Capability::Float64,
1008 Capability::GroupNonUniform,
1009 Capability::Image1D,
1010 Capability::SampledBuffer,
1011 Capability::ImageBuffer,
1012 Capability::UniformBufferArrayDynamicIndexing,
1013 Capability::SampledImageArrayDynamicIndexing,
1014 Capability::StorageBufferArrayDynamicIndexing,
1015 Capability::StorageImageArrayDynamicIndexing,
1016 Capability::DerivativeControl,
1017 Capability::MinLod,
1018 Capability::ImageQuery,
1019 Capability::ImageGatherExtended,
1020 Capability::Addresses,
1021 Capability::VulkanMemoryModelKHR,
1022 Capability::StorageImageExtendedFormats,
1023 Capability::StorageImageMultisample,
1024 Capability::ImageMSArray});
1025
1026 // Became core in Vulkan 1.2
1027 if (ST.isAtLeastSPIRVVer(VersionTuple(1, 5))) {
1029 {Capability::ShaderNonUniformEXT, Capability::RuntimeDescriptorArrayEXT,
1030 Capability::InputAttachmentArrayDynamicIndexingEXT,
1031 Capability::UniformTexelBufferArrayDynamicIndexingEXT,
1032 Capability::StorageTexelBufferArrayDynamicIndexingEXT,
1033 Capability::UniformBufferArrayNonUniformIndexingEXT,
1034 Capability::SampledImageArrayNonUniformIndexingEXT,
1035 Capability::StorageBufferArrayNonUniformIndexingEXT,
1036 Capability::StorageImageArrayNonUniformIndexingEXT,
1037 Capability::InputAttachmentArrayNonUniformIndexingEXT,
1038 Capability::UniformTexelBufferArrayNonUniformIndexingEXT,
1039 Capability::StorageTexelBufferArrayNonUniformIndexingEXT});
1040 }
1041
1042 // Became core in Vulkan 1.3
1043 if (ST.isAtLeastSPIRVVer(VersionTuple(1, 6)))
1044 addAvailableCaps({Capability::StorageImageWriteWithoutFormat,
1045 Capability::StorageImageReadWithoutFormat});
1046}
1047
1048} // namespace SPIRV
1049} // namespace llvm
1050
1051// Add the required capabilities from a decoration instruction (including
1052// BuiltIns).
1053static void addOpDecorateReqs(const MachineInstr &MI, unsigned DecIndex,
1055 const SPIRVSubtarget &ST) {
1056 int64_t DecOp = MI.getOperand(DecIndex).getImm();
1057 auto Dec = static_cast<SPIRV::Decoration::Decoration>(DecOp);
1058 Reqs.addRequirements(getSymbolicOperandRequirements(
1059 SPIRV::OperandCategory::DecorationOperand, Dec, ST, Reqs));
1060
1061 if (Dec == SPIRV::Decoration::BuiltIn) {
1062 int64_t BuiltInOp = MI.getOperand(DecIndex + 1).getImm();
1063 auto BuiltIn = static_cast<SPIRV::BuiltIn::BuiltIn>(BuiltInOp);
1064 Reqs.addRequirements(getSymbolicOperandRequirements(
1065 SPIRV::OperandCategory::BuiltInOperand, BuiltIn, ST, Reqs));
1066 } else if (Dec == SPIRV::Decoration::LinkageAttributes) {
1067 int64_t LinkageOp = MI.getOperand(MI.getNumOperands() - 1).getImm();
1068 SPIRV::LinkageType::LinkageType LnkType =
1069 static_cast<SPIRV::LinkageType::LinkageType>(LinkageOp);
1070 if (LnkType == SPIRV::LinkageType::LinkOnceODR)
1071 Reqs.addExtension(SPIRV::Extension::SPV_KHR_linkonce_odr);
1072 else if (LnkType == SPIRV::LinkageType::WeakAMD) {
1073 Reqs.addExtension(SPIRV::Extension::SPV_AMD_weak_linkage);
1074 Reqs.addCapability(SPIRV::Capability::WeakLinkageAMD);
1075 }
1076 } else if (Dec == SPIRV::Decoration::CacheControlLoadINTEL ||
1077 Dec == SPIRV::Decoration::CacheControlStoreINTEL) {
1078 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_cache_controls);
1079 } else if (Dec == SPIRV::Decoration::HostAccessINTEL) {
1080 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_global_variable_host_access);
1081 } else if (Dec == SPIRV::Decoration::InitModeINTEL ||
1082 Dec == SPIRV::Decoration::ImplementInRegisterMapINTEL) {
1083 Reqs.addExtension(
1084 SPIRV::Extension::SPV_INTEL_global_variable_fpga_decorations);
1085 } else if (Dec == SPIRV::Decoration::NonUniformEXT) {
1086 Reqs.addRequirements(SPIRV::Capability::ShaderNonUniformEXT);
1087 } else if (Dec == SPIRV::Decoration::FPMaxErrorDecorationINTEL) {
1088 Reqs.addRequirements(SPIRV::Capability::FPMaxErrorINTEL);
1089 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_fp_max_error);
1090 } else if (Dec == SPIRV::Decoration::FPFastMathMode) {
1091 if (ST.canUseExtension(SPIRV::Extension::SPV_KHR_float_controls2)) {
1092 Reqs.addRequirements(SPIRV::Capability::FloatControls2);
1093 Reqs.addExtension(SPIRV::Extension::SPV_KHR_float_controls2);
1094 }
1095 }
1096}
1097
1098// Add requirements for image handling.
1099static void addOpTypeImageReqs(const MachineInstr &MI,
1101 const SPIRVSubtarget &ST) {
1102 assert(MI.getNumOperands() >= 8 && "Insufficient operands for OpTypeImage");
1103 // The operand indices used here are based on the OpTypeImage layout, which
1104 // the MachineInstr follows as well.
1105 int64_t ImgFormatOp = MI.getOperand(7).getImm();
1106 auto ImgFormat = static_cast<SPIRV::ImageFormat::ImageFormat>(ImgFormatOp);
1107 Reqs.getAndAddRequirements(SPIRV::OperandCategory::ImageFormatOperand,
1108 ImgFormat, ST);
1109
1110 bool IsArrayed = MI.getOperand(4).getImm() == 1;
1111 bool IsMultisampled = MI.getOperand(5).getImm() == 1;
1112 bool NoSampler = MI.getOperand(6).getImm() == 2;
1113 // Add dimension requirements.
1114 assert(MI.getOperand(2).isImm());
1115 switch (MI.getOperand(2).getImm()) {
1116 case SPIRV::Dim::DIM_1D:
1117 Reqs.addRequirements(NoSampler ? SPIRV::Capability::Image1D
1118 : SPIRV::Capability::Sampled1D);
1119 break;
1120 case SPIRV::Dim::DIM_2D:
1121 if (IsMultisampled && NoSampler)
1122 Reqs.addRequirements(SPIRV::Capability::StorageImageMultisample);
1123 if (IsMultisampled && IsArrayed)
1124 Reqs.addRequirements(SPIRV::Capability::ImageMSArray);
1125 break;
1126 case SPIRV::Dim::DIM_3D:
1127 break;
1128 case SPIRV::Dim::DIM_Cube:
1129 Reqs.addRequirements(SPIRV::Capability::Shader);
1130 if (IsArrayed)
1131 Reqs.addRequirements(NoSampler ? SPIRV::Capability::ImageCubeArray
1132 : SPIRV::Capability::SampledCubeArray);
1133 break;
1134 case SPIRV::Dim::DIM_Rect:
1135 Reqs.addRequirements(NoSampler ? SPIRV::Capability::ImageRect
1136 : SPIRV::Capability::SampledRect);
1137 break;
1138 case SPIRV::Dim::DIM_Buffer:
1139 Reqs.addRequirements(NoSampler ? SPIRV::Capability::ImageBuffer
1140 : SPIRV::Capability::SampledBuffer);
1141 break;
1142 case SPIRV::Dim::DIM_SubpassData:
1143 Reqs.addRequirements(SPIRV::Capability::InputAttachment);
1144 break;
1145 }
1146
1147 // Check if the sampled type is a 64-bit integer, which requires
1148 // Int64ImageEXT capability.
1149 assert(MI.getOperand(1).isReg());
1150 const MachineRegisterInfo &MRI = MI.getMF()->getRegInfo();
1151 SPIRVTypeInst SampledTypeDef = MRI.getVRegDef(MI.getOperand(1).getReg());
1152 if (SampledTypeDef.isTypeIntN(64)) {
1153 Reqs.addCapability(SPIRV::Capability::Int64ImageEXT);
1154 Reqs.addExtension(SPIRV::Extension::SPV_EXT_shader_image_int64);
1155 }
1156
1157 // Has optional access qualifier.
1158 if (!ST.isShader()) {
1159 if (MI.getNumOperands() > 8 &&
1160 MI.getOperand(8).getImm() == SPIRV::AccessQualifier::ReadWrite)
1161 Reqs.addRequirements(SPIRV::Capability::ImageReadWrite);
1162 else
1163 Reqs.addRequirements(SPIRV::Capability::ImageBasic);
1164 }
1165}
1166
1167static bool isBFloat16Type(SPIRVTypeInst TypeDef) {
1168 return TypeDef && TypeDef->getNumOperands() == 3 &&
1169 TypeDef->getOpcode() == SPIRV::OpTypeFloat &&
1170 TypeDef->getOperand(1).getImm() == 16 &&
1171 TypeDef->getOperand(2).getImm() == SPIRV::FPEncoding::BFloat16KHR;
1172}
1173
1174// Add requirements for handling atomic float instructions
1175#define ATOM_FLT_REQ_EXT_MSG(ExtName) \
1176 "The atomic float instruction requires the following SPIR-V " \
1177 "extension: SPV_EXT_shader_atomic_float" ExtName
1178static void AddAtomicVectorFloatRequirements(const MachineInstr &MI,
1180 const SPIRVSubtarget &ST) {
1181 SPIRVTypeInst VecTypeDef =
1182 MI.getMF()->getRegInfo().getVRegDef(MI.getOperand(1).getReg());
1183
1184 const unsigned Rank = VecTypeDef->getOperand(2).getImm();
1185 if (Rank != 2 && Rank != 4)
1186 reportFatalUsageError("Result type of an atomic vector float instruction "
1187 "must be a 2-component or 4 component vector");
1188
1189 SPIRVTypeInst EltTypeDef =
1190 MI.getMF()->getRegInfo().getVRegDef(VecTypeDef->getOperand(1).getReg());
1191
1192 if (EltTypeDef->getOpcode() != SPIRV::OpTypeFloat ||
1193 EltTypeDef->getOperand(1).getImm() != 16)
1195 "The element type for the result type of an atomic vector float "
1196 "instruction must be a 16-bit floating-point scalar");
1197
1198 if (isBFloat16Type(EltTypeDef))
1200 "The element type for the result type of an atomic vector float "
1201 "instruction cannot be a bfloat16 scalar");
1202 if (!ST.canUseExtension(SPIRV::Extension::SPV_NV_shader_atomic_fp16_vector))
1204 "The atomic float16 vector instruction requires the following SPIR-V "
1205 "extension: SPV_NV_shader_atomic_fp16_vector");
1206
1207 Reqs.addExtension(SPIRV::Extension::SPV_NV_shader_atomic_fp16_vector);
1208 Reqs.addCapability(SPIRV::Capability::AtomicFloat16VectorNV);
1209}
1210
1211static void AddAtomicFloatRequirements(const MachineInstr &MI,
1213 const SPIRVSubtarget &ST) {
1214 assert(MI.getOperand(1).isReg() &&
1215 "Expect register operand in atomic float instruction");
1216 Register TypeReg = MI.getOperand(1).getReg();
1217 SPIRVTypeInst TypeDef = MI.getMF()->getRegInfo().getVRegDef(TypeReg);
1218
1219 if (TypeDef->getOpcode() == SPIRV::OpTypeVector)
1220 return AddAtomicVectorFloatRequirements(MI, Reqs, ST);
1221
1222 if (TypeDef->getOpcode() != SPIRV::OpTypeFloat)
1223 report_fatal_error("Result type of an atomic float instruction must be a "
1224 "floating-point type scalar");
1225
1226 unsigned BitWidth = TypeDef->getOperand(1).getImm();
1227 unsigned Op = MI.getOpcode();
1228 if (Op == SPIRV::OpAtomicFAddEXT) {
1229 if (!ST.canUseExtension(SPIRV::Extension::SPV_EXT_shader_atomic_float_add))
1231 Reqs.addExtension(SPIRV::Extension::SPV_EXT_shader_atomic_float_add);
1232 switch (BitWidth) {
1233 case 16:
1234 if (isBFloat16Type(TypeDef)) {
1235 if (!ST.canUseExtension(SPIRV::Extension::SPV_INTEL_16bit_atomics))
1237 "The atomic bfloat16 instruction requires the following SPIR-V "
1238 "extension: SPV_INTEL_16bit_atomics",
1239 false);
1240 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_16bit_atomics);
1241 Reqs.addCapability(SPIRV::Capability::AtomicBFloat16AddINTEL);
1242 } else {
1243 if (!ST.canUseExtension(
1244 SPIRV::Extension::SPV_EXT_shader_atomic_float16_add))
1245 report_fatal_error(ATOM_FLT_REQ_EXT_MSG("16_add"), false);
1246 Reqs.addExtension(SPIRV::Extension::SPV_EXT_shader_atomic_float16_add);
1247 Reqs.addCapability(SPIRV::Capability::AtomicFloat16AddEXT);
1248 }
1249 break;
1250 case 32:
1251 Reqs.addCapability(SPIRV::Capability::AtomicFloat32AddEXT);
1252 break;
1253 case 64:
1254 Reqs.addCapability(SPIRV::Capability::AtomicFloat64AddEXT);
1255 break;
1256 default:
1258 "Unexpected floating-point type width in atomic float instruction");
1259 }
1260 } else {
1261 if (!ST.canUseExtension(
1262 SPIRV::Extension::SPV_EXT_shader_atomic_float_min_max))
1263 report_fatal_error(ATOM_FLT_REQ_EXT_MSG("_min_max"), false);
1264 Reqs.addExtension(SPIRV::Extension::SPV_EXT_shader_atomic_float_min_max);
1265 switch (BitWidth) {
1266 case 16:
1267 if (isBFloat16Type(TypeDef)) {
1268 if (!ST.canUseExtension(SPIRV::Extension::SPV_INTEL_16bit_atomics))
1270 "The atomic bfloat16 instruction requires the following SPIR-V "
1271 "extension: SPV_INTEL_16bit_atomics",
1272 false);
1273 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_16bit_atomics);
1274 Reqs.addCapability(SPIRV::Capability::AtomicBFloat16MinMaxINTEL);
1275 } else {
1276 Reqs.addCapability(SPIRV::Capability::AtomicFloat16MinMaxEXT);
1277 }
1278 break;
1279 case 32:
1280 Reqs.addCapability(SPIRV::Capability::AtomicFloat32MinMaxEXT);
1281 break;
1282 case 64:
1283 Reqs.addCapability(SPIRV::Capability::AtomicFloat64MinMaxEXT);
1284 break;
1285 default:
1287 "Unexpected floating-point type width in atomic float instruction");
1288 }
1289 }
1290}
1291
1292bool isUniformTexelBuffer(MachineInstr *ImageInst) {
1293 if (ImageInst->getOpcode() != SPIRV::OpTypeImage)
1294 return false;
1295 uint32_t Dim = ImageInst->getOperand(2).getImm();
1296 uint32_t Sampled = ImageInst->getOperand(6).getImm();
1297 return Dim == SPIRV::Dim::DIM_Buffer && Sampled == 1;
1298}
1299
1300bool isStorageTexelBuffer(MachineInstr *ImageInst) {
1301 if (ImageInst->getOpcode() != SPIRV::OpTypeImage)
1302 return false;
1303 uint32_t Dim = ImageInst->getOperand(2).getImm();
1304 uint32_t Sampled = ImageInst->getOperand(6).getImm();
1305 return Dim == SPIRV::Dim::DIM_Buffer && Sampled == 2;
1306}
1307
1308bool isSampledImage(MachineInstr *ImageInst) {
1309 if (ImageInst->getOpcode() != SPIRV::OpTypeImage)
1310 return false;
1311 uint32_t Dim = ImageInst->getOperand(2).getImm();
1312 uint32_t Sampled = ImageInst->getOperand(6).getImm();
1313 return Dim != SPIRV::Dim::DIM_Buffer && Sampled == 1;
1314}
1315
1316bool isInputAttachment(MachineInstr *ImageInst) {
1317 if (ImageInst->getOpcode() != SPIRV::OpTypeImage)
1318 return false;
1319 uint32_t Dim = ImageInst->getOperand(2).getImm();
1320 uint32_t Sampled = ImageInst->getOperand(6).getImm();
1321 return Dim == SPIRV::Dim::DIM_SubpassData && Sampled == 2;
1322}
1323
1324bool isStorageImage(MachineInstr *ImageInst) {
1325 if (ImageInst->getOpcode() != SPIRV::OpTypeImage)
1326 return false;
1327 uint32_t Dim = ImageInst->getOperand(2).getImm();
1328 uint32_t Sampled = ImageInst->getOperand(6).getImm();
1329 return Dim != SPIRV::Dim::DIM_Buffer && Sampled == 2;
1330}
1331
1332bool isCombinedImageSampler(MachineInstr *SampledImageInst) {
1333 if (SampledImageInst->getOpcode() != SPIRV::OpTypeSampledImage)
1334 return false;
1335
1336 const MachineRegisterInfo &MRI = SampledImageInst->getMF()->getRegInfo();
1337 Register ImageReg = SampledImageInst->getOperand(1).getReg();
1338 auto *ImageInst = MRI.getUniqueVRegDef(ImageReg);
1339 return isSampledImage(ImageInst);
1340}
1341
1342bool hasNonUniformDecoration(Register Reg, const MachineRegisterInfo &MRI) {
1343 for (const auto &MI : MRI.reg_instructions(Reg)) {
1344 if (MI.getOpcode() != SPIRV::OpDecorate)
1345 continue;
1346
1347 uint32_t Dec = MI.getOperand(1).getImm();
1348 if (Dec == SPIRV::Decoration::NonUniformEXT)
1349 return true;
1350 }
1351 return false;
1352}
1353
1354void addOpAccessChainReqs(const MachineInstr &Instr,
1356 const SPIRVSubtarget &Subtarget) {
1357 const MachineRegisterInfo &MRI = Instr.getMF()->getRegInfo();
1358 // Get the result type. If it is an image type, then the shader uses
1359 // descriptor indexing. The appropriate capabilities will be added based
1360 // on the specifics of the image.
1361 Register ResTypeReg = Instr.getOperand(1).getReg();
1362 MachineInstr *ResTypeInst = MRI.getUniqueVRegDef(ResTypeReg);
1363
1364 assert(ResTypeInst->getOpcode() == SPIRV::OpTypePointer);
1365 uint32_t StorageClass = ResTypeInst->getOperand(1).getImm();
1366 if (StorageClass != SPIRV::StorageClass::StorageClass::UniformConstant &&
1367 StorageClass != SPIRV::StorageClass::StorageClass::Uniform &&
1368 StorageClass != SPIRV::StorageClass::StorageClass::StorageBuffer) {
1369 return;
1370 }
1371
1372 bool IsNonUniform =
1373 hasNonUniformDecoration(Instr.getOperand(0).getReg(), MRI);
1374
1375 auto FirstIndexReg = Instr.getOperand(3).getReg();
1376 bool FirstIndexIsConstant =
1377 Subtarget.getInstrInfo()->isConstantInstr(*MRI.getVRegDef(FirstIndexReg));
1378
1379 if (StorageClass == SPIRV::StorageClass::StorageClass::StorageBuffer) {
1380 if (IsNonUniform)
1381 Handler.addRequirements(
1382 SPIRV::Capability::StorageBufferArrayNonUniformIndexingEXT);
1383 else if (!FirstIndexIsConstant)
1384 Handler.addRequirements(
1385 SPIRV::Capability::StorageBufferArrayDynamicIndexing);
1386 return;
1387 }
1388
1389 Register PointeeTypeReg = ResTypeInst->getOperand(2).getReg();
1390 MachineInstr *PointeeType = MRI.getUniqueVRegDef(PointeeTypeReg);
1391 if (PointeeType->getOpcode() != SPIRV::OpTypeImage &&
1392 PointeeType->getOpcode() != SPIRV::OpTypeSampledImage &&
1393 PointeeType->getOpcode() != SPIRV::OpTypeSampler) {
1394 return;
1395 }
1396
1397 if (isUniformTexelBuffer(PointeeType)) {
1398 if (IsNonUniform)
1399 Handler.addRequirements(
1400 SPIRV::Capability::UniformTexelBufferArrayNonUniformIndexingEXT);
1401 else if (!FirstIndexIsConstant)
1402 Handler.addRequirements(
1403 SPIRV::Capability::UniformTexelBufferArrayDynamicIndexingEXT);
1404 } else if (isInputAttachment(PointeeType)) {
1405 if (IsNonUniform)
1406 Handler.addRequirements(
1407 SPIRV::Capability::InputAttachmentArrayNonUniformIndexingEXT);
1408 else if (!FirstIndexIsConstant)
1409 Handler.addRequirements(
1410 SPIRV::Capability::InputAttachmentArrayDynamicIndexingEXT);
1411 } else if (isStorageTexelBuffer(PointeeType)) {
1412 if (IsNonUniform)
1413 Handler.addRequirements(
1414 SPIRV::Capability::StorageTexelBufferArrayNonUniformIndexingEXT);
1415 else if (!FirstIndexIsConstant)
1416 Handler.addRequirements(
1417 SPIRV::Capability::StorageTexelBufferArrayDynamicIndexingEXT);
1418 } else if (isSampledImage(PointeeType) ||
1419 isCombinedImageSampler(PointeeType) ||
1420 PointeeType->getOpcode() == SPIRV::OpTypeSampler) {
1421 if (IsNonUniform)
1422 Handler.addRequirements(
1423 SPIRV::Capability::SampledImageArrayNonUniformIndexingEXT);
1424 else if (!FirstIndexIsConstant)
1425 Handler.addRequirements(
1426 SPIRV::Capability::SampledImageArrayDynamicIndexing);
1427 } else if (isStorageImage(PointeeType)) {
1428 if (IsNonUniform)
1429 Handler.addRequirements(
1430 SPIRV::Capability::StorageImageArrayNonUniformIndexingEXT);
1431 else if (!FirstIndexIsConstant)
1432 Handler.addRequirements(
1433 SPIRV::Capability::StorageImageArrayDynamicIndexing);
1434 }
1435}
1436
1437static bool isImageTypeWithUnknownFormat(SPIRVTypeInst TypeInst) {
1438 if (TypeInst->getOpcode() != SPIRV::OpTypeImage)
1439 return false;
1440 assert(TypeInst->getOperand(7).isImm() && "The image format must be an imm.");
1441 return TypeInst->getOperand(7).getImm() == 0;
1442}
1443
1444static void AddDotProductRequirements(const MachineInstr &MI,
1446 const SPIRVSubtarget &ST) {
1447 if (ST.canUseExtension(SPIRV::Extension::SPV_KHR_integer_dot_product))
1448 Reqs.addExtension(SPIRV::Extension::SPV_KHR_integer_dot_product);
1449 Reqs.addCapability(SPIRV::Capability::DotProduct);
1450
1451 const MachineRegisterInfo &MRI = MI.getMF()->getRegInfo();
1452 assert(MI.getOperand(2).isReg() && "Unexpected operand in dot");
1453 // We do not consider what the previous instruction is. This is just used
1454 // to get the input register and to check the type.
1455 const MachineInstr *Input = MRI.getVRegDef(MI.getOperand(2).getReg());
1456 assert(Input->getOperand(1).isReg() && "Unexpected operand in dot input");
1457 Register InputReg = Input->getOperand(1).getReg();
1458
1459 SPIRVTypeInst TypeDef = MRI.getVRegDef(InputReg);
1460 if (TypeDef->getOpcode() == SPIRV::OpTypeInt) {
1461 assert(TypeDef->getOperand(1).getImm() == 32);
1462 Reqs.addCapability(SPIRV::Capability::DotProductInput4x8BitPacked);
1463 } else if (TypeDef->getOpcode() == SPIRV::OpTypeVector) {
1464 SPIRVTypeInst ScalarTypeDef =
1465 MRI.getVRegDef(TypeDef->getOperand(1).getReg());
1466 assert(ScalarTypeDef->getOpcode() == SPIRV::OpTypeInt);
1467 if (ScalarTypeDef->getOperand(1).getImm() == 8) {
1468 assert(TypeDef->getOperand(2).getImm() == 4 &&
1469 "Dot operand of 8-bit integer type requires 4 components");
1470 Reqs.addCapability(SPIRV::Capability::DotProductInput4x8Bit);
1471 } else {
1472 Reqs.addCapability(SPIRV::Capability::DotProductInputAll);
1473 }
1474 }
1475}
1476
1477void addPrintfRequirements(const MachineInstr &MI,
1479 const SPIRVSubtarget &ST) {
1480 SPIRVGlobalRegistry *GR = ST.getSPIRVGlobalRegistry();
1481 SPIRVTypeInst PtrType = GR->getSPIRVTypeForVReg(MI.getOperand(4).getReg());
1482 if (PtrType) {
1483 MachineOperand ASOp = PtrType->getOperand(1);
1484 if (ASOp.isImm()) {
1485 unsigned AddrSpace = ASOp.getImm();
1486 if (AddrSpace != SPIRV::StorageClass::UniformConstant) {
1487 if (!ST.canUseExtension(
1489 SPV_EXT_relaxed_printf_string_address_space)) {
1490 report_fatal_error("SPV_EXT_relaxed_printf_string_address_space is "
1491 "required because printf uses a format string not "
1492 "in constant address space.",
1493 false);
1494 }
1495 Reqs.addExtension(
1496 SPIRV::Extension::SPV_EXT_relaxed_printf_string_address_space);
1497 }
1498 }
1499 }
1500}
1501
1502static void addImageOperandReqs(const MachineInstr &MI,
1504 const SPIRVSubtarget &ST, unsigned OpIdx) {
1505 if (MI.getNumOperands() <= OpIdx)
1506 return;
1507 uint32_t Mask = MI.getOperand(OpIdx).getImm();
1508 for (uint32_t I = 0; I < 32; ++I)
1509 if (Mask & (1U << I))
1510 Reqs.getAndAddRequirements(SPIRV::OperandCategory::ImageOperandOperand,
1511 1U << I, ST);
1512}
1513
1514void addInstrRequirements(const MachineInstr &MI,
1516 const SPIRVSubtarget &ST) {
1517 SPIRV::RequirementHandler &Reqs = MAI.Reqs;
1518 unsigned Op = MI.getOpcode();
1519 switch (Op) {
1520 case SPIRV::OpMemoryModel: {
1521 int64_t Addr = MI.getOperand(0).getImm();
1522 Reqs.getAndAddRequirements(SPIRV::OperandCategory::AddressingModelOperand,
1523 Addr, ST);
1524 int64_t Mem = MI.getOperand(1).getImm();
1525 Reqs.getAndAddRequirements(SPIRV::OperandCategory::MemoryModelOperand, Mem,
1526 ST);
1527 break;
1528 }
1529 case SPIRV::OpEntryPoint: {
1530 int64_t Exe = MI.getOperand(0).getImm();
1531 Reqs.getAndAddRequirements(SPIRV::OperandCategory::ExecutionModelOperand,
1532 Exe, ST);
1533 break;
1534 }
1535 case SPIRV::OpExecutionMode:
1536 case SPIRV::OpExecutionModeId: {
1537 int64_t Exe = MI.getOperand(1).getImm();
1538 Reqs.getAndAddRequirements(SPIRV::OperandCategory::ExecutionModeOperand,
1539 Exe, ST);
1540 break;
1541 }
1542 case SPIRV::OpTypeMatrix:
1543 Reqs.addCapability(SPIRV::Capability::Matrix);
1544 break;
1545 case SPIRV::OpTypeInt: {
1546 unsigned BitWidth = MI.getOperand(1).getImm();
1547 if (BitWidth == 64)
1548 Reqs.addCapability(SPIRV::Capability::Int64);
1549 else if (BitWidth == 16)
1550 Reqs.addCapability(SPIRV::Capability::Int16);
1551 else if (BitWidth == 8)
1552 Reqs.addCapability(SPIRV::Capability::Int8);
1553 else if (BitWidth == 4 &&
1554 ST.canUseExtension(SPIRV::Extension::SPV_INTEL_int4)) {
1555 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_int4);
1556 Reqs.addCapability(SPIRV::Capability::Int4TypeINTEL);
1557 } else if (BitWidth != 32) {
1558 if (!ST.canUseExtension(
1559 SPIRV::Extension::SPV_ALTERA_arbitrary_precision_integers))
1561 "OpTypeInt type with a width other than 8, 16, 32 or 64 bits "
1562 "requires the following SPIR-V extension: "
1563 "SPV_ALTERA_arbitrary_precision_integers");
1564 Reqs.addExtension(
1565 SPIRV::Extension::SPV_ALTERA_arbitrary_precision_integers);
1566 Reqs.addCapability(SPIRV::Capability::ArbitraryPrecisionIntegersALTERA);
1567 }
1568 break;
1569 }
1570 case SPIRV::OpDot: {
1571 const MachineRegisterInfo &MRI = MI.getMF()->getRegInfo();
1572 SPIRVTypeInst TypeDef = MRI.getVRegDef(MI.getOperand(1).getReg());
1573 if (isBFloat16Type(TypeDef))
1574 Reqs.addCapability(SPIRV::Capability::BFloat16DotProductKHR);
1575 break;
1576 }
1577 case SPIRV::OpTypeFloat: {
1578 unsigned BitWidth = MI.getOperand(1).getImm();
1579 if (BitWidth == 64)
1580 Reqs.addCapability(SPIRV::Capability::Float64);
1581 else if (BitWidth == 16) {
1582 if (isBFloat16Type(&MI)) {
1583 if (!ST.canUseExtension(SPIRV::Extension::SPV_KHR_bfloat16))
1584 report_fatal_error("OpTypeFloat type with bfloat requires the "
1585 "following SPIR-V extension: SPV_KHR_bfloat16",
1586 false);
1587 Reqs.addExtension(SPIRV::Extension::SPV_KHR_bfloat16);
1588 Reqs.addCapability(SPIRV::Capability::BFloat16TypeKHR);
1589 } else {
1590 Reqs.addCapability(SPIRV::Capability::Float16);
1591 }
1592 }
1593 break;
1594 }
1595 case SPIRV::OpTypeVector: {
1596 unsigned NumComponents = MI.getOperand(2).getImm();
1597 if (NumComponents == 8 || NumComponents == 16)
1598 Reqs.addCapability(SPIRV::Capability::Vector16);
1599
1600 assert(MI.getOperand(1).isReg());
1601 const MachineRegisterInfo &MRI = MI.getMF()->getRegInfo();
1602 SPIRVTypeInst ElemTypeDef = MRI.getVRegDef(MI.getOperand(1).getReg());
1603 if (ElemTypeDef->getOpcode() == SPIRV::OpTypePointer &&
1604 ST.canUseExtension(SPIRV::Extension::SPV_INTEL_masked_gather_scatter)) {
1605 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_masked_gather_scatter);
1606 Reqs.addCapability(SPIRV::Capability::MaskedGatherScatterINTEL);
1607 }
1608 break;
1609 }
1610 case SPIRV::OpTypePointer: {
1611 auto SC = MI.getOperand(1).getImm();
1612 Reqs.getAndAddRequirements(SPIRV::OperandCategory::StorageClassOperand, SC,
1613 ST);
1614 // If it's a type of pointer to float16 targeting OpenCL, add Float16Buffer
1615 // capability.
1616 if (ST.isShader())
1617 break;
1618 assert(MI.getOperand(2).isReg());
1619 const MachineRegisterInfo &MRI = MI.getMF()->getRegInfo();
1620 SPIRVTypeInst TypeDef = MRI.getVRegDef(MI.getOperand(2).getReg());
1621 if ((TypeDef->getNumOperands() == 2) &&
1622 (TypeDef->getOpcode() == SPIRV::OpTypeFloat) &&
1623 (TypeDef->getOperand(1).getImm() == 16))
1624 Reqs.addCapability(SPIRV::Capability::Float16Buffer);
1625 break;
1626 }
1627 case SPIRV::OpExtInst: {
1628 if (MI.getOperand(2).getImm() ==
1629 static_cast<int64_t>(
1630 SPIRV::InstructionSet::NonSemantic_Shader_DebugInfo_100)) {
1631 Reqs.addExtension(SPIRV::Extension::SPV_KHR_non_semantic_info);
1632 break;
1633 }
1634 if (MI.getOperand(3).getImm() ==
1635 static_cast<int64_t>(SPIRV::OpenCLExtInst::printf)) {
1636 addPrintfRequirements(MI, Reqs, ST);
1637 break;
1638 }
1639 // TODO: handle bfloat16 extended instructions when
1640 // SPV_INTEL_bfloat16_arithmetic is enabled.
1641 break;
1642 }
1643 case SPIRV::OpAliasDomainDeclINTEL:
1644 case SPIRV::OpAliasScopeDeclINTEL:
1645 case SPIRV::OpAliasScopeListDeclINTEL: {
1646 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_memory_access_aliasing);
1647 Reqs.addCapability(SPIRV::Capability::MemoryAccessAliasingINTEL);
1648 break;
1649 }
1650 case SPIRV::OpBitReverse:
1651 case SPIRV::OpBitFieldInsert:
1652 case SPIRV::OpBitFieldSExtract:
1653 case SPIRV::OpBitFieldUExtract:
1654 if (!ST.canUseExtension(SPIRV::Extension::SPV_KHR_bit_instructions)) {
1655 Reqs.addCapability(SPIRV::Capability::Shader);
1656 break;
1657 }
1658 Reqs.addExtension(SPIRV::Extension::SPV_KHR_bit_instructions);
1659 Reqs.addCapability(SPIRV::Capability::BitInstructions);
1660 break;
1661 case SPIRV::OpTypeRuntimeArray:
1662 Reqs.addCapability(SPIRV::Capability::Shader);
1663 break;
1664 case SPIRV::OpTypeOpaque:
1665 case SPIRV::OpTypeEvent:
1666 Reqs.addCapability(SPIRV::Capability::Kernel);
1667 break;
1668 case SPIRV::OpTypePipe:
1669 case SPIRV::OpTypeReserveId:
1670 Reqs.addCapability(SPIRV::Capability::Pipes);
1671 break;
1672 case SPIRV::OpTypeDeviceEvent:
1673 case SPIRV::OpTypeQueue:
1674 case SPIRV::OpBuildNDRange:
1675 case SPIRV::OpEnqueueKernel:
1676 Reqs.addCapability(SPIRV::Capability::DeviceEnqueue);
1677 break;
1678 case SPIRV::OpDecorate:
1679 case SPIRV::OpDecorateId:
1680 case SPIRV::OpDecorateString:
1681 addOpDecorateReqs(MI, 1, Reqs, ST);
1682 break;
1683 case SPIRV::OpMemberDecorate:
1684 case SPIRV::OpMemberDecorateString:
1685 addOpDecorateReqs(MI, 2, Reqs, ST);
1686 break;
1687 case SPIRV::OpInBoundsPtrAccessChain:
1688 Reqs.addCapability(SPIRV::Capability::Addresses);
1689 break;
1690 case SPIRV::OpConstantSampler:
1691 Reqs.addCapability(SPIRV::Capability::LiteralSampler);
1692 break;
1693 case SPIRV::OpInBoundsAccessChain:
1694 case SPIRV::OpAccessChain:
1695 addOpAccessChainReqs(MI, Reqs, ST);
1696 break;
1697 case SPIRV::OpTypeImage:
1698 addOpTypeImageReqs(MI, Reqs, ST);
1699 break;
1700 case SPIRV::OpTypeSampler:
1701 if (!ST.isShader()) {
1702 Reqs.addCapability(SPIRV::Capability::ImageBasic);
1703 }
1704 break;
1705 case SPIRV::OpTypeForwardPointer:
1706 // TODO: check if it's OpenCL's kernel.
1707 Reqs.addCapability(SPIRV::Capability::Addresses);
1708 break;
1709 case SPIRV::OpAtomicFlagTestAndSet:
1710 case SPIRV::OpAtomicLoad:
1711 case SPIRV::OpAtomicStore:
1712 case SPIRV::OpAtomicExchange:
1713 case SPIRV::OpAtomicCompareExchange:
1714 case SPIRV::OpAtomicIIncrement:
1715 case SPIRV::OpAtomicIDecrement:
1716 case SPIRV::OpAtomicIAdd:
1717 case SPIRV::OpAtomicISub:
1718 case SPIRV::OpAtomicUMin:
1719 case SPIRV::OpAtomicUMax:
1720 case SPIRV::OpAtomicSMin:
1721 case SPIRV::OpAtomicSMax:
1722 case SPIRV::OpAtomicAnd:
1723 case SPIRV::OpAtomicOr:
1724 case SPIRV::OpAtomicXor: {
1725 const MachineRegisterInfo &MRI = MI.getMF()->getRegInfo();
1726 const MachineInstr *InstrPtr = &MI;
1727 if (Op == SPIRV::OpAtomicStore) {
1728 assert(MI.getOperand(3).isReg());
1729 InstrPtr = MRI.getVRegDef(MI.getOperand(3).getReg());
1730 assert(InstrPtr && "Unexpected type instruction for OpAtomicStore");
1731 }
1732 assert(InstrPtr->getOperand(1).isReg() && "Unexpected operand in atomic");
1733 Register TypeReg = InstrPtr->getOperand(1).getReg();
1734 SPIRVTypeInst TypeDef = MRI.getVRegDef(TypeReg);
1735
1736 if (TypeDef->getOpcode() == SPIRV::OpTypeInt) {
1737 unsigned BitWidth = TypeDef->getOperand(1).getImm();
1738 if (BitWidth == 64)
1739 Reqs.addCapability(SPIRV::Capability::Int64Atomics);
1740 else if (BitWidth == 16) {
1741 if (!ST.canUseExtension(SPIRV::Extension::SPV_INTEL_16bit_atomics))
1743 "16-bit integer atomic operations require the following SPIR-V "
1744 "extension: SPV_INTEL_16bit_atomics",
1745 false);
1746 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_16bit_atomics);
1747 switch (Op) {
1748 case SPIRV::OpAtomicLoad:
1749 case SPIRV::OpAtomicStore:
1750 case SPIRV::OpAtomicExchange:
1751 case SPIRV::OpAtomicCompareExchange:
1752 case SPIRV::OpAtomicCompareExchangeWeak:
1753 Reqs.addCapability(
1754 SPIRV::Capability::AtomicInt16CompareExchangeINTEL);
1755 break;
1756 default:
1757 Reqs.addCapability(SPIRV::Capability::Int16AtomicsINTEL);
1758 break;
1759 }
1760 }
1761 } else if (isBFloat16Type(TypeDef)) {
1762 if (is_contained({SPIRV::OpAtomicLoad, SPIRV::OpAtomicStore,
1763 SPIRV::OpAtomicExchange},
1764 Op)) {
1765 if (!ST.canUseExtension(SPIRV::Extension::SPV_INTEL_16bit_atomics))
1767 "The atomic bfloat16 instruction requires the following SPIR-V "
1768 "extension: SPV_INTEL_16bit_atomics",
1769 false);
1770 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_16bit_atomics);
1771 Reqs.addCapability(SPIRV::Capability::AtomicBFloat16LoadStoreINTEL);
1772 }
1773 }
1774 break;
1775 }
1776 case SPIRV::OpGroupNonUniformIAdd:
1777 case SPIRV::OpGroupNonUniformFAdd:
1778 case SPIRV::OpGroupNonUniformIMul:
1779 case SPIRV::OpGroupNonUniformFMul:
1780 case SPIRV::OpGroupNonUniformSMin:
1781 case SPIRV::OpGroupNonUniformUMin:
1782 case SPIRV::OpGroupNonUniformFMin:
1783 case SPIRV::OpGroupNonUniformSMax:
1784 case SPIRV::OpGroupNonUniformUMax:
1785 case SPIRV::OpGroupNonUniformFMax:
1786 case SPIRV::OpGroupNonUniformBitwiseAnd:
1787 case SPIRV::OpGroupNonUniformBitwiseOr:
1788 case SPIRV::OpGroupNonUniformBitwiseXor:
1789 case SPIRV::OpGroupNonUniformLogicalAnd:
1790 case SPIRV::OpGroupNonUniformLogicalOr:
1791 case SPIRV::OpGroupNonUniformLogicalXor: {
1792 assert(MI.getOperand(3).isImm());
1793 int64_t GroupOp = MI.getOperand(3).getImm();
1794 switch (GroupOp) {
1795 case SPIRV::GroupOperation::Reduce:
1796 case SPIRV::GroupOperation::InclusiveScan:
1797 case SPIRV::GroupOperation::ExclusiveScan:
1798 Reqs.addCapability(SPIRV::Capability::GroupNonUniformArithmetic);
1799 break;
1800 case SPIRV::GroupOperation::ClusteredReduce:
1801 Reqs.addCapability(SPIRV::Capability::GroupNonUniformClustered);
1802 break;
1803 case SPIRV::GroupOperation::PartitionedReduceNV:
1804 case SPIRV::GroupOperation::PartitionedInclusiveScanNV:
1805 case SPIRV::GroupOperation::PartitionedExclusiveScanNV:
1806 Reqs.addCapability(SPIRV::Capability::GroupNonUniformPartitionedNV);
1807 break;
1808 }
1809 break;
1810 }
1811 case SPIRV::OpGroupNonUniformQuadSwap:
1812 Reqs.addCapability(SPIRV::Capability::GroupNonUniformQuad);
1813 break;
1814 case SPIRV::OpImageQueryLod:
1815 Reqs.addCapability(SPIRV::Capability::ImageQuery);
1816 break;
1817 case SPIRV::OpImageQuerySize:
1818 case SPIRV::OpImageQuerySizeLod:
1819 case SPIRV::OpImageQueryLevels:
1820 case SPIRV::OpImageQuerySamples:
1821 if (ST.isShader())
1822 Reqs.addCapability(SPIRV::Capability::ImageQuery);
1823 break;
1824 case SPIRV::OpImageQueryFormat: {
1825 Register ResultReg = MI.getOperand(0).getReg();
1826 const MachineRegisterInfo &MRI = MI.getMF()->getRegInfo();
1827 static const unsigned CompareOps[] = {
1828 SPIRV::OpIEqual, SPIRV::OpINotEqual,
1829 SPIRV::OpUGreaterThan, SPIRV::OpUGreaterThanEqual,
1830 SPIRV::OpULessThan, SPIRV::OpULessThanEqual,
1831 SPIRV::OpSGreaterThan, SPIRV::OpSGreaterThanEqual,
1832 SPIRV::OpSLessThan, SPIRV::OpSLessThanEqual};
1833
1834 auto CheckAndAddExtension = [&](int64_t ImmVal) {
1835 if (ImmVal == 4323 || ImmVal == 4324) {
1836 if (ST.canUseExtension(SPIRV::Extension::SPV_EXT_image_raw10_raw12))
1837 Reqs.addExtension(SPIRV::Extension::SPV_EXT_image_raw10_raw12);
1838 else
1839 report_fatal_error("This requires the "
1840 "SPV_EXT_image_raw10_raw12 extension");
1841 }
1842 };
1843
1844 for (MachineInstr &UseInst : MRI.use_instructions(ResultReg)) {
1845 unsigned Opc = UseInst.getOpcode();
1846
1847 if (Opc == SPIRV::OpSwitch) {
1848 for (const MachineOperand &Op : UseInst.operands())
1849 if (Op.isImm())
1850 CheckAndAddExtension(Op.getImm());
1851 } else if (llvm::is_contained(CompareOps, Opc)) {
1852 for (unsigned i = 1; i < UseInst.getNumOperands(); ++i) {
1853 Register UseReg = UseInst.getOperand(i).getReg();
1854 MachineInstr *ConstInst = MRI.getVRegDef(UseReg);
1855 if (ConstInst && ConstInst->getOpcode() == SPIRV::OpConstantI) {
1856 int64_t ImmVal = ConstInst->getOperand(2).getImm();
1857 if (ImmVal)
1858 CheckAndAddExtension(ImmVal);
1859 }
1860 }
1861 }
1862 }
1863 break;
1864 }
1865
1866 case SPIRV::OpGroupNonUniformShuffle:
1867 case SPIRV::OpGroupNonUniformShuffleXor:
1868 Reqs.addCapability(SPIRV::Capability::GroupNonUniformShuffle);
1869 break;
1870 case SPIRV::OpGroupNonUniformShuffleUp:
1871 case SPIRV::OpGroupNonUniformShuffleDown:
1872 Reqs.addCapability(SPIRV::Capability::GroupNonUniformShuffleRelative);
1873 break;
1874 case SPIRV::OpGroupAll:
1875 case SPIRV::OpGroupAny:
1876 case SPIRV::OpGroupBroadcast:
1877 case SPIRV::OpGroupIAdd:
1878 case SPIRV::OpGroupFAdd:
1879 case SPIRV::OpGroupFMin:
1880 case SPIRV::OpGroupUMin:
1881 case SPIRV::OpGroupSMin:
1882 case SPIRV::OpGroupFMax:
1883 case SPIRV::OpGroupUMax:
1884 case SPIRV::OpGroupSMax:
1885 Reqs.addCapability(SPIRV::Capability::Groups);
1886 break;
1887 case SPIRV::OpGroupNonUniformElect:
1888 Reqs.addCapability(SPIRV::Capability::GroupNonUniform);
1889 break;
1890 case SPIRV::OpGroupNonUniformAll:
1891 case SPIRV::OpGroupNonUniformAny:
1892 case SPIRV::OpGroupNonUniformAllEqual:
1893 Reqs.addCapability(SPIRV::Capability::GroupNonUniformVote);
1894 break;
1895 case SPIRV::OpGroupNonUniformBroadcast:
1896 case SPIRV::OpGroupNonUniformBroadcastFirst:
1897 case SPIRV::OpGroupNonUniformBallot:
1898 case SPIRV::OpGroupNonUniformInverseBallot:
1899 case SPIRV::OpGroupNonUniformBallotBitExtract:
1900 case SPIRV::OpGroupNonUniformBallotBitCount:
1901 case SPIRV::OpGroupNonUniformBallotFindLSB:
1902 case SPIRV::OpGroupNonUniformBallotFindMSB:
1903 Reqs.addCapability(SPIRV::Capability::GroupNonUniformBallot);
1904 break;
1905 case SPIRV::OpSubgroupShuffleINTEL:
1906 case SPIRV::OpSubgroupShuffleDownINTEL:
1907 case SPIRV::OpSubgroupShuffleUpINTEL:
1908 case SPIRV::OpSubgroupShuffleXorINTEL:
1909 if (ST.canUseExtension(SPIRV::Extension::SPV_INTEL_subgroups)) {
1910 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_subgroups);
1911 Reqs.addCapability(SPIRV::Capability::SubgroupShuffleINTEL);
1912 }
1913 break;
1914 case SPIRV::OpSubgroupBlockReadINTEL:
1915 case SPIRV::OpSubgroupBlockWriteINTEL:
1916 if (ST.canUseExtension(SPIRV::Extension::SPV_INTEL_subgroups)) {
1917 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_subgroups);
1918 Reqs.addCapability(SPIRV::Capability::SubgroupBufferBlockIOINTEL);
1919 }
1920 break;
1921 case SPIRV::OpSubgroupImageBlockReadINTEL:
1922 case SPIRV::OpSubgroupImageBlockWriteINTEL:
1923 if (ST.canUseExtension(SPIRV::Extension::SPV_INTEL_subgroups)) {
1924 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_subgroups);
1925 Reqs.addCapability(SPIRV::Capability::SubgroupImageBlockIOINTEL);
1926 }
1927 break;
1928 case SPIRV::OpSubgroupImageMediaBlockReadINTEL:
1929 case SPIRV::OpSubgroupImageMediaBlockWriteINTEL:
1930 if (ST.canUseExtension(SPIRV::Extension::SPV_INTEL_media_block_io)) {
1931 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_media_block_io);
1932 Reqs.addCapability(SPIRV::Capability::SubgroupImageMediaBlockIOINTEL);
1933 }
1934 break;
1935 case SPIRV::OpAssumeTrueKHR:
1936 case SPIRV::OpExpectKHR:
1937 if (ST.canUseExtension(SPIRV::Extension::SPV_KHR_expect_assume)) {
1938 Reqs.addExtension(SPIRV::Extension::SPV_KHR_expect_assume);
1939 Reqs.addCapability(SPIRV::Capability::ExpectAssumeKHR);
1940 }
1941 break;
1942 case SPIRV::OpFmaKHR:
1943 if (ST.canUseExtension(SPIRV::Extension::SPV_KHR_fma)) {
1944 Reqs.addExtension(SPIRV::Extension::SPV_KHR_fma);
1945 Reqs.addCapability(SPIRV::Capability::FmaKHR);
1946 }
1947 break;
1948 case SPIRV::OpPtrCastToCrossWorkgroupINTEL:
1949 case SPIRV::OpCrossWorkgroupCastToPtrINTEL:
1950 if (ST.canUseExtension(SPIRV::Extension::SPV_INTEL_usm_storage_classes)) {
1951 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_usm_storage_classes);
1952 Reqs.addCapability(SPIRV::Capability::USMStorageClassesINTEL);
1953 }
1954 break;
1955 case SPIRV::OpConstantFunctionPointerINTEL:
1956 if (ST.canUseExtension(SPIRV::Extension::SPV_INTEL_function_pointers)) {
1957 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_function_pointers);
1958 Reqs.addCapability(SPIRV::Capability::FunctionPointersINTEL);
1959 }
1960 break;
1961 case SPIRV::OpGroupNonUniformRotateKHR:
1962 if (!ST.canUseExtension(SPIRV::Extension::SPV_KHR_subgroup_rotate))
1963 report_fatal_error("OpGroupNonUniformRotateKHR instruction requires the "
1964 "following SPIR-V extension: SPV_KHR_subgroup_rotate",
1965 false);
1966 Reqs.addExtension(SPIRV::Extension::SPV_KHR_subgroup_rotate);
1967 Reqs.addCapability(SPIRV::Capability::GroupNonUniformRotateKHR);
1968 Reqs.addCapability(SPIRV::Capability::GroupNonUniform);
1969 break;
1970 case SPIRV::OpFixedCosALTERA:
1971 case SPIRV::OpFixedSinALTERA:
1972 case SPIRV::OpFixedCosPiALTERA:
1973 case SPIRV::OpFixedSinPiALTERA:
1974 case SPIRV::OpFixedExpALTERA:
1975 case SPIRV::OpFixedLogALTERA:
1976 case SPIRV::OpFixedRecipALTERA:
1977 case SPIRV::OpFixedSqrtALTERA:
1978 case SPIRV::OpFixedSinCosALTERA:
1979 case SPIRV::OpFixedSinCosPiALTERA:
1980 case SPIRV::OpFixedRsqrtALTERA:
1981 if (!ST.canUseExtension(
1982 SPIRV::Extension::SPV_ALTERA_arbitrary_precision_fixed_point))
1983 report_fatal_error("This instruction requires the "
1984 "following SPIR-V extension: "
1985 "SPV_ALTERA_arbitrary_precision_fixed_point",
1986 false);
1987 Reqs.addExtension(
1988 SPIRV::Extension::SPV_ALTERA_arbitrary_precision_fixed_point);
1989 Reqs.addCapability(SPIRV::Capability::ArbitraryPrecisionFixedPointALTERA);
1990 break;
1991 case SPIRV::OpGroupIMulKHR:
1992 case SPIRV::OpGroupFMulKHR:
1993 case SPIRV::OpGroupBitwiseAndKHR:
1994 case SPIRV::OpGroupBitwiseOrKHR:
1995 case SPIRV::OpGroupBitwiseXorKHR:
1996 case SPIRV::OpGroupLogicalAndKHR:
1997 case SPIRV::OpGroupLogicalOrKHR:
1998 case SPIRV::OpGroupLogicalXorKHR:
1999 if (ST.canUseExtension(
2000 SPIRV::Extension::SPV_KHR_uniform_group_instructions)) {
2001 Reqs.addExtension(SPIRV::Extension::SPV_KHR_uniform_group_instructions);
2002 Reqs.addCapability(SPIRV::Capability::GroupUniformArithmeticKHR);
2003 }
2004 break;
2005 case SPIRV::OpReadClockKHR:
2006 if (!ST.canUseExtension(SPIRV::Extension::SPV_KHR_shader_clock))
2007 report_fatal_error("OpReadClockKHR instruction requires the "
2008 "following SPIR-V extension: SPV_KHR_shader_clock",
2009 false);
2010 Reqs.addExtension(SPIRV::Extension::SPV_KHR_shader_clock);
2011 Reqs.addCapability(SPIRV::Capability::ShaderClockKHR);
2012 break;
2013 case SPIRV::OpAbortKHR:
2014 if (!ST.canUseExtension(SPIRV::Extension::SPV_KHR_abort))
2015 report_fatal_error("OpAbortKHR instruction requires the "
2016 "following SPIR-V extension: SPV_KHR_abort",
2017 false);
2018 Reqs.addExtension(SPIRV::Extension::SPV_KHR_abort);
2019 Reqs.addCapability(SPIRV::Capability::AbortKHR);
2020 break;
2021 case SPIRV::OpPoisonKHR:
2022 case SPIRV::OpFreezeKHR:
2023 if (!ST.canUseExtension(SPIRV::Extension::SPV_KHR_poison_freeze))
2024 report_fatal_error("OpPoisonKHR/OpFreezeKHR instruction requires the "
2025 "following SPIR-V extension: SPV_KHR_poison_freeze",
2026 false);
2027 Reqs.addExtension(SPIRV::Extension::SPV_KHR_poison_freeze);
2028 Reqs.addCapability(SPIRV::Capability::PoisonFreezeKHR);
2029 break;
2030 case SPIRV::OpFunctionPointerCallINTEL:
2031 if (ST.canUseExtension(SPIRV::Extension::SPV_INTEL_function_pointers)) {
2032 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_function_pointers);
2033 Reqs.addCapability(SPIRV::Capability::FunctionPointersINTEL);
2034 }
2035 break;
2036 case SPIRV::OpAtomicFAddEXT:
2037 case SPIRV::OpAtomicFMinEXT:
2038 case SPIRV::OpAtomicFMaxEXT:
2039 AddAtomicFloatRequirements(MI, Reqs, ST);
2040 break;
2041 case SPIRV::OpConvertBF16ToFINTEL:
2042 case SPIRV::OpConvertFToBF16INTEL:
2043 if (ST.canUseExtension(SPIRV::Extension::SPV_INTEL_bfloat16_conversion)) {
2044 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_bfloat16_conversion);
2045 Reqs.addCapability(SPIRV::Capability::BFloat16ConversionINTEL);
2046 }
2047 break;
2048 case SPIRV::OpRoundFToTF32INTEL:
2049 if (ST.canUseExtension(
2050 SPIRV::Extension::SPV_INTEL_tensor_float32_conversion)) {
2051 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_tensor_float32_conversion);
2052 Reqs.addCapability(SPIRV::Capability::TensorFloat32RoundingINTEL);
2053 }
2054 break;
2055 case SPIRV::OpVariableLengthArrayINTEL:
2056 case SPIRV::OpSaveMemoryINTEL:
2057 case SPIRV::OpRestoreMemoryINTEL:
2058 if (ST.canUseExtension(SPIRV::Extension::SPV_INTEL_variable_length_array)) {
2059 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_variable_length_array);
2060 Reqs.addCapability(SPIRV::Capability::VariableLengthArrayINTEL);
2061 }
2062 break;
2063 case SPIRV::OpAsmTargetINTEL:
2064 case SPIRV::OpAsmINTEL:
2065 case SPIRV::OpAsmCallINTEL:
2066 if (ST.canUseExtension(SPIRV::Extension::SPV_INTEL_inline_assembly)) {
2067 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_inline_assembly);
2068 Reqs.addCapability(SPIRV::Capability::AsmINTEL);
2069 }
2070 break;
2071 case SPIRV::OpTypeCooperativeMatrixKHR: {
2072 if (!ST.canUseExtension(SPIRV::Extension::SPV_KHR_cooperative_matrix))
2074 "OpTypeCooperativeMatrixKHR type requires the "
2075 "following SPIR-V extension: SPV_KHR_cooperative_matrix",
2076 false);
2077 Reqs.addExtension(SPIRV::Extension::SPV_KHR_cooperative_matrix);
2078 Reqs.addCapability(SPIRV::Capability::CooperativeMatrixKHR);
2079 const MachineRegisterInfo &MRI = MI.getMF()->getRegInfo();
2080 SPIRVTypeInst TypeDef = MRI.getVRegDef(MI.getOperand(1).getReg());
2081 if (isBFloat16Type(TypeDef))
2082 Reqs.addCapability(SPIRV::Capability::BFloat16CooperativeMatrixKHR);
2083 break;
2084 }
2085 case SPIRV::OpArithmeticFenceEXT:
2086 if (!ST.canUseExtension(SPIRV::Extension::SPV_EXT_arithmetic_fence))
2087 report_fatal_error("OpArithmeticFenceEXT requires the "
2088 "following SPIR-V extension: SPV_EXT_arithmetic_fence",
2089 false);
2090 Reqs.addExtension(SPIRV::Extension::SPV_EXT_arithmetic_fence);
2091 Reqs.addCapability(SPIRV::Capability::ArithmeticFenceEXT);
2092 break;
2093 case SPIRV::OpControlBarrierArriveINTEL:
2094 case SPIRV::OpControlBarrierWaitINTEL:
2095 if (ST.canUseExtension(SPIRV::Extension::SPV_INTEL_split_barrier)) {
2096 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_split_barrier);
2097 Reqs.addCapability(SPIRV::Capability::SplitBarrierINTEL);
2098 }
2099 break;
2100 case SPIRV::OpCooperativeMatrixMulAddKHR: {
2101 if (!ST.canUseExtension(SPIRV::Extension::SPV_KHR_cooperative_matrix))
2102 report_fatal_error("Cooperative matrix instructions require the "
2103 "following SPIR-V extension: "
2104 "SPV_KHR_cooperative_matrix",
2105 false);
2106 Reqs.addExtension(SPIRV::Extension::SPV_KHR_cooperative_matrix);
2107 Reqs.addCapability(SPIRV::Capability::CooperativeMatrixKHR);
2108 constexpr unsigned MulAddMaxSize = 6;
2109 if (MI.getNumOperands() != MulAddMaxSize)
2110 break;
2111 const int64_t CoopOperands = MI.getOperand(MulAddMaxSize - 1).getImm();
2112 if (CoopOperands &
2113 SPIRV::CooperativeMatrixOperands::MatrixAAndBTF32ComponentsINTEL) {
2114 if (!ST.canUseExtension(SPIRV::Extension::SPV_INTEL_joint_matrix))
2115 report_fatal_error("MatrixAAndBTF32ComponentsINTEL type interpretation "
2116 "require the following SPIR-V extension: "
2117 "SPV_INTEL_joint_matrix",
2118 false);
2119 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_joint_matrix);
2120 Reqs.addCapability(
2121 SPIRV::Capability::CooperativeMatrixTF32ComponentTypeINTEL);
2122 }
2123 if (CoopOperands & SPIRV::CooperativeMatrixOperands::
2124 MatrixAAndBBFloat16ComponentsINTEL ||
2125 CoopOperands &
2126 SPIRV::CooperativeMatrixOperands::MatrixCBFloat16ComponentsINTEL ||
2127 CoopOperands & SPIRV::CooperativeMatrixOperands::
2128 MatrixResultBFloat16ComponentsINTEL) {
2129 if (!ST.canUseExtension(SPIRV::Extension::SPV_INTEL_joint_matrix))
2130 report_fatal_error("***BF16ComponentsINTEL type interpretations "
2131 "require the following SPIR-V extension: "
2132 "SPV_INTEL_joint_matrix",
2133 false);
2134 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_joint_matrix);
2135 Reqs.addCapability(
2136 SPIRV::Capability::CooperativeMatrixBFloat16ComponentTypeINTEL);
2137 }
2138 break;
2139 }
2140 case SPIRV::OpCooperativeMatrixLoadKHR:
2141 case SPIRV::OpCooperativeMatrixStoreKHR:
2142 case SPIRV::OpCooperativeMatrixLoadCheckedINTEL:
2143 case SPIRV::OpCooperativeMatrixStoreCheckedINTEL:
2144 case SPIRV::OpCooperativeMatrixPrefetchINTEL: {
2145 if (!ST.canUseExtension(SPIRV::Extension::SPV_KHR_cooperative_matrix))
2146 report_fatal_error("Cooperative matrix instructions require the "
2147 "following SPIR-V extension: "
2148 "SPV_KHR_cooperative_matrix",
2149 false);
2150 Reqs.addExtension(SPIRV::Extension::SPV_KHR_cooperative_matrix);
2151 Reqs.addCapability(SPIRV::Capability::CooperativeMatrixKHR);
2152
2153 // Check Layout operand in case if it's not a standard one and add the
2154 // appropriate capability.
2155 std::unordered_map<unsigned, unsigned> LayoutToInstMap = {
2156 {SPIRV::OpCooperativeMatrixLoadKHR, 3},
2157 {SPIRV::OpCooperativeMatrixStoreKHR, 2},
2158 {SPIRV::OpCooperativeMatrixLoadCheckedINTEL, 5},
2159 {SPIRV::OpCooperativeMatrixStoreCheckedINTEL, 4},
2160 {SPIRV::OpCooperativeMatrixPrefetchINTEL, 4}};
2161
2162 const unsigned LayoutNum = LayoutToInstMap[Op];
2163 Register RegLayout = MI.getOperand(LayoutNum).getReg();
2164 const MachineRegisterInfo &MRI = MI.getMF()->getRegInfo();
2165 MachineInstr *MILayout = MRI.getUniqueVRegDef(RegLayout);
2166 if (MILayout->getOpcode() == SPIRV::OpConstantI) {
2167 const unsigned LayoutVal = MILayout->getOperand(2).getImm();
2168 if (LayoutVal ==
2169 static_cast<unsigned>(SPIRV::CooperativeMatrixLayout::PackedINTEL)) {
2170 if (!ST.canUseExtension(SPIRV::Extension::SPV_INTEL_joint_matrix))
2171 report_fatal_error("PackedINTEL layout require the following SPIR-V "
2172 "extension: SPV_INTEL_joint_matrix",
2173 false);
2174 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_joint_matrix);
2175 Reqs.addCapability(SPIRV::Capability::PackedCooperativeMatrixINTEL);
2176 }
2177 }
2178
2179 // Nothing to do.
2180 if (Op == SPIRV::OpCooperativeMatrixLoadKHR ||
2181 Op == SPIRV::OpCooperativeMatrixStoreKHR)
2182 break;
2183
2184 std::string InstName;
2185 switch (Op) {
2186 case SPIRV::OpCooperativeMatrixPrefetchINTEL:
2187 InstName = "OpCooperativeMatrixPrefetchINTEL";
2188 break;
2189 case SPIRV::OpCooperativeMatrixLoadCheckedINTEL:
2190 InstName = "OpCooperativeMatrixLoadCheckedINTEL";
2191 break;
2192 case SPIRV::OpCooperativeMatrixStoreCheckedINTEL:
2193 InstName = "OpCooperativeMatrixStoreCheckedINTEL";
2194 break;
2195 }
2196
2197 if (!ST.canUseExtension(SPIRV::Extension::SPV_INTEL_joint_matrix)) {
2198 const std::string ErrorMsg =
2199 InstName + " instruction requires the "
2200 "following SPIR-V extension: SPV_INTEL_joint_matrix";
2201 report_fatal_error(ErrorMsg.c_str(), false);
2202 }
2203 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_joint_matrix);
2204 if (Op == SPIRV::OpCooperativeMatrixPrefetchINTEL) {
2205 Reqs.addCapability(SPIRV::Capability::CooperativeMatrixPrefetchINTEL);
2206 break;
2207 }
2208 Reqs.addCapability(
2209 SPIRV::Capability::CooperativeMatrixCheckedInstructionsINTEL);
2210 break;
2211 }
2212 case SPIRV::OpCooperativeMatrixConstructCheckedINTEL:
2213 if (!ST.canUseExtension(SPIRV::Extension::SPV_INTEL_joint_matrix))
2214 report_fatal_error("OpCooperativeMatrixConstructCheckedINTEL "
2215 "instructions require the following SPIR-V extension: "
2216 "SPV_INTEL_joint_matrix",
2217 false);
2218 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_joint_matrix);
2219 Reqs.addCapability(
2220 SPIRV::Capability::CooperativeMatrixCheckedInstructionsINTEL);
2221 break;
2222 case SPIRV::OpReadPipeBlockingALTERA:
2223 case SPIRV::OpWritePipeBlockingALTERA:
2224 if (ST.canUseExtension(SPIRV::Extension::SPV_ALTERA_blocking_pipes)) {
2225 Reqs.addExtension(SPIRV::Extension::SPV_ALTERA_blocking_pipes);
2226 Reqs.addCapability(SPIRV::Capability::BlockingPipesALTERA);
2227 }
2228 break;
2229 case SPIRV::OpCooperativeMatrixGetElementCoordINTEL:
2230 if (!ST.canUseExtension(SPIRV::Extension::SPV_INTEL_joint_matrix))
2231 report_fatal_error("OpCooperativeMatrixGetElementCoordINTEL requires the "
2232 "following SPIR-V extension: SPV_INTEL_joint_matrix",
2233 false);
2234 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_joint_matrix);
2235 Reqs.addCapability(
2236 SPIRV::Capability::CooperativeMatrixInvocationInstructionsINTEL);
2237 break;
2238 case SPIRV::OpConvertHandleToImageINTEL:
2239 case SPIRV::OpConvertHandleToSamplerINTEL:
2240 case SPIRV::OpConvertHandleToSampledImageINTEL: {
2241 if (!ST.canUseExtension(SPIRV::Extension::SPV_INTEL_bindless_images))
2242 report_fatal_error("OpConvertHandleTo[Image/Sampler/SampledImage]INTEL "
2243 "instructions require the following SPIR-V extension: "
2244 "SPV_INTEL_bindless_images",
2245 false);
2246 SPIRVGlobalRegistry *GR = ST.getSPIRVGlobalRegistry();
2247 SPIRV::AddressingModel::AddressingModel AddrModel = MAI.Addr;
2248 SPIRVTypeInst TyDef = GR->getSPIRVTypeForVReg(MI.getOperand(1).getReg());
2249 if (Op == SPIRV::OpConvertHandleToImageINTEL &&
2250 TyDef->getOpcode() != SPIRV::OpTypeImage) {
2251 report_fatal_error("Incorrect return type for the instruction "
2252 "OpConvertHandleToImageINTEL",
2253 false);
2254 } else if (Op == SPIRV::OpConvertHandleToSamplerINTEL &&
2255 TyDef->getOpcode() != SPIRV::OpTypeSampler) {
2256 report_fatal_error("Incorrect return type for the instruction "
2257 "OpConvertHandleToSamplerINTEL",
2258 false);
2259 } else if (Op == SPIRV::OpConvertHandleToSampledImageINTEL &&
2260 TyDef->getOpcode() != SPIRV::OpTypeSampledImage) {
2261 report_fatal_error("Incorrect return type for the instruction "
2262 "OpConvertHandleToSampledImageINTEL",
2263 false);
2264 }
2265 SPIRVTypeInst SpvTy = GR->getSPIRVTypeForVReg(MI.getOperand(2).getReg());
2266 unsigned Bitwidth = GR->getScalarOrVectorBitWidth(SpvTy);
2267 if (!(Bitwidth == 32 && AddrModel == SPIRV::AddressingModel::Physical32) &&
2268 !(Bitwidth == 64 && AddrModel == SPIRV::AddressingModel::Physical64)) {
2270 "Parameter value must be a 32-bit scalar in case of "
2271 "Physical32 addressing model or a 64-bit scalar in case of "
2272 "Physical64 addressing model",
2273 false);
2274 }
2275 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_bindless_images);
2276 Reqs.addCapability(SPIRV::Capability::BindlessImagesINTEL);
2277 break;
2278 }
2279 case SPIRV::OpSubgroup2DBlockLoadINTEL:
2280 case SPIRV::OpSubgroup2DBlockLoadTransposeINTEL:
2281 case SPIRV::OpSubgroup2DBlockLoadTransformINTEL:
2282 case SPIRV::OpSubgroup2DBlockPrefetchINTEL:
2283 case SPIRV::OpSubgroup2DBlockStoreINTEL: {
2284 if (!ST.canUseExtension(SPIRV::Extension::SPV_INTEL_2d_block_io))
2285 report_fatal_error("OpSubgroup2DBlock[Load/LoadTranspose/LoadTransform/"
2286 "Prefetch/Store]INTEL instructions require the "
2287 "following SPIR-V extension: SPV_INTEL_2d_block_io",
2288 false);
2289 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_2d_block_io);
2290 Reqs.addCapability(SPIRV::Capability::Subgroup2DBlockIOINTEL);
2291
2292 if (Op == SPIRV::OpSubgroup2DBlockLoadTransposeINTEL) {
2293 Reqs.addCapability(SPIRV::Capability::Subgroup2DBlockTransposeINTEL);
2294 break;
2295 }
2296 if (Op == SPIRV::OpSubgroup2DBlockLoadTransformINTEL) {
2297 Reqs.addCapability(SPIRV::Capability::Subgroup2DBlockTransformINTEL);
2298 break;
2299 }
2300 break;
2301 }
2302 case SPIRV::OpKill: {
2303 Reqs.addCapability(SPIRV::Capability::Shader);
2304 } break;
2305 case SPIRV::OpDemoteToHelperInvocation:
2306 Reqs.addCapability(SPIRV::Capability::DemoteToHelperInvocation);
2307
2308 if (ST.canUseExtension(
2309 SPIRV::Extension::SPV_EXT_demote_to_helper_invocation)) {
2310 if (!ST.isAtLeastSPIRVVer(llvm::VersionTuple(1, 6)))
2311 Reqs.addExtension(
2312 SPIRV::Extension::SPV_EXT_demote_to_helper_invocation);
2313 }
2314 break;
2315 case SPIRV::OpSDot:
2316 case SPIRV::OpUDot:
2317 case SPIRV::OpSUDot:
2318 case SPIRV::OpSDotAccSat:
2319 case SPIRV::OpUDotAccSat:
2320 case SPIRV::OpSUDotAccSat:
2321 AddDotProductRequirements(MI, Reqs, ST);
2322 break;
2323 case SPIRV::OpImageSampleImplicitLod:
2324 Reqs.addCapability(SPIRV::Capability::Shader);
2325 addImageOperandReqs(MI, Reqs, ST, 4);
2326 break;
2327 case SPIRV::OpImageSampleExplicitLod:
2328 addImageOperandReqs(MI, Reqs, ST, 4);
2329 break;
2330 case SPIRV::OpImageSampleDrefImplicitLod:
2331 Reqs.addCapability(SPIRV::Capability::Shader);
2332 addImageOperandReqs(MI, Reqs, ST, 5);
2333 break;
2334 case SPIRV::OpImageSampleDrefExplicitLod:
2335 Reqs.addCapability(SPIRV::Capability::Shader);
2336 addImageOperandReqs(MI, Reqs, ST, 5);
2337 break;
2338 case SPIRV::OpImageFetch:
2339 Reqs.addCapability(SPIRV::Capability::Shader);
2340 addImageOperandReqs(MI, Reqs, ST, 4);
2341 break;
2342 case SPIRV::OpImageDrefGather:
2343 case SPIRV::OpImageGather:
2344 Reqs.addCapability(SPIRV::Capability::Shader);
2345 addImageOperandReqs(MI, Reqs, ST, 5);
2346 break;
2347 case SPIRV::OpImageRead: {
2348 Register ImageReg = MI.getOperand(2).getReg();
2349 SPIRVTypeInst TypeDef = ST.getSPIRVGlobalRegistry()->getResultType(
2350 ImageReg, const_cast<MachineFunction *>(MI.getMF()));
2351 // OpImageRead and OpImageWrite can use Unknown Image Formats
2352 // when the Kernel capability is declared. In the OpenCL environment we are
2353 // not allowed to produce
2354 // StorageImageReadWithoutFormat/StorageImageWriteWithoutFormat, see
2355 // https://github.com/KhronosGroup/SPIRV-Headers/issues/487
2356
2357 if (isImageTypeWithUnknownFormat(TypeDef) && ST.isShader())
2358 Reqs.addCapability(SPIRV::Capability::StorageImageReadWithoutFormat);
2359 break;
2360 }
2361 case SPIRV::OpImageWrite: {
2362 Register ImageReg = MI.getOperand(0).getReg();
2363 SPIRVTypeInst TypeDef = ST.getSPIRVGlobalRegistry()->getResultType(
2364 ImageReg, const_cast<MachineFunction *>(MI.getMF()));
2365 // OpImageRead and OpImageWrite can use Unknown Image Formats
2366 // when the Kernel capability is declared. In the OpenCL environment we are
2367 // not allowed to produce
2368 // StorageImageReadWithoutFormat/StorageImageWriteWithoutFormat, see
2369 // https://github.com/KhronosGroup/SPIRV-Headers/issues/487
2370
2371 if (isImageTypeWithUnknownFormat(TypeDef) && ST.isShader())
2372 Reqs.addCapability(SPIRV::Capability::StorageImageWriteWithoutFormat);
2373 break;
2374 }
2375 case SPIRV::OpTypeStructContinuedINTEL:
2376 case SPIRV::OpConstantCompositeContinuedINTEL:
2377 case SPIRV::OpSpecConstantCompositeContinuedINTEL:
2378 case SPIRV::OpCompositeConstructContinuedINTEL: {
2379 if (!ST.canUseExtension(SPIRV::Extension::SPV_INTEL_long_composites))
2381 "Continued instructions require the "
2382 "following SPIR-V extension: SPV_INTEL_long_composites",
2383 false);
2384 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_long_composites);
2385 Reqs.addCapability(SPIRV::Capability::LongCompositesINTEL);
2386 break;
2387 }
2388 case SPIRV::OpArbitraryFloatEQALTERA:
2389 case SPIRV::OpArbitraryFloatGEALTERA:
2390 case SPIRV::OpArbitraryFloatGTALTERA:
2391 case SPIRV::OpArbitraryFloatLEALTERA:
2392 case SPIRV::OpArbitraryFloatLTALTERA:
2393 case SPIRV::OpArbitraryFloatCbrtALTERA:
2394 case SPIRV::OpArbitraryFloatCosALTERA:
2395 case SPIRV::OpArbitraryFloatCosPiALTERA:
2396 case SPIRV::OpArbitraryFloatExp10ALTERA:
2397 case SPIRV::OpArbitraryFloatExp2ALTERA:
2398 case SPIRV::OpArbitraryFloatExpALTERA:
2399 case SPIRV::OpArbitraryFloatExpm1ALTERA:
2400 case SPIRV::OpArbitraryFloatHypotALTERA:
2401 case SPIRV::OpArbitraryFloatLog10ALTERA:
2402 case SPIRV::OpArbitraryFloatLog1pALTERA:
2403 case SPIRV::OpArbitraryFloatLog2ALTERA:
2404 case SPIRV::OpArbitraryFloatLogALTERA:
2405 case SPIRV::OpArbitraryFloatRecipALTERA:
2406 case SPIRV::OpArbitraryFloatSinCosALTERA:
2407 case SPIRV::OpArbitraryFloatSinCosPiALTERA:
2408 case SPIRV::OpArbitraryFloatSinALTERA:
2409 case SPIRV::OpArbitraryFloatSinPiALTERA:
2410 case SPIRV::OpArbitraryFloatSqrtALTERA:
2411 case SPIRV::OpArbitraryFloatACosALTERA:
2412 case SPIRV::OpArbitraryFloatACosPiALTERA:
2413 case SPIRV::OpArbitraryFloatAddALTERA:
2414 case SPIRV::OpArbitraryFloatASinALTERA:
2415 case SPIRV::OpArbitraryFloatASinPiALTERA:
2416 case SPIRV::OpArbitraryFloatATan2ALTERA:
2417 case SPIRV::OpArbitraryFloatATanALTERA:
2418 case SPIRV::OpArbitraryFloatATanPiALTERA:
2419 case SPIRV::OpArbitraryFloatCastFromIntALTERA:
2420 case SPIRV::OpArbitraryFloatCastALTERA:
2421 case SPIRV::OpArbitraryFloatCastToIntALTERA:
2422 case SPIRV::OpArbitraryFloatDivALTERA:
2423 case SPIRV::OpArbitraryFloatMulALTERA:
2424 case SPIRV::OpArbitraryFloatPowALTERA:
2425 case SPIRV::OpArbitraryFloatPowNALTERA:
2426 case SPIRV::OpArbitraryFloatPowRALTERA:
2427 case SPIRV::OpArbitraryFloatRSqrtALTERA:
2428 case SPIRV::OpArbitraryFloatSubALTERA: {
2429 if (!ST.canUseExtension(
2430 SPIRV::Extension::SPV_ALTERA_arbitrary_precision_floating_point))
2432 "Floating point instructions can't be translated correctly without "
2433 "enabled SPV_ALTERA_arbitrary_precision_floating_point extension!",
2434 false);
2435 Reqs.addExtension(
2436 SPIRV::Extension::SPV_ALTERA_arbitrary_precision_floating_point);
2437 Reqs.addCapability(
2438 SPIRV::Capability::ArbitraryPrecisionFloatingPointALTERA);
2439 break;
2440 }
2441 case SPIRV::OpSubgroupMatrixMultiplyAccumulateINTEL: {
2442 if (!ST.canUseExtension(
2443 SPIRV::Extension::SPV_INTEL_subgroup_matrix_multiply_accumulate))
2445 "OpSubgroupMatrixMultiplyAccumulateINTEL instruction requires the "
2446 "following SPIR-V "
2447 "extension: SPV_INTEL_subgroup_matrix_multiply_accumulate",
2448 false);
2449 Reqs.addExtension(
2450 SPIRV::Extension::SPV_INTEL_subgroup_matrix_multiply_accumulate);
2451 Reqs.addCapability(
2452 SPIRV::Capability::SubgroupMatrixMultiplyAccumulateINTEL);
2453 break;
2454 }
2455 case SPIRV::OpBitwiseFunctionINTEL: {
2456 if (!ST.canUseExtension(
2457 SPIRV::Extension::SPV_INTEL_ternary_bitwise_function))
2459 "OpBitwiseFunctionINTEL instruction requires the following SPIR-V "
2460 "extension: SPV_INTEL_ternary_bitwise_function",
2461 false);
2462 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_ternary_bitwise_function);
2463 Reqs.addCapability(SPIRV::Capability::TernaryBitwiseFunctionINTEL);
2464 break;
2465 }
2466 case SPIRV::OpCopyMemorySized: {
2467 Reqs.addCapability(SPIRV::Capability::Addresses);
2468 // TODO: Add UntypedPointersKHR when implemented.
2469 break;
2470 }
2471 case SPIRV::OpPredicatedLoadINTEL:
2472 case SPIRV::OpPredicatedStoreINTEL: {
2473 if (!ST.canUseExtension(SPIRV::Extension::SPV_INTEL_predicated_io))
2475 "OpPredicated[Load/Store]INTEL instructions require "
2476 "the following SPIR-V extension: SPV_INTEL_predicated_io",
2477 false);
2478 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_predicated_io);
2479 Reqs.addCapability(SPIRV::Capability::PredicatedIOINTEL);
2480 break;
2481 }
2482 case SPIRV::OpFAddS:
2483 case SPIRV::OpFSubS:
2484 case SPIRV::OpFMulS:
2485 case SPIRV::OpFDivS:
2486 case SPIRV::OpFRemS:
2487 case SPIRV::OpFMod:
2488 case SPIRV::OpFNegate:
2489 case SPIRV::OpFAddV:
2490 case SPIRV::OpFSubV:
2491 case SPIRV::OpFMulV:
2492 case SPIRV::OpFDivV:
2493 case SPIRV::OpFRemV:
2494 case SPIRV::OpFNegateV: {
2495 const MachineRegisterInfo &MRI = MI.getMF()->getRegInfo();
2496 SPIRVTypeInst TypeDef = MRI.getVRegDef(MI.getOperand(1).getReg());
2497 if (TypeDef->getOpcode() == SPIRV::OpTypeVector)
2498 TypeDef = MRI.getVRegDef(TypeDef->getOperand(1).getReg());
2499 if (isBFloat16Type(TypeDef)) {
2500 if (!ST.canUseExtension(SPIRV::Extension::SPV_INTEL_bfloat16_arithmetic))
2502 "Arithmetic instructions with bfloat16 arguments require the "
2503 "following SPIR-V extension: SPV_INTEL_bfloat16_arithmetic",
2504 false);
2505 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_bfloat16_arithmetic);
2506 Reqs.addCapability(SPIRV::Capability::BFloat16ArithmeticINTEL);
2507 }
2508 break;
2509 }
2510 case SPIRV::OpOrdered:
2511 case SPIRV::OpUnordered:
2512 case SPIRV::OpFOrdEqual:
2513 case SPIRV::OpFOrdNotEqual:
2514 case SPIRV::OpFOrdLessThan:
2515 case SPIRV::OpFOrdLessThanEqual:
2516 case SPIRV::OpFOrdGreaterThan:
2517 case SPIRV::OpFOrdGreaterThanEqual:
2518 case SPIRV::OpFUnordEqual:
2519 case SPIRV::OpFUnordNotEqual:
2520 case SPIRV::OpFUnordLessThan:
2521 case SPIRV::OpFUnordLessThanEqual:
2522 case SPIRV::OpFUnordGreaterThan:
2523 case SPIRV::OpFUnordGreaterThanEqual: {
2524 const MachineRegisterInfo &MRI = MI.getMF()->getRegInfo();
2525 MachineInstr *OperandDef = MRI.getVRegDef(MI.getOperand(2).getReg());
2526 SPIRVTypeInst TypeDef = MRI.getVRegDef(OperandDef->getOperand(1).getReg());
2527 if (TypeDef->getOpcode() == SPIRV::OpTypeVector)
2528 TypeDef = MRI.getVRegDef(TypeDef->getOperand(1).getReg());
2529 if (isBFloat16Type(TypeDef)) {
2530 if (!ST.canUseExtension(SPIRV::Extension::SPV_INTEL_bfloat16_arithmetic))
2532 "Relational instructions with bfloat16 arguments require the "
2533 "following SPIR-V extension: SPV_INTEL_bfloat16_arithmetic",
2534 false);
2535 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_bfloat16_arithmetic);
2536 Reqs.addCapability(SPIRV::Capability::BFloat16ArithmeticINTEL);
2537 }
2538 break;
2539 }
2540 case SPIRV::OpDPdxCoarse:
2541 case SPIRV::OpDPdyCoarse:
2542 case SPIRV::OpDPdxFine:
2543 case SPIRV::OpDPdyFine: {
2544 Reqs.addCapability(SPIRV::Capability::DerivativeControl);
2545 break;
2546 }
2547 case SPIRV::OpLoopControlINTEL: {
2548 Reqs.addExtension(SPIRV::Extension::SPV_INTEL_unstructured_loop_controls);
2549 Reqs.addCapability(SPIRV::Capability::UnstructuredLoopControlsINTEL);
2550 break;
2551 }
2552
2553 default:
2554 break;
2555 }
2556
2557 // If we require capability Shader, then we can remove the requirement for
2558 // the BitInstructions capability, since Shader is a superset capability
2559 // of BitInstructions.
2560 Reqs.removeCapabilityIf(SPIRV::Capability::BitInstructions,
2561 SPIRV::Capability::Shader);
2562}
2563
2564static void collectReqs(const Module &M, SPIRV::ModuleAnalysisInfo &MAI,
2565 MachineModuleInfo *MMI, const SPIRVSubtarget &ST) {
2566 // Collect requirements for existing instructions.
2567 for (const Function &F : M) {
2569 if (!MF)
2570 continue;
2571 for (const MachineBasicBlock &MBB : *MF)
2572 for (const MachineInstr &MI : MBB)
2573 addInstrRequirements(MI, MAI, ST);
2574 }
2575 // Collect requirements for OpExecutionMode instructions.
2576 auto Node = M.getNamedMetadata("spirv.ExecutionMode");
2577 if (Node) {
2578 bool RequireFloatControls = false, RequireIntelFloatControls2 = false,
2579 RequireKHRFloatControls2 = false,
2580 VerLower14 = !ST.isAtLeastSPIRVVer(VersionTuple(1, 4));
2581 bool HasIntelFloatControls2 =
2582 ST.canUseExtension(SPIRV::Extension::SPV_INTEL_float_controls2);
2583 bool HasKHRFloatControls2 =
2584 ST.canUseExtension(SPIRV::Extension::SPV_KHR_float_controls2);
2585 for (unsigned i = 0; i < Node->getNumOperands(); i++) {
2586 MDNode *MDN = cast<MDNode>(Node->getOperand(i));
2587 const MDOperand &MDOp = MDN->getOperand(1);
2588 if (auto *CMeta = dyn_cast<ConstantAsMetadata>(MDOp)) {
2589 Constant *C = CMeta->getValue();
2590 if (ConstantInt *Const = dyn_cast<ConstantInt>(C)) {
2591 auto EM = Const->getZExtValue();
2592 // SPV_KHR_float_controls is not available until v1.4:
2593 // add SPV_KHR_float_controls if the version is too low
2594 switch (EM) {
2595 case SPIRV::ExecutionMode::DenormPreserve:
2596 case SPIRV::ExecutionMode::DenormFlushToZero:
2597 case SPIRV::ExecutionMode::RoundingModeRTE:
2598 case SPIRV::ExecutionMode::RoundingModeRTZ:
2599 RequireFloatControls = VerLower14;
2601 SPIRV::OperandCategory::ExecutionModeOperand, EM, ST);
2602 break;
2603 case SPIRV::ExecutionMode::RoundingModeRTPINTEL:
2604 case SPIRV::ExecutionMode::RoundingModeRTNINTEL:
2605 case SPIRV::ExecutionMode::FloatingPointModeALTINTEL:
2606 case SPIRV::ExecutionMode::FloatingPointModeIEEEINTEL:
2607 if (HasIntelFloatControls2) {
2608 RequireIntelFloatControls2 = true;
2610 SPIRV::OperandCategory::ExecutionModeOperand, EM, ST);
2611 }
2612 break;
2613 case SPIRV::ExecutionMode::FPFastMathDefault: {
2614 if (HasKHRFloatControls2) {
2615 RequireKHRFloatControls2 = true;
2617 SPIRV::OperandCategory::ExecutionModeOperand, EM, ST);
2618 }
2619 break;
2620 }
2621 case SPIRV::ExecutionMode::ContractionOff:
2622 case SPIRV::ExecutionMode::SignedZeroInfNanPreserve:
2623 if (HasKHRFloatControls2) {
2624 RequireKHRFloatControls2 = true;
2626 SPIRV::OperandCategory::ExecutionModeOperand,
2627 SPIRV::ExecutionMode::FPFastMathDefault, ST);
2628 } else {
2630 SPIRV::OperandCategory::ExecutionModeOperand, EM, ST);
2631 }
2632 break;
2633 default:
2635 SPIRV::OperandCategory::ExecutionModeOperand, EM, ST);
2636 }
2637 }
2638 }
2639 }
2640 if (RequireFloatControls &&
2641 ST.canUseExtension(SPIRV::Extension::SPV_KHR_float_controls))
2642 MAI.Reqs.addExtension(SPIRV::Extension::SPV_KHR_float_controls);
2643 if (RequireIntelFloatControls2)
2644 MAI.Reqs.addExtension(SPIRV::Extension::SPV_INTEL_float_controls2);
2645 if (RequireKHRFloatControls2)
2646 MAI.Reqs.addExtension(SPIRV::Extension::SPV_KHR_float_controls2);
2647 }
2648 for (const Function &F : M) {
2649 if (F.isDeclaration())
2650 continue;
2651 if (F.getMetadata("reqd_work_group_size"))
2653 SPIRV::OperandCategory::ExecutionModeOperand,
2654 SPIRV::ExecutionMode::LocalSize, ST);
2655 if (F.getFnAttribute("hlsl.numthreads").isValid()) {
2657 SPIRV::OperandCategory::ExecutionModeOperand,
2658 SPIRV::ExecutionMode::LocalSize, ST);
2659 }
2660 if (F.getFnAttribute("enable-maximal-reconvergence").getValueAsBool()) {
2661 MAI.Reqs.addExtension(SPIRV::Extension::SPV_KHR_maximal_reconvergence);
2662 }
2663 if (F.getMetadata("work_group_size_hint"))
2665 SPIRV::OperandCategory::ExecutionModeOperand,
2666 SPIRV::ExecutionMode::LocalSizeHint, ST);
2667 if (F.getMetadata("intel_reqd_sub_group_size") ||
2668 F.getMetadata("reqd_sub_group_size"))
2670 SPIRV::OperandCategory::ExecutionModeOperand,
2671 SPIRV::ExecutionMode::SubgroupSize, ST);
2672 if (F.getMetadata("max_work_group_size"))
2674 SPIRV::OperandCategory::ExecutionModeOperand,
2675 SPIRV::ExecutionMode::MaxWorkgroupSizeINTEL, ST);
2676 if (F.getMetadata("vec_type_hint"))
2678 SPIRV::OperandCategory::ExecutionModeOperand,
2679 SPIRV::ExecutionMode::VecTypeHint, ST);
2680
2681 if (F.hasOptNone()) {
2682 if (ST.canUseExtension(SPIRV::Extension::SPV_INTEL_optnone)) {
2683 MAI.Reqs.addExtension(SPIRV::Extension::SPV_INTEL_optnone);
2684 MAI.Reqs.addCapability(SPIRV::Capability::OptNoneINTEL);
2685 } else if (ST.canUseExtension(SPIRV::Extension::SPV_EXT_optnone)) {
2686 MAI.Reqs.addExtension(SPIRV::Extension::SPV_EXT_optnone);
2687 MAI.Reqs.addCapability(SPIRV::Capability::OptNoneEXT);
2688 }
2689 }
2690 }
2691}
2692
2693static unsigned getFastMathFlags(const MachineInstr &I,
2694 const SPIRVSubtarget &ST) {
2695 unsigned Flags = SPIRV::FPFastMathMode::None;
2696 bool CanUseKHRFloatControls2 =
2697 ST.canUseExtension(SPIRV::Extension::SPV_KHR_float_controls2);
2698 if (I.getFlag(MachineInstr::MIFlag::FmNoNans))
2699 Flags |= SPIRV::FPFastMathMode::NotNaN;
2700 if (I.getFlag(MachineInstr::MIFlag::FmNoInfs))
2701 Flags |= SPIRV::FPFastMathMode::NotInf;
2702 if (I.getFlag(MachineInstr::MIFlag::FmNsz))
2703 Flags |= SPIRV::FPFastMathMode::NSZ;
2704 if (I.getFlag(MachineInstr::MIFlag::FmArcp))
2705 Flags |= SPIRV::FPFastMathMode::AllowRecip;
2706 if (I.getFlag(MachineInstr::MIFlag::FmContract) && CanUseKHRFloatControls2)
2707 Flags |= SPIRV::FPFastMathMode::AllowContract;
2708 if (I.getFlag(MachineInstr::MIFlag::FmReassoc)) {
2709 if (CanUseKHRFloatControls2)
2710 // LLVM reassoc maps to SPIRV transform, see
2711 // https://github.com/KhronosGroup/SPIRV-Registry/issues/326 for details.
2712 // Because we are enabling AllowTransform, we must enable AllowReassoc and
2713 // AllowContract too, as required by SPIRV spec. Also, we used to map
2714 // MIFlag::FmReassoc to FPFastMathMode::Fast, which now should instead by
2715 // replaced by turning all the other bits instead. Therefore, we're
2716 // enabling every bit here except None and Fast.
2717 Flags |= SPIRV::FPFastMathMode::NotNaN | SPIRV::FPFastMathMode::NotInf |
2718 SPIRV::FPFastMathMode::NSZ | SPIRV::FPFastMathMode::AllowRecip |
2719 SPIRV::FPFastMathMode::AllowTransform |
2720 SPIRV::FPFastMathMode::AllowReassoc |
2721 SPIRV::FPFastMathMode::AllowContract;
2722 else
2723 Flags |= SPIRV::FPFastMathMode::Fast;
2724 }
2725
2726 if (CanUseKHRFloatControls2) {
2727 // Error out if SPIRV::FPFastMathMode::Fast is enabled.
2728 assert(!(Flags & SPIRV::FPFastMathMode::Fast) &&
2729 "SPIRV::FPFastMathMode::Fast is deprecated and should not be used "
2730 "anymore.");
2731
2732 // Error out if AllowTransform is enabled without AllowReassoc and
2733 // AllowContract.
2734 assert((!(Flags & SPIRV::FPFastMathMode::AllowTransform) ||
2735 ((Flags & SPIRV::FPFastMathMode::AllowReassoc &&
2736 Flags & SPIRV::FPFastMathMode::AllowContract))) &&
2737 "SPIRV::FPFastMathMode::AllowTransform requires AllowReassoc and "
2738 "AllowContract flags to be enabled as well.");
2739 }
2740
2741 return Flags;
2742}
2743
2744static bool isFastMathModeAvailable(const SPIRVSubtarget &ST) {
2745 if (ST.isKernel())
2746 return true;
2747 if (ST.getSPIRVVersion() < VersionTuple(1, 2))
2748 return false;
2749 return ST.canUseExtension(SPIRV::Extension::SPV_KHR_float_controls2);
2750}
2751
2752static void handleMIFlagDecoration(
2753 MachineInstr &I, const SPIRVSubtarget &ST, const SPIRVInstrInfo &TII,
2755 SPIRV::FPFastMathDefaultInfoVector &FPFastMathDefaultInfoVec) {
2756 if (I.getFlag(MachineInstr::MIFlag::NoSWrap) && TII.canUseNSW(I) &&
2757 getSymbolicOperandRequirements(SPIRV::OperandCategory::DecorationOperand,
2758 SPIRV::Decoration::NoSignedWrap, ST, Reqs)
2759 .IsSatisfiable) {
2760 buildOpDecorate(I.getOperand(0).getReg(), I, TII,
2761 SPIRV::Decoration::NoSignedWrap, {});
2762 }
2763 if (I.getFlag(MachineInstr::MIFlag::NoUWrap) && TII.canUseNUW(I) &&
2764 getSymbolicOperandRequirements(SPIRV::OperandCategory::DecorationOperand,
2765 SPIRV::Decoration::NoUnsignedWrap, ST,
2766 Reqs)
2767 .IsSatisfiable) {
2768 buildOpDecorate(I.getOperand(0).getReg(), I, TII,
2769 SPIRV::Decoration::NoUnsignedWrap, {});
2770 }
2771 // In Kernel environments, FPFastMathMode on OpExtInst is valid per core
2772 // spec. For other instruction types, SPV_KHR_float_controls2 is required.
2773 bool CanUseFM =
2774 TII.canUseFastMathFlags(
2775 I, ST.canUseExtension(SPIRV::Extension::SPV_KHR_float_controls2)) ||
2776 (ST.isKernel() && I.getOpcode() == SPIRV::OpExtInst);
2777 if (!CanUseFM)
2778 return;
2779
2780 unsigned FMFlags = getFastMathFlags(I, ST);
2781 if (FMFlags == SPIRV::FPFastMathMode::None) {
2782 // We also need to check if any FPFastMathDefault info was set for the
2783 // types used in this instruction.
2784 if (FPFastMathDefaultInfoVec.empty())
2785 return;
2786
2787 // There are three types of instructions that can use fast math flags:
2788 // 1. Arithmetic instructions (FAdd, FMul, FSub, FDiv, FRem, etc.)
2789 // 2. Relational instructions (FCmp, FOrd, FUnord, etc.)
2790 // 3. Extended instructions (ExtInst)
2791 // For arithmetic instructions, the floating point type can be in the
2792 // result type or in the operands, but they all must be the same.
2793 // For the relational and logical instructions, the floating point type
2794 // can only be in the operands 1 and 2, not the result type. Also, the
2795 // operands must have the same type. For the extended instructions, the
2796 // floating point type can be in the result type or in the operands. It's
2797 // unclear if the operands and the result type must be the same. Let's
2798 // assume they must be. Therefore, for 1. and 2., we can check the first
2799 // operand type, and for 3. we can check the result type.
2800 assert(I.getNumOperands() >= 3 && "Expected at least 3 operands");
2801 Register ResReg = I.getOpcode() == SPIRV::OpExtInst
2802 ? I.getOperand(1).getReg()
2803 : I.getOperand(2).getReg();
2804 SPIRVTypeInst ResType = GR->getSPIRVTypeForVReg(ResReg, I.getMF());
2805 const Type *Ty = GR->getTypeForSPIRVType(ResType);
2806 Ty = Ty->isVectorTy() ? cast<VectorType>(Ty)->getElementType() : Ty;
2807
2808 // Match instruction type with the FPFastMathDefaultInfoVec.
2809 bool Emit = false;
2810 for (SPIRV::FPFastMathDefaultInfo &Elem : FPFastMathDefaultInfoVec) {
2811 if (Ty == Elem.Ty) {
2812 FMFlags = Elem.FastMathFlags;
2813 Emit = Elem.ContractionOff || Elem.SignedZeroInfNanPreserve ||
2814 Elem.FPFastMathDefault;
2815 break;
2816 }
2817 }
2818
2819 if (FMFlags == SPIRV::FPFastMathMode::None && !Emit)
2820 return;
2821 }
2822 if (isFastMathModeAvailable(ST)) {
2823 Register DstReg = I.getOperand(0).getReg();
2824 buildOpDecorate(DstReg, I, TII, SPIRV::Decoration::FPFastMathMode,
2825 {FMFlags});
2826 }
2827}
2828
2829// Walk all functions and add decorations related to MI flags.
2830static void addDecorations(const Module &M, const SPIRVInstrInfo &TII,
2831 MachineModuleInfo *MMI, const SPIRVSubtarget &ST,
2833 const SPIRVGlobalRegistry *GR) {
2834 for (const Function &F : M) {
2836 if (!MF)
2837 continue;
2838
2839 for (auto &MBB : *MF)
2840 for (auto &MI : MBB)
2841 handleMIFlagDecoration(MI, ST, TII, MAI.Reqs, GR,
2843 }
2844}
2845
2846static void addMBBNames(const Module &M, const SPIRVInstrInfo &TII,
2847 MachineModuleInfo *MMI, const SPIRVSubtarget &ST,
2849 for (const Function &F : M) {
2851 if (!MF)
2852 continue;
2853 if (MF->getFunction()
2855 .isValid())
2856 continue;
2857 MachineRegisterInfo &MRI = MF->getRegInfo();
2858 for (auto &MBB : *MF) {
2859 if (!MBB.hasName() || MBB.empty())
2860 continue;
2861 // Emit basic block names.
2863 MRI.setRegClass(Reg, &SPIRV::IDRegClass);
2864 buildOpName(Reg, MBB.getName(), *std::prev(MBB.end()), TII);
2865 MCRegister GlobalReg = MAI.getOrCreateMBBRegister(MBB);
2866 MAI.setRegisterAlias(MF, Reg, GlobalReg);
2867 }
2868 }
2869}
2870
2871// patching Instruction::PHI to SPIRV::OpPhi
2872static void patchPhis(const Module &M, SPIRVGlobalRegistry *GR,
2873 const SPIRVInstrInfo &TII, MachineModuleInfo *MMI) {
2874 for (const Function &F : M) {
2876 if (!MF)
2877 continue;
2878 for (auto &MBB : *MF) {
2879 for (MachineInstr &MI : MBB.phis()) {
2880 MI.setDesc(TII.get(SPIRV::OpPhi));
2881 Register ResTypeReg = GR->getSPIRVTypeID(
2882 GR->getSPIRVTypeForVReg(MI.getOperand(0).getReg(), MF));
2883 MI.insert(MI.operands_begin() + 1,
2884 {MachineOperand::CreateReg(ResTypeReg, false)});
2885 }
2886 }
2887
2888 MF->getProperties().setNoPHIs();
2889 }
2890}
2891
2893 const Module &M, SPIRV::ModuleAnalysisInfo &MAI, const Function *F) {
2894 auto it = MAI.FPFastMathDefaultInfoMap.find(F);
2895 if (it != MAI.FPFastMathDefaultInfoMap.end())
2896 return it->second;
2897
2898 // If the map does not contain the entry, create a new one. Initialize it to
2899 // contain all 3 elements sorted by bit width of target type: {half, float,
2900 // double}.
2901 SPIRV::FPFastMathDefaultInfoVector FPFastMathDefaultInfoVec;
2902 FPFastMathDefaultInfoVec.emplace_back(Type::getHalfTy(M.getContext()),
2903 SPIRV::FPFastMathMode::None);
2904 FPFastMathDefaultInfoVec.emplace_back(Type::getFloatTy(M.getContext()),
2905 SPIRV::FPFastMathMode::None);
2906 FPFastMathDefaultInfoVec.emplace_back(Type::getDoubleTy(M.getContext()),
2907 SPIRV::FPFastMathMode::None);
2908 return MAI.FPFastMathDefaultInfoMap[F] = std::move(FPFastMathDefaultInfoVec);
2909}
2910
2912 SPIRV::FPFastMathDefaultInfoVector &FPFastMathDefaultInfoVec,
2913 const Type *Ty) {
2914 size_t BitWidth = Ty->getScalarSizeInBits();
2915 int Index =
2917 BitWidth);
2918 assert(Index >= 0 && Index < 3 &&
2919 "Expected FPFastMathDefaultInfo for half, float, or double");
2920 assert(FPFastMathDefaultInfoVec.size() == 3 &&
2921 "Expected FPFastMathDefaultInfoVec to have exactly 3 elements");
2922 return FPFastMathDefaultInfoVec[Index];
2923}
2924
2925static void collectFPFastMathDefaults(const Module &M,
2927 const SPIRVSubtarget &ST) {
2928 if (!ST.canUseExtension(SPIRV::Extension::SPV_KHR_float_controls2))
2929 return;
2930
2931 // Store the FPFastMathDefaultInfo in the FPFastMathDefaultInfoMap.
2932 // We need the entry point (function) as the key, and the target
2933 // type and flags as the value.
2934 // We also need to check ContractionOff and SignedZeroInfNanPreserve
2935 // execution modes, as they are now deprecated and must be replaced
2936 // with FPFastMathDefaultInfo.
2937 auto Node = M.getNamedMetadata("spirv.ExecutionMode");
2938 if (!Node)
2939 return;
2940
2941 for (unsigned i = 0; i < Node->getNumOperands(); i++) {
2942 MDNode *MDN = cast<MDNode>(Node->getOperand(i));
2943 assert(MDN->getNumOperands() >= 2 && "Expected at least 2 operands");
2944 const Function *F = cast<Function>(
2945 cast<ConstantAsMetadata>(MDN->getOperand(0))->getValue());
2946 const auto EM =
2948 cast<ConstantAsMetadata>(MDN->getOperand(1))->getValue())
2949 ->getZExtValue();
2950 if (EM == SPIRV::ExecutionMode::FPFastMathDefault) {
2951 assert(MDN->getNumOperands() == 4 &&
2952 "Expected 4 operands for FPFastMathDefault");
2953
2954 const Type *T = cast<ValueAsMetadata>(MDN->getOperand(2))->getType();
2955 unsigned Flags =
2957 cast<ConstantAsMetadata>(MDN->getOperand(3))->getValue())
2958 ->getZExtValue();
2959 SPIRV::FPFastMathDefaultInfoVector &FPFastMathDefaultInfoVec =
2962 getFPFastMathDefaultInfo(FPFastMathDefaultInfoVec, T);
2963 Info.FastMathFlags = Flags;
2964 Info.FPFastMathDefault = true;
2965 } else if (EM == SPIRV::ExecutionMode::ContractionOff) {
2966 assert(MDN->getNumOperands() == 2 &&
2967 "Expected no operands for ContractionOff");
2968
2969 // We need to save this info for every possible FP type, i.e. {half,
2970 // float, double, fp128}.
2971 SPIRV::FPFastMathDefaultInfoVector &FPFastMathDefaultInfoVec =
2973 for (SPIRV::FPFastMathDefaultInfo &Info : FPFastMathDefaultInfoVec) {
2974 Info.ContractionOff = true;
2975 }
2976 } else if (EM == SPIRV::ExecutionMode::SignedZeroInfNanPreserve) {
2977 assert(MDN->getNumOperands() == 3 &&
2978 "Expected 1 operand for SignedZeroInfNanPreserve");
2979 unsigned TargetWidth =
2981 cast<ConstantAsMetadata>(MDN->getOperand(2))->getValue())
2982 ->getZExtValue();
2983 // We need to save this info only for the FP type with TargetWidth.
2984 SPIRV::FPFastMathDefaultInfoVector &FPFastMathDefaultInfoVec =
2988 assert(Index >= 0 && Index < 3 &&
2989 "Expected FPFastMathDefaultInfo for half, float, or double");
2990 assert(FPFastMathDefaultInfoVec.size() == 3 &&
2991 "Expected FPFastMathDefaultInfoVec to have exactly 3 elements");
2992 FPFastMathDefaultInfoVec[Index].SignedZeroInfNanPreserve = true;
2993 }
2994 }
2995}
2996
2998 AU.addRequired<TargetPassConfig>();
2999 AU.addRequired<MachineModuleInfoWrapperPass>();
3000}
3001
3003 SPIRVTargetMachine &TM =
3004 getAnalysis<TargetPassConfig>().getTM<SPIRVTargetMachine>();
3005 ST = TM.getSubtargetImpl();
3006 GR = ST->getSPIRVGlobalRegistry();
3007 TII = ST->getInstrInfo();
3008
3010
3011 setBaseInfo(M);
3012
3013 patchPhis(M, GR, *TII, MMI);
3014
3015 addMBBNames(M, *TII, MMI, *ST, MAI);
3016 collectFPFastMathDefaults(M, MAI, *ST);
3017 addDecorations(M, *TII, MMI, *ST, MAI, GR);
3018
3019 collectReqs(M, MAI, MMI, *ST);
3020
3021 // Process type/const/global var/func decl instructions, number their
3022 // destination registers from 0 to N, collect Extensions and Capabilities.
3023 collectReqs(M, MAI, MMI, *ST);
3024 collectDeclarations(M);
3025
3026 // Number rest of registers from N+1 onwards.
3027 numberRegistersGlobally(M);
3028
3029 // Collect OpName, OpEntryPoint, OpDecorate etc, process other instructions.
3030 processOtherInstrs(M);
3031
3032 // If there are no entry points, we need the Linkage capability.
3033 if (MAI.MS[SPIRV::MB_EntryPoints].empty())
3034 MAI.Reqs.addCapability(SPIRV::Capability::Linkage);
3035
3036 // Set maximum ID used.
3037 GR->setBound(MAI.MaxID);
3038
3039 return false;
3040}
MachineInstrBuilder & UseMI
MachineInstrBuilder MachineInstrBuilder & DefMI
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
ReachingDefInfo InstSet & ToRemove
MachineBasicBlock & MBB
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
#define clEnumValN(ENUMVAL, FLAGNAME, DESC)
#define DEBUG_TYPE
static Register UseReg(const MachineOperand &MO)
const HexagonInstrInfo * TII
IRTranslator LLVM IR MI
#define F(x, y, z)
Definition MD5.cpp:54
#define I(x, y, z)
Definition MD5.cpp:57
Register Reg
Promote Memory to Register
Definition Mem2Reg.cpp:110
#define T
MachineInstr unsigned OpIdx
#define INITIALIZE_PASS(passName, arg, name, cfg, analysis)
Definition PassSupport.h:56
static SPIRV::FPFastMathDefaultInfoVector & getOrCreateFPFastMathDefaultInfoVec(const Module &M, DenseMap< Function *, SPIRV::FPFastMathDefaultInfoVector > &FPFastMathDefaultInfoMap, Function *F)
static SPIRV::FPFastMathDefaultInfo & getFPFastMathDefaultInfo(SPIRV::FPFastMathDefaultInfoVector &FPFastMathDefaultInfoVec, const Type *Ty)
#define ATOM_FLT_REQ_EXT_MSG(ExtName)
static cl::opt< bool > SPVDumpDeps("spv-dump-deps", cl::desc("Dump MIR with SPIR-V dependencies info"), cl::Optional, cl::init(false))
static cl::list< SPIRV::Capability::Capability > AvoidCapabilities("avoid-spirv-capabilities", cl::desc("SPIR-V capabilities to avoid if there are " "other options enabling a feature"), cl::Hidden, cl::values(clEnumValN(SPIRV::Capability::Shader, "Shader", "SPIR-V Shader capability")))
unsigned OpIndex
#define SPIRV_BACKEND_SERVICE_FUN_NAME
Definition SPIRVUtils.h:528
This file contains some templates that are useful if you are working with the STL at all.
#define LLVM_DEBUG(...)
Definition Debug.h:119
Target-Independent Code Generator Pass Configuration Options pass.
The Input class is used to parse a yaml document into in-memory structs and vectors.
Represent the analysis usage information of a pass.
AnalysisUsage & addRequired()
bool isValid() const
Return true if the attribute is any kind of attribute.
Definition Attributes.h:261
This is the shared class of boolean and integer constants.
Definition Constants.h:87
This is an important base class in LLVM.
Definition Constant.h:43
Attribute getFnAttribute(Attribute::AttrKind Kind) const
Return the attribute for the given attribute kind.
Definition Function.cpp:763
static constexpr LLT scalar(unsigned SizeInBits)
Get a low-level scalar or aggregate "bag of bits".
Wrapper class representing physical registers. Should be passed by value.
Definition MCRegister.h:41
constexpr bool isValid() const
Definition MCRegister.h:84
Metadata node.
Definition Metadata.h:1080
const MDOperand & getOperand(unsigned I) const
Definition Metadata.h:1444
unsigned getNumOperands() const
Return number of MDNode operands.
Definition Metadata.h:1450
Tracking metadata reference owned by Metadata.
Definition Metadata.h:902
const MachineFunction * getParent() const
Return the MachineFunction containing this basic block.
MachineRegisterInfo & getRegInfo()
getRegInfo - Return information about the registers currently in use.
Function & getFunction()
Return the LLVM function that this machine code represents.
const MachineFunctionProperties & getProperties() const
Get the function properties.
Register getReg(unsigned Idx) const
Get the register for the operand index.
Representation of each machine instruction.
unsigned getOpcode() const
Returns the opcode of this MachineInstr.
const MachineBasicBlock * getParent() const
unsigned getNumOperands() const
Retuns the total number of operands.
LLVM_ABI const MachineFunction * getMF() const
Return the function that contains the basic block that this instruction belongs to.
const MachineOperand & getOperand(unsigned i) const
This class contains meta information specific to a module.
LLVM_ABI MachineFunction * getMachineFunction(const Function &F) const
Returns the MachineFunction associated to IR function F if there is one, otherwise nullptr.
MachineOperand class - Representation of each machine instruction operand.
unsigned getSubReg() const
int64_t getImm() const
bool isReg() const
isReg - Tests if this is a MO_Register operand.
bool isImm() const
isImm - Tests if this is a MO_Immediate operand.
LLVM_ABI void print(raw_ostream &os, const TargetRegisterInfo *TRI=nullptr) const
Print the MachineOperand to os.
MachineInstr * getParent()
getParent - Return the instruction that this operand belongs to.
static MachineOperand CreateImm(int64_t Val)
MachineOperandType getType() const
getType - Returns the MachineOperandType for this operand.
Register getReg() const
getReg - Returns the register number.
MachineRegisterInfo - Keep track of information for virtual and physical registers,...
const TargetRegisterClass * getRegClass(Register Reg) const
Return the register class of the specified virtual register.
LLVM_ABI MachineInstr * getVRegDef(Register Reg) const
getVRegDef - Return the machine instr that defines the specified virtual register or null if none is ...
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.
iterator_range< reg_instr_iterator > reg_instructions(Register Reg) const
iterator_range< use_instr_iterator > use_instructions(Register Reg) const
LLVM_ABI MachineInstr * getUniqueVRegDef(Register Reg) const
getUniqueVRegDef - Return the unique machine instr that defines the specified virtual register or nul...
A Module instance is used to store all the information related to an LLVM module.
Definition Module.h:68
virtual void print(raw_ostream &OS, const Module *M) const
print - Print out the internal state of the pass.
Definition Pass.cpp:140
AnalysisType & getAnalysis() const
getAnalysis<AnalysisType>() - This function is used by subclasses to get to the analysis information ...
Wrapper class representing virtual and physical registers.
Definition Register.h:20
constexpr bool isValid() const
Definition Register.h:112
unsigned getScalarOrVectorBitWidth(SPIRVTypeInst Type) const
const Type * getTypeForSPIRVType(SPIRVTypeInst Ty) const
Register getSPIRVTypeID(SPIRVTypeInst SpirvType) const
SPIRVTypeInst getSPIRVTypeForVReg(Register VReg, const MachineFunction *MF=nullptr) const
bool isConstantInstr(const MachineInstr &MI) const
const SPIRVInstrInfo * getInstrInfo() const override
SPIRVGlobalRegistry * getSPIRVGlobalRegistry() const
const SPIRVSubtarget * getSubtargetImpl() const
bool isTypeIntN(unsigned N=0) const
SmallSet - This maintains a set of unique values, optimizing for the case when the set is small (less...
Definition SmallSet.h:134
bool contains(const T &V) const
Check if the SmallSet contains the given element.
Definition SmallSet.h:229
std::pair< const_iterator, bool > insert(const T &V)
insert - Insert an element into the set if it isn't already there.
Definition SmallSet.h:184
reference emplace_back(ArgTypes &&... Args)
void append(ItTy in_start, ItTy in_end)
Add the specified range to the end of the SmallVector.
iterator insert(iterator I, T &&Elt)
void push_back(const T &Elt)
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:46
bool isVectorTy() const
True if this is an instance of VectorType.
Definition Type.h:288
static LLVM_ABI Type * getDoubleTy(LLVMContext &C)
Definition Type.cpp:287
static LLVM_ABI Type * getFloatTy(LLVMContext &C)
Definition Type.cpp:286
static LLVM_ABI Type * getHalfTy(LLVMContext &C)
Definition Type.cpp:284
Represents a version number in the form major[.minor[.subminor[.build]]].
bool empty() const
Determine whether this version information is empty (e.g., all version components are zero).
NodeTy * getNextNode()
Get the next node, or nullptr for the list tail.
Definition ilist_node.h:348
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
constexpr std::underlying_type_t< E > Mask()
Get a bitmask with 1s in all places up to the high-order bit of E's largest value.
@ C
The default llvm calling convention, compatible with C.
Definition CallingConv.h:34
SmallVector< const MachineInstr * > InstrList
ValuesClass values(OptsTy... Options)
Helper to build a ValuesClass by forwarding a variable number of arguments as an initializer list to ...
initializer< Ty > init(const Ty &Val)
std::enable_if_t< detail::IsValidPointer< X, Y >::value, X * > extract(Y &&MD)
Extract a Value from Metadata.
Definition Metadata.h:668
NodeAddr< InstrNode * > Instr
Definition RDFGraph.h:389
This is an optimization pass for GlobalISel generic memory operations.
void buildOpName(Register Target, const StringRef &Name, MachineIRBuilder &MIRBuilder)
FunctionAddr VTableAddr Value
Definition InstrProf.h:137
std::string getStringImm(const MachineInstr &MI, unsigned StartIndex)
bool all_of(R &&range, UnaryPredicate P)
Provide wrappers to std::all_of which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1738
hash_code hash_value(const FixedPointSemantics &Val)
ExtensionList getSymbolicOperandExtensions(SPIRV::OperandCategory::OperandCategory Category, uint32_t Value)
CapabilityList getSymbolicOperandCapabilities(SPIRV::OperandCategory::OperandCategory Category, uint32_t Value)
SmallVector< SPIRV::Extension::Extension, 8 > ExtensionList
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:643
SmallVector< size_t > InstrSignature
VersionTuple getSymbolicOperandMaxVersion(SPIRV::OperandCategory::OperandCategory Category, uint32_t Value)
void buildOpDecorate(Register Reg, MachineIRBuilder &MIRBuilder, SPIRV::Decoration::Decoration Dec, const std::vector< uint32_t > &DecArgs, StringRef StrImm)
MachineInstr * getImm(const MachineOperand &MO, const MachineRegisterInfo *MRI)
CapabilityList getCapabilitiesEnabledByExtension(SPIRV::Extension::Extension Extension)
LLVM_ABI raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition Debug.cpp:209
LLVM_ABI void report_fatal_error(Error Err, bool gen_crash_diag=true)
Definition Error.cpp:163
std::string getSymbolicOperandMnemonic(SPIRV::OperandCategory::OperandCategory Category, int32_t Value)
LLVM_ABI raw_fd_ostream & errs()
This returns a reference to a raw_ostream for standard error.
DWARFExpression::Operation Op
VersionTuple getSymbolicOperandMinVersion(SPIRV::OperandCategory::OperandCategory Category, uint32_t Value)
constexpr unsigned BitWidth
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:559
bool is_contained(R &&Range, const E &Element)
Returns true if Element is found in Range.
Definition STLExtras.h:1946
SmallVector< SPIRV::Capability::Capability, 8 > CapabilityList
std::set< InstrSignature > InstrTraces
hash_code hash_combine(const Ts &...args)
Combine values into a single hash_code.
Definition Hashing.h:325
std::map< SmallVector< size_t >, unsigned > InstrGRegsMap
LLVM_ABI void reportFatalUsageError(Error Err)
Report a fatal error that does not indicate a bug in LLVM.
Definition Error.cpp:177
#define N
SmallSet< SPIRV::Capability::Capability, 4 > S
void getAnalysisUsage(AnalysisUsage &AU) const override
getAnalysisUsage - This function should be overriden by passes that need analysis information to do t...
SPIRV::ModuleAnalysisInfo MAI
bool runOnModule(Module &M) override
runOnModule - Virtual method overriden by subclasses to process the module being operated on.
static size_t computeFPFastMathDefaultInfoVecIndex(size_t BitWidth)
Definition SPIRVUtils.h:148
void setSkipEmission(const MachineInstr *MI)
MCRegister getRegisterAlias(const MachineFunction *MF, Register Reg)
MCRegister getOrCreateMBBRegister(const MachineBasicBlock &MBB)
InstrList MS[NUM_MODULE_SECTIONS]
AddressingModel::AddressingModel Addr
void setRegisterAlias(const MachineFunction *MF, Register Reg, MCRegister AliasReg)
DenseMap< const Function *, SPIRV::FPFastMathDefaultInfoVector > FPFastMathDefaultInfoMap
void addCapabilities(const CapabilityList &ToAdd)
bool isCapabilityAvailable(Capability::Capability Cap) const
void checkSatisfiable(const SPIRVSubtarget &ST) const
void getAndAddRequirements(SPIRV::OperandCategory::OperandCategory Category, uint32_t i, const SPIRVSubtarget &ST)
void addExtension(Extension::Extension ToAdd)
void initAvailableCapabilities(const SPIRVSubtarget &ST)
void removeCapabilityIf(const Capability::Capability ToRemove, const Capability::Capability IfPresent)
void addCapability(Capability::Capability ToAdd)
void addAvailableCaps(const CapabilityList &ToAdd)
void addRequirements(const Requirements &Req)
const std::optional< Capability::Capability > Cap