LLVM 23.0.0git
SPIRVInstructionSelector.cpp
Go to the documentation of this file.
1//===- SPIRVInstructionSelector.cpp ------------------------------*- C++ -*-==//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file implements the targeting of the InstructionSelector class for
10// SPIRV.
11// TODO: This should be generated by TableGen.
12//
13//===----------------------------------------------------------------------===//
14
17#include "SPIRV.h"
18#include "SPIRVGlobalRegistry.h"
19#include "SPIRVInstrInfo.h"
20#include "SPIRVRegisterInfo.h"
21#include "SPIRVTargetMachine.h"
22#include "SPIRVTypeInst.h"
23#include "SPIRVUtils.h"
24#include "llvm/ADT/APFloat.h"
34#include "llvm/IR/IntrinsicsSPIRV.h"
35#include "llvm/Support/Debug.h"
37#include <functional>
38#include <optional>
39
40#define DEBUG_TYPE "spirv-isel"
41
42using namespace llvm;
43namespace CL = SPIRV::OpenCLExtInst;
44namespace GL = SPIRV::GLSLExtInst;
45
47 std::vector<std::pair<SPIRV::InstructionSet::InstructionSet, uint32_t>>;
48
49namespace {
50
51struct ImageOperands {
52 std::optional<Register> Bias;
53 std::optional<Register> Offset;
54 std::optional<Register> MinLod;
55 std::optional<Register> GradX;
56 std::optional<Register> GradY;
57 std::optional<Register> Lod;
58 std::optional<Register> Compare;
59};
60
61struct SplitParts {
62 SPIRVTypeInst Type = nullptr;
65 bool IsScalar = false;
66};
67
68llvm::SPIRV::SelectionControl::SelectionControl
69getSelectionOperandForImm(int Imm) {
70 if (Imm == 2)
71 return SPIRV::SelectionControl::Flatten;
72 if (Imm == 1)
73 return SPIRV::SelectionControl::DontFlatten;
74 if (Imm == 0)
75 return SPIRV::SelectionControl::None;
76 llvm_unreachable("Invalid immediate");
77}
78
79#define GET_GLOBALISEL_PREDICATE_BITSET
80#include "SPIRVGenGlobalISel.inc"
81#undef GET_GLOBALISEL_PREDICATE_BITSET
82
83class SPIRVInstructionSelector : public InstructionSelector {
84 const SPIRVSubtarget &STI;
85 const SPIRVInstrInfo &TII;
87 const RegisterBankInfo &RBI;
90 MachineFunction *HasVRegsReset = nullptr;
91
92 /// We need to keep track of the number we give to anonymous global values to
93 /// generate the same name every time when this is needed.
94 mutable DenseMap<const GlobalValue *, unsigned> UnnamedGlobalIDs;
96
97public:
98 SPIRVInstructionSelector(const SPIRVTargetMachine &TM,
99 const SPIRVSubtarget &ST,
100 const RegisterBankInfo &RBI);
101 void setupMF(MachineFunction &MF, GISelValueTracking *VT,
102 CodeGenCoverage *CoverageInfo, ProfileSummaryInfo *PSI,
103 BlockFrequencyInfo *BFI) override;
104 // Common selection code. Instruction-specific selection occurs in spvSelect.
105 bool select(MachineInstr &I) override;
106 static const char *getName() { return DEBUG_TYPE; }
107
108#define GET_GLOBALISEL_PREDICATES_DECL
109#include "SPIRVGenGlobalISel.inc"
110#undef GET_GLOBALISEL_PREDICATES_DECL
111
112#define GET_GLOBALISEL_TEMPORARIES_DECL
113#include "SPIRVGenGlobalISel.inc"
114#undef GET_GLOBALISEL_TEMPORARIES_DECL
115
116private:
117 void resetVRegsType(MachineFunction &MF);
118 void removeDeadInstruction(MachineInstr &MI) const;
119 void removeOpNamesForDeadMI(MachineInstr &MI) const;
120
121 // tblgen-erated 'select' implementation, used as the initial selector for
122 // the patterns that don't require complex C++.
123 bool selectImpl(MachineInstr &I, CodeGenCoverage &CoverageInfo) const;
124
125 // All instruction-specific selection that didn't happen in "select()".
126 // Is basically a large Switch/Case delegating to all other select method.
127 bool spvSelect(Register ResVReg, SPIRVTypeInst ResType,
128 MachineInstr &I) const;
129
130 bool selectFirstBitHigh(Register ResVReg, SPIRVTypeInst ResType,
131 MachineInstr &I, bool IsSigned) const;
132
133 bool selectFirstBitLow(Register ResVReg, SPIRVTypeInst ResType,
134 MachineInstr &I) const;
135
136 bool selectFirstBitSet16(Register ResVReg, SPIRVTypeInst ResType,
137 MachineInstr &I, unsigned ExtendOpcode,
138 unsigned BitSetOpcode) const;
139
140 bool selectFirstBitSet32(Register ResVReg, SPIRVTypeInst ResType,
141 MachineInstr &I, Register SrcReg,
142 unsigned BitSetOpcode) const;
143
144 bool selectFirstBitSet64(Register ResVReg, SPIRVTypeInst ResType,
145 MachineInstr &I, Register SrcReg,
146 unsigned BitSetOpcode, bool SwapPrimarySide) const;
147
148 bool selectGlobalValue(Register ResVReg, MachineInstr &I,
149 const MachineInstr *Init = nullptr) const;
150
151 bool selectOpWithSrcs(Register ResVReg, SPIRVTypeInst ResType,
153 unsigned Opcode) const;
154
155 bool selectUnOp(Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I,
156 unsigned Opcode) const;
157
158 bool selectBitcast(Register ResVReg, SPIRVTypeInst ResType,
159 MachineInstr &I) const;
160
161 bool selectLoad(Register ResVReg, SPIRVTypeInst ResType,
162 MachineInstr &I) const;
163 bool selectAtomicLoad(Register ResVReg, SPIRVTypeInst ResType,
164 MachineInstr &I) const;
165 bool selectStore(MachineInstr &I) const;
166 bool selectAtomicStore(MachineInstr &I) const;
167
168 bool selectStackSave(Register ResVReg, SPIRVTypeInst ResType,
169 MachineInstr &I) const;
170 bool selectStackRestore(MachineInstr &I) const;
171
172 bool selectMemOperation(Register ResVReg, MachineInstr &I) const;
173 Register getOrCreateMemSetGlobal(MachineInstr &I) const;
174 bool selectCopyMemory(MachineInstr &I, Register SrcReg) const;
175 bool selectCopyMemorySized(MachineInstr &I, Register SrcReg) const;
176
177 bool selectAtomicRMW(Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I,
178 unsigned NewOpcode, unsigned NegateOpcode = 0) const;
179
180 bool selectInterlockedAdd(Register ResVReg, SPIRVTypeInst ResType,
181 MachineInstr &I) const;
182
183 bool selectAtomicCmpXchg(Register ResVReg, SPIRVTypeInst ResType,
184 MachineInstr &I) const;
185
186 bool selectFence(MachineInstr &I) const;
187
188 bool selectAddrSpaceCast(Register ResVReg, SPIRVTypeInst ResType,
189 MachineInstr &I) const;
190
191 bool selectPtrMask(Register ResVReg, SPIRVTypeInst ResType,
192 MachineInstr &I) const;
193
194 bool selectAnyOrAll(Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I,
195 unsigned OpType) const;
196
197 bool selectAll(Register ResVReg, SPIRVTypeInst ResType,
198 MachineInstr &I) const;
199
200 bool selectAny(Register ResVReg, SPIRVTypeInst ResType,
201 MachineInstr &I) const;
202
203 bool selectBitreverse(Register ResVReg, SPIRVTypeInst ResType,
204 MachineInstr &I) const;
205
206 bool selectBitreverse16(Register ResVReg, SPIRVTypeInst ResType,
207 MachineInstr &I, Register Op) const;
208
209 bool selectBitreverse64(Register ResVReg, SPIRVTypeInst ResType,
210 MachineInstr &I, Register SrcReg) const;
211
212 bool selectBitreverseNative(Register ResVReg, SPIRVTypeInst ResType,
213 MachineInstr &I, Register Op) const;
214
215 bool selectBuildVector(Register ResVReg, SPIRVTypeInst ResType,
216 MachineInstr &I) const;
217 bool selectSplatVector(Register ResVReg, SPIRVTypeInst ResType,
218 MachineInstr &I) const;
219 bool selectConcatVectors(Register ResVReg, SPIRVTypeInst ResType,
220 MachineInstr &I) const;
221
222 bool selectCmp(Register ResVReg, SPIRVTypeInst ResType,
223 unsigned comparisonOpcode, MachineInstr &I) const;
224 bool selectDiscard(Register ResVReg, SPIRVTypeInst ResType,
225 MachineInstr &I) const;
226
227 bool selectICmp(Register ResVReg, SPIRVTypeInst ResType,
228 MachineInstr &I) const;
229 bool selectFCmp(Register ResVReg, SPIRVTypeInst ResType,
230 MachineInstr &I) const;
231
232 bool selectSign(Register ResVReg, SPIRVTypeInst ResType,
233 MachineInstr &I) const;
234
235 bool selectFloatDot(Register ResVReg, SPIRVTypeInst ResType,
236 MachineInstr &I) const;
237
238 bool selectOverflowArith(Register ResVReg, SPIRVTypeInst ResType,
239 MachineInstr &I, unsigned Opcode) const;
240 bool selectDebugTrap(Register ResVReg, SPIRVTypeInst ResType,
241 MachineInstr &I) const;
242
243 bool selectIntegerDot(Register ResVReg, SPIRVTypeInst ResType,
244 MachineInstr &I, bool Signed) const;
245
246 bool selectIntegerDotExpansion(Register ResVReg, SPIRVTypeInst ResType,
247 MachineInstr &I) const;
248
249 bool selectOpIsInf(Register ResVReg, SPIRVTypeInst ResType,
250 MachineInstr &I) const;
251
252 bool selectOpIsNan(Register ResVReg, SPIRVTypeInst ResType,
253 MachineInstr &I) const;
254
255 bool selectOpIsFinite(Register ResVReg, SPIRVTypeInst ResType,
256 MachineInstr &I) const;
257
258 bool selectOpIsNormal(Register ResVReg, SPIRVTypeInst ResType,
259 MachineInstr &I) const;
260
261 bool selectPopCount(Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I,
262 unsigned Opcode) const;
263
264 bool selectPopCount16(Register ResVReg, SPIRVTypeInst ResType,
265 MachineInstr &I, unsigned ExtOpcode,
266 unsigned Opcode) const;
267
268 bool selectPopCount32(Register ResVReg, SPIRVTypeInst ResType,
269 MachineInstr &I, Register SrcReg,
270 unsigned Opcode) const;
271
272 bool selectPopCount64(Register ResVReg, SPIRVTypeInst ResType,
273 MachineInstr &I, Register SrcReg,
274 unsigned Opcode) const;
275
276 template <bool Signed>
277 bool selectDot4AddPacked(Register ResVReg, SPIRVTypeInst ResType,
278 MachineInstr &I) const;
279 template <bool Signed>
280 bool selectDot4AddPackedExpansion(Register ResVReg, SPIRVTypeInst ResType,
281 MachineInstr &I) const;
282
283 bool selectWavePrefixBitCount(Register ResVReg, SPIRVTypeInst ResType,
284 MachineInstr &I) const;
285
286 template <typename PickOpcodeFn>
287 bool selectWaveReduce(Register ResVReg, SPIRVTypeInst ResType,
288 MachineInstr &I, bool IsUnsigned,
289 PickOpcodeFn &&PickOpcode) const;
290
291 bool selectWaveReduceOp(Register ResVReg, SPIRVTypeInst ResType,
292 MachineInstr &I, unsigned Opcode) const;
293
294 bool selectWaveReduceMax(Register ResVReg, SPIRVTypeInst ResType,
295 MachineInstr &I, bool IsUnsigned) const;
296
297 bool selectWaveReduceMin(Register ResVReg, SPIRVTypeInst ResType,
298 MachineInstr &I, bool IsUnsigned) const;
299
300 bool selectWaveReduceSum(Register ResVReg, SPIRVTypeInst ResType,
301 MachineInstr &I) const;
302
303 bool selectWaveReduceProduct(Register ResVReg, const SPIRVTypeInst ResType,
304 MachineInstr &I) const;
305
306 template <typename PickOpcodeFn>
307 bool selectWaveExclusiveScan(Register ResVReg, SPIRVTypeInst ResType,
308 MachineInstr &I, bool IsUnsigned,
309 PickOpcodeFn &&PickOpcode) const;
310
311 bool selectWaveExclusiveScanSum(Register ResVReg, SPIRVTypeInst ResType,
312 MachineInstr &I) const;
313
314 bool selectWaveExclusiveScanProduct(Register ResVReg, SPIRVTypeInst ResType,
315 MachineInstr &I) const;
316
317 bool selectQuadSwap(Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I,
318 unsigned Direction) const;
319
320 bool selectConst(Register ResVReg, SPIRVTypeInst ResType,
321 MachineInstr &I) const;
322
323 bool selectSelect(Register ResVReg, SPIRVTypeInst ResType,
324 MachineInstr &I) const;
325 bool selectBoolToInt(Register ResVReg, SPIRVTypeInst ResType,
326 Register BooleanVReg, MachineInstr &InsertAt,
327 bool IsSigned) const;
328 bool selectIToF(Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I,
329 bool IsSigned, unsigned Opcode) const;
330 bool selectExt(Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I,
331 bool IsSigned) const;
332
333 bool selectTrunc(Register ResVReg, SPIRVTypeInst ResType,
334 MachineInstr &I) const;
335
336 bool selectSUCmp(Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I,
337 bool IsSigned) const;
338
339 bool selectIntToBool(Register IntReg, Register ResVReg, MachineInstr &I,
340 SPIRVTypeInst intTy, SPIRVTypeInst boolTy) const;
341
342 bool selectOpUndef(Register ResVReg, SPIRVTypeInst ResType,
343 MachineInstr &I) const;
344 bool selectFreeze(Register ResVReg, SPIRVTypeInst ResType,
345 MachineInstr &I) const;
346 bool selectIntrinsic(Register ResVReg, SPIRVTypeInst ResType,
347 MachineInstr &I) const;
348 bool selectExtractVal(Register ResVReg, SPIRVTypeInst ResType,
349 MachineInstr &I) const;
350 bool selectInsertVal(Register ResVReg, SPIRVTypeInst ResType,
351 MachineInstr &I) const;
352 bool selectExtractElt(Register ResVReg, SPIRVTypeInst ResType,
353 MachineInstr &I) const;
354 bool selectInsertElt(Register ResVReg, SPIRVTypeInst ResType,
355 MachineInstr &I) const;
356 bool selectGEP(Register ResVReg, SPIRVTypeInst ResType,
357 MachineInstr &I) const;
358
359 bool selectMaskedGather(Register ResVReg, SPIRVTypeInst ResType,
360 MachineInstr &I) const;
361 bool selectMaskedScatter(MachineInstr &I) const;
362
363 bool diagnoseUnsupported(const MachineInstr &I, const Twine &Msg) const;
364
365 bool selectAbort(MachineInstr &I) const;
366 bool selectTrap(MachineInstr &I) const;
367 bool selectFrameIndex(Register ResVReg, SPIRVTypeInst ResType,
368 MachineInstr &I) const;
369 bool selectAllocaArray(Register ResVReg, SPIRVTypeInst ResType,
370 MachineInstr &I) const;
371
372 bool selectBranch(MachineInstr &I) const;
373 bool selectBranchCond(MachineInstr &I) const;
374
375 bool selectPhi(Register ResVReg, MachineInstr &I) const;
376
377 bool selectExtInst(Register ResVReg, SPIRVTypeInst RestType, MachineInstr &I,
378 GL::GLSLExtInst GLInst, bool setMIFlags = true,
379 bool useMISrc = true,
380 ArrayRef<Register> SrcRegs = {}) const;
381 bool selectExtInst(Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I,
382 CL::OpenCLExtInst CLInst, bool setMIFlags = true,
383 bool useMISrc = true,
384 ArrayRef<Register> SrcRegs = {}) const;
385 bool selectExtInst(Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I,
386 CL::OpenCLExtInst CLInst, GL::GLSLExtInst GLInst,
387 bool setMIFlags = true, bool useMISrc = true,
388 ArrayRef<Register> SrcRegs = {}) const;
389 bool selectExtInst(Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I,
390 const ExtInstList &ExtInsts, bool setMIFlags = true,
391 bool useMISrc = true,
392 ArrayRef<Register> SrcRegs = {}) const;
393
394 bool selectLog10(Register ResVReg, SPIRVTypeInst ResType,
395 MachineInstr &I) const;
396
397 bool selectFpowi(Register ResVReg, SPIRVTypeInst ResType,
398 MachineInstr &I) const;
399
400 bool selectSaturate(Register ResVReg, SPIRVTypeInst ResType,
401 MachineInstr &I) const;
402
403 bool selectWaveOpInst(Register ResVReg, SPIRVTypeInst ResType,
404 MachineInstr &I, unsigned Opcode) const;
405
406 bool selectBarrierInst(MachineInstr &I, unsigned Scope, unsigned MemSem,
407 bool WithGroupSync) const;
408
409 bool selectWaveActiveCountBits(Register ResVReg, SPIRVTypeInst ResType,
410 MachineInstr &I) const;
411
412 bool selectWaveActiveAllEqual(Register ResVReg, SPIRVTypeInst ResType,
413 MachineInstr &I) const;
414
415 bool selectUnmergeValues(MachineInstr &I) const;
416
417 bool selectHandleFromBinding(Register &ResVReg, SPIRVTypeInst ResType,
418 MachineInstr &I) const;
419
420 bool selectCounterHandleFromBinding(Register &ResVReg, SPIRVTypeInst ResType,
421 MachineInstr &I) const;
422
423 bool selectReadImageIntrinsic(Register &ResVReg, SPIRVTypeInst ResType,
424 MachineInstr &I) const;
425 bool selectGetDimensionsIntrinsic(Register &ResVReg, SPIRVTypeInst ResType,
426 MachineInstr &I) const;
427 bool selectGetDimensionsLevelsIntrinsic(Register &ResVReg,
428 SPIRVTypeInst ResType,
429 MachineInstr &I) const;
430 bool selectGetDimensionsMSIntrinsic(Register &ResVReg, SPIRVTypeInst ResType,
431 MachineInstr &I) const;
432 bool
433 selectImageQuerySize(Register ImageReg, Register &ResVReg, MachineInstr &I,
434 std::optional<Register> LodReg = std::nullopt) const;
435 bool selectSampleBasicIntrinsic(Register &ResVReg, SPIRVTypeInst ResType,
436 MachineInstr &I) const;
437 bool selectCalculateLodIntrinsic(Register &ResVReg, SPIRVTypeInst ResType,
438 MachineInstr &I) const;
439 bool selectSampleBiasIntrinsic(Register &ResVReg, SPIRVTypeInst ResType,
440 MachineInstr &I) const;
441 bool selectSampleGradIntrinsic(Register &ResVReg, SPIRVTypeInst ResType,
442 MachineInstr &I) const;
443 bool selectSampleLevelIntrinsic(Register &ResVReg, SPIRVTypeInst ResType,
444 MachineInstr &I) const;
445 bool selectLoadLevelIntrinsic(Register &ResVReg, SPIRVTypeInst ResType,
446 MachineInstr &I) const;
447 bool selectSampleCmpIntrinsic(Register &ResVReg, SPIRVTypeInst ResType,
448 MachineInstr &I) const;
449 bool selectSampleCmpLevelZeroIntrinsic(Register &ResVReg,
450 SPIRVTypeInst ResType,
451 MachineInstr &I) const;
452 bool selectGatherIntrinsic(Register &ResVReg, SPIRVTypeInst ResType,
453 MachineInstr &I) const;
454 bool selectImageWriteIntrinsic(MachineInstr &I) const;
455 bool selectResourceGetPointer(Register &ResVReg, SPIRVTypeInst ResType,
456 MachineInstr &I) const;
457 bool selectPushConstantGetPointer(Register &ResVReg, SPIRVTypeInst ResType,
458 MachineInstr &I) const;
459 bool selectResourceNonUniformIndex(Register &ResVReg, SPIRVTypeInst ResType,
460 MachineInstr &I) const;
461 bool selectModf(Register ResVReg, SPIRVTypeInst ResType,
462 MachineInstr &I) const;
463 bool selectUpdateCounter(Register &ResVReg, SPIRVTypeInst ResType,
464 MachineInstr &I) const;
465 bool selectFrexp(Register ResVReg, SPIRVTypeInst ResType,
466 MachineInstr &I) const;
467 bool selectSincos(Register ResVReg, SPIRVTypeInst ResType,
468 MachineInstr &I) const;
469 bool selectExp10(Register ResVReg, SPIRVTypeInst ResType,
470 MachineInstr &I) const;
471 bool selectDerivativeInst(Register ResVReg, SPIRVTypeInst ResType,
472 MachineInstr &I, const unsigned DPdOpCode) const;
473 // Utilities
474 Register buildI32Constant(uint32_t Val, MachineInstr &I,
475 SPIRVTypeInst ResType = nullptr) const;
476 Register buildI32ConstantInEntryBlock(uint32_t Val, MachineInstr &I,
477 SPIRVTypeInst ResType = nullptr) const;
478
479 Register buildZerosVal(SPIRVTypeInst ResType, MachineInstr &I) const;
480 bool isScalarOrVectorIntConstantZero(Register Reg) const;
481 Register buildZerosValF(SPIRVTypeInst ResType, MachineInstr &I) const;
482 Register buildOnesVal(bool AllOnes, SPIRVTypeInst ResType,
483 MachineInstr &I) const;
484 Register buildOnesValF(SPIRVTypeInst ResType, MachineInstr &I) const;
485
486 bool wrapIntoSpecConstantOp(MachineInstr &I,
487 SmallVector<Register> &CompositeArgs) const;
488
489 Register getUcharPtrTypeReg(MachineInstr &I,
490 SPIRV::StorageClass::StorageClass SC) const;
491 MachineInstrBuilder buildSpecConstantOp(MachineInstr &I, Register Dest,
492 Register Src, Register DestType,
493 uint32_t Opcode) const;
494 MachineInstrBuilder buildConstGenericPtr(MachineInstr &I, Register SrcPtr,
495 SPIRVTypeInst SrcPtrTy) const;
496 Register buildPointerToResource(SPIRVTypeInst ResType,
497 SPIRV::StorageClass::StorageClass SC,
498 uint32_t Set, uint32_t Binding,
499 uint32_t ArraySize, Register IndexReg,
500 StringRef Name,
501 MachineIRBuilder MIRBuilder) const;
502 SPIRVTypeInst widenTypeToVec4(SPIRVTypeInst Type, MachineInstr &I) const;
503 bool extractSubvector(Register &ResVReg, SPIRVTypeInst ResType,
504 Register &ReadReg, MachineInstr &InsertionPoint) const;
505 bool generateImageReadOrFetch(Register &ResVReg, SPIRVTypeInst ResType,
506 Register ImageReg, Register IdxReg,
507 DebugLoc Loc, MachineInstr &Pos,
508 const ImageOperands *ImOps = nullptr) const;
509 bool generateSampleImage(Register ResVReg, SPIRVTypeInst ResType,
510 Register ImageReg, Register SamplerReg,
511 Register CoordinateReg, const ImageOperands &ImOps,
512 DebugLoc Loc, MachineInstr &I) const;
513 bool BuildCOPY(Register DestReg, Register SrcReg, MachineInstr &I) const;
514 bool loadVec3BuiltinInputID(SPIRV::BuiltIn::BuiltIn BuiltInValue,
515 Register ResVReg, SPIRVTypeInst ResType,
516 MachineInstr &I) const;
517 bool loadBuiltinInputID(SPIRV::BuiltIn::BuiltIn BuiltInValue,
518 Register ResVReg, SPIRVTypeInst ResType,
519 MachineInstr &I) const;
520 bool loadHandleBeforePosition(Register &HandleReg, SPIRVTypeInst ResType,
521 GIntrinsic &HandleDef, MachineInstr &Pos) const;
522 void decorateUsesAsNonUniform(Register &NonUniformReg) const;
523 bool errorIfInstrOutsideShader(MachineInstr &I) const;
524
525 std::optional<SplitParts> splitEvenOddLanes(Register PopCountReg,
526 unsigned ComponentCount,
527 MachineInstr &I,
528 SPIRVTypeInst I32Type) const;
529
530 bool
531 handle64BitOverflow(Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I,
532 Register SrcReg, unsigned int Opcode,
533 std::function<bool(Register, SPIRVTypeInst,
534 MachineInstr &, Register, unsigned)>
535 CallbackFunction) const;
536};
537
538bool sampledTypeIsSignedInteger(const llvm::Type *HandleType) {
539 const TargetExtType *TET = cast<TargetExtType>(HandleType);
540 if (TET->getTargetExtName() == "spirv.Image") {
541 return false;
542 }
543 assert(TET->getTargetExtName() == "spirv.SignedImage");
544 return TET->getTypeParameter(0)->isIntegerTy();
545}
546} // end anonymous namespace
547
548#define GET_GLOBALISEL_IMPL
549#include "SPIRVGenGlobalISel.inc"
550#undef GET_GLOBALISEL_IMPL
551
552SPIRVInstructionSelector::SPIRVInstructionSelector(const SPIRVTargetMachine &TM,
553 const SPIRVSubtarget &ST,
554 const RegisterBankInfo &RBI)
555 : InstructionSelector(), STI(ST), TII(*ST.getInstrInfo()),
556 TRI(*ST.getRegisterInfo()), RBI(RBI), GR(*ST.getSPIRVGlobalRegistry()),
557 MRI(nullptr),
559#include "SPIRVGenGlobalISel.inc"
562#include "SPIRVGenGlobalISel.inc"
564{
565}
566
567void SPIRVInstructionSelector::setupMF(MachineFunction &MF,
569 CodeGenCoverage *CoverageInfo,
571 BlockFrequencyInfo *BFI) {
572 MRI = &MF.getRegInfo();
573 GR.setCurrentFunc(MF);
574 InstructionSelector::setupMF(MF, VT, CoverageInfo, PSI, BFI);
575}
576
577// Ensure that register classes correspond to pattern matching rules.
578void SPIRVInstructionSelector::resetVRegsType(MachineFunction &MF) {
579 if (HasVRegsReset == &MF)
580 return;
581 HasVRegsReset = &MF;
582
583 MachineRegisterInfo &MRI = MF.getRegInfo();
584 for (unsigned I = 0, E = MRI.getNumVirtRegs(); I != E; ++I) {
585 Register Reg = Register::index2VirtReg(I);
586 LLT RegType = MRI.getType(Reg);
587 if (RegType.isScalar())
588 MRI.setType(Reg, LLT::scalar(64));
589 else if (RegType.isPointer())
590 MRI.setType(Reg, LLT::pointer(0, 64));
591 else if (RegType.isVector())
593 }
594 for (const auto &MBB : MF) {
595 for (const auto &MI : MBB) {
596 if (isPreISelGenericOpcode(MI.getOpcode()))
597 GR.erase(&MI);
598 if (MI.getOpcode() != SPIRV::ASSIGN_TYPE)
599 continue;
600
601 Register DstReg = MI.getOperand(0).getReg();
602 LLT DstType = MRI.getType(DstReg);
603 Register SrcReg = MI.getOperand(1).getReg();
604 LLT SrcType = MRI.getType(SrcReg);
605 if (DstType != SrcType)
606 MRI.setType(DstReg, MRI.getType(SrcReg));
607
608 const TargetRegisterClass *DstRC = MRI.getRegClassOrNull(DstReg);
609 const TargetRegisterClass *SrcRC = MRI.getRegClassOrNull(SrcReg);
610 if (DstRC != SrcRC && SrcRC)
611 MRI.setRegClass(DstReg, SrcRC);
612 }
613 }
614}
615
616// Return true if the MachineInstr represents a constant register
617static bool isConstReg(MachineRegisterInfo *MRI, MachineInstr *OpDef) {
618
619 SmallVector<MachineInstr *> Stack = {OpDef};
621
622 while (!Stack.empty()) {
623 MachineInstr *MI = Stack.pop_back_val();
624 MI = passCopy(MI, MRI);
625 if (!Visited.insert(MI).second)
626 continue;
627 switch (MI->getOpcode()) {
628 case TargetOpcode::G_INTRINSIC:
629 case TargetOpcode::G_INTRINSIC_W_SIDE_EFFECTS:
630 case TargetOpcode::G_INTRINSIC_CONVERGENT_W_SIDE_EFFECTS: {
632 unsigned IntrID = GIntr->getIntrinsicID();
633 if (IntrID != Intrinsic::spv_const_composite &&
634 IntrID != Intrinsic::spv_undef && IntrID != Intrinsic::spv_poison)
635 return false;
636 continue;
637 }
638 case TargetOpcode::G_BUILD_VECTOR:
639 case TargetOpcode::G_SPLAT_VECTOR:
640 for (unsigned i = OpDef->getNumExplicitDefs();
641 i < OpDef->getNumOperands(); i++) {
642 if (!OpDef->getOperand(i).isReg())
643 continue;
644 MachineInstr *OpNestedDef =
645 MRI->getVRegDef(OpDef->getOperand(i).getReg());
646 Stack.push_back(OpNestedDef);
647 }
648 continue;
649 case TargetOpcode::G_CONSTANT:
650 case TargetOpcode::G_FCONSTANT:
651 case TargetOpcode::G_IMPLICIT_DEF:
652 case SPIRV::OpConstantTrue:
653 case SPIRV::OpConstantFalse:
654 case SPIRV::OpConstantI:
655 case SPIRV::OpConstantF:
656 case SPIRV::OpConstantComposite:
657 case SPIRV::OpConstantCompositeContinuedINTEL:
658 case SPIRV::OpConstantSampler:
659 case SPIRV::OpConstantNull:
660 case SPIRV::OpUndef:
661 case SPIRV::OpPoisonKHR:
662 case SPIRV::OpConstantFunctionPointerINTEL:
663 continue;
664 default:
665 return false;
666 }
667 }
668 return true;
669}
670
671// Return true if the virtual register represents a constant
672static bool isConstReg(MachineRegisterInfo *MRI, Register OpReg) {
673 if (MachineInstr *OpDef = MRI->getVRegDef(OpReg))
674 return isConstReg(MRI, OpDef);
675 return false;
676}
677
678// TODO(168736): We should make this either a flag in tabelgen
679// or reduce our dependence on the global registry, so we can remove this
680// function. It can easily be missed when new intrinsics are added.
681
682// Most SPIR-V intrinsics are considered to have side-effects in their tablegen
683// definition because they are referenced in the global registry. This is a list
684// of intrinsics that have no side effects other than their references in the
685// global registry.
687 switch (ID) {
688 // This is not an exhaustive list and may need to be updated.
689 case Intrinsic::spv_all:
690 case Intrinsic::spv_alloca:
691 case Intrinsic::spv_any:
692 case Intrinsic::spv_bitcast:
693 case Intrinsic::spv_const_composite:
694 case Intrinsic::spv_cross:
695 case Intrinsic::spv_degrees:
696 case Intrinsic::spv_distance:
697 case Intrinsic::spv_extractelt:
698 case Intrinsic::spv_extractv:
699 case Intrinsic::spv_faceforward:
700 case Intrinsic::spv_fdot:
701 case Intrinsic::spv_firstbitlow:
702 case Intrinsic::spv_firstbitshigh:
703 case Intrinsic::spv_firstbituhigh:
704 case Intrinsic::spv_frac:
705 case Intrinsic::spv_gep:
706 case Intrinsic::spv_global_offset:
707 case Intrinsic::spv_global_size:
708 case Intrinsic::spv_group_id:
709 case Intrinsic::spv_insertelt:
710 case Intrinsic::spv_insertv:
711 case Intrinsic::spv_isinf:
712 case Intrinsic::spv_isnan:
713 case Intrinsic::spv_isfinite:
714 case Intrinsic::spv_isnormal:
715 case Intrinsic::spv_lerp:
716 case Intrinsic::spv_length:
717 case Intrinsic::spv_normalize:
718 case Intrinsic::spv_num_subgroups:
719 case Intrinsic::spv_num_workgroups:
720 case Intrinsic::spv_ptrcast:
721 case Intrinsic::spv_radians:
722 case Intrinsic::spv_reflect:
723 case Intrinsic::spv_refract:
724 case Intrinsic::spv_resource_getbasepointer:
725 case Intrinsic::spv_resource_getpointer:
726 case Intrinsic::spv_resource_handlefrombinding:
727 case Intrinsic::spv_resource_handlefromimplicitbinding:
728 case Intrinsic::spv_resource_nonuniformindex:
729 case Intrinsic::spv_resource_sample:
730 case Intrinsic::spv_rsqrt:
731 case Intrinsic::spv_saturate:
732 case Intrinsic::spv_sdot:
733 case Intrinsic::spv_sign:
734 case Intrinsic::spv_smoothstep:
735 case Intrinsic::spv_step:
736 case Intrinsic::spv_subgroup_id:
737 case Intrinsic::spv_subgroup_local_invocation_id:
738 case Intrinsic::spv_subgroup_max_size:
739 case Intrinsic::spv_subgroup_size:
740 case Intrinsic::spv_thread_id:
741 case Intrinsic::spv_thread_id_in_group:
742 case Intrinsic::spv_udot:
743 case Intrinsic::spv_undef:
744 case Intrinsic::spv_value_md:
745 case Intrinsic::spv_workgroup_size:
746 return false;
747 default:
748 return true;
749 }
750}
751
752// TODO(168736): We should make this either a flag in tabelgen
753// or reduce our dependence on the global registry, so we can remove this
754// function. It can easily be missed when new intrinsics are added.
755static bool isOpcodeWithNoSideEffects(unsigned Opcode) {
756 switch (Opcode) {
757 case SPIRV::OpTypeVoid:
758 case SPIRV::OpTypeBool:
759 case SPIRV::OpTypeInt:
760 case SPIRV::OpTypeFloat:
761 case SPIRV::OpTypeVector:
762 case SPIRV::OpTypeMatrix:
763 case SPIRV::OpTypeImage:
764 case SPIRV::OpTypeSampler:
765 case SPIRV::OpTypeSampledImage:
766 case SPIRV::OpTypeArray:
767 case SPIRV::OpTypeRuntimeArray:
768 case SPIRV::OpTypeStruct:
769 case SPIRV::OpTypeOpaque:
770 case SPIRV::OpTypePointer:
771 case SPIRV::OpTypeFunction:
772 case SPIRV::OpTypeEvent:
773 case SPIRV::OpTypeDeviceEvent:
774 case SPIRV::OpTypeReserveId:
775 case SPIRV::OpTypeQueue:
776 case SPIRV::OpTypePipe:
777 case SPIRV::OpTypeForwardPointer:
778 case SPIRV::OpTypePipeStorage:
779 case SPIRV::OpTypeNamedBarrier:
780 case SPIRV::OpTypeAccelerationStructureNV:
781 case SPIRV::OpTypeCooperativeMatrixNV:
782 case SPIRV::OpTypeCooperativeMatrixKHR:
783 return true;
784 default:
785 return false;
786 }
787}
788
789bool isDead(const MachineInstr &MI, const MachineRegisterInfo &MRI) {
790 // If there are no definitions, then assume there is some other
791 // side-effect that makes this instruction live.
792 if (MI.getNumDefs() == 0)
793 return false;
794
795 for (const auto &MO : MI.all_defs()) {
796 Register Reg = MO.getReg();
797 if (Reg.isPhysical()) {
798 LLVM_DEBUG(dbgs() << "Not dead: def of physical register " << Reg);
799 return false;
800 }
801 for (const auto &UseMI : MRI.use_nodbg_instructions(Reg)) {
802 if (UseMI.getOpcode() != SPIRV::OpName) {
803 LLVM_DEBUG(dbgs() << "Not dead: def " << MO << " has use in " << UseMI);
804 return false;
805 }
806 }
807 }
808
809 if (MI.getOpcode() == TargetOpcode::LOCAL_ESCAPE || MI.isFakeUse() ||
810 MI.isLifetimeMarker()) {
812 dbgs()
813 << "Not dead: Opcode is LOCAL_ESCAPE, fake use, or lifetime marker.\n");
814 return false;
815 }
816 if (MI.isPHI()) {
817 LLVM_DEBUG(dbgs() << "Dead: Phi instruction with no uses.\n");
818 return true;
819 }
820
821 // It is possible that the only side effect is that the instruction is
822 // referenced in the global registry. If that is the only side effect, the
823 // intrinsic is dead.
824 if (MI.getOpcode() == TargetOpcode::G_INTRINSIC_W_SIDE_EFFECTS ||
825 MI.getOpcode() == TargetOpcode::G_INTRINSIC_CONVERGENT_W_SIDE_EFFECTS) {
826 const auto &Intr = cast<GIntrinsic>(MI);
827 if (!intrinsicHasSideEffects(Intr.getIntrinsicID())) {
828 LLVM_DEBUG(dbgs() << "Dead: Intrinsic with no real side effects.\n");
829 return true;
830 }
831 }
832
833 if (MI.mayStore() || MI.isCall() ||
834 (MI.mayLoad() && MI.hasOrderedMemoryRef()) || MI.isPosition() ||
835 MI.isDebugInstr() || MI.isTerminator() || MI.isJumpTableDebugInfo()) {
836 LLVM_DEBUG(dbgs() << "Not dead: instruction has side effects.\n");
837 return false;
838 }
839
840 if (isPreISelGenericOpcode(MI.getOpcode())) {
841 // TODO: Is there a generic way to check if the opcode has side effects?
842 LLVM_DEBUG(dbgs() << "Dead: Generic opcode with no uses.\n");
843 return true;
844 }
845
846 if (isOpcodeWithNoSideEffects(MI.getOpcode())) {
847 LLVM_DEBUG(dbgs() << "Dead: known opcode with no side effects\n");
848 return true;
849 }
850
851 return false;
852}
853
854void SPIRVInstructionSelector::removeOpNamesForDeadMI(MachineInstr &MI) const {
855 // Delete the OpName that uses the result if there is one.
856 for (const auto &MO : MI.all_defs()) {
857 Register Reg = MO.getReg();
858 if (Reg.isPhysical())
859 continue;
860 SmallVector<MachineInstr *, 4> UselessOpNames;
861 for (MachineInstr &UseMI : MRI->use_nodbg_instructions(Reg)) {
862 assert(UseMI.getOpcode() == SPIRV::OpName &&
863 "There is still a use of the dead function.");
864 UselessOpNames.push_back(&UseMI);
865 }
866 for (MachineInstr *OpNameMI : UselessOpNames) {
867 GR.invalidateMachineInstr(OpNameMI);
868 OpNameMI->eraseFromParent();
869 }
870 }
871}
872
873void SPIRVInstructionSelector::removeDeadInstruction(MachineInstr &MI) const {
874 salvageDebugInfo(*MRI, MI);
876 removeOpNamesForDeadMI(MI);
877 MI.eraseFromParent();
878}
879
880bool SPIRVInstructionSelector::select(MachineInstr &I) {
881 resetVRegsType(*I.getParent()->getParent());
882
883 assert(I.getParent() && "Instruction should be in a basic block!");
884 assert(I.getParent()->getParent() && "Instruction should be in a function!");
885
886 LLVM_DEBUG(dbgs() << "Checking if instruction is dead: " << I;);
887 if (isDead(I, *MRI)) {
888 LLVM_DEBUG(dbgs() << "Instruction is dead.\n");
889 removeDeadInstruction(I);
890 return true;
891 }
892
893 Register Opcode = I.getOpcode();
894 // If it's not a GMIR instruction, we've selected it already.
895 if (!isPreISelGenericOpcode(Opcode)) {
896 if (Opcode == SPIRV::ASSIGN_TYPE) { // These pseudos aren't needed any more.
897 Register DstReg = I.getOperand(0).getReg();
898 Register SrcReg = I.getOperand(1).getReg();
899 auto *Def = MRI->getVRegDef(SrcReg);
900 if (isTypeFoldingSupported(Def->getOpcode()) &&
901 Def->getOpcode() != TargetOpcode::G_CONSTANT &&
902 Def->getOpcode() != TargetOpcode::G_FCONSTANT) {
903 if (Def->getOpcode() == TargetOpcode::G_SELECT) {
904 Register SelectDstReg = Def->getOperand(0).getReg();
905 bool SuccessToSelectSelect [[maybe_unused]] = selectSelect(
906 SelectDstReg, GR.getSPIRVTypeForVReg(SelectDstReg), *Def);
907 assert(SuccessToSelectSelect);
909 Def->eraseFromParent();
910 MRI->replaceRegWith(DstReg, SelectDstReg);
912 I.eraseFromParent();
913 return true;
914 }
915
916 bool Res = selectImpl(I, *CoverageInfo);
917 LLVM_DEBUG({
918 if (!Res && Def->getOpcode() != TargetOpcode::G_CONSTANT) {
919 dbgs() << "Unexpected pattern in ASSIGN_TYPE.\nInstruction: ";
920 I.print(dbgs());
921 }
922 });
923 assert(Res || Def->getOpcode() == TargetOpcode::G_CONSTANT);
924 if (Res) {
925 if (!isTriviallyDead(*Def, *MRI) && isDead(*Def, *MRI))
926 DeadMIs.insert(Def);
927 return Res;
928 }
929 }
930 MRI->setRegClass(SrcReg, MRI->getRegClass(DstReg));
931 MRI->replaceRegWith(SrcReg, DstReg);
933 I.eraseFromParent();
934 return true;
935 } else if (I.getNumDefs() == 1) {
936 // Make all vregs 64 bits (for SPIR-V IDs).
937 MRI->setType(I.getOperand(0).getReg(), LLT::scalar(64));
938 }
940 return true;
941 }
942
943 if (DeadMIs.contains(&I)) {
944 // if the instruction has been already made dead by folding it away
945 // erase it
946 LLVM_DEBUG(dbgs() << "Instruction is folded and dead.\n");
947 removeDeadInstruction(I);
948 DeadMIs.erase(&I);
949 return true;
950 }
951
952 if (I.getNumOperands() != I.getNumExplicitOperands()) {
953 LLVM_DEBUG(errs() << "Generic instr has unexpected implicit operands\n");
954 return false;
955 }
956
957 // Common code for getting return reg+type, and removing selected instr
958 // from parent occurs here. Instr-specific selection happens in spvSelect().
959 bool HasDefs = I.getNumDefs() > 0;
960 Register ResVReg = HasDefs ? I.getOperand(0).getReg() : Register(0);
961 SPIRVTypeInst ResType = HasDefs ? GR.getSPIRVTypeForVReg(ResVReg) : nullptr;
962 assert(!HasDefs || ResType || I.getOpcode() == TargetOpcode::G_GLOBAL_VALUE ||
963 I.getOpcode() == TargetOpcode::G_IMPLICIT_DEF);
964 if (spvSelect(ResVReg, ResType, I)) {
965 if (HasDefs) // Make all vregs 64 bits (for SPIR-V IDs).
966 for (unsigned i = 0; i < I.getNumDefs(); ++i)
967 MRI->setType(I.getOperand(i).getReg(), LLT::scalar(64));
969 I.eraseFromParent();
970 return true;
971 }
972 return false;
973}
974
975static bool mayApplyGenericSelection(unsigned Opcode) {
976 switch (Opcode) {
977 case TargetOpcode::G_CONSTANT:
978 case TargetOpcode::G_FCONSTANT:
979 return false;
980 }
981 return isTypeFoldingSupported(Opcode);
982}
983
984bool SPIRVInstructionSelector::BuildCOPY(Register DestReg, Register SrcReg,
985 MachineInstr &I) const {
986 const TargetRegisterClass *DstRC = MRI->getRegClassOrNull(DestReg);
987 const TargetRegisterClass *SrcRC = MRI->getRegClassOrNull(SrcReg);
988 if (DstRC != SrcRC && SrcRC)
989 MRI->setRegClass(DestReg, SrcRC);
990 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(TargetOpcode::COPY))
991 .addDef(DestReg)
992 .addUse(SrcReg)
993 .constrainAllUses(TII, TRI, RBI);
994 return true;
995}
996
997bool SPIRVInstructionSelector::spvSelect(Register ResVReg,
998 SPIRVTypeInst ResType,
999 MachineInstr &I) const {
1000 const unsigned Opcode = I.getOpcode();
1001 if (mayApplyGenericSelection(Opcode))
1002 return selectImpl(I, *CoverageInfo);
1003 switch (Opcode) {
1004 case TargetOpcode::G_CONSTANT:
1005 case TargetOpcode::G_FCONSTANT:
1006 return selectConst(ResVReg, ResType, I);
1007 case TargetOpcode::G_GLOBAL_VALUE:
1008 return selectGlobalValue(ResVReg, I);
1009 case TargetOpcode::G_IMPLICIT_DEF:
1010 return selectOpUndef(ResVReg, ResType, I);
1011 case TargetOpcode::G_FREEZE:
1012 return selectFreeze(ResVReg, ResType, I);
1013
1014 case TargetOpcode::G_INTRINSIC:
1015 case TargetOpcode::G_INTRINSIC_W_SIDE_EFFECTS:
1016 case TargetOpcode::G_INTRINSIC_CONVERGENT:
1017 case TargetOpcode::G_INTRINSIC_CONVERGENT_W_SIDE_EFFECTS:
1018 return selectIntrinsic(ResVReg, ResType, I);
1019 case TargetOpcode::G_BITREVERSE:
1020 return selectBitreverse(ResVReg, ResType, I);
1021
1022 case TargetOpcode::G_BUILD_VECTOR:
1023 return selectBuildVector(ResVReg, ResType, I);
1024 case TargetOpcode::G_SPLAT_VECTOR:
1025 return selectSplatVector(ResVReg, ResType, I);
1026 case TargetOpcode::G_CONCAT_VECTORS:
1027 return selectConcatVectors(ResVReg, ResType, I);
1028
1029 case TargetOpcode::G_SHUFFLE_VECTOR: {
1030 MachineBasicBlock &BB = *I.getParent();
1031 auto MIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpVectorShuffle))
1032 .addDef(ResVReg)
1033 .addUse(GR.getSPIRVTypeID(ResType))
1034 .addUse(I.getOperand(1).getReg())
1035 .addUse(I.getOperand(2).getReg());
1036 for (auto V : I.getOperand(3).getShuffleMask())
1037 MIB.addImm(V);
1038 MIB.constrainAllUses(TII, TRI, RBI);
1039 return true;
1040 }
1041 case TargetOpcode::G_MEMMOVE:
1042 case TargetOpcode::G_MEMCPY:
1043 case TargetOpcode::G_MEMCPY_INLINE:
1044 case TargetOpcode::G_MEMSET:
1045 case TargetOpcode::G_MEMSET_INLINE:
1046 return selectMemOperation(ResVReg, I);
1047
1048 case TargetOpcode::G_ICMP:
1049 return selectICmp(ResVReg, ResType, I);
1050 case TargetOpcode::G_FCMP:
1051 return selectFCmp(ResVReg, ResType, I);
1052
1053 case TargetOpcode::G_FRAME_INDEX:
1054 return selectFrameIndex(ResVReg, ResType, I);
1055
1056 case TargetOpcode::G_LOAD:
1057 return selectLoad(ResVReg, ResType, I);
1058 case TargetOpcode::G_STORE:
1059 return selectStore(I);
1060
1061 case TargetOpcode::G_BR:
1062 return selectBranch(I);
1063 case TargetOpcode::G_BRCOND:
1064 return selectBranchCond(I);
1065
1066 case TargetOpcode::G_PHI:
1067 return selectPhi(ResVReg, I);
1068
1069 case TargetOpcode::G_FPTOSI:
1070 return selectUnOp(ResVReg, ResType, I, SPIRV::OpConvertFToS);
1071 case TargetOpcode::G_FPTOUI:
1072 return selectUnOp(ResVReg, ResType, I, SPIRV::OpConvertFToU);
1073
1074 case TargetOpcode::G_FPTOSI_SAT:
1075 return selectUnOp(ResVReg, ResType, I, SPIRV::OpConvertFToS);
1076 case TargetOpcode::G_FPTOUI_SAT:
1077 return selectUnOp(ResVReg, ResType, I, SPIRV::OpConvertFToU);
1078
1079 case TargetOpcode::G_SITOFP:
1080 return selectIToF(ResVReg, ResType, I, true, SPIRV::OpConvertSToF);
1081 case TargetOpcode::G_UITOFP:
1082 return selectIToF(ResVReg, ResType, I, false, SPIRV::OpConvertUToF);
1083
1084 case TargetOpcode::G_CTPOP:
1085 return selectPopCount(ResVReg, ResType, I, SPIRV::OpBitCount);
1086 case TargetOpcode::G_SMIN:
1087 return selectExtInst(ResVReg, ResType, I, CL::s_min, GL::SMin);
1088 case TargetOpcode::G_UMIN:
1089 return selectExtInst(ResVReg, ResType, I, CL::u_min, GL::UMin);
1090
1091 case TargetOpcode::G_SMAX:
1092 return selectExtInst(ResVReg, ResType, I, CL::s_max, GL::SMax);
1093 case TargetOpcode::G_UMAX:
1094 return selectExtInst(ResVReg, ResType, I, CL::u_max, GL::UMax);
1095
1096 case TargetOpcode::G_SCMP:
1097 return selectSUCmp(ResVReg, ResType, I, true);
1098 case TargetOpcode::G_UCMP:
1099 return selectSUCmp(ResVReg, ResType, I, false);
1100 case TargetOpcode::G_LROUND:
1101 case TargetOpcode::G_LLROUND: {
1102 Register regForLround =
1103 MRI->createVirtualRegister(MRI->getRegClass(ResVReg), "lround");
1104 MRI->setRegClass(regForLround, &SPIRV::iIDRegClass);
1105 GR.assignSPIRVTypeToVReg(GR.getSPIRVTypeForVReg(I.getOperand(1).getReg()),
1106 regForLround, *(I.getParent()->getParent()));
1107 selectExtInst(regForLround, GR.getSPIRVTypeForVReg(regForLround), I,
1108 CL::round, GL::Round, /* setMIFlags */ false);
1109 MachineBasicBlock &BB = *I.getParent();
1110 auto MIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpConvertFToS))
1111 .addDef(ResVReg)
1112 .addUse(GR.getSPIRVTypeID(ResType))
1113 .addUse(regForLround);
1114 MIB.constrainAllUses(TII, TRI, RBI);
1115 return true;
1116 }
1117 case TargetOpcode::G_STRICT_FMA:
1118 case TargetOpcode::G_FMA: {
1119 if (STI.canUseExtension(SPIRV::Extension::SPV_KHR_fma)) {
1120 MachineBasicBlock &BB = *I.getParent();
1121 auto MIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpFmaKHR))
1122 .addDef(ResVReg)
1123 .addUse(GR.getSPIRVTypeID(ResType))
1124 .addUse(I.getOperand(1).getReg())
1125 .addUse(I.getOperand(2).getReg())
1126 .addUse(I.getOperand(3).getReg())
1127 .setMIFlags(I.getFlags());
1128 MIB.constrainAllUses(TII, TRI, RBI);
1129 return true;
1130 }
1131 return selectExtInst(ResVReg, ResType, I, CL::fma, GL::Fma);
1132 }
1133
1134 case TargetOpcode::G_STRICT_FLDEXP:
1135 return selectExtInst(ResVReg, ResType, I, CL::ldexp);
1136
1137 case TargetOpcode::G_FPOW:
1138 return selectExtInst(ResVReg, ResType, I, CL::pow, GL::Pow);
1139 case TargetOpcode::G_FPOWI:
1140 return selectFpowi(ResVReg, ResType, I);
1141
1142 case TargetOpcode::G_FEXP:
1143 return selectExtInst(ResVReg, ResType, I, CL::exp, GL::Exp);
1144 case TargetOpcode::G_FEXP2:
1145 return selectExtInst(ResVReg, ResType, I, CL::exp2, GL::Exp2);
1146 case TargetOpcode::G_FEXP10:
1147 return selectExp10(ResVReg, ResType, I);
1148
1149 case TargetOpcode::G_FMODF:
1150 return selectModf(ResVReg, ResType, I);
1151 case TargetOpcode::G_FSINCOS:
1152 return selectSincos(ResVReg, ResType, I);
1153
1154 case TargetOpcode::G_FLOG:
1155 return selectExtInst(ResVReg, ResType, I, CL::log, GL::Log);
1156 case TargetOpcode::G_FLOG2:
1157 return selectExtInst(ResVReg, ResType, I, CL::log2, GL::Log2);
1158 case TargetOpcode::G_FLOG10:
1159 return selectLog10(ResVReg, ResType, I);
1160
1161 case TargetOpcode::G_FABS:
1162 return selectExtInst(ResVReg, ResType, I, CL::fabs, GL::FAbs);
1163 case TargetOpcode::G_ABS:
1164 return selectExtInst(ResVReg, ResType, I, CL::s_abs, GL::SAbs);
1165
1166 case TargetOpcode::G_FMINNUM:
1167 case TargetOpcode::G_FMINIMUM:
1168 return selectExtInst(ResVReg, ResType, I, CL::fmin, GL::NMin);
1169 case TargetOpcode::G_FMAXNUM:
1170 case TargetOpcode::G_FMAXIMUM:
1171 return selectExtInst(ResVReg, ResType, I, CL::fmax, GL::NMax);
1172
1173 case TargetOpcode::G_FCOPYSIGN:
1174 return selectExtInst(ResVReg, ResType, I, CL::copysign);
1175
1176 case TargetOpcode::G_FCEIL:
1177 return selectExtInst(ResVReg, ResType, I, CL::ceil, GL::Ceil);
1178 case TargetOpcode::G_FFLOOR:
1179 return selectExtInst(ResVReg, ResType, I, CL::floor, GL::Floor);
1180
1181 case TargetOpcode::G_FCOS:
1182 return selectExtInst(ResVReg, ResType, I, CL::cos, GL::Cos);
1183 case TargetOpcode::G_FSIN:
1184 return selectExtInst(ResVReg, ResType, I, CL::sin, GL::Sin);
1185 case TargetOpcode::G_FTAN:
1186 return selectExtInst(ResVReg, ResType, I, CL::tan, GL::Tan);
1187 case TargetOpcode::G_FACOS:
1188 return selectExtInst(ResVReg, ResType, I, CL::acos, GL::Acos);
1189 case TargetOpcode::G_FASIN:
1190 return selectExtInst(ResVReg, ResType, I, CL::asin, GL::Asin);
1191 case TargetOpcode::G_FATAN:
1192 return selectExtInst(ResVReg, ResType, I, CL::atan, GL::Atan);
1193 case TargetOpcode::G_FATAN2:
1194 return selectExtInst(ResVReg, ResType, I, CL::atan2, GL::Atan2);
1195 case TargetOpcode::G_FCOSH:
1196 return selectExtInst(ResVReg, ResType, I, CL::cosh, GL::Cosh);
1197 case TargetOpcode::G_FSINH:
1198 return selectExtInst(ResVReg, ResType, I, CL::sinh, GL::Sinh);
1199 case TargetOpcode::G_FTANH:
1200 return selectExtInst(ResVReg, ResType, I, CL::tanh, GL::Tanh);
1201
1202 case TargetOpcode::G_STRICT_FSQRT:
1203 case TargetOpcode::G_FSQRT:
1204 return selectExtInst(ResVReg, ResType, I, CL::sqrt, GL::Sqrt);
1205
1206 case TargetOpcode::G_CTTZ:
1207 case TargetOpcode::G_CTTZ_ZERO_POISON:
1208 return selectExtInst(ResVReg, ResType, I, CL::ctz);
1209 case TargetOpcode::G_CTLZ:
1210 case TargetOpcode::G_CTLZ_ZERO_POISON:
1211 return selectExtInst(ResVReg, ResType, I, CL::clz);
1212
1213 case TargetOpcode::G_INTRINSIC_ROUND:
1214 return selectExtInst(ResVReg, ResType, I, CL::round, GL::Round);
1215 case TargetOpcode::G_INTRINSIC_ROUNDEVEN:
1216 return selectExtInst(ResVReg, ResType, I, CL::rint, GL::RoundEven);
1217 case TargetOpcode::G_INTRINSIC_TRUNC:
1218 return selectExtInst(ResVReg, ResType, I, CL::trunc, GL::Trunc);
1219 case TargetOpcode::G_FRINT:
1220 case TargetOpcode::G_FNEARBYINT:
1221 return selectExtInst(ResVReg, ResType, I, CL::rint, GL::RoundEven);
1222
1223 case TargetOpcode::G_SMULH:
1224 return selectExtInst(ResVReg, ResType, I, CL::s_mul_hi);
1225 case TargetOpcode::G_UMULH:
1226 return selectExtInst(ResVReg, ResType, I, CL::u_mul_hi);
1227
1228 case TargetOpcode::G_SADDSAT:
1229 return selectExtInst(ResVReg, ResType, I, CL::s_add_sat);
1230 case TargetOpcode::G_UADDSAT:
1231 return selectExtInst(ResVReg, ResType, I, CL::u_add_sat);
1232 case TargetOpcode::G_SSUBSAT:
1233 return selectExtInst(ResVReg, ResType, I, CL::s_sub_sat);
1234 case TargetOpcode::G_USUBSAT:
1235 return selectExtInst(ResVReg, ResType, I, CL::u_sub_sat);
1236
1237 case TargetOpcode::G_FFREXP:
1238 return selectFrexp(ResVReg, ResType, I);
1239
1240 case TargetOpcode::G_UADDO:
1241 return selectOverflowArith(ResVReg, ResType, I,
1242 ResType->getOpcode() == SPIRV::OpTypeVector
1243 ? SPIRV::OpIAddCarryV
1244 : SPIRV::OpIAddCarryS);
1245 case TargetOpcode::G_USUBO:
1246 return selectOverflowArith(ResVReg, ResType, I,
1247 ResType->getOpcode() == SPIRV::OpTypeVector
1248 ? SPIRV::OpISubBorrowV
1249 : SPIRV::OpISubBorrowS);
1250 case TargetOpcode::G_UMULO:
1251 return selectOverflowArith(ResVReg, ResType, I, SPIRV::OpUMulExtended);
1252 case TargetOpcode::G_SMULO:
1253 return selectOverflowArith(ResVReg, ResType, I, SPIRV::OpSMulExtended);
1254
1255 case TargetOpcode::G_SEXT:
1256 return selectExt(ResVReg, ResType, I, true);
1257 case TargetOpcode::G_ANYEXT:
1258 case TargetOpcode::G_ZEXT:
1259 return selectExt(ResVReg, ResType, I, false);
1260 case TargetOpcode::G_TRUNC:
1261 return selectTrunc(ResVReg, ResType, I);
1262 case TargetOpcode::G_FPTRUNC:
1263 case TargetOpcode::G_FPEXT:
1264 return selectUnOp(ResVReg, ResType, I, SPIRV::OpFConvert);
1265
1266 case TargetOpcode::G_PTRTOINT:
1267 return selectUnOp(ResVReg, ResType, I, SPIRV::OpConvertPtrToU);
1268 case TargetOpcode::G_INTTOPTR:
1269 return selectUnOp(ResVReg, ResType, I, SPIRV::OpConvertUToPtr);
1270 case TargetOpcode::G_BITCAST:
1271 return selectBitcast(ResVReg, ResType, I);
1272 case TargetOpcode::G_ADDRSPACE_CAST:
1273 return selectAddrSpaceCast(ResVReg, ResType, I);
1274 case TargetOpcode::G_PTRMASK:
1275 return selectPtrMask(ResVReg, ResType, I);
1276 case TargetOpcode::G_PTR_ADD: {
1277 // Currently, we get G_PTR_ADD only applied to global variables.
1278 assert(I.getOperand(1).isReg() && I.getOperand(2).isReg());
1279 Register GV = I.getOperand(1).getReg();
1281 (void)II;
1282 assert(((*II).getOpcode() == TargetOpcode::G_GLOBAL_VALUE ||
1283 (*II).getOpcode() == TargetOpcode::COPY ||
1284 (*II).getOpcode() == SPIRV::OpVariable) &&
1285 getImm(I.getOperand(2), MRI));
1286 // It may be the initialization of a global variable.
1287 bool IsGVInit = false;
1289 UseIt = MRI->use_instr_begin(I.getOperand(0).getReg()),
1290 UseEnd = MRI->use_instr_end();
1291 UseIt != UseEnd; UseIt = std::next(UseIt)) {
1292 if ((*UseIt).getOpcode() == TargetOpcode::G_GLOBAL_VALUE ||
1293 (*UseIt).getOpcode() == SPIRV::OpSpecConstantOp ||
1294 (*UseIt).getOpcode() == SPIRV::OpVariable) {
1295 IsGVInit = true;
1296 break;
1297 }
1298 }
1299 MachineBasicBlock &BB = *I.getParent();
1300 if (!IsGVInit) {
1301 SPIRVTypeInst GVType = GR.getSPIRVTypeForVReg(GV);
1302 SPIRVTypeInst GVPointeeType = GR.getPointeeType(GVType);
1303 SPIRVTypeInst ResPointeeType = GR.getPointeeType(ResType);
1304 if (GVPointeeType && ResPointeeType && GVPointeeType != ResPointeeType) {
1305 // Build a new virtual register that is associated with the required
1306 // data type.
1307 Register NewVReg = MRI->createGenericVirtualRegister(MRI->getType(GV));
1308 MRI->setRegClass(NewVReg, MRI->getRegClass(GV));
1309 // Having a correctly typed base we are ready to build the actually
1310 // required GEP. It may not be a constant though, because all Operands
1311 // of OpSpecConstantOp is to originate from other const instructions,
1312 // and only the AccessChain named opcodes accept a global OpVariable
1313 // instruction. We can't use an AccessChain opcode because of the type
1314 // mismatch between result and base types.
1315 if (!GR.isBitcastCompatible(ResType, GVType))
1316 return diagnoseUnsupported(
1317 I, "incompatible result and operand types in a bitcast");
1318 Register ResTypeReg = GR.getSPIRVTypeID(ResType);
1319 MachineInstrBuilder MIB =
1320 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpBitcast))
1321 .addDef(NewVReg)
1322 .addUse(ResTypeReg)
1323 .addUse(GV);
1324 MIB.constrainAllUses(TII, TRI, RBI);
1325 BuildMI(BB, I, I.getDebugLoc(),
1326 TII.get(STI.isLogicalSPIRV() ? SPIRV::OpInBoundsAccessChain
1327 : SPIRV::OpInBoundsPtrAccessChain))
1328 .addDef(ResVReg)
1329 .addUse(ResTypeReg)
1330 .addUse(NewVReg)
1331 .addUse(I.getOperand(2).getReg())
1332 .constrainAllUses(TII, TRI, RBI);
1333 } else {
1334 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpSpecConstantOp))
1335 .addDef(ResVReg)
1336 .addUse(GR.getSPIRVTypeID(ResType))
1337 .addImm(
1338 static_cast<uint32_t>(SPIRV::Opcode::InBoundsPtrAccessChain))
1339 .addUse(GV)
1340 .addUse(I.getOperand(2).getReg())
1341 .constrainAllUses(TII, TRI, RBI);
1342 }
1343 return true;
1344 }
1345 // It's possible to translate G_PTR_ADD to OpSpecConstantOp: either to
1346 // initialize a global variable with a constant expression (e.g., the test
1347 // case opencl/basic/progvar_prog_scope_init.ll), or for another use case
1348 Register Idx = buildZerosVal(GR.getOrCreateSPIRVIntegerType(32, I, TII), I);
1349 auto MIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpSpecConstantOp))
1350 .addDef(ResVReg)
1351 .addUse(GR.getSPIRVTypeID(ResType))
1352 .addImm(static_cast<uint32_t>(
1353 SPIRV::Opcode::InBoundsPtrAccessChain))
1354 .addUse(GV)
1355 .addUse(Idx)
1356 .addUse(I.getOperand(2).getReg());
1357 MIB.constrainAllUses(TII, TRI, RBI);
1358 return true;
1359 }
1360
1361 case TargetOpcode::G_ATOMICRMW_OR:
1362 return selectAtomicRMW(ResVReg, ResType, I, SPIRV::OpAtomicOr);
1363 case TargetOpcode::G_ATOMICRMW_ADD:
1364 return selectAtomicRMW(ResVReg, ResType, I, SPIRV::OpAtomicIAdd);
1365 case TargetOpcode::G_ATOMICRMW_AND:
1366 return selectAtomicRMW(ResVReg, ResType, I, SPIRV::OpAtomicAnd);
1367 case TargetOpcode::G_ATOMICRMW_MAX:
1368 return selectAtomicRMW(ResVReg, ResType, I, SPIRV::OpAtomicSMax);
1369 case TargetOpcode::G_ATOMICRMW_MIN:
1370 return selectAtomicRMW(ResVReg, ResType, I, SPIRV::OpAtomicSMin);
1371 case TargetOpcode::G_ATOMICRMW_SUB:
1372 return selectAtomicRMW(ResVReg, ResType, I, SPIRV::OpAtomicISub);
1373 case TargetOpcode::G_ATOMICRMW_XOR:
1374 return selectAtomicRMW(ResVReg, ResType, I, SPIRV::OpAtomicXor);
1375 case TargetOpcode::G_ATOMICRMW_UMAX:
1376 return selectAtomicRMW(ResVReg, ResType, I, SPIRV::OpAtomicUMax);
1377 case TargetOpcode::G_ATOMICRMW_UMIN:
1378 return selectAtomicRMW(ResVReg, ResType, I, SPIRV::OpAtomicUMin);
1379 case TargetOpcode::G_ATOMICRMW_XCHG:
1380 return selectAtomicRMW(ResVReg, ResType, I, SPIRV::OpAtomicExchange);
1381
1382 case TargetOpcode::G_ATOMICRMW_FADD:
1383 return selectAtomicRMW(ResVReg, ResType, I, SPIRV::OpAtomicFAddEXT);
1384 case TargetOpcode::G_ATOMICRMW_FSUB:
1385 // Translate G_ATOMICRMW_FSUB to OpAtomicFAddEXT with negative value operand
1386 return selectAtomicRMW(ResVReg, ResType, I, SPIRV::OpAtomicFAddEXT,
1387 ResType->getOpcode() == SPIRV::OpTypeVector
1388 ? SPIRV::OpFNegateV
1389 : SPIRV::OpFNegate);
1390 case TargetOpcode::G_ATOMICRMW_FMIN:
1391 return selectAtomicRMW(ResVReg, ResType, I, SPIRV::OpAtomicFMinEXT);
1392 case TargetOpcode::G_ATOMICRMW_FMAX:
1393 return selectAtomicRMW(ResVReg, ResType, I, SPIRV::OpAtomicFMaxEXT);
1394
1395 case TargetOpcode::G_FENCE:
1396 return selectFence(I);
1397
1398 case TargetOpcode::G_STACKSAVE:
1399 return selectStackSave(ResVReg, ResType, I);
1400 case TargetOpcode::G_STACKRESTORE:
1401 return selectStackRestore(I);
1402
1403 case TargetOpcode::G_UNMERGE_VALUES:
1404 return selectUnmergeValues(I);
1405
1406 case TargetOpcode::G_TRAP:
1407 case TargetOpcode::G_UBSANTRAP:
1408 return selectTrap(I);
1409
1410 // Discard gen opcodes for intrinsics which we do not expect to actually
1411 // represent code after lowering or intrinsics which are not implemented but
1412 // should not crash when found in a customer's LLVM IR input.
1413 case TargetOpcode::DBG_LABEL:
1414 return true;
1415 case TargetOpcode::G_DEBUGTRAP:
1416 return selectDebugTrap(ResVReg, ResType, I);
1417
1418 default:
1419 return false;
1420 }
1421}
1422
1423bool SPIRVInstructionSelector::selectDebugTrap(Register ResVReg,
1424 SPIRVTypeInst ResType,
1425 MachineInstr &I) const {
1426 unsigned Opcode = SPIRV::OpNop;
1427 MachineBasicBlock &BB = *I.getParent();
1428 BuildMI(BB, I, I.getDebugLoc(), TII.get(Opcode))
1429 .constrainAllUses(TII, TRI, RBI);
1430 return true;
1431}
1432
1433bool SPIRVInstructionSelector::selectExtInst(Register ResVReg,
1434 SPIRVTypeInst ResType,
1435 MachineInstr &I,
1436 GL::GLSLExtInst GLInst,
1437 bool setMIFlags, bool useMISrc,
1438 ArrayRef<Register> SrcRegs) const {
1439 if (!STI.canUseExtInstSet(
1440 SPIRV::InstructionSet::InstructionSet::GLSL_std_450))
1441 return diagnoseUnsupported(
1442 I,
1443 "this instruction is only supported with the GLSL extended instruction "
1444 "set.");
1445 return selectExtInst(ResVReg, ResType, I,
1446 {{SPIRV::InstructionSet::GLSL_std_450, GLInst}},
1447 setMIFlags, useMISrc, SrcRegs);
1448}
1449
1450bool SPIRVInstructionSelector::selectExtInst(Register ResVReg,
1451 SPIRVTypeInst ResType,
1452 MachineInstr &I,
1453 CL::OpenCLExtInst CLInst,
1454 bool setMIFlags, bool useMISrc,
1455 ArrayRef<Register> SrcRegs) const {
1456 return selectExtInst(ResVReg, ResType, I,
1457 {{SPIRV::InstructionSet::OpenCL_std, CLInst}},
1458 setMIFlags, useMISrc, SrcRegs);
1459}
1460
1461bool SPIRVInstructionSelector::selectExtInst(
1462 Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I,
1463 CL::OpenCLExtInst CLInst, GL::GLSLExtInst GLInst, bool setMIFlags,
1464 bool useMISrc, ArrayRef<Register> SrcRegs) const {
1465 ExtInstList ExtInsts = {{SPIRV::InstructionSet::OpenCL_std, CLInst},
1466 {SPIRV::InstructionSet::GLSL_std_450, GLInst}};
1467 return selectExtInst(ResVReg, ResType, I, ExtInsts, setMIFlags, useMISrc,
1468 SrcRegs);
1469}
1470
1471bool SPIRVInstructionSelector::selectExtInst(Register ResVReg,
1472 SPIRVTypeInst ResType,
1473 MachineInstr &I,
1474 const ExtInstList &Insts,
1475 bool setMIFlags, bool useMISrc,
1476 ArrayRef<Register> SrcRegs) const {
1477
1478 for (const auto &[InstructionSet, Opcode] : Insts) {
1479 if (!STI.canUseExtInstSet(InstructionSet))
1480 continue;
1481 MachineBasicBlock &BB = *I.getParent();
1482 auto MIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpExtInst))
1483 .addDef(ResVReg)
1484 .addUse(GR.getSPIRVTypeID(ResType))
1485 .addImm(static_cast<uint32_t>(InstructionSet))
1486 .addImm(Opcode);
1487 if (setMIFlags)
1488 MIB.setMIFlags(I.getFlags());
1489 if (useMISrc) {
1490 const unsigned NumOps = I.getNumOperands();
1491 unsigned Index = 1;
1492 if (Index < NumOps &&
1493 I.getOperand(Index).getType() ==
1494 MachineOperand::MachineOperandType::MO_IntrinsicID)
1495 Index = 2;
1496 for (; Index < NumOps; ++Index)
1497 MIB.add(I.getOperand(Index));
1498 } else {
1499 for (Register SReg : SrcRegs) {
1500 MIB.addUse(SReg);
1501 }
1502 }
1503 MIB.constrainAllUses(TII, TRI, RBI);
1504 return true;
1505 }
1506 return false;
1507}
1508
1509bool SPIRVInstructionSelector::selectFrexp(Register ResVReg,
1510 SPIRVTypeInst ResType,
1511 MachineInstr &I) const {
1512 ExtInstList ExtInsts = {{SPIRV::InstructionSet::OpenCL_std, CL::frexp},
1513 {SPIRV::InstructionSet::GLSL_std_450, GL::Frexp}};
1514 for (const auto &Ex : ExtInsts) {
1515 SPIRV::InstructionSet::InstructionSet Set = Ex.first;
1516 uint32_t Opcode = Ex.second;
1517 if (!STI.canUseExtInstSet(Set))
1518 continue;
1519
1520 MachineIRBuilder MIRBuilder(I);
1521 SPIRVTypeInst PointeeTy = GR.getSPIRVTypeForVReg(I.getOperand(1).getReg());
1522 const SPIRVTypeInst PointerType = GR.getOrCreateSPIRVPointerType(
1523 PointeeTy, MIRBuilder, SPIRV::StorageClass::Function);
1524 Register PointerVReg =
1525 createVirtualRegister(PointerType, &GR, MRI, MRI->getMF());
1526
1527 auto It = getOpVariableMBBIt(*I.getMF());
1528 BuildMI(*It->getParent(), It, It->getDebugLoc(), TII.get(SPIRV::OpVariable))
1529 .addDef(PointerVReg)
1530 .addUse(GR.getSPIRVTypeID(PointerType))
1531 .addImm(static_cast<uint32_t>(SPIRV::StorageClass::Function))
1532 .constrainAllUses(TII, TRI, RBI);
1533
1534 SPIRVTypeInst MantissaTy = GR.getSPIRVTypeForVReg(I.getOperand(2).getReg());
1535 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpExtInst))
1536 .addDef(ResVReg)
1537 .addUse(GR.getSPIRVTypeID(MantissaTy))
1538 .addImm(static_cast<uint32_t>(Ex.first))
1539 .addImm(Opcode)
1540 .add(I.getOperand(2))
1541 .addUse(PointerVReg)
1542 .constrainAllUses(TII, TRI, RBI);
1543
1544 Register ExpResReg = I.getOperand(1).getReg();
1545 if (!MRI->use_nodbg_empty(ExpResReg))
1546 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpLoad))
1547 .addDef(ExpResReg)
1548 .addUse(GR.getSPIRVTypeID(PointeeTy))
1549 .addUse(PointerVReg)
1550 .constrainAllUses(TII, TRI, RBI);
1551 return true;
1552 }
1553 return false;
1554}
1555
1556bool SPIRVInstructionSelector::selectSincos(Register ResVReg,
1557 SPIRVTypeInst ResType,
1558 MachineInstr &I) const {
1559 Register CosResVReg = I.getOperand(1).getReg();
1560 unsigned SrcIdx = I.getNumExplicitDefs();
1561 Register ResTypeReg = GR.getSPIRVTypeID(ResType);
1562
1563 if (STI.canUseExtInstSet(SPIRV::InstructionSet::OpenCL_std)) {
1564 // OpenCL.std sincos(x, cosval*) -> returns sin(x), writes cos(x) to ptr.
1565 MachineIRBuilder MIRBuilder(I);
1566 const SPIRVTypeInst PointerType = GR.getOrCreateSPIRVPointerType(
1567 ResType, MIRBuilder, SPIRV::StorageClass::Function);
1568 Register PointerVReg =
1569 createVirtualRegister(PointerType, &GR, MRI, MRI->getMF());
1570
1571 auto It = getOpVariableMBBIt(*I.getMF());
1572 BuildMI(*It->getParent(), It, It->getDebugLoc(), TII.get(SPIRV::OpVariable))
1573 .addDef(PointerVReg)
1574 .addUse(GR.getSPIRVTypeID(PointerType))
1575 .addImm(static_cast<uint32_t>(SPIRV::StorageClass::Function))
1576 .constrainAllUses(TII, TRI, RBI);
1577 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpExtInst))
1578 .addDef(ResVReg)
1579 .addUse(ResTypeReg)
1580 .addImm(static_cast<uint32_t>(SPIRV::InstructionSet::OpenCL_std))
1581 .addImm(CL::sincos)
1582 .add(I.getOperand(SrcIdx))
1583 .addUse(PointerVReg)
1584 .constrainAllUses(TII, TRI, RBI);
1585 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpLoad))
1586 .addDef(CosResVReg)
1587 .addUse(ResTypeReg)
1588 .addUse(PointerVReg)
1589 .constrainAllUses(TII, TRI, RBI);
1590 return true;
1591 } else if (STI.canUseExtInstSet(SPIRV::InstructionSet::GLSL_std_450)) {
1592 // GLSL.std.450 has no combined sincos; emit separate Sin and Cos.
1593 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpExtInst))
1594 .addDef(ResVReg)
1595 .addUse(ResTypeReg)
1596 .addImm(static_cast<uint32_t>(SPIRV::InstructionSet::GLSL_std_450))
1597 .addImm(GL::Sin)
1598 .add(I.getOperand(SrcIdx))
1599 .constrainAllUses(TII, TRI, RBI);
1600 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpExtInst))
1601 .addDef(CosResVReg)
1602 .addUse(ResTypeReg)
1603 .addImm(static_cast<uint32_t>(SPIRV::InstructionSet::GLSL_std_450))
1604 .addImm(GL::Cos)
1605 .add(I.getOperand(SrcIdx))
1606 .constrainAllUses(TII, TRI, RBI);
1607 return true;
1608 }
1609 return false;
1610}
1611
1612bool SPIRVInstructionSelector::selectOpWithSrcs(Register ResVReg,
1613 SPIRVTypeInst ResType,
1614 MachineInstr &I,
1615 ArrayRef<Register> Srcs,
1616 unsigned Opcode) const {
1617 auto MIB = BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(Opcode))
1618 .addDef(ResVReg)
1619 .addUse(GR.getSPIRVTypeID(ResType));
1620 for (Register SReg : Srcs) {
1621 MIB.addUse(SReg);
1622 }
1623 MIB.constrainAllUses(TII, TRI, RBI);
1624 return true;
1625}
1626
1627std::optional<SplitParts> SPIRVInstructionSelector::splitEvenOddLanes(
1628 Register PopCountReg, unsigned ComponentCount, MachineInstr &I,
1629 SPIRVTypeInst I32Type) const {
1630 SplitParts Parts;
1631
1632 if (ComponentCount == 1) {
1633 // ---- Scalar path: extract element 1 (high word) and element 0 (low word)
1634 // ----
1635 Parts.IsScalar = true;
1636 Parts.Type = I32Type;
1637 Parts.High = MRI->createVirtualRegister(GR.getRegClass(I32Type));
1638 Parts.Low = MRI->createVirtualRegister(GR.getRegClass(I32Type));
1639
1640 bool ZeroAsNull = !STI.isShader();
1641 Register IdxZero = GR.getOrCreateConstInt(0, I, I32Type, TII, ZeroAsNull);
1642 Register IdxOne = GR.getOrCreateConstInt(1, I, I32Type, TII, ZeroAsNull);
1643
1644 if (!selectOpWithSrcs(Parts.High, I32Type, I, {PopCountReg, IdxOne},
1645 SPIRV::OpVectorExtractDynamic))
1646 return std::nullopt;
1647
1648 if (!selectOpWithSrcs(Parts.Low, I32Type, I, {PopCountReg, IdxZero},
1649 SPIRV::OpVectorExtractDynamic))
1650 return std::nullopt;
1651
1652 } else {
1653 // ---- Vector path: shuffle odd lanes → High, even lanes → Low ----
1654 MachineIRBuilder MIRBuilder(I);
1655 Parts.IsScalar = false;
1656 Parts.Type = GR.getOrCreateSPIRVVectorType(I32Type, ComponentCount,
1657 MIRBuilder, /*IsSigned=*/false);
1658 Parts.High = MRI->createVirtualRegister(GR.getRegClass(Parts.Type));
1659 Parts.Low = MRI->createVirtualRegister(GR.getRegClass(Parts.Type));
1660
1661 // High = odd-indexed elements (1, 3, 5, …) — the upper 32-bit halves.
1662 auto MIB = BuildMI(*I.getParent(), I, I.getDebugLoc(),
1663 TII.get(SPIRV::OpVectorShuffle))
1664 .addDef(Parts.High)
1665 .addUse(GR.getSPIRVTypeID(Parts.Type))
1666 .addUse(PopCountReg)
1667 .addUse(PopCountReg);
1668 for (unsigned J = 1; J < ComponentCount * 2; J += 2)
1669 MIB.addImm(J);
1670 MIB.constrainAllUses(TII, TRI, RBI);
1671
1672 // Low = even-indexed elements (0, 2, 4, …) — the lower 32-bit halves.
1673 MIB = BuildMI(*I.getParent(), I, I.getDebugLoc(),
1674 TII.get(SPIRV::OpVectorShuffle))
1675 .addDef(Parts.Low)
1676 .addUse(GR.getSPIRVTypeID(Parts.Type))
1677 .addUse(PopCountReg)
1678 .addUse(PopCountReg);
1679 for (unsigned J = 0; J < ComponentCount * 2; J += 2)
1680 MIB.addImm(J);
1681 MIB.constrainAllUses(TII, TRI, RBI);
1682 }
1683
1684 return Parts;
1685}
1686
1687bool SPIRVInstructionSelector::selectPopCount16(Register ResVReg,
1688 SPIRVTypeInst ResType,
1689 MachineInstr &I,
1690 unsigned ExtOpcode,
1691 unsigned Opcode) const {
1692 Register OpReg = I.getOperand(1).getReg();
1693 unsigned NumElems = GR.getScalarOrVectorComponentCount(OpReg);
1694
1695 MachineIRBuilder MIRBuilder(I);
1696 SPIRVTypeInst I32Type = GR.getOrCreateSPIRVIntegerType(32, MIRBuilder);
1697 SPIRVTypeInst I32VectorType =
1698 GR.getOrCreateSPIRVVectorType(I32Type, NumElems, MIRBuilder, false);
1699
1700 bool IsVector = NumElems > 1;
1701 SPIRVTypeInst ExtType = IsVector ? I32VectorType : I32Type;
1702 Register ExtReg = MRI->createVirtualRegister(GR.getRegClass(ExtType));
1703 // Always use OpUConvert to always use a 0 extend
1704 if (!selectOpWithSrcs(ExtReg, ExtType, I, {OpReg}, SPIRV::OpUConvert))
1705 return false;
1706
1707 Register PopCountReg = MRI->createVirtualRegister(GR.getRegClass(ExtType));
1708 if (!selectPopCount32(PopCountReg, ExtType, I, ExtReg, Opcode))
1709 return false;
1710
1711 return selectOpWithSrcs(ResVReg, ResType, I, {PopCountReg}, ExtOpcode);
1712}
1713
1714bool SPIRVInstructionSelector::selectPopCount32(Register ResVReg,
1715 SPIRVTypeInst ResType,
1716 MachineInstr &I,
1717 Register SrcReg,
1718 unsigned Opcode) const {
1719 return selectOpWithSrcs(ResVReg, ResType, I, {SrcReg}, Opcode);
1720}
1721
1722bool SPIRVInstructionSelector::selectPopCount64(Register ResVReg,
1723 SPIRVTypeInst ResType,
1724 MachineInstr &I,
1725 Register SrcReg,
1726 unsigned Opcode) const {
1727 unsigned ComponentCount = GR.getScalarOrVectorComponentCount(ResType);
1728 if (ComponentCount > 2)
1729 return handle64BitOverflow(
1730 ResVReg, ResType, I, SrcReg, Opcode,
1731 [this](Register R, SPIRVTypeInst T, MachineInstr &I, Register S,
1732 unsigned O) { return this->selectPopCount64(R, T, I, S, O); });
1733
1734 MachineIRBuilder MIRBuilder(I);
1735
1736 // ---- Types ----
1737 SPIRVTypeInst I32Type = GR.getOrCreateSPIRVIntegerType(32, MIRBuilder);
1738 SPIRVTypeInst VecI32Type = GR.getOrCreateSPIRVVectorType(
1739 I32Type, 2 * ComponentCount, MIRBuilder, /*IsSigned=*/false);
1740
1741 // Converts 64 bit into and array of 32 bit, containing 2 elements.
1742 Register Vec32 = MRI->createVirtualRegister(GR.getRegClass(VecI32Type));
1743 if (!selectOpWithSrcs(Vec32, VecI32Type, I, {SrcReg}, SPIRV::OpBitcast))
1744 return false;
1745
1746 // Apply popcount on each 32 bit lane
1747 Register Pop32 = MRI->createVirtualRegister(GR.getRegClass(VecI32Type));
1748 if (!selectPopCount32(Pop32, VecI32Type, I, Vec32, Opcode))
1749 return false;
1750
1751 // Splits result into highbit lane and lowbit lane
1752 auto MaybeParts = splitEvenOddLanes(Pop32, ComponentCount, I, I32Type);
1753 if (!MaybeParts)
1754 return false;
1755 SplitParts &Parts = *MaybeParts;
1756
1757 // Sum high part and low part
1758 unsigned OpAdd = Parts.IsScalar ? SPIRV::OpIAddS : SPIRV::OpIAddV;
1759 Register Sum = MRI->createVirtualRegister(GR.getRegClass(Parts.Type));
1760 if (!selectOpWithSrcs(Sum, Parts.Type, I, {Parts.High, Parts.Low}, OpAdd))
1761 return false;
1762
1763 // Convert 32 bit sum into 64 bit scalar
1764 bool IsSigned = GR.isScalarOrVectorSigned(ResType);
1765 unsigned ConvOp = IsSigned ? SPIRV::OpSConvert : SPIRV::OpUConvert;
1766 return selectOpWithSrcs(ResVReg, ResType, I, {Sum}, ConvOp);
1767}
1768
1769bool SPIRVInstructionSelector::selectPopCount(Register ResVReg,
1770 SPIRVTypeInst ResType,
1771 MachineInstr &I,
1772 unsigned Opcode) const {
1773 // Vulkan restricts OpBitCount to 32-bit integers or vectors of 32-bit
1774 // integers unless VK_KHR_maintenance9 is enabled. Until VK_KHR_maintenance9
1775 // is core we will not generate OpBitCount with any other types when
1776 // targeting Vulkan.
1777 if (!STI.getTargetTriple().isVulkanOS())
1778 return selectUnOp(ResVReg, ResType, I, Opcode);
1779
1780 Register OpReg = I.getOperand(1).getReg();
1781 SPIRVTypeInst OpType = GR.getSPIRVTypeForVReg(OpReg);
1782 unsigned ExtOpcode = GR.isScalarOrVectorSigned(ResType) ? SPIRV::OpSConvert
1783 : SPIRV::OpUConvert;
1784 switch (GR.getScalarOrVectorBitWidth(OpType)) {
1785 case 8:
1786 case 16:
1787 return selectPopCount16(ResVReg, ResType, I, ExtOpcode, Opcode);
1788 case 32:
1789 return selectPopCount32(ResVReg, ResType, I, OpReg, Opcode);
1790 case 64:
1791 return selectPopCount64(ResVReg, ResType, I, OpReg, Opcode);
1792 default:
1793 return diagnoseUnsupported(I, "unsupported operand bit width for popcount");
1794 }
1795}
1796
1797bool SPIRVInstructionSelector::selectUnOp(Register ResVReg,
1798 SPIRVTypeInst ResType,
1799 MachineInstr &I,
1800 unsigned Opcode) const {
1801 if (STI.isPhysicalSPIRV() && I.getOperand(1).isReg()) {
1802 Register SrcReg = I.getOperand(1).getReg();
1803 bool IsGV = false;
1805 MRI->def_instr_begin(SrcReg);
1806 DefIt != MRI->def_instr_end(); DefIt = std::next(DefIt)) {
1807 unsigned DefOpCode = DefIt->getOpcode();
1808 if (DefOpCode == SPIRV::ASSIGN_TYPE || DefOpCode == TargetOpcode::COPY) {
1809 // We need special handling to look through the type assignment or the
1810 // COPY pseudo-op and see if this is a constant or a global.
1811 if (auto *VRD = getVRegDef(*MRI, DefIt->getOperand(1).getReg()))
1812 DefOpCode = VRD->getOpcode();
1813 }
1814 if (DefOpCode == TargetOpcode::G_GLOBAL_VALUE ||
1815 DefOpCode == TargetOpcode::G_CONSTANT ||
1816 DefOpCode == SPIRV::OpVariable || DefOpCode == SPIRV::OpConstantI) {
1817 IsGV = true;
1818 break;
1819 }
1820 }
1821 if (IsGV) {
1822 uint32_t SpecOpcode = 0;
1823 switch (Opcode) {
1824 case SPIRV::OpConvertPtrToU:
1825 SpecOpcode = static_cast<uint32_t>(SPIRV::Opcode::ConvertPtrToU);
1826 break;
1827 case SPIRV::OpConvertUToPtr:
1828 SpecOpcode = static_cast<uint32_t>(SPIRV::Opcode::ConvertUToPtr);
1829 break;
1830 }
1831 if (SpecOpcode) {
1832 BuildMI(*I.getParent(), I, I.getDebugLoc(),
1833 TII.get(SPIRV::OpSpecConstantOp))
1834 .addDef(ResVReg)
1835 .addUse(GR.getSPIRVTypeID(ResType))
1836 .addImm(SpecOpcode)
1837 .addUse(SrcReg)
1838 .constrainAllUses(TII, TRI, RBI);
1839 return true;
1840 }
1841 }
1842 }
1843 return selectOpWithSrcs(ResVReg, ResType, I, {I.getOperand(1).getReg()},
1844 Opcode);
1845}
1846
1847bool SPIRVInstructionSelector::selectBitcast(Register ResVReg,
1848 SPIRVTypeInst ResType,
1849 MachineInstr &I) const {
1850 Register OpReg = I.getOperand(1).getReg();
1851 SPIRVTypeInst OpType =
1852 OpReg.isValid() ? GR.getSPIRVTypeForVReg(OpReg) : nullptr;
1853 if (!GR.isBitcastCompatible(ResType, OpType))
1854 return diagnoseUnsupported(
1855 I, "incompatible result and operand types in a bitcast");
1856 return selectUnOp(ResVReg, ResType, I, SPIRV::OpBitcast);
1857}
1858
1861 MachineIRBuilder &MIRBuilder,
1862 SPIRVGlobalRegistry &GR) {
1863 const SPIRVSubtarget *ST =
1864 static_cast<const SPIRVSubtarget *>(&MIRBuilder.getMF().getSubtarget());
1865 uint32_t SpvMemOp = static_cast<uint32_t>(SPIRV::MemoryOperand::None);
1866 if (MemOp->isVolatile())
1867 SpvMemOp |= static_cast<uint32_t>(SPIRV::MemoryOperand::Volatile);
1868 if (MemOp->isNonTemporal())
1869 SpvMemOp |= static_cast<uint32_t>(SPIRV::MemoryOperand::Nontemporal);
1870 // Aligned memory operand requires the Kernel capability.
1871 if (!ST->isShader() && MemOp->getAlign().value())
1872 SpvMemOp |= static_cast<uint32_t>(SPIRV::MemoryOperand::Aligned);
1873
1874 [[maybe_unused]] MachineInstr *AliasList = nullptr;
1875 [[maybe_unused]] MachineInstr *NoAliasList = nullptr;
1876 if (ST->canUseExtension(SPIRV::Extension::SPV_INTEL_memory_access_aliasing)) {
1877 if (auto *MD = MemOp->getAAInfo().Scope) {
1878 AliasList = GR.getOrAddMemAliasingINTELInst(MIRBuilder, MD);
1879 if (AliasList)
1880 SpvMemOp |=
1881 static_cast<uint32_t>(SPIRV::MemoryOperand::AliasScopeINTELMask);
1882 }
1883 if (auto *MD = MemOp->getAAInfo().NoAlias) {
1884 NoAliasList = GR.getOrAddMemAliasingINTELInst(MIRBuilder, MD);
1885 if (NoAliasList)
1886 SpvMemOp |=
1887 static_cast<uint32_t>(SPIRV::MemoryOperand::NoAliasINTELMask);
1888 }
1889 }
1890
1891 if (SpvMemOp != static_cast<uint32_t>(SPIRV::MemoryOperand::None)) {
1892 MIB.addImm(SpvMemOp);
1893 if (SpvMemOp & static_cast<uint32_t>(SPIRV::MemoryOperand::Aligned))
1894 MIB.addImm(MemOp->getAlign().value());
1895 if (AliasList)
1896 MIB.addUse(AliasList->getOperand(0).getReg());
1897 if (NoAliasList)
1898 MIB.addUse(NoAliasList->getOperand(0).getReg());
1899 }
1900}
1901
1903 uint32_t SpvMemOp = static_cast<uint32_t>(SPIRV::MemoryOperand::None);
1905 SpvMemOp |= static_cast<uint32_t>(SPIRV::MemoryOperand::Volatile);
1907 SpvMemOp |= static_cast<uint32_t>(SPIRV::MemoryOperand::Nontemporal);
1908
1909 if (SpvMemOp != static_cast<uint32_t>(SPIRV::MemoryOperand::None))
1910 MIB.addImm(SpvMemOp);
1911}
1912
1913bool SPIRVInstructionSelector::selectLoad(Register ResVReg,
1914 SPIRVTypeInst ResType,
1915 MachineInstr &I) const {
1916 unsigned OpOffset = isa<GIntrinsic>(I) ? 1 : 0;
1917 Register Ptr = I.getOperand(1 + OpOffset).getReg();
1918
1919 auto *PtrDef = getVRegDef(*MRI, Ptr);
1920 auto *IntPtrDef = dyn_cast<GIntrinsic>(PtrDef);
1921 if (IntPtrDef &&
1922 (IntPtrDef->getIntrinsicID() == Intrinsic::spv_resource_getbasepointer ||
1923 IntPtrDef->getIntrinsicID() == Intrinsic::spv_resource_getpointer)) {
1924
1925 Register HandleReg = IntPtrDef->getOperand(2).getReg();
1926 SPIRVTypeInst HandleType = GR.getSPIRVTypeForVReg(HandleReg);
1927 if (HandleType->getOpcode() == SPIRV::OpTypeImage) {
1928 Register NewHandleReg =
1929 MRI->createVirtualRegister(MRI->getRegClass(HandleReg));
1930 auto *HandleDef = cast<GIntrinsic>(getVRegDef(*MRI, HandleReg));
1931 if (!loadHandleBeforePosition(NewHandleReg, HandleType, *HandleDef, I)) {
1932 return false;
1933 }
1934
1935 Register IdxReg = IntPtrDef->getOperand(3).getReg();
1936 return generateImageReadOrFetch(ResVReg, ResType, NewHandleReg, IdxReg,
1937 I.getDebugLoc(), I);
1938 }
1939 }
1940
1941 MachineIRBuilder MIRBuilder(I);
1942
1943 if (I.getNumMemOperands()) {
1944 const MachineMemOperand *MemOp = *I.memoperands_begin();
1945 if (MemOp->isAtomic())
1946 return selectAtomicLoad(ResVReg, ResType, I);
1947 }
1948
1949 auto MIB = MIRBuilder.buildInstr(SPIRV::OpLoad)
1950 .addDef(ResVReg)
1951 .addUse(GR.getSPIRVTypeID(ResType))
1952 .addUse(Ptr);
1953 if (!I.getNumMemOperands()) {
1954 assert(I.getOpcode() == TargetOpcode::G_INTRINSIC_W_SIDE_EFFECTS ||
1955 I.getOpcode() ==
1956 TargetOpcode::G_INTRINSIC_CONVERGENT_W_SIDE_EFFECTS);
1957 addMemoryOperands(I.getOperand(2 + OpOffset).getImm(), MIB);
1958 } else {
1959 addMemoryOperands(*I.memoperands_begin(), MIB, MIRBuilder, GR);
1960 }
1961 MIB.constrainAllUses(TII, TRI, RBI);
1962 return true;
1963}
1964
1965bool SPIRVInstructionSelector::selectAtomicLoad(Register ResVReg,
1966 SPIRVTypeInst ResType,
1967 MachineInstr &I) const {
1968 LLVMContext &Context = I.getMF()->getFunction().getContext();
1969
1970 unsigned OpOffset = isa<GIntrinsic>(I) ? 1 : 0;
1971 Register Ptr = I.getOperand(1 + OpOffset).getReg();
1972
1973 if (!ResType.isTypeIntOrFloat() && !ResType.isTypePtr())
1974 return diagnoseUnsupported(
1975 I, "Lowering to SPIR-V of atomic load is only "
1976 "allowed for integer, floating point or pointer types");
1977
1978 assert(I.getNumMemOperands());
1979 const MachineMemOperand &MemOp = **I.memoperands_begin();
1980 assert(MemOp.isAtomic());
1981
1982 uint32_t Scope =
1983 static_cast<uint32_t>(getMemScope(Context, MemOp.getSyncScopeID()));
1984 Register ScopeReg = buildI32Constant(Scope, I);
1985
1986 AtomicOrdering AO = MemOp.getSuccessOrdering();
1987 uint32_t StorageClass = static_cast<uint32_t>(getMemSemanticsForStorageClass(
1988 addressSpaceToStorageClass(MemOp.getAddrSpace(), STI)));
1989 uint32_t MemSem = static_cast<uint32_t>(getMemSemantics(AO));
1990 if (MemOp.isVolatile() && STI.getTargetTriple().isVulkanOS())
1991 MemSem |= static_cast<uint32_t>(SPIRV::MemorySemantics::Volatile);
1992 Register MemSemReg = buildI32Constant(MemSem | StorageClass, I);
1993
1994 MachineIRBuilder MIRBuilder(I);
1995
1996 if (ResType.isTypePtr()) {
1997 if (!STI.isPhysicalSPIRV())
1998 return diagnoseUnsupported(
1999 I, "Lowering to SPIR-V of atomic load is only "
2000 "allowed for pointer types for physical addressing model");
2001 // If data to load is a pointer type we bitcast the Ptr parameter to pointer
2002 // to an integer type of the same size as the pointer size and then generate
2003 // OpAtomicLoad the return value of that OpAtomicLoad is an integet that is
2004 // converted back to a pointer type using OpConvertUToPtr.
2005
2006 unsigned PtrSize = GR.getPointerSize();
2007 SPIRVTypeInst PtrAsIntSpirvType =
2008 GR.getOrCreateSPIRVIntegerType(PtrSize, MIRBuilder);
2009 Register PtrToUVal =
2011 MRI->setRegClass(PtrToUVal, GR.getRegClass(PtrAsIntSpirvType));
2012 GR.assignSPIRVTypeToVReg(PtrAsIntSpirvType, PtrToUVal, MIRBuilder.getMF());
2013
2014 Register PtrCastedToMatchValReg =
2016 MRI->setRegClass(PtrCastedToMatchValReg, MRI->getRegClassOrNull(Ptr));
2017 SPIRVTypeInst PtrType = GR.getOrCreateSPIRVPointerType(
2018 PtrAsIntSpirvType, MIRBuilder,
2019 addressSpaceToStorageClass(MemOp.getAddrSpace(), STI));
2020 GR.assignSPIRVTypeToVReg(PtrType, PtrCastedToMatchValReg,
2021 MIRBuilder.getMF());
2022
2023 MIRBuilder.buildInstr(SPIRV::OpBitcast)
2024 .addDef(PtrCastedToMatchValReg)
2025 .addUse(GR.getSPIRVTypeID(PtrType))
2026 .addUse(Ptr)
2027 .constrainAllUses(TII, TRI, RBI);
2028
2029 MIRBuilder.buildInstr(SPIRV::OpAtomicLoad)
2030 .addDef(PtrToUVal)
2031 .addUse(GR.getSPIRVTypeID(PtrAsIntSpirvType))
2032 .addUse(PtrCastedToMatchValReg)
2033 .addUse(ScopeReg)
2034 .addUse(MemSemReg)
2035 .constrainAllUses(TII, TRI, RBI);
2036 MIRBuilder.buildInstr(SPIRV::OpConvertUToPtr)
2037 .addDef(ResVReg)
2038 .addUse(GR.getSPIRVTypeID(ResType))
2039 .addUse(PtrToUVal)
2040 .constrainAllUses(TII, TRI, RBI);
2041 return true;
2042 }
2043 auto AtomicLoad = MIRBuilder.buildInstr(SPIRV::OpAtomicLoad)
2044 .addDef(ResVReg)
2045 .addUse(GR.getSPIRVTypeID(ResType))
2046 .addUse(Ptr)
2047 .addUse(ScopeReg)
2048 .addUse(MemSemReg);
2049 AtomicLoad.constrainAllUses(TII, TRI, RBI);
2050
2051 return true;
2052}
2053
2054bool SPIRVInstructionSelector::selectStore(MachineInstr &I) const {
2055 unsigned OpOffset = isa<GIntrinsic>(I) ? 1 : 0;
2056 Register StoreVal = I.getOperand(0 + OpOffset).getReg();
2057 Register Ptr = I.getOperand(1 + OpOffset).getReg();
2058
2059 auto *PtrDef = getVRegDef(*MRI, Ptr);
2060 auto *IntPtrDef = dyn_cast<GIntrinsic>(PtrDef);
2061 if (IntPtrDef &&
2062 (IntPtrDef->getIntrinsicID() == Intrinsic::spv_resource_getbasepointer ||
2063 IntPtrDef->getIntrinsicID() == Intrinsic::spv_resource_getpointer)) {
2064
2065 Register HandleReg = IntPtrDef->getOperand(2).getReg();
2066 Register NewHandleReg =
2067 MRI->createVirtualRegister(MRI->getRegClass(HandleReg));
2068 auto *HandleDef = cast<GIntrinsic>(getVRegDef(*MRI, HandleReg));
2069 SPIRVTypeInst HandleType = GR.getSPIRVTypeForVReg(HandleReg);
2070 if (!loadHandleBeforePosition(NewHandleReg, HandleType, *HandleDef, I)) {
2071 return false;
2072 }
2073
2074 Register IdxReg = IntPtrDef->getOperand(3).getReg();
2075 if (HandleType->getOpcode() == SPIRV::OpTypeImage) {
2076 auto BMI = BuildMI(*I.getParent(), I, I.getDebugLoc(),
2077 TII.get(SPIRV::OpImageWrite))
2078 .addUse(NewHandleReg)
2079 .addUse(IdxReg)
2080 .addUse(StoreVal);
2081
2082 const llvm::Type *LLVMHandleType = GR.getTypeForSPIRVType(HandleType);
2083 if (sampledTypeIsSignedInteger(LLVMHandleType))
2084 BMI.addImm(0x1000); // SignExtend
2085
2086 BMI.constrainAllUses(TII, TRI, RBI);
2087 return true;
2088 }
2089 }
2090
2091 if (I.getNumMemOperands()) {
2092 const MachineMemOperand *MemOp = *I.memoperands_begin();
2093 if (MemOp->isAtomic())
2094 return selectAtomicStore(I);
2095 }
2096
2097 MachineIRBuilder MIRBuilder(I);
2098 auto MIB = MIRBuilder.buildInstr(SPIRV::OpStore).addUse(Ptr).addUse(StoreVal);
2099 if (!I.getNumMemOperands()) {
2100 assert(I.getOpcode() == TargetOpcode::G_INTRINSIC_W_SIDE_EFFECTS ||
2101 I.getOpcode() ==
2102 TargetOpcode::G_INTRINSIC_CONVERGENT_W_SIDE_EFFECTS);
2103 addMemoryOperands(I.getOperand(2 + OpOffset).getImm(), MIB);
2104 } else {
2105 addMemoryOperands(*I.memoperands_begin(), MIB, MIRBuilder, GR);
2106 }
2107 MIB.constrainAllUses(TII, TRI, RBI);
2108 return true;
2109}
2110
2111bool SPIRVInstructionSelector::selectAtomicStore(MachineInstr &I) const {
2112 LLVMContext &Context = I.getMF()->getFunction().getContext();
2113
2114 unsigned OpOffset = isa<GIntrinsic>(I) ? 1 : 0;
2115 Register StoreVal = I.getOperand(0 + OpOffset).getReg();
2116 Register Ptr = I.getOperand(1 + OpOffset).getReg();
2117
2118 SPIRVTypeInst PtrType = GR.getSPIRVTypeForVReg(Ptr);
2119 SPIRVTypeInst PointeeType = GR.getPointeeType(PtrType);
2120
2121 assert(I.getNumMemOperands());
2122 const MachineMemOperand &MemOp = **I.memoperands_begin();
2123 assert(MemOp.isAtomic());
2124
2125 uint32_t Scope =
2126 static_cast<uint32_t>(getMemScope(Context, MemOp.getSyncScopeID()));
2127 Register ScopeReg = buildI32Constant(Scope, I);
2128
2129 AtomicOrdering AO = MemOp.getSuccessOrdering();
2130 uint32_t StorageClass = static_cast<uint32_t>(getMemSemanticsForStorageClass(
2131 addressSpaceToStorageClass(MemOp.getAddrSpace(), STI)));
2132 uint32_t MemSem = static_cast<uint32_t>(getMemSemantics(AO));
2133 if (MemOp.isVolatile() && STI.getTargetTriple().isVulkanOS())
2134 MemSem |= static_cast<uint32_t>(SPIRV::MemorySemantics::Volatile);
2135 Register MemSemReg = buildI32Constant(MemSem | StorageClass, I);
2136 MachineIRBuilder MIRBuilder(I);
2137
2138 if (PointeeType.isTypePtr()) {
2139 if (!STI.isPhysicalSPIRV())
2140 return diagnoseUnsupported(
2141 I, "Lowering to SPIR-V of atomic store is only "
2142 "allowed for pointer types for physical addressing model");
2143 // If data to store is a pointer type we cast it to an integer type of the
2144 // same size as the pointer size using OpConvertPtrToU, bitcast Ptr
2145 // parameter to pointer to integer type and then generate OpAtomicStore
2146 // with casted values as required by spec.
2147 unsigned PtrSize = GR.getPointerSize();
2148 SPIRVTypeInst PtrAsIntSpirvType =
2149 GR.getOrCreateSPIRVIntegerType(PtrSize, MIRBuilder);
2150
2151 Register PtrToUVal =
2153 MRI->setRegClass(PtrToUVal, GR.getRegClass(PtrAsIntSpirvType));
2154 GR.assignSPIRVTypeToVReg(PtrAsIntSpirvType, PtrToUVal, MIRBuilder.getMF());
2155 MIRBuilder.buildInstr(SPIRV::OpConvertPtrToU)
2156 .addDef(PtrToUVal)
2157 .addUse(GR.getSPIRVTypeID(PtrAsIntSpirvType)) // Result type
2158 .addUse(StoreVal) // Pointer operand
2159 .constrainAllUses(TII, TRI, RBI);
2160
2161 Register PtrCastedToMatchValReg =
2163 MRI->setRegClass(PtrCastedToMatchValReg, MRI->getRegClassOrNull(Ptr));
2164 SPIRVTypeInst PtrType = GR.getOrCreateSPIRVPointerType(
2165 PtrAsIntSpirvType, MIRBuilder,
2166 addressSpaceToStorageClass(MemOp.getAddrSpace(), STI));
2167 GR.assignSPIRVTypeToVReg(PtrType, PtrCastedToMatchValReg,
2168 MIRBuilder.getMF());
2169
2170 MIRBuilder.buildInstr(SPIRV::OpBitcast)
2171 .addDef(PtrCastedToMatchValReg)
2172 .addUse(GR.getSPIRVTypeID(PtrType))
2173 .addUse(Ptr)
2174 .constrainAllUses(TII, TRI, RBI);
2175
2176 StoreVal = PtrToUVal;
2177 Ptr = PtrCastedToMatchValReg;
2178 PointeeType = PtrAsIntSpirvType;
2179 }
2180
2181 if (!PointeeType.isTypeIntOrFloat())
2182 return diagnoseUnsupported(I,
2183 "Lowering to SPIR-V of atomic store is only "
2184 "allowed for integer or floating point types");
2185
2186 auto AtomicStore = MIRBuilder.buildInstr(SPIRV::OpAtomicStore)
2187 .addUse(Ptr)
2188 .addUse(ScopeReg)
2189 .addUse(MemSemReg)
2190 .addUse(StoreVal);
2191 AtomicStore.constrainAllUses(TII, TRI, RBI);
2192
2193 return true;
2194}
2195
2196bool SPIRVInstructionSelector::selectMaskedGather(Register ResVReg,
2197 SPIRVTypeInst ResType,
2198 MachineInstr &I) const {
2199 assert(I.getNumExplicitDefs() == 1 && "Expected single def for gather");
2200 // Operand indices:
2201 // 0: result (def)
2202 // 1: intrinsic ID
2203 // 2: vector of pointers
2204 // 3: alignment (i32 immediate)
2205 // 4: mask (vector of i1)
2206 // 5: passthru/fill value
2207 const Register PtrsReg = I.getOperand(2).getReg();
2208 const uint32_t Alignment = I.getOperand(3).getImm();
2209 const Register MaskReg = I.getOperand(4).getReg();
2210 const Register PassthruReg = I.getOperand(5).getReg();
2211 const Register AlignmentReg = buildI32Constant(Alignment, I);
2212
2213 MachineBasicBlock &BB = *I.getParent();
2214 auto MIB =
2215 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpMaskedGatherINTEL))
2216 .addDef(ResVReg)
2217 .addUse(GR.getSPIRVTypeID(ResType))
2218 .addUse(PtrsReg)
2219 .addUse(AlignmentReg)
2220 .addUse(MaskReg)
2221 .addUse(PassthruReg);
2222 MIB.constrainAllUses(TII, TRI, RBI);
2223 return true;
2224}
2225
2226bool SPIRVInstructionSelector::selectMaskedScatter(MachineInstr &I) const {
2227 assert(I.getNumExplicitDefs() == 0 && "Expected no defs for scatter");
2228 // Operand indices (no explicit defs):
2229 // 0: intrinsic ID
2230 // 1: value vector
2231 // 2: vector of pointers
2232 // 3: alignment (i32 immediate)
2233 // 4: mask (vector of i1)
2234 const Register ValuesReg = I.getOperand(1).getReg();
2235 const Register PtrsReg = I.getOperand(2).getReg();
2236 const uint32_t Alignment = I.getOperand(3).getImm();
2237 const Register MaskReg = I.getOperand(4).getReg();
2238 const Register AlignmentReg = buildI32Constant(Alignment, I);
2239 MachineBasicBlock &BB = *I.getParent();
2240
2241 auto MIB =
2242 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpMaskedScatterINTEL))
2243 .addUse(PtrsReg)
2244 .addUse(AlignmentReg)
2245 .addUse(MaskReg)
2246 .addUse(ValuesReg);
2247 MIB.constrainAllUses(TII, TRI, RBI);
2248 return true;
2249}
2250
2251bool SPIRVInstructionSelector::diagnoseUnsupported(const MachineInstr &I,
2252 const Twine &Msg) const {
2253 const Function &F = I.getMF()->getFunction();
2254 F.getContext().diagnose(
2255 DiagnosticInfoUnsupported(F, Msg, I.getDebugLoc(), DS_Error));
2256 return false;
2257}
2258
2259bool SPIRVInstructionSelector::selectStackSave(Register ResVReg,
2260 SPIRVTypeInst ResType,
2261 MachineInstr &I) const {
2262 if (!STI.canUseExtension(SPIRV::Extension::SPV_INTEL_variable_length_array))
2263 return diagnoseUnsupported(
2264 I, "llvm.stacksave intrinsic: this instruction requires the following "
2265 "SPIR-V extension: SPV_INTEL_variable_length_array");
2266 MachineBasicBlock &BB = *I.getParent();
2267 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpSaveMemoryINTEL))
2268 .addDef(ResVReg)
2269 .addUse(GR.getSPIRVTypeID(ResType))
2270 .constrainAllUses(TII, TRI, RBI);
2271 return true;
2272}
2273
2274bool SPIRVInstructionSelector::selectStackRestore(MachineInstr &I) const {
2275 if (!STI.canUseExtension(SPIRV::Extension::SPV_INTEL_variable_length_array))
2276 return diagnoseUnsupported(
2277 I,
2278 "llvm.stackrestore intrinsic: this instruction requires the following "
2279 "SPIR-V extension: SPV_INTEL_variable_length_array");
2280 if (!I.getOperand(0).isReg())
2281 return false;
2282 MachineBasicBlock &BB = *I.getParent();
2283 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpRestoreMemoryINTEL))
2284 .addUse(I.getOperand(0).getReg())
2285 .constrainAllUses(TII, TRI, RBI);
2286 return true;
2287}
2288
2290SPIRVInstructionSelector::getOrCreateMemSetGlobal(MachineInstr &I) const {
2291 MachineIRBuilder MIRBuilder(I);
2292 assert(I.getOperand(1).isReg() && I.getOperand(2).isReg());
2293
2294 // TODO: check if we have such GV, add init, use buildGlobalVariable.
2295 unsigned Num = getIConstVal(I.getOperand(2).getReg(), MRI);
2296 Function &CurFunction = GR.CurMF->getFunction();
2297 Type *LLVMArrTy =
2298 ArrayType::get(IntegerType::get(CurFunction.getContext(), 8), Num);
2299 GlobalVariable *GV = new GlobalVariable(*CurFunction.getParent(), LLVMArrTy,
2301 Constant::getNullValue(LLVMArrTy));
2302
2303 Type *ValTy = Type::getInt8Ty(I.getMF()->getFunction().getContext());
2304 Type *ArrTy = ArrayType::get(ValTy, Num);
2305 SPIRVTypeInst VarTy = GR.getOrCreateSPIRVPointerType(
2306 ArrTy, MIRBuilder, SPIRV::StorageClass::UniformConstant);
2307
2308 SPIRVTypeInst SpvArrTy = GR.getOrCreateSPIRVType(
2309 ArrTy, MIRBuilder, SPIRV::AccessQualifier::None, false);
2310
2311 unsigned Val = getIConstVal(I.getOperand(1).getReg(), MRI);
2312 Register Const = GR.getOrCreateConstIntArray(Val, Num, I, SpvArrTy, TII);
2313
2315 auto MIBVar =
2316 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpVariable))
2317 .addDef(VarReg)
2318 .addUse(GR.getSPIRVTypeID(VarTy))
2319 .addImm(SPIRV::StorageClass::UniformConstant)
2320 .addUse(Const);
2321 MIBVar.constrainAllUses(TII, TRI, RBI);
2322
2323 GR.add(GV, MIBVar);
2324 GR.addGlobalObject(GV, GR.CurMF, VarReg);
2325
2326 buildOpDecorate(VarReg, I, TII, SPIRV::Decoration::Constant, {});
2327 return VarReg;
2328}
2329
2330bool SPIRVInstructionSelector::selectCopyMemory(MachineInstr &I,
2331 Register SrcReg) const {
2332 MachineBasicBlock &BB = *I.getParent();
2333 Register DstReg = I.getOperand(0).getReg();
2334 SPIRVTypeInst DstTy = GR.getSPIRVTypeForVReg(DstReg);
2335 SPIRVTypeInst SrcTy = GR.getSPIRVTypeForVReg(SrcReg);
2336 if (GR.getPointeeType(DstTy) != GR.getPointeeType(SrcTy))
2337 return diagnoseUnsupported(
2338 I, "OpCopyMemory requires operands to have the same type");
2339 uint64_t CopySize = getIConstVal(I.getOperand(2).getReg(), MRI);
2340 SPIRVTypeInst PointeeTy = GR.getPointeeType(DstTy);
2341 const Type *LLVMPointeeTy = GR.getTypeForSPIRVType(PointeeTy);
2342 if (!LLVMPointeeTy)
2343 return diagnoseUnsupported(
2344 I, "Unable to determine pointee type size for OpCopyMemory");
2345 const DataLayout &DL = I.getMF()->getFunction().getDataLayout();
2346 if (CopySize != DL.getTypeStoreSize(const_cast<Type *>(LLVMPointeeTy)))
2347 return diagnoseUnsupported(
2348 I, "OpCopyMemory requires the size to match the pointee type size");
2349 auto MIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpCopyMemory))
2350 .addUse(DstReg)
2351 .addUse(SrcReg);
2352 if (I.getNumMemOperands()) {
2353 MachineIRBuilder MIRBuilder(I);
2354 addMemoryOperands(*I.memoperands_begin(), MIB, MIRBuilder, GR);
2355 }
2356 MIB.constrainAllUses(TII, TRI, RBI);
2357 return true;
2358}
2359
2360bool SPIRVInstructionSelector::selectCopyMemorySized(MachineInstr &I,
2361 Register SrcReg) const {
2362 MachineBasicBlock &BB = *I.getParent();
2363 auto MIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpCopyMemorySized))
2364 .addUse(I.getOperand(0).getReg())
2365 .addUse(SrcReg)
2366 .addUse(I.getOperand(2).getReg());
2367 if (I.getNumMemOperands()) {
2368 MachineIRBuilder MIRBuilder(I);
2369 addMemoryOperands(*I.memoperands_begin(), MIB, MIRBuilder, GR);
2370 }
2371 MIB.constrainAllUses(TII, TRI, RBI);
2372 return true;
2373}
2374
2375bool SPIRVInstructionSelector::selectMemOperation(Register ResVReg,
2376 MachineInstr &I) const {
2377 // Zero-sized memcpy/memmove/memset are no-ops.
2378 Register SizeReg = I.getOperand(2).getReg();
2379 if (MachineInstr *SizeDef = getDefInstrMaybeConstant(SizeReg, MRI);
2380 SizeDef && SizeDef->getOpcode() == TargetOpcode::G_CONSTANT &&
2381 getIConstVal(SizeReg, MRI) == 0)
2382 return true;
2383
2384 Register SrcReg = I.getOperand(1).getReg();
2385 if (I.getOpcode() == TargetOpcode::G_MEMSET ||
2386 I.getOpcode() == TargetOpcode::G_MEMSET_INLINE) {
2387 Register VarReg = getOrCreateMemSetGlobal(I);
2388 if (!VarReg.isValid())
2389 return false;
2390 Type *ValTy = Type::getInt8Ty(I.getMF()->getFunction().getContext());
2391 SPIRVTypeInst SourceTy = GR.getOrCreateSPIRVPointerType(
2392 ValTy, I, SPIRV::StorageClass::UniformConstant);
2393 SrcReg = MRI->createGenericVirtualRegister(LLT::scalar(64));
2394 if (!selectOpWithSrcs(SrcReg, SourceTy, I, {VarReg}, SPIRV::OpBitcast))
2395 return false;
2396 }
2397 if (STI.isLogicalSPIRV()) {
2398 if (!selectCopyMemory(I, SrcReg))
2399 return false;
2400 } else {
2401 if (!selectCopyMemorySized(I, SrcReg))
2402 return false;
2403 }
2404 if (ResVReg.isValid() && ResVReg != I.getOperand(0).getReg())
2405 if (!BuildCOPY(ResVReg, I.getOperand(0).getReg(), I))
2406 return false;
2407 return true;
2408}
2409
2410bool SPIRVInstructionSelector::selectAtomicRMW(Register ResVReg,
2411 SPIRVTypeInst ResType,
2412 MachineInstr &I,
2413 unsigned NewOpcode,
2414 unsigned NegateOpcode) const {
2415 assert(I.hasOneMemOperand());
2416 const MachineMemOperand *MemOp = *I.memoperands_begin();
2417 uint32_t Scope = static_cast<uint32_t>(getMemScope(
2418 GR.CurMF->getFunction().getContext(), MemOp->getSyncScopeID()));
2419 Register ScopeReg = buildI32Constant(Scope, I);
2420
2421 Register Ptr = I.getOperand(1).getReg();
2422 uint32_t ScSem = static_cast<uint32_t>(
2424 AtomicOrdering AO = MemOp->getSuccessOrdering();
2425 uint32_t MemSem = static_cast<uint32_t>(getMemSemantics(AO)) | ScSem;
2426 Register MemSemReg = buildI32Constant(MemSem, I);
2427
2428 Register ValueReg = I.getOperand(2).getReg();
2429 if (NegateOpcode != 0) {
2430 // Translation with negative value operand is requested
2431 Register TmpReg = createVirtualRegister(ResType, &GR, MRI, MRI->getMF());
2432 if (!selectOpWithSrcs(TmpReg, ResType, I, {ValueReg}, NegateOpcode))
2433 return false;
2434 ValueReg = TmpReg;
2435 }
2436
2437 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(NewOpcode))
2438 .addDef(ResVReg)
2439 .addUse(GR.getSPIRVTypeID(ResType))
2440 .addUse(Ptr)
2441 .addUse(ScopeReg)
2442 .addUse(MemSemReg)
2443 .addUse(ValueReg)
2444 .constrainAllUses(TII, TRI, RBI);
2445 return true;
2446}
2447
2448bool SPIRVInstructionSelector::selectInterlockedAdd(Register ResVReg,
2449 SPIRVTypeInst ResType,
2450 MachineInstr &I) const {
2451 Register Ptr = I.getOperand(2).getReg();
2452 Register Value = I.getOperand(3).getReg();
2453
2454 SPIRV::StorageClass::StorageClass SC = GR.getPointerStorageClass(Ptr);
2455 assert((SC == SPIRV::StorageClass::Workgroup ||
2456 SC == SPIRV::StorageClass::StorageBuffer) &&
2457 "InterlockedAdd requires Workgroup or StorageBuffer storage class");
2458 uint32_t Scope = static_cast<uint32_t>(SC == SPIRV::StorageClass::Workgroup
2459 ? SPIRV::Scope::Workgroup
2460 : SPIRV::Scope::Device);
2461 Register ScopeReg = buildI32Constant(Scope, I);
2462
2463 uint32_t MemSem = static_cast<uint32_t>(getMemSemanticsForStorageClass(SC));
2464 Register MemSemReg = buildI32Constant(MemSem, I);
2465
2466 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpAtomicIAdd))
2467 .addDef(ResVReg)
2468 .addUse(GR.getSPIRVTypeID(ResType))
2469 .addUse(Ptr)
2470 .addUse(ScopeReg)
2471 .addUse(MemSemReg)
2472 .addUse(Value)
2473 .constrainAllUses(TII, TRI, RBI);
2474 return true;
2475}
2476
2477bool SPIRVInstructionSelector::selectUnmergeValues(MachineInstr &I) const {
2478 unsigned ArgI = I.getNumOperands() - 1;
2479 Register SrcReg =
2480 I.getOperand(ArgI).isReg() ? I.getOperand(ArgI).getReg() : Register(0);
2481 SPIRVTypeInst SrcType =
2482 SrcReg.isValid() ? GR.getSPIRVTypeForVReg(SrcReg) : nullptr;
2483 if (!SrcType || SrcType->getOpcode() != SPIRV::OpTypeVector)
2485 "cannot select G_UNMERGE_VALUES with a non-vector argument");
2486
2487 SPIRVTypeInst ScalarType = GR.getScalarOrVectorComponentType(SrcType);
2488 MachineBasicBlock &BB = *I.getParent();
2489 unsigned CurrentIndex = 0;
2490 for (unsigned i = 0; i < I.getNumDefs(); ++i) {
2491 Register ResVReg = I.getOperand(i).getReg();
2492 SPIRVTypeInst ResType = GR.getSPIRVTypeForVReg(ResVReg);
2493 if (!ResType) {
2494 LLT ResLLT = MRI->getType(ResVReg);
2495 assert(ResLLT.isValid());
2496 if (ResLLT.isVector()) {
2497 ResType = GR.getOrCreateSPIRVVectorType(
2498 ScalarType, ResLLT.getNumElements(), I, TII);
2499 } else {
2500 ResType = ScalarType;
2501 }
2502 MRI->setRegClass(ResVReg, GR.getRegClass(ResType));
2503 GR.assignSPIRVTypeToVReg(ResType, ResVReg, *GR.CurMF);
2504 }
2505
2506 if (ResType->getOpcode() == SPIRV::OpTypeVector) {
2507 Register UndefReg = GR.getOrCreateUndef(I, SrcType, TII);
2508 auto MIB =
2509 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpVectorShuffle))
2510 .addDef(ResVReg)
2511 .addUse(GR.getSPIRVTypeID(ResType))
2512 .addUse(SrcReg)
2513 .addUse(UndefReg);
2514 unsigned NumElements = GR.getScalarOrVectorComponentCount(ResType);
2515 for (unsigned j = 0; j < NumElements; ++j) {
2516 MIB.addImm(CurrentIndex + j);
2517 }
2518 CurrentIndex += NumElements;
2519 MIB.constrainAllUses(TII, TRI, RBI);
2520 } else {
2521 auto MIB =
2522 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpCompositeExtract))
2523 .addDef(ResVReg)
2524 .addUse(GR.getSPIRVTypeID(ResType))
2525 .addUse(SrcReg)
2526 .addImm(CurrentIndex);
2527 CurrentIndex++;
2528 MIB.constrainAllUses(TII, TRI, RBI);
2529 }
2530 }
2531 return true;
2532}
2533
2534bool SPIRVInstructionSelector::selectFence(MachineInstr &I) const {
2535 AtomicOrdering AO = AtomicOrdering(I.getOperand(0).getImm());
2536 uint32_t MemSem = static_cast<uint32_t>(getMemSemantics(AO));
2537 Register MemSemReg = buildI32Constant(MemSem, I);
2538 SyncScope::ID Ord = SyncScope::ID(I.getOperand(1).getImm());
2539 uint32_t Scope = static_cast<uint32_t>(
2540 getMemScope(GR.CurMF->getFunction().getContext(), Ord));
2541 Register ScopeReg = buildI32Constant(Scope, I);
2542 MachineBasicBlock &BB = *I.getParent();
2543 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpMemoryBarrier))
2544 .addUse(ScopeReg)
2545 .addUse(MemSemReg)
2546 .constrainAllUses(TII, TRI, RBI);
2547 return true;
2548}
2549
2550bool SPIRVInstructionSelector::selectOverflowArith(Register ResVReg,
2551 SPIRVTypeInst ResType,
2552 MachineInstr &I,
2553 unsigned Opcode) const {
2554 Type *ResTy = nullptr;
2555 StringRef ResName;
2556 if (!GR.findValueAttrs(&I, ResTy, ResName))
2557 return diagnoseUnsupported(
2558 I,
2559 "Not enough info to select the arithmetic with overflow instruction");
2560 if (!ResTy || !ResTy->isStructTy())
2561 return diagnoseUnsupported(I,
2562 "Expect struct type result for the arithmetic "
2563 "with overflow instruction");
2564 // "Result Type must be from OpTypeStruct. The struct must have two members,
2565 // and the two members must be the same type."
2566 Type *ResElemTy = cast<StructType>(ResTy)->getElementType(0);
2567 ResTy = StructType::get(ResElemTy, ResElemTy);
2568 // Build SPIR-V types and constant(s) if needed.
2569 MachineIRBuilder MIRBuilder(I);
2570 SPIRVTypeInst StructType = GR.getOrCreateSPIRVType(
2571 ResTy, MIRBuilder, SPIRV::AccessQualifier::ReadWrite, false);
2572 assert(I.getNumDefs() > 1 && "Not enought operands");
2573 SPIRVTypeInst BoolType = GR.getOrCreateSPIRVBoolType(I, TII);
2574 unsigned N = GR.getScalarOrVectorComponentCount(ResType);
2575 if (N > 1)
2576 BoolType = GR.getOrCreateSPIRVVectorType(BoolType, N, I, TII);
2577 Register BoolTypeReg = GR.getSPIRVTypeID(BoolType);
2578 Register ZeroReg = buildZerosVal(ResType, I);
2579 // A new virtual register to store the result struct.
2580 Register StructVReg = MRI->createGenericVirtualRegister(LLT::scalar(64));
2581 MRI->setRegClass(StructVReg, &SPIRV::IDRegClass);
2582 // Build the result name if needed.
2583 if (ResName.size() > 0)
2584 buildOpName(StructVReg, ResName, MIRBuilder);
2585 // Build the arithmetic with overflow instruction.
2586 MachineBasicBlock &BB = *I.getParent();
2587 auto MIB =
2588 BuildMI(BB, MIRBuilder.getInsertPt(), I.getDebugLoc(), TII.get(Opcode))
2589 .addDef(StructVReg)
2590 .addUse(GR.getSPIRVTypeID(StructType));
2591 for (unsigned i = I.getNumDefs(); i < I.getNumOperands(); ++i)
2592 MIB.addUse(I.getOperand(i).getReg());
2593 MIB.constrainAllUses(TII, TRI, RBI);
2594 // Build instructions to extract fields of the instruction's result.
2595 // A new virtual register to store the higher part of the result struct.
2596 Register HigherVReg = MRI->createGenericVirtualRegister(LLT::scalar(64));
2597 MRI->setRegClass(HigherVReg, &SPIRV::iIDRegClass);
2598 for (unsigned i = 0; i < I.getNumDefs(); ++i) {
2599 auto MIB =
2600 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpCompositeExtract))
2601 .addDef(i == 1 ? HigherVReg : I.getOperand(i).getReg())
2602 .addUse(GR.getSPIRVTypeID(ResType))
2603 .addUse(StructVReg)
2604 .addImm(i);
2605 MIB.constrainAllUses(TII, TRI, RBI);
2606 }
2607 // Build boolean value from the higher part.
2608 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpINotEqual))
2609 .addDef(I.getOperand(1).getReg())
2610 .addUse(BoolTypeReg)
2611 .addUse(HigherVReg)
2612 .addUse(ZeroReg)
2613 .constrainAllUses(TII, TRI, RBI);
2614 return true;
2615}
2616
2617bool SPIRVInstructionSelector::selectAtomicCmpXchg(Register ResVReg,
2618 SPIRVTypeInst ResType,
2619 MachineInstr &I) const {
2621 "selectAtomicCmpXchg only handles the spv_cmpxchg intrinsic");
2622 Register Ptr = I.getOperand(2).getReg();
2623 Register ScopeReg = I.getOperand(5).getReg();
2624 Register MemSemEqReg = I.getOperand(6).getReg();
2625 Register MemSemNeqReg = I.getOperand(7).getReg();
2626 Register Cmp = I.getOperand(3).getReg();
2627 Register Val = I.getOperand(4).getReg();
2628 SPIRVTypeInst SpvValTy = GR.getSPIRVTypeForVReg(Val);
2629 Register ACmpRes = createVirtualRegister(SpvValTy, &GR, MRI, *I.getMF());
2630 const DebugLoc &DL = I.getDebugLoc();
2631 BuildMI(*I.getParent(), I, DL, TII.get(SPIRV::OpAtomicCompareExchange))
2632 .addDef(ACmpRes)
2633 .addUse(GR.getSPIRVTypeID(SpvValTy))
2634 .addUse(Ptr)
2635 .addUse(ScopeReg)
2636 .addUse(MemSemEqReg)
2637 .addUse(MemSemNeqReg)
2638 .addUse(Val)
2639 .addUse(Cmp)
2640 .constrainAllUses(TII, TRI, RBI);
2641 SPIRVTypeInst BoolTy = GR.getOrCreateSPIRVBoolType(I, TII);
2642 Register CmpSuccReg = createVirtualRegister(BoolTy, &GR, MRI, *I.getMF());
2643 BuildMI(*I.getParent(), I, DL, TII.get(SPIRV::OpIEqual))
2644 .addDef(CmpSuccReg)
2645 .addUse(GR.getSPIRVTypeID(BoolTy))
2646 .addUse(ACmpRes)
2647 .addUse(Cmp)
2648 .constrainAllUses(TII, TRI, RBI);
2649 Register TmpReg = createVirtualRegister(ResType, &GR, MRI, *I.getMF());
2650 BuildMI(*I.getParent(), I, DL, TII.get(SPIRV::OpCompositeInsert))
2651 .addDef(TmpReg)
2652 .addUse(GR.getSPIRVTypeID(ResType))
2653 .addUse(ACmpRes)
2654 .addUse(GR.getOrCreateUndef(I, ResType, TII))
2655 .addImm(0)
2656 .constrainAllUses(TII, TRI, RBI);
2657 BuildMI(*I.getParent(), I, DL, TII.get(SPIRV::OpCompositeInsert))
2658 .addDef(ResVReg)
2659 .addUse(GR.getSPIRVTypeID(ResType))
2660 .addUse(CmpSuccReg)
2661 .addUse(TmpReg)
2662 .addImm(1)
2663 .constrainAllUses(TII, TRI, RBI);
2664 return true;
2665}
2666
2667static bool isUSMStorageClass(SPIRV::StorageClass::StorageClass SC) {
2668 switch (SC) {
2669 case SPIRV::StorageClass::DeviceOnlyINTEL:
2670 case SPIRV::StorageClass::HostOnlyINTEL:
2671 return true;
2672 default:
2673 return false;
2674 }
2675}
2676
2677// Returns true ResVReg is referred only from global vars and OpName's.
2678static bool isASCastInGVar(MachineRegisterInfo *MRI, Register ResVReg) {
2679 bool IsGRef = false;
2680 bool IsAllowedRefs =
2681 llvm::all_of(MRI->use_instructions(ResVReg), [&IsGRef](auto const &It) {
2682 unsigned Opcode = It.getOpcode();
2683 if (Opcode == SPIRV::OpConstantComposite ||
2684 Opcode == SPIRV::OpSpecConstantComposite ||
2685 Opcode == SPIRV::OpVariable ||
2686 isSpvIntrinsic(It, Intrinsic::spv_init_global))
2687 return IsGRef = true;
2688 return Opcode == SPIRV::OpName;
2689 });
2690 return IsAllowedRefs && IsGRef;
2691}
2692
2693Register SPIRVInstructionSelector::getUcharPtrTypeReg(
2694 MachineInstr &I, SPIRV::StorageClass::StorageClass SC) const {
2696 Type::getInt8Ty(I.getMF()->getFunction().getContext()), I, SC));
2697}
2698
2699MachineInstrBuilder
2700SPIRVInstructionSelector::buildSpecConstantOp(MachineInstr &I, Register Dest,
2701 Register Src, Register DestType,
2702 uint32_t Opcode) const {
2703 return BuildMI(*I.getParent(), I, I.getDebugLoc(),
2704 TII.get(SPIRV::OpSpecConstantOp))
2705 .addDef(Dest)
2706 .addUse(DestType)
2707 .addImm(Opcode)
2708 .addUse(Src);
2709}
2710
2711MachineInstrBuilder
2712SPIRVInstructionSelector::buildConstGenericPtr(MachineInstr &I, Register SrcPtr,
2713 SPIRVTypeInst SrcPtrTy) const {
2714 SPIRVTypeInst GenericPtrTy =
2715 GR.changePointerStorageClass(SrcPtrTy, SPIRV::StorageClass::Generic, I);
2716 Register Tmp = MRI->createVirtualRegister(&SPIRV::pIDRegClass);
2718 SPIRV::StorageClass::Generic),
2719 GR.getPointerSize()));
2720 MachineFunction *MF = I.getParent()->getParent();
2721 GR.assignSPIRVTypeToVReg(GenericPtrTy, Tmp, *MF);
2722 MachineInstrBuilder MIB = buildSpecConstantOp(
2723 I, Tmp, SrcPtr, GR.getSPIRVTypeID(GenericPtrTy),
2724 static_cast<uint32_t>(SPIRV::Opcode::PtrCastToGeneric));
2725 GR.add(MIB.getInstr(), MIB);
2726 return MIB;
2727}
2728
2729// In SPIR-V address space casting can only happen to and from the Generic
2730// storage class. We can also only cast Workgroup, CrossWorkgroup, or Function
2731// pointers to and from Generic pointers. As such, we can convert e.g. from
2732// Workgroup to Function by going via a Generic pointer as an intermediary. All
2733// other combinations can only be done by a bitcast, and are probably not safe.
2734bool SPIRVInstructionSelector::selectAddrSpaceCast(Register ResVReg,
2735 SPIRVTypeInst ResType,
2736 MachineInstr &I) const {
2737 MachineBasicBlock &BB = *I.getParent();
2738 const DebugLoc &DL = I.getDebugLoc();
2739
2740 Register SrcPtr = I.getOperand(1).getReg();
2741 SPIRVTypeInst SrcPtrTy = GR.getSPIRVTypeForVReg(SrcPtr);
2742
2743 // don't generate a cast for a null that may be represented by OpTypeInt
2744 if (SrcPtrTy->getOpcode() != SPIRV::OpTypePointer ||
2745 ResType->getOpcode() != SPIRV::OpTypePointer)
2746 return BuildCOPY(ResVReg, SrcPtr, I);
2747
2748 SPIRV::StorageClass::StorageClass SrcSC = GR.getPointerStorageClass(SrcPtrTy);
2749 SPIRV::StorageClass::StorageClass DstSC = GR.getPointerStorageClass(ResType);
2750
2751 if (isASCastInGVar(MRI, ResVReg)) {
2752 // AddrSpaceCast uses within OpVariable and OpConstantComposite instructions
2753 // are expressed by OpSpecConstantOp with an Opcode.
2754 // TODO: maybe insert a check whether the Kernel capability was declared and
2755 // so PtrCastToGeneric/GenericCastToPtr are available.
2756 unsigned SpecOpcode =
2757 DstSC == SPIRV::StorageClass::Generic && isGenericCastablePtr(SrcSC)
2758 ? static_cast<uint32_t>(SPIRV::Opcode::PtrCastToGeneric)
2759 : (SrcSC == SPIRV::StorageClass::Generic &&
2761 ? static_cast<uint32_t>(SPIRV::Opcode::GenericCastToPtr)
2762 : 0);
2763 // TODO: OpConstantComposite expects i8*, so we are forced to forget a
2764 // correct value of ResType and use general i8* instead. Maybe this should
2765 // be addressed in the emit-intrinsic step to infer a correct
2766 // OpConstantComposite type.
2767 if (SpecOpcode) {
2768 buildSpecConstantOp(I, ResVReg, SrcPtr, getUcharPtrTypeReg(I, DstSC),
2769 SpecOpcode)
2770 .constrainAllUses(TII, TRI, RBI);
2771 } else if (isGenericCastablePtr(SrcSC) && isGenericCastablePtr(DstSC)) {
2772 MachineInstrBuilder MIB = buildConstGenericPtr(I, SrcPtr, SrcPtrTy);
2773 MIB.constrainAllUses(TII, TRI, RBI);
2774 buildSpecConstantOp(
2775 I, ResVReg, MIB->getOperand(0).getReg(), getUcharPtrTypeReg(I, DstSC),
2776 static_cast<uint32_t>(SPIRV::Opcode::GenericCastToPtr))
2777 .constrainAllUses(TII, TRI, RBI);
2778 }
2779 return true;
2780 }
2781
2782 // don't generate a cast between identical storage classes
2783 if (SrcSC == DstSC)
2784 return BuildCOPY(ResVReg, SrcPtr, I);
2785
2786 if ((SrcSC == SPIRV::StorageClass::Function &&
2787 DstSC == SPIRV::StorageClass::Private) ||
2788 (DstSC == SPIRV::StorageClass::Function &&
2789 SrcSC == SPIRV::StorageClass::Private))
2790 return BuildCOPY(ResVReg, SrcPtr, I);
2791
2792 // Casting from an eligible pointer to Generic.
2793 if (DstSC == SPIRV::StorageClass::Generic && isGenericCastablePtr(SrcSC))
2794 return selectUnOp(ResVReg, ResType, I, SPIRV::OpPtrCastToGeneric);
2795 // Casting from Generic to an eligible pointer.
2796 if (SrcSC == SPIRV::StorageClass::Generic && isGenericCastablePtr(DstSC))
2797 return selectUnOp(ResVReg, ResType, I, SPIRV::OpGenericCastToPtr);
2798 // Casting between 2 eligible pointers using Generic as an intermediary.
2799 if (isGenericCastablePtr(SrcSC) && isGenericCastablePtr(DstSC)) {
2800 SPIRVTypeInst GenericPtrTy =
2801 GR.changePointerStorageClass(SrcPtrTy, SPIRV::StorageClass::Generic, I);
2802 Register Tmp = createVirtualRegister(GenericPtrTy, &GR, MRI, MRI->getMF());
2803 BuildMI(BB, I, DL, TII.get(SPIRV::OpPtrCastToGeneric))
2804 .addDef(Tmp)
2805 .addUse(GR.getSPIRVTypeID(GenericPtrTy))
2806 .addUse(SrcPtr)
2807 .constrainAllUses(TII, TRI, RBI);
2808 BuildMI(BB, I, DL, TII.get(SPIRV::OpGenericCastToPtr))
2809 .addDef(ResVReg)
2810 .addUse(GR.getSPIRVTypeID(ResType))
2811 .addUse(Tmp)
2812 .constrainAllUses(TII, TRI, RBI);
2813 return true;
2814 }
2815
2816 // Check if instructions from the SPV_INTEL_usm_storage_classes extension may
2817 // be applied
2818 if (isUSMStorageClass(SrcSC) && DstSC == SPIRV::StorageClass::CrossWorkgroup)
2819 return selectUnOp(ResVReg, ResType, I,
2820 SPIRV::OpPtrCastToCrossWorkgroupINTEL);
2821 if (SrcSC == SPIRV::StorageClass::CrossWorkgroup && isUSMStorageClass(DstSC))
2822 return selectUnOp(ResVReg, ResType, I,
2823 SPIRV::OpCrossWorkgroupCastToPtrINTEL);
2824 if (isUSMStorageClass(SrcSC) && DstSC == SPIRV::StorageClass::Generic)
2825 return selectUnOp(ResVReg, ResType, I, SPIRV::OpPtrCastToGeneric);
2826 if (SrcSC == SPIRV::StorageClass::Generic && isUSMStorageClass(DstSC))
2827 return selectUnOp(ResVReg, ResType, I, SPIRV::OpGenericCastToPtr);
2828
2829 // Bitcast for pointers requires that the address spaces must match
2830 return false;
2831}
2832
2833// G_PTRMASK - Apply a bitmask to a pointer value.
2834// Result = Ptr & Mask
2835// We need to convert the pointer to an integer, perform the AND operation,
2836// and convert back to a pointer.
2837bool SPIRVInstructionSelector::selectPtrMask(Register ResVReg,
2838 SPIRVTypeInst ResType,
2839 MachineInstr &I) const {
2840 if (STI.isLogicalSPIRV())
2841 return diagnoseUnsupported(
2842 I, "G_PTRMASK is not supported with logical SPIR-V");
2843 MachineBasicBlock &BB = *I.getParent();
2844 MachineFunction &MF = *BB.getParent();
2845 const DebugLoc &DL = I.getDebugLoc();
2846
2847 Register PtrReg = I.getOperand(1).getReg();
2848 Register MaskReg = I.getOperand(2).getReg();
2849
2850 SPIRVTypeInst MaskType = GR.getSPIRVTypeForVReg(MaskReg);
2851
2852 // Convert pointer to integer.
2853 Register PtrAsInt = MRI->createVirtualRegister(GR.getRegClass(MaskType));
2854 GR.assignSPIRVTypeToVReg(MaskType, PtrAsInt, MF);
2855
2856 BuildMI(BB, I, DL, TII.get(SPIRV::OpConvertPtrToU))
2857 .addDef(PtrAsInt)
2858 .addUse(GR.getSPIRVTypeID(MaskType))
2859 .addUse(PtrReg)
2860 .constrainAllUses(TII, TRI, RBI);
2861
2862 // Perform bitwise AND.
2863 Register MaskedInt = MRI->createVirtualRegister(GR.getRegClass(MaskType));
2864 GR.assignSPIRVTypeToVReg(MaskType, MaskedInt, MF);
2865
2866 unsigned AndOpcode = GR.getScalarOrVectorComponentCount(MaskType) > 1
2867 ? SPIRV::OpBitwiseAndV
2868 : SPIRV::OpBitwiseAndS;
2869
2870 BuildMI(BB, I, DL, TII.get(AndOpcode))
2871 .addDef(MaskedInt)
2872 .addUse(GR.getSPIRVTypeID(MaskType))
2873 .addUse(PtrAsInt)
2874 .addUse(MaskReg)
2875 .constrainAllUses(TII, TRI, RBI);
2876
2877 // Convert integer back to pointer.
2878 BuildMI(BB, I, DL, TII.get(SPIRV::OpConvertUToPtr))
2879 .addDef(ResVReg)
2880 .addUse(GR.getSPIRVTypeID(ResType))
2881 .addUse(MaskedInt)
2882 .constrainAllUses(TII, TRI, RBI);
2883
2884 return true;
2885}
2886
2887static unsigned getFCmpOpcode(unsigned PredNum) {
2888 auto Pred = static_cast<CmpInst::Predicate>(PredNum);
2889 switch (Pred) {
2890 case CmpInst::FCMP_OEQ:
2891 return SPIRV::OpFOrdEqual;
2892 case CmpInst::FCMP_OGE:
2893 return SPIRV::OpFOrdGreaterThanEqual;
2894 case CmpInst::FCMP_OGT:
2895 return SPIRV::OpFOrdGreaterThan;
2896 case CmpInst::FCMP_OLE:
2897 return SPIRV::OpFOrdLessThanEqual;
2898 case CmpInst::FCMP_OLT:
2899 return SPIRV::OpFOrdLessThan;
2900 case CmpInst::FCMP_ONE:
2901 return SPIRV::OpFOrdNotEqual;
2902 case CmpInst::FCMP_ORD:
2903 return SPIRV::OpOrdered;
2904 case CmpInst::FCMP_UEQ:
2905 return SPIRV::OpFUnordEqual;
2906 case CmpInst::FCMP_UGE:
2907 return SPIRV::OpFUnordGreaterThanEqual;
2908 case CmpInst::FCMP_UGT:
2909 return SPIRV::OpFUnordGreaterThan;
2910 case CmpInst::FCMP_ULE:
2911 return SPIRV::OpFUnordLessThanEqual;
2912 case CmpInst::FCMP_ULT:
2913 return SPIRV::OpFUnordLessThan;
2914 case CmpInst::FCMP_UNE:
2915 return SPIRV::OpFUnordNotEqual;
2916 case CmpInst::FCMP_UNO:
2917 return SPIRV::OpUnordered;
2918 default:
2919 llvm_unreachable("Unknown predicate type for FCmp");
2920 }
2921}
2922
2923static unsigned getICmpOpcode(unsigned PredNum) {
2924 auto Pred = static_cast<CmpInst::Predicate>(PredNum);
2925 switch (Pred) {
2926 case CmpInst::ICMP_EQ:
2927 return SPIRV::OpIEqual;
2928 case CmpInst::ICMP_NE:
2929 return SPIRV::OpINotEqual;
2930 case CmpInst::ICMP_SGE:
2931 return SPIRV::OpSGreaterThanEqual;
2932 case CmpInst::ICMP_SGT:
2933 return SPIRV::OpSGreaterThan;
2934 case CmpInst::ICMP_SLE:
2935 return SPIRV::OpSLessThanEqual;
2936 case CmpInst::ICMP_SLT:
2937 return SPIRV::OpSLessThan;
2938 case CmpInst::ICMP_UGE:
2939 return SPIRV::OpUGreaterThanEqual;
2940 case CmpInst::ICMP_UGT:
2941 return SPIRV::OpUGreaterThan;
2942 case CmpInst::ICMP_ULE:
2943 return SPIRV::OpULessThanEqual;
2944 case CmpInst::ICMP_ULT:
2945 return SPIRV::OpULessThan;
2946 default:
2947 llvm_unreachable("Unknown predicate type for ICmp");
2948 }
2949}
2950
2951static unsigned getPtrCmpOpcode(unsigned Pred) {
2952 switch (static_cast<CmpInst::Predicate>(Pred)) {
2953 case CmpInst::ICMP_EQ:
2954 return SPIRV::OpPtrEqual;
2955 case CmpInst::ICMP_NE:
2956 return SPIRV::OpPtrNotEqual;
2957 default:
2958 llvm_unreachable("Unknown predicate type for pointer comparison");
2959 }
2960}
2961
2962// Return the logical operation, or abort if none exists.
2963static unsigned getBoolCmpOpcode(unsigned PredNum) {
2964 auto Pred = static_cast<CmpInst::Predicate>(PredNum);
2965 switch (Pred) {
2966 case CmpInst::ICMP_EQ:
2967 return SPIRV::OpLogicalEqual;
2968 case CmpInst::ICMP_NE:
2969 return SPIRV::OpLogicalNotEqual;
2970 default:
2971 llvm_unreachable("Unknown predicate type for Bool comparison");
2972 }
2973}
2974
2975static APFloat getZeroFP(const Type *LLVMFloatTy) {
2976 if (!LLVMFloatTy)
2978 switch (LLVMFloatTy->getScalarType()->getTypeID()) {
2979 case Type::HalfTyID:
2981 default:
2982 case Type::FloatTyID:
2984 case Type::DoubleTyID:
2986 }
2987}
2988
2989static APFloat getOneFP(const Type *LLVMFloatTy) {
2990 if (!LLVMFloatTy)
2992 switch (LLVMFloatTy->getScalarType()->getTypeID()) {
2993 case Type::HalfTyID:
2995 default:
2996 case Type::FloatTyID:
2998 case Type::DoubleTyID:
3000 }
3001}
3002
3003bool SPIRVInstructionSelector::selectAnyOrAll(Register ResVReg,
3004 SPIRVTypeInst ResType,
3005 MachineInstr &I,
3006 unsigned OpAnyOrAll) const {
3007 assert(I.getNumOperands() == 3);
3008 assert(I.getOperand(2).isReg());
3009 MachineBasicBlock &BB = *I.getParent();
3010 Register InputRegister = I.getOperand(2).getReg();
3011 SPIRVTypeInst InputType = GR.getSPIRVTypeForVReg(InputRegister);
3012
3013 assert(InputType && "VReg has no type assigned");
3014
3015 bool IsBoolTy = GR.isScalarOrVectorOfType(InputRegister, SPIRV::OpTypeBool);
3016 bool IsVectorTy = InputType->getOpcode() == SPIRV::OpTypeVector;
3017 if (IsBoolTy && !IsVectorTy) {
3018 assert(ResVReg == I.getOperand(0).getReg());
3019 return BuildCOPY(ResVReg, InputRegister, I);
3020 }
3021
3022 bool IsFloatTy = GR.isScalarOrVectorOfType(InputRegister, SPIRV::OpTypeFloat);
3023 unsigned SpirvNotEqualId =
3024 IsFloatTy ? SPIRV::OpFOrdNotEqual : SPIRV::OpINotEqual;
3025 SPIRVTypeInst SpvBoolScalarTy = GR.getOrCreateSPIRVBoolType(I, TII);
3026 SPIRVTypeInst SpvBoolTy = SpvBoolScalarTy;
3027 Register NotEqualReg = ResVReg;
3028
3029 if (IsVectorTy) {
3030 NotEqualReg =
3031 IsBoolTy ? InputRegister
3032 : createVirtualRegister(SpvBoolTy, &GR, MRI, MRI->getMF());
3033 const unsigned NumElts = GR.getScalarOrVectorComponentCount(InputType);
3034 SpvBoolTy = GR.getOrCreateSPIRVVectorType(SpvBoolTy, NumElts, I, TII);
3035 }
3036
3037 if (!IsBoolTy) {
3038 Register ConstZeroReg =
3039 IsFloatTy ? buildZerosValF(InputType, I) : buildZerosVal(InputType, I);
3040
3041 BuildMI(BB, I, I.getDebugLoc(), TII.get(SpirvNotEqualId))
3042 .addDef(NotEqualReg)
3043 .addUse(GR.getSPIRVTypeID(SpvBoolTy))
3044 .addUse(InputRegister)
3045 .addUse(ConstZeroReg)
3046 .constrainAllUses(TII, TRI, RBI);
3047 }
3048
3049 if (IsVectorTy)
3050 BuildMI(BB, I, I.getDebugLoc(), TII.get(OpAnyOrAll))
3051 .addDef(ResVReg)
3052 .addUse(GR.getSPIRVTypeID(SpvBoolScalarTy))
3053 .addUse(NotEqualReg)
3054 .constrainAllUses(TII, TRI, RBI);
3055 return true;
3056}
3057
3058bool SPIRVInstructionSelector::selectAll(Register ResVReg,
3059 SPIRVTypeInst ResType,
3060 MachineInstr &I) const {
3061 return selectAnyOrAll(ResVReg, ResType, I, SPIRV::OpAll);
3062}
3063
3064bool SPIRVInstructionSelector::selectAny(Register ResVReg,
3065 SPIRVTypeInst ResType,
3066 MachineInstr &I) const {
3067 return selectAnyOrAll(ResVReg, ResType, I, SPIRV::OpAny);
3068}
3069
3070// Select the OpDot instruction for the given float dot
3071bool SPIRVInstructionSelector::selectFloatDot(Register ResVReg,
3072 SPIRVTypeInst ResType,
3073 MachineInstr &I) const {
3074 assert(I.getNumOperands() == 4);
3075 assert(I.getOperand(2).isReg());
3076 assert(I.getOperand(3).isReg());
3077
3078 [[maybe_unused]] SPIRVTypeInst VecType =
3079 GR.getSPIRVTypeForVReg(I.getOperand(2).getReg());
3080
3081 assert(VecType->getOpcode() == SPIRV::OpTypeVector &&
3082 GR.getScalarOrVectorComponentCount(VecType) > 1 &&
3083 "dot product requires a vector of at least 2 components");
3084
3085 [[maybe_unused]] SPIRVTypeInst EltType =
3087
3088 assert(EltType->getOpcode() == SPIRV::OpTypeFloat);
3089
3090 MachineBasicBlock &BB = *I.getParent();
3091 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpDot))
3092 .addDef(ResVReg)
3093 .addUse(GR.getSPIRVTypeID(ResType))
3094 .addUse(I.getOperand(2).getReg())
3095 .addUse(I.getOperand(3).getReg())
3096 .constrainAllUses(TII, TRI, RBI);
3097 return true;
3098}
3099
3100bool SPIRVInstructionSelector::selectIntegerDot(Register ResVReg,
3101 SPIRVTypeInst ResType,
3102 MachineInstr &I,
3103 bool Signed) const {
3104 assert(I.getNumOperands() == 4);
3105 assert(I.getOperand(2).isReg());
3106 assert(I.getOperand(3).isReg());
3107 MachineBasicBlock &BB = *I.getParent();
3108
3109 auto DotOp = Signed ? SPIRV::OpSDot : SPIRV::OpUDot;
3110 BuildMI(BB, I, I.getDebugLoc(), TII.get(DotOp))
3111 .addDef(ResVReg)
3112 .addUse(GR.getSPIRVTypeID(ResType))
3113 .addUse(I.getOperand(2).getReg())
3114 .addUse(I.getOperand(3).getReg())
3115 .constrainAllUses(TII, TRI, RBI);
3116 return true;
3117}
3118
3119// Since pre-1.6 SPIRV has no integer dot implementation,
3120// expand by piecewise multiplying and adding the results
3121bool SPIRVInstructionSelector::selectIntegerDotExpansion(
3122 Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I) const {
3123 assert(I.getNumOperands() == 4);
3124 assert(I.getOperand(2).isReg());
3125 assert(I.getOperand(3).isReg());
3126 MachineBasicBlock &BB = *I.getParent();
3127
3128 // Multiply the vectors, then sum the results
3129 Register Vec0 = I.getOperand(2).getReg();
3130 Register Vec1 = I.getOperand(3).getReg();
3131 Register TmpVec = MRI->createVirtualRegister(GR.getRegClass(ResType));
3132 SPIRVTypeInst VecType = GR.getSPIRVTypeForVReg(Vec0);
3133
3134 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpIMulV))
3135 .addDef(TmpVec)
3136 .addUse(GR.getSPIRVTypeID(VecType))
3137 .addUse(Vec0)
3138 .addUse(Vec1)
3139 .constrainAllUses(TII, TRI, RBI);
3140
3141 assert(VecType->getOpcode() == SPIRV::OpTypeVector &&
3142 GR.getScalarOrVectorComponentCount(VecType) > 1 &&
3143 "dot product requires a vector of at least 2 components");
3144
3145 Register Res = MRI->createVirtualRegister(GR.getRegClass(ResType));
3146 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpCompositeExtract))
3147 .addDef(Res)
3148 .addUse(GR.getSPIRVTypeID(ResType))
3149 .addUse(TmpVec)
3150 .addImm(0)
3151 .constrainAllUses(TII, TRI, RBI);
3152
3153 for (unsigned i = 1; i < GR.getScalarOrVectorComponentCount(VecType); i++) {
3154 Register Elt = MRI->createVirtualRegister(GR.getRegClass(ResType));
3155
3156 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpCompositeExtract))
3157 .addDef(Elt)
3158 .addUse(GR.getSPIRVTypeID(ResType))
3159 .addUse(TmpVec)
3160 .addImm(i)
3161 .constrainAllUses(TII, TRI, RBI);
3162
3163 Register Sum = i < GR.getScalarOrVectorComponentCount(VecType) - 1
3164 ? MRI->createVirtualRegister(GR.getRegClass(ResType))
3165 : ResVReg;
3166
3167 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpIAddS))
3168 .addDef(Sum)
3169 .addUse(GR.getSPIRVTypeID(ResType))
3170 .addUse(Res)
3171 .addUse(Elt)
3172 .constrainAllUses(TII, TRI, RBI);
3173 Res = Sum;
3174 }
3175
3176 return true;
3177}
3178
3179bool SPIRVInstructionSelector::selectOpIsInf(Register ResVReg,
3180 SPIRVTypeInst ResType,
3181 MachineInstr &I) const {
3182 MachineBasicBlock &BB = *I.getParent();
3183 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpIsInf))
3184 .addDef(ResVReg)
3185 .addUse(GR.getSPIRVTypeID(ResType))
3186 .addUse(I.getOperand(2).getReg())
3187 .constrainAllUses(TII, TRI, RBI);
3188 return true;
3189}
3190
3191bool SPIRVInstructionSelector::selectOpIsNan(Register ResVReg,
3192 SPIRVTypeInst ResType,
3193 MachineInstr &I) const {
3194 MachineBasicBlock &BB = *I.getParent();
3195 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpIsNan))
3196 .addDef(ResVReg)
3197 .addUse(GR.getSPIRVTypeID(ResType))
3198 .addUse(I.getOperand(2).getReg())
3199 .constrainAllUses(TII, TRI, RBI);
3200 return true;
3201}
3202
3203bool SPIRVInstructionSelector::selectOpIsFinite(Register ResVReg,
3204 SPIRVTypeInst ResType,
3205 MachineInstr &I) const {
3206 MachineBasicBlock &BB = *I.getParent();
3207 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpIsFinite))
3208 .addDef(ResVReg)
3209 .addUse(GR.getSPIRVTypeID(ResType))
3210 .addUse(I.getOperand(2).getReg())
3211 .constrainAllUses(TII, TRI, RBI);
3212 return true;
3213}
3214
3215bool SPIRVInstructionSelector::selectOpIsNormal(Register ResVReg,
3216 SPIRVTypeInst ResType,
3217 MachineInstr &I) const {
3218 MachineBasicBlock &BB = *I.getParent();
3219 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpIsNormal))
3220 .addDef(ResVReg)
3221 .addUse(GR.getSPIRVTypeID(ResType))
3222 .addUse(I.getOperand(2).getReg())
3223 .constrainAllUses(TII, TRI, RBI);
3224 return true;
3225}
3226
3227template <bool Signed>
3228bool SPIRVInstructionSelector::selectDot4AddPacked(Register ResVReg,
3229 SPIRVTypeInst ResType,
3230 MachineInstr &I) const {
3231 assert(I.getNumOperands() == 5);
3232 assert(I.getOperand(2).isReg());
3233 assert(I.getOperand(3).isReg());
3234 assert(I.getOperand(4).isReg());
3235 MachineBasicBlock &BB = *I.getParent();
3236
3237 Register Acc = I.getOperand(2).getReg();
3238 Register X = I.getOperand(3).getReg();
3239 Register Y = I.getOperand(4).getReg();
3240
3241 auto DotOp = Signed ? SPIRV::OpSDot : SPIRV::OpUDot;
3242 Register Dot = MRI->createVirtualRegister(GR.getRegClass(ResType));
3243 auto MIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(DotOp))
3244 .addDef(Dot)
3245 .addUse(GR.getSPIRVTypeID(ResType))
3246 .addUse(X)
3247 .addUse(Y);
3248 MIB.addImm(SPIRV::BuiltIn::PackedVectorFormat4x8Bit);
3249 MIB.constrainAllUses(TII, TRI, RBI);
3250
3251 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpIAddS))
3252 .addDef(ResVReg)
3253 .addUse(GR.getSPIRVTypeID(ResType))
3254 .addUse(Dot)
3255 .addUse(Acc)
3256 .constrainAllUses(TII, TRI, RBI);
3257 return true;
3258}
3259
3260// Since pre-1.6 SPIRV has no DotProductInput4x8BitPacked implementation,
3261// extract the elements of the packed inputs, multiply them and add the result
3262// to the accumulator.
3263template <bool Signed>
3264bool SPIRVInstructionSelector::selectDot4AddPackedExpansion(
3265 Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I) const {
3266 assert(I.getNumOperands() == 5);
3267 assert(I.getOperand(2).isReg());
3268 assert(I.getOperand(3).isReg());
3269 assert(I.getOperand(4).isReg());
3270 MachineBasicBlock &BB = *I.getParent();
3271
3272 Register Acc = I.getOperand(2).getReg();
3273 Register X = I.getOperand(3).getReg();
3274 Register Y = I.getOperand(4).getReg();
3275
3276 SPIRVTypeInst EltType = GR.getOrCreateSPIRVIntegerType(8, I, TII);
3277 auto ExtractOp =
3278 Signed ? SPIRV::OpBitFieldSExtract : SPIRV::OpBitFieldUExtract;
3279
3280 bool ZeroAsNull = !STI.isShader();
3281 // Extract the i8 element, multiply and add it to the accumulator
3282 for (unsigned i = 0; i < 4; i++) {
3283 // A[i]
3284 Register AElt = MRI->createVirtualRegister(&SPIRV::IDRegClass);
3285 BuildMI(BB, I, I.getDebugLoc(), TII.get(ExtractOp))
3286 .addDef(AElt)
3287 .addUse(GR.getSPIRVTypeID(ResType))
3288 .addUse(X)
3289 .addUse(GR.getOrCreateConstInt(i * 8, I, EltType, TII, ZeroAsNull))
3290 .addUse(GR.getOrCreateConstInt(8, I, EltType, TII, ZeroAsNull))
3291 .constrainAllUses(TII, TRI, RBI);
3292
3293 // B[i]
3294 Register BElt = MRI->createVirtualRegister(&SPIRV::IDRegClass);
3295 BuildMI(BB, I, I.getDebugLoc(), TII.get(ExtractOp))
3296 .addDef(BElt)
3297 .addUse(GR.getSPIRVTypeID(ResType))
3298 .addUse(Y)
3299 .addUse(GR.getOrCreateConstInt(i * 8, I, EltType, TII, ZeroAsNull))
3300 .addUse(GR.getOrCreateConstInt(8, I, EltType, TII, ZeroAsNull))
3301 .constrainAllUses(TII, TRI, RBI);
3302
3303 // A[i] * B[i]
3304 Register Mul = MRI->createVirtualRegister(&SPIRV::IDRegClass);
3305 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpIMulS))
3306 .addDef(Mul)
3307 .addUse(GR.getSPIRVTypeID(ResType))
3308 .addUse(AElt)
3309 .addUse(BElt)
3310 .constrainAllUses(TII, TRI, RBI);
3311
3312 // Discard 24 highest-bits so that stored i32 register is i8 equivalent
3313 Register MaskMul = MRI->createVirtualRegister(&SPIRV::IDRegClass);
3314 BuildMI(BB, I, I.getDebugLoc(), TII.get(ExtractOp))
3315 .addDef(MaskMul)
3316 .addUse(GR.getSPIRVTypeID(ResType))
3317 .addUse(Mul)
3318 .addUse(GR.getOrCreateConstInt(0, I, EltType, TII, ZeroAsNull))
3319 .addUse(GR.getOrCreateConstInt(8, I, EltType, TII, ZeroAsNull))
3320 .constrainAllUses(TII, TRI, RBI);
3321
3322 // Acc = Acc + A[i] * B[i]
3323 Register Sum =
3324 i < 3 ? MRI->createVirtualRegister(&SPIRV::IDRegClass) : ResVReg;
3325 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpIAddS))
3326 .addDef(Sum)
3327 .addUse(GR.getSPIRVTypeID(ResType))
3328 .addUse(Acc)
3329 .addUse(MaskMul)
3330 .constrainAllUses(TII, TRI, RBI);
3331
3332 Acc = Sum;
3333 }
3334
3335 return true;
3336}
3337
3338/// Transform saturate(x) to clamp(x, 0.0f, 1.0f) as SPIRV
3339/// does not have a saturate builtin.
3340bool SPIRVInstructionSelector::selectSaturate(Register ResVReg,
3341 SPIRVTypeInst ResType,
3342 MachineInstr &I) const {
3343 assert(I.getNumOperands() == 3);
3344 assert(I.getOperand(2).isReg());
3345 MachineBasicBlock &BB = *I.getParent();
3346 Register VZero = buildZerosValF(ResType, I);
3347 Register VOne = buildOnesValF(ResType, I);
3348
3349 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpExtInst))
3350 .addDef(ResVReg)
3351 .addUse(GR.getSPIRVTypeID(ResType))
3352 .addImm(static_cast<uint32_t>(SPIRV::InstructionSet::GLSL_std_450))
3353 .addImm(GL::FClamp)
3354 .addUse(I.getOperand(2).getReg())
3355 .addUse(VZero)
3356 .addUse(VOne)
3357 .constrainAllUses(TII, TRI, RBI);
3358 return true;
3359}
3360
3361bool SPIRVInstructionSelector::selectSign(Register ResVReg,
3362 SPIRVTypeInst ResType,
3363 MachineInstr &I) const {
3364 assert(I.getNumOperands() == 3);
3365 assert(I.getOperand(2).isReg());
3366 MachineBasicBlock &BB = *I.getParent();
3367 Register InputRegister = I.getOperand(2).getReg();
3368 SPIRVTypeInst InputType = GR.getSPIRVTypeForVReg(InputRegister);
3369 auto &DL = I.getDebugLoc();
3370
3371 if (!InputType)
3372 return diagnoseUnsupported(I, "Input Type could not be determined.");
3373
3374 bool IsFloatTy = GR.isScalarOrVectorOfType(InputRegister, SPIRV::OpTypeFloat);
3375
3376 unsigned SignBitWidth = GR.getScalarOrVectorBitWidth(InputType);
3377 unsigned ResBitWidth = GR.getScalarOrVectorBitWidth(ResType);
3378
3379 bool NeedsConversion = IsFloatTy || SignBitWidth != ResBitWidth;
3380
3381 auto SignOpcode = IsFloatTy ? GL::FSign : GL::SSign;
3382 Register SignReg = NeedsConversion
3383 ? MRI->createVirtualRegister(&SPIRV::IDRegClass)
3384 : ResVReg;
3385
3386 BuildMI(BB, I, DL, TII.get(SPIRV::OpExtInst))
3387 .addDef(SignReg)
3388 .addUse(GR.getSPIRVTypeID(InputType))
3389 .addImm(static_cast<uint32_t>(SPIRV::InstructionSet::GLSL_std_450))
3390 .addImm(SignOpcode)
3391 .addUse(InputRegister)
3392 .constrainAllUses(TII, TRI, RBI);
3393
3394 if (NeedsConversion) {
3395 auto ConvertOpcode = IsFloatTy ? SPIRV::OpConvertFToS : SPIRV::OpSConvert;
3396 BuildMI(*I.getParent(), I, DL, TII.get(ConvertOpcode))
3397 .addDef(ResVReg)
3398 .addUse(GR.getSPIRVTypeID(ResType))
3399 .addUse(SignReg)
3400 .constrainAllUses(TII, TRI, RBI);
3401 }
3402
3403 return true;
3404}
3405
3406bool SPIRVInstructionSelector::selectWaveOpInst(Register ResVReg,
3407 SPIRVTypeInst ResType,
3408 MachineInstr &I,
3409 unsigned Opcode) const {
3410 MachineBasicBlock &BB = *I.getParent();
3411 SPIRVTypeInst IntTy = GR.getOrCreateSPIRVIntegerType(32, I, TII);
3412
3413 auto BMI = BuildMI(BB, I, I.getDebugLoc(), TII.get(Opcode))
3414 .addDef(ResVReg)
3415 .addUse(GR.getSPIRVTypeID(ResType))
3416 .addUse(GR.getOrCreateConstInt(SPIRV::Scope::Subgroup, I,
3417 IntTy, TII, !STI.isShader()));
3418
3419 for (unsigned J = 2; J < I.getNumOperands(); J++) {
3420 BMI.addUse(I.getOperand(J).getReg());
3421 }
3422
3423 BMI.constrainAllUses(TII, TRI, RBI);
3424 return true;
3425}
3426
3427bool SPIRVInstructionSelector::selectBarrierInst(MachineInstr &I,
3428 unsigned Scope,
3429 unsigned MemSem,
3430 bool WithGroupSync) const {
3431 auto BarrierType =
3432 WithGroupSync ? SPIRV::OpControlBarrier : SPIRV::OpMemoryBarrier;
3433
3434 MemSem |= SPIRV::MemorySemantics::AcquireRelease;
3435
3436 assert(((Scope != SPIRV::Scope::Workgroup) ||
3437 ((MemSem & SPIRV::MemorySemantics::WorkgroupMemory) > 0)) &&
3438 "Workgroup Scope must set WorkGroupMemory semantic "
3439 "in Barrier instruction");
3440
3441 assert(((Scope != SPIRV::Scope::Device) ||
3442 ((MemSem & SPIRV::MemorySemantics::UniformMemory) > 0 &&
3443 (MemSem & SPIRV::MemorySemantics::ImageMemory) > 0)) &&
3444 "Device Scope must set UniformMemory and ImageMemory semantic "
3445 "in Barrier instruction");
3446
3447 MachineBasicBlock &BB = *I.getParent();
3448 auto MI = BuildMI(BB, I, I.getDebugLoc(), TII.get(BarrierType));
3449
3450 // OpControlBarrier needs to also set Execution Scope
3451 if (WithGroupSync) {
3452 Register ExecReg = buildI32Constant(SPIRV::Scope::Workgroup, I);
3453 MI.addUse(ExecReg);
3454 }
3455
3456 Register ScopeReg = buildI32Constant(Scope, I);
3457 Register MemSemReg = buildI32Constant(MemSem, I);
3458
3459 MI.addUse(ScopeReg).addUse(MemSemReg).constrainAllUses(TII, TRI, RBI);
3460 return true;
3461}
3462
3463bool SPIRVInstructionSelector::selectWaveActiveCountBits(
3464 Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I) const {
3465
3466 SPIRVTypeInst IntTy = GR.getOrCreateSPIRVIntegerType(32, I, TII);
3467 SPIRVTypeInst BallotType = GR.getOrCreateSPIRVVectorType(IntTy, 4, I, TII);
3468 Register BallotReg = MRI->createVirtualRegister(GR.getRegClass(BallotType));
3469 if (!selectWaveOpInst(BallotReg, BallotType, I,
3470 SPIRV::OpGroupNonUniformBallot))
3471 return false;
3472
3473 MachineBasicBlock &BB = *I.getParent();
3474 BuildMI(BB, I, I.getDebugLoc(),
3475 TII.get(SPIRV::OpGroupNonUniformBallotBitCount))
3476 .addDef(ResVReg)
3477 .addUse(GR.getSPIRVTypeID(ResType))
3478 .addUse(GR.getOrCreateConstInt(SPIRV::Scope::Subgroup, I, IntTy, TII,
3479 !STI.isShader()))
3480 .addImm(SPIRV::GroupOperation::Reduce)
3481 .addUse(BallotReg)
3482 .constrainAllUses(TII, TRI, RBI);
3483
3484 return true;
3485}
3486
3487bool SPIRVInstructionSelector::selectWaveActiveAllEqual(Register ResVReg,
3488 SPIRVTypeInst ResType,
3489 MachineInstr &I) const {
3490 MachineBasicBlock &BB = *I.getParent();
3491 const DebugLoc &DL = I.getDebugLoc();
3492
3493 // Input to the intrinsic
3494 Register InputReg = I.getOperand(2).getReg();
3495 SPIRVTypeInst InputType = GR.getSPIRVTypeForVReg(InputReg);
3496
3497 // Determine if input is vector
3498 unsigned NumElems = GR.getScalarOrVectorComponentCount(InputType);
3499 bool IsVector = NumElems > 1;
3500
3501 // Determine element types
3502 SPIRVTypeInst ElemInputType = GR.getScalarOrVectorComponentType(InputType);
3503 SPIRVTypeInst ElemBoolType = GR.getScalarOrVectorComponentType(ResType);
3504
3505 // Subgroup scope constant
3506 SPIRVTypeInst IntTy = GR.getOrCreateSPIRVIntegerType(32, I, TII);
3507 Register ScopeConst = GR.getOrCreateConstInt(SPIRV::Scope::Subgroup, I, IntTy,
3508 TII, !STI.isShader());
3509
3510 // Scalar case
3511 if (!IsVector) {
3512 return selectWaveOpInst(ResVReg, ElemBoolType, I,
3513 SPIRV::OpGroupNonUniformAllEqual);
3514 }
3515
3516 // Vector case
3517 SmallVector<Register, 4> ElementResults;
3518 ElementResults.reserve(NumElems);
3519
3520 for (unsigned Idx = 0; Idx < NumElems; ++Idx) {
3521 // Extract element
3522 Register ElemInput = InputReg;
3523 Register Extracted =
3524 MRI->createVirtualRegister(GR.getRegClass(ElemInputType));
3525
3526 BuildMI(BB, I, DL, TII.get(SPIRV::OpCompositeExtract))
3527 .addDef(Extracted)
3528 .addUse(GR.getSPIRVTypeID(ElemInputType))
3529 .addUse(InputReg)
3530 .addImm(Idx)
3531 .constrainAllUses(TII, TRI, RBI);
3532
3533 ElemInput = Extracted;
3534
3535 // Emit per-element AllEqual
3536 Register ElemResult =
3537 MRI->createVirtualRegister(GR.getRegClass(ElemBoolType));
3538
3539 BuildMI(BB, I, DL, TII.get(SPIRV::OpGroupNonUniformAllEqual))
3540 .addDef(ElemResult)
3541 .addUse(GR.getSPIRVTypeID(ElemBoolType))
3542 .addUse(ScopeConst)
3543 .addUse(ElemInput)
3544 .constrainAllUses(TII, TRI, RBI);
3545
3546 ElementResults.push_back(ElemResult);
3547 }
3548
3549 // Reconstruct vector<bool>
3550 auto MIB = BuildMI(BB, I, DL, TII.get(SPIRV::OpCompositeConstruct))
3551 .addDef(ResVReg)
3552 .addUse(GR.getSPIRVTypeID(ResType));
3553 for (Register R : ElementResults)
3554 MIB.addUse(R);
3555
3556 MIB.constrainAllUses(TII, TRI, RBI);
3557
3558 return true;
3559}
3560
3561bool SPIRVInstructionSelector::selectWavePrefixBitCount(Register ResVReg,
3562 SPIRVTypeInst ResType,
3563 MachineInstr &I) const {
3564
3565 assert(I.getNumOperands() == 3);
3566
3567 auto Op = I.getOperand(2);
3568 assert(Op.isReg());
3569
3570 MachineBasicBlock &BB = *I.getParent();
3571 DebugLoc DL = I.getDebugLoc();
3572
3573 Register InputRegister = Op.getReg();
3574 SPIRVTypeInst InputType = GR.getSPIRVTypeForVReg(InputRegister);
3575
3576 if (!InputType)
3577 return diagnoseUnsupported(I, "Input Type could not be determined.");
3578
3579 if (InputType->getOpcode() != SPIRV::OpTypeBool)
3580 return diagnoseUnsupported(I, "WavePrefixBitCount requires boolean input");
3581
3582 // Types
3583 SPIRVTypeInst Int32Ty = GR.getOrCreateSPIRVIntegerType(32, I, TII);
3584
3585 // Ballot result type: vector<uint32>
3586 // Match DXC: %v4uint for Subgroup size
3587 SPIRVTypeInst BallotTy = GR.getOrCreateSPIRVVectorType(Int32Ty, 4, I, TII);
3588
3589 // Create a vreg for the ballot result
3590 Register BallotVReg = MRI->createVirtualRegister(&SPIRV::IDRegClass);
3591
3592 // 1. OpGroupNonUniformBallot
3593 BuildMI(BB, I, DL, TII.get(SPIRV::OpGroupNonUniformBallot))
3594 .addDef(BallotVReg)
3595 .addUse(GR.getSPIRVTypeID(BallotTy))
3596 .addUse(GR.getOrCreateConstInt(SPIRV::Scope::Subgroup, I, Int32Ty, TII))
3597 .addUse(InputRegister)
3598 .constrainAllUses(TII, TRI, RBI);
3599
3600 // 2. OpGroupNonUniformBallotBitCount
3601 BuildMI(BB, I, DL, TII.get(SPIRV::OpGroupNonUniformBallotBitCount))
3602 .addDef(ResVReg)
3603 .addUse(GR.getSPIRVTypeID(ResType))
3604 .addUse(GR.getOrCreateConstInt(SPIRV::Scope::Subgroup, I, Int32Ty, TII))
3605 .addImm(SPIRV::GroupOperation::ExclusiveScan)
3606 .addUse(BallotVReg)
3607 .constrainAllUses(TII, TRI, RBI);
3608
3609 return true;
3610}
3611
3612bool SPIRVInstructionSelector::selectWaveReduceMax(Register ResVReg,
3613 SPIRVTypeInst ResType,
3614 MachineInstr &I,
3615 bool IsUnsigned) const {
3616 return selectWaveReduce(
3617 ResVReg, ResType, I, IsUnsigned,
3618 [&](Register InputRegister, bool IsUnsigned) {
3619 const bool IsFloatTy =
3620 GR.isScalarOrVectorOfType(InputRegister, SPIRV::OpTypeFloat);
3621 const auto IntOp = IsUnsigned ? SPIRV::OpGroupNonUniformUMax
3622 : SPIRV::OpGroupNonUniformSMax;
3623 return IsFloatTy ? SPIRV::OpGroupNonUniformFMax : IntOp;
3624 });
3625}
3626
3627bool SPIRVInstructionSelector::selectWaveReduceMin(Register ResVReg,
3628 SPIRVTypeInst ResType,
3629 MachineInstr &I,
3630 bool IsUnsigned) const {
3631 return selectWaveReduce(
3632 ResVReg, ResType, I, IsUnsigned,
3633 [&](Register InputRegister, bool IsUnsigned) {
3634 const bool IsFloatTy =
3635 GR.isScalarOrVectorOfType(InputRegister, SPIRV::OpTypeFloat);
3636 const auto IntOp = IsUnsigned ? SPIRV::OpGroupNonUniformUMin
3637 : SPIRV::OpGroupNonUniformSMin;
3638 return IsFloatTy ? SPIRV::OpGroupNonUniformFMin : IntOp;
3639 });
3640}
3641
3642bool SPIRVInstructionSelector::selectWaveReduceSum(Register ResVReg,
3643 SPIRVTypeInst ResType,
3644 MachineInstr &I) const {
3645 return selectWaveReduce(ResVReg, ResType, I, /*IsUnsigned*/ false,
3646 [&](Register InputRegister, bool IsUnsigned) {
3647 bool IsFloatTy = GR.isScalarOrVectorOfType(
3648 InputRegister, SPIRV::OpTypeFloat);
3649 return IsFloatTy ? SPIRV::OpGroupNonUniformFAdd
3650 : SPIRV::OpGroupNonUniformIAdd;
3651 });
3652}
3653
3654bool SPIRVInstructionSelector::selectWaveReduceProduct(Register ResVReg,
3655 SPIRVTypeInst ResType,
3656 MachineInstr &I) const {
3657 return selectWaveReduce(ResVReg, ResType, I, /*IsUnsigned*/ false,
3658 [&](Register InputRegister, bool IsUnsigned) {
3659 bool IsFloatTy = GR.isScalarOrVectorOfType(
3660 InputRegister, SPIRV::OpTypeFloat);
3661 return IsFloatTy ? SPIRV::OpGroupNonUniformFMul
3662 : SPIRV::OpGroupNonUniformIMul;
3663 });
3664}
3665
3666template <typename PickOpcodeFn>
3667bool SPIRVInstructionSelector::selectWaveReduce(
3668 Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I, bool IsUnsigned,
3669 PickOpcodeFn &&PickOpcode) const {
3670 assert(I.getNumOperands() == 3);
3671 assert(I.getOperand(2).isReg());
3672 MachineBasicBlock &BB = *I.getParent();
3673 Register InputRegister = I.getOperand(2).getReg();
3674 SPIRVTypeInst InputType = GR.getSPIRVTypeForVReg(InputRegister);
3675
3676 if (!InputType)
3677 return diagnoseUnsupported(I, "Input Type could not be determined.");
3678
3679 SPIRVTypeInst IntTy = GR.getOrCreateSPIRVIntegerType(32, I, TII);
3680 const unsigned Opcode = PickOpcode(InputRegister, IsUnsigned);
3681 BuildMI(BB, I, I.getDebugLoc(), TII.get(Opcode))
3682 .addDef(ResVReg)
3683 .addUse(GR.getSPIRVTypeID(ResType))
3684 .addUse(GR.getOrCreateConstInt(SPIRV::Scope::Subgroup, I, IntTy, TII,
3685 !STI.isShader()))
3686 .addImm(SPIRV::GroupOperation::Reduce)
3687 .addUse(I.getOperand(2).getReg())
3688 .constrainAllUses(TII, TRI, RBI);
3689 return true;
3690}
3691
3692bool SPIRVInstructionSelector::selectWaveReduceOp(Register ResVReg,
3693 SPIRVTypeInst ResType,
3694 MachineInstr &I,
3695 unsigned Opcode) const {
3696 return selectWaveReduce(
3697 ResVReg, ResType, I, false,
3698 [&](Register InputRegister, bool IsUnsigned) { return Opcode; });
3699}
3700
3701bool SPIRVInstructionSelector::selectWaveExclusiveScanSum(
3702 Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I) const {
3703 return selectWaveExclusiveScan(ResVReg, ResType, I, /*IsUnsigned*/ false,
3704 [&](Register InputRegister, bool IsUnsigned) {
3705 bool IsFloatTy = GR.isScalarOrVectorOfType(
3706 InputRegister, SPIRV::OpTypeFloat);
3707 return IsFloatTy
3708 ? SPIRV::OpGroupNonUniformFAdd
3709 : SPIRV::OpGroupNonUniformIAdd;
3710 });
3711}
3712
3713bool SPIRVInstructionSelector::selectWaveExclusiveScanProduct(
3714 Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I) const {
3715 return selectWaveExclusiveScan(ResVReg, ResType, I, /*IsUnsigned*/ false,
3716 [&](Register InputRegister, bool IsUnsigned) {
3717 bool IsFloatTy = GR.isScalarOrVectorOfType(
3718 InputRegister, SPIRV::OpTypeFloat);
3719 return IsFloatTy
3720 ? SPIRV::OpGroupNonUniformFMul
3721 : SPIRV::OpGroupNonUniformIMul;
3722 });
3723}
3724
3725template <typename PickOpcodeFn>
3726bool SPIRVInstructionSelector::selectWaveExclusiveScan(
3727 Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I, bool IsUnsigned,
3728 PickOpcodeFn &&PickOpcode) const {
3729 assert(I.getNumOperands() == 3);
3730 assert(I.getOperand(2).isReg());
3731 MachineBasicBlock &BB = *I.getParent();
3732 Register InputRegister = I.getOperand(2).getReg();
3733 SPIRVTypeInst InputType = GR.getSPIRVTypeForVReg(InputRegister);
3734
3735 if (!InputType)
3736 return diagnoseUnsupported(I, "Input Type could not be determined.");
3737
3738 SPIRVTypeInst IntTy = GR.getOrCreateSPIRVIntegerType(32, I, TII);
3739 const unsigned Opcode = PickOpcode(InputRegister, IsUnsigned);
3740 BuildMI(BB, I, I.getDebugLoc(), TII.get(Opcode))
3741 .addDef(ResVReg)
3742 .addUse(GR.getSPIRVTypeID(ResType))
3743 .addUse(GR.getOrCreateConstInt(SPIRV::Scope::Subgroup, I, IntTy, TII,
3744 !STI.isShader()))
3745 .addImm(SPIRV::GroupOperation::ExclusiveScan)
3746 .addUse(I.getOperand(2).getReg())
3747 .constrainAllUses(TII, TRI, RBI);
3748 return true;
3749}
3750
3751bool SPIRVInstructionSelector::selectQuadSwap(Register ResVReg,
3752 SPIRVTypeInst ResType,
3753 MachineInstr &I,
3754 unsigned Direction) const {
3755 assert(I.getNumOperands() == 3);
3756 assert(I.getOperand(2).isReg());
3757 MachineBasicBlock &BB = *I.getParent();
3758 Register InputRegister = I.getOperand(2).getReg();
3759
3760 SPIRVTypeInst IntTy = GR.getOrCreateSPIRVIntegerType(32, I, TII);
3761 bool ZeroAsNull = !STI.isShader();
3762 Register DirectionReg =
3763 GR.getOrCreateConstInt(Direction, I, IntTy, TII, ZeroAsNull);
3764 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpGroupNonUniformQuadSwap))
3765 .addDef(ResVReg)
3766 .addUse(GR.getSPIRVTypeID(ResType))
3767 .addUse(GR.getOrCreateConstInt(SPIRV::Scope::Subgroup, I, IntTy, TII,
3768 ZeroAsNull))
3769 .addUse(InputRegister)
3770 .addUse(DirectionReg)
3771 .constrainAllUses(TII, TRI, RBI);
3772 return true;
3773}
3774
3775bool SPIRVInstructionSelector::selectBitreverse16(Register ResVReg,
3776 SPIRVTypeInst ResType,
3777 MachineInstr &I,
3778 Register Op) const {
3779 SPIRVTypeInst Int32Type = GR.getOrCreateSPIRVIntegerType(32, I, TII);
3780 Register ShiftConst = GR.getOrCreateConstInt(16, I, Int32Type, TII);
3781 unsigned ShiftOp = SPIRV::OpShiftRightLogicalS;
3782
3783 const unsigned N = GR.getScalarOrVectorComponentCount(ResType);
3784 const unsigned ExtendOpcode = GR.isScalarOrVectorSigned(ResType)
3785 ? SPIRV::OpSConvert
3786 : SPIRV::OpUConvert;
3787
3788 if (N > 1) {
3789 Int32Type = GR.getOrCreateSPIRVVectorType(Int32Type, N, I, TII);
3790 ShiftOp = SPIRV::OpShiftRightLogicalV;
3791
3792 // Vector shifts require a composite constant
3793 const Register CompositeReg =
3794 MRI->createVirtualRegister(GR.getRegClass(Int32Type));
3795 auto MIB = BuildMI(*I.getParent(), I, I.getDebugLoc(),
3796 TII.get(SPIRV::OpConstantComposite))
3797 .addDef(CompositeReg)
3798 .addUse(GR.getSPIRVTypeID(Int32Type));
3799 for (unsigned It = 0; It < N; ++It)
3800 MIB.addUse(ShiftConst);
3801 MIB.constrainAllUses(TII, TRI, RBI);
3802
3803 ShiftConst = CompositeReg;
3804 }
3805
3806 // Converts the i16 input to i32 (or vector of i32)
3807 Register ExtReg = MRI->createVirtualRegister(GR.getRegClass(Int32Type));
3808 if (!selectOpWithSrcs(ExtReg, Int32Type, I, {Op}, ExtendOpcode))
3809 return false;
3810
3811 // Perform bitreverse on the i32 value
3812 Register BitrevReg = MRI->createVirtualRegister(GR.getRegClass(Int32Type));
3813 if (!selectBitreverseNative(BitrevReg, Int32Type, I, ExtReg))
3814 return false;
3815
3816 // Shift the bit-reversed value to get the final result.
3817 Register ShiftReg = MRI->createVirtualRegister(GR.getRegClass(Int32Type));
3818 if (!selectOpWithSrcs(ShiftReg, Int32Type, I, {BitrevReg, ShiftConst},
3819 ShiftOp))
3820 return false;
3821
3822 // Finally, convert the result back to i16 (or vector of i16).
3823 return selectOpWithSrcs(ResVReg, ResType, I, {ShiftReg}, ExtendOpcode);
3824}
3825
3826bool SPIRVInstructionSelector::handle64BitOverflow(
3827 Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I, Register SrcReg,
3828 unsigned int Opcode,
3829 std::function<bool(Register, SPIRVTypeInst, MachineInstr &, Register,
3830 unsigned)>
3831 CallbackFunction) const {
3832
3833 SPIRVTypeInst BaseType = GR.retrieveScalarOrVectorIntType(ResType);
3834 assert(BaseType->getOpcode() == SPIRV::OpTypeInt &&
3835 "handle64BitOverflow should only be used for integer types");
3836 unsigned ComponentCount = GR.getScalarOrVectorComponentCount(ResType);
3837 assert(ComponentCount < 5 && "Vec 5+ will generate invalid SPIR-V ops");
3838
3839 MachineIRBuilder MIRBuilder(I);
3840 SPIRVTypeInst I64Type = GR.getOrCreateSPIRVIntegerType(64, MIRBuilder);
3841 SPIRVTypeInst I64x2Type =
3842 GR.getOrCreateSPIRVVectorType(I64Type, 2, MIRBuilder, false);
3843 SPIRVTypeInst Vec2ResType =
3844 GR.getOrCreateSPIRVVectorType(BaseType, 2, MIRBuilder, false);
3845
3846 std::vector<Register> PartialRegs;
3847
3848 unsigned CurrentComponent = 0;
3849 for (; CurrentComponent + 1 < ComponentCount; CurrentComponent += 2) {
3850 Register PopCountResult =
3851 MRI->createVirtualRegister(GR.getRegClass(I64x2Type));
3852
3853 auto MIB = BuildMI(*I.getParent(), I, I.getDebugLoc(),
3854 TII.get(SPIRV::OpVectorShuffle))
3855 .addDef(PopCountResult)
3856 .addUse(GR.getSPIRVTypeID(I64x2Type))
3857 .addUse(SrcReg)
3858 .addUse(SrcReg)
3859 .addImm(CurrentComponent)
3860 .addImm(CurrentComponent + 1);
3861
3862 MIB.constrainAllUses(TII, TRI, RBI);
3863
3864 Register SubVecReg =
3865 MRI->createVirtualRegister(GR.getRegClass(Vec2ResType));
3866
3867 if (!CallbackFunction(SubVecReg, Vec2ResType, I, PopCountResult, Opcode))
3868 return false;
3869
3870 PartialRegs.push_back(SubVecReg);
3871 }
3872 // On odd component counts we need to handle one more component
3873 if (CurrentComponent != ComponentCount) {
3874 bool ZeroAsNull = !STI.isShader();
3875 Register FinalElemReg = MRI->createVirtualRegister(GR.getRegClass(I64Type));
3876 Register ConstIntLastIdx = GR.getOrCreateConstInt(
3877 ComponentCount - 1, I, BaseType, TII, ZeroAsNull);
3878
3879 if (!selectOpWithSrcs(FinalElemReg, I64Type, I, {SrcReg, ConstIntLastIdx},
3880 SPIRV::OpVectorExtractDynamic))
3881 return false;
3882
3883 Register FinalElemResReg =
3885
3886 if (!CallbackFunction(FinalElemResReg, BaseType, I, FinalElemReg, Opcode))
3887 return false;
3888
3889 PartialRegs.push_back(FinalElemResReg);
3890 }
3891 // Join all the resulting registers back into the return type in order
3892 // (ie i32x2, i32x2, i32x1 -> i32x5)
3893 return selectOpWithSrcs(ResVReg, ResType, I, PartialRegs,
3894 SPIRV::OpCompositeConstruct);
3895}
3896
3897bool SPIRVInstructionSelector::selectBitreverse64(Register ResVReg,
3898 SPIRVTypeInst ResType,
3899 MachineInstr &I,
3900 Register SrcReg) const {
3901 unsigned ComponentCount = GR.getScalarOrVectorComponentCount(ResType);
3902 if (ComponentCount > 2)
3903 return handle64BitOverflow(
3904 ResVReg, ResType, I, SrcReg, SPIRV::OpBitReverse,
3905 [this](Register R, SPIRVTypeInst T, MachineInstr &I, Register S,
3906 unsigned O) { return this->selectBitreverse64(R, T, I, S); });
3907
3908 MachineIRBuilder MIRBuilder(I);
3909
3910 SPIRVTypeInst I32Type = GR.getOrCreateSPIRVIntegerType(32, MIRBuilder);
3911 SPIRVTypeInst VecI32Type = GR.getOrCreateSPIRVVectorType(
3912 I32Type, 2 * ComponentCount, MIRBuilder, /*IsSigned=*/false);
3913
3914 // Converts 64 bit into and array of 32 bit, containing 2 elements.
3915 Register Vec32 = MRI->createVirtualRegister(GR.getRegClass(VecI32Type));
3916 if (!selectOpWithSrcs(Vec32, VecI32Type, I, {SrcReg}, SPIRV::OpBitcast))
3917 return false;
3918
3919 // Apply bitreverse on each 32 bit lane
3920 Register Reverse32 = MRI->createVirtualRegister(GR.getRegClass(VecI32Type));
3921 if (!selectBitreverseNative(Reverse32, VecI32Type, I, Vec32))
3922 return false;
3923
3924 // Reversing a 64-bit value = reverse each 32-bit half AND swap them,
3925 // so the old High word becomes lane 0 (low) and old Low becomes lane 1
3926 // (high).
3927 Register SwappedVec = MRI->createVirtualRegister(GR.getRegClass(VecI32Type));
3928 auto MIB = BuildMI(*I.getParent(), I, I.getDebugLoc(),
3929 TII.get(SPIRV::OpVectorShuffle))
3930 .addDef(SwappedVec)
3931 .addUse(GR.getSPIRVTypeID(VecI32Type))
3932 .addUse(Reverse32)
3933 .addUse(Reverse32);
3934 for (unsigned J = 0; J < ComponentCount; ++J) {
3935 MIB.addImm(2 * J + 1);
3936 MIB.addImm(2 * J);
3937 }
3938 MIB.constrainAllUses(TII, TRI, RBI);
3939
3940 // Groups 32 bit vector back to 64 bit scalar.
3941 return selectOpWithSrcs(ResVReg, ResType, I, {SwappedVec}, SPIRV::OpBitcast);
3942}
3943
3944bool SPIRVInstructionSelector::selectBitreverseNative(Register ResVReg,
3945 SPIRVTypeInst ResType,
3946 MachineInstr &I,
3947 Register Op) const {
3948 MachineBasicBlock &BB = *I.getParent();
3949 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpBitReverse))
3950 .addDef(ResVReg)
3951 .addUse(GR.getSPIRVTypeID(ResType))
3952 .addUse(Op)
3953 .constrainAllUses(TII, TRI, RBI);
3954 return true;
3955}
3956
3957bool SPIRVInstructionSelector::selectBitreverse(Register ResVReg,
3958 SPIRVTypeInst ResType,
3959 MachineInstr &I) const {
3960 Register OpReg = I.getOperand(1).getReg();
3961
3962 // TODO: Fix shader behavior in case of VK_KHR_maintenance9 extension is set
3963 if (STI.isShader()) {
3964 SPIRVTypeInst OpType = GR.getSPIRVTypeForVReg(OpReg);
3965 switch (GR.getScalarOrVectorBitWidth(OpType)) {
3966 case 8:
3967 case 16:
3968 return selectBitreverse16(ResVReg, ResType, I, OpReg);
3969 case 32:
3970 return selectBitreverseNative(ResVReg, ResType, I, OpReg);
3971 case 64:
3972 return selectBitreverse64(ResVReg, ResType, I, OpReg);
3973 }
3974 return SPIRVInstructionSelector::diagnoseUnsupported(
3975 I, "G_BITREVERSE only support 16,32,64 bits.");
3976 }
3977
3978 if (STI.canUseExtension(SPIRV::Extension::SPV_KHR_bit_instructions))
3979 return selectBitreverseNative(ResVReg, ResType, I, OpReg);
3980
3981 // Expansion bitreverse using bit manipulation operations
3982 // Algo: https://graphics.stanford.edu/~seander/bithacks.html#ReverseParallel
3983 const unsigned BitWidth = GR.getScalarOrVectorBitWidth(ResType);
3984 // TODO: add support for any bit width and bitwidth more than 64.
3985 if (BitWidth > 64 || !isPowerOf2_32(BitWidth))
3986 return false;
3987
3988 const unsigned N = GR.getScalarOrVectorComponentCount(ResType);
3989
3990 unsigned AndOp = SPIRV::OpBitwiseAndS;
3991 unsigned OrOp = SPIRV::OpBitwiseOrS;
3992 unsigned ShlOp = SPIRV::OpShiftLeftLogicalS;
3993 unsigned ShrOp = SPIRV::OpShiftRightLogicalS;
3994 if (N > 1) {
3995 AndOp = SPIRV::OpBitwiseAndV;
3996 OrOp = SPIRV::OpBitwiseOrV;
3997 ShlOp = SPIRV::OpShiftLeftLogicalV;
3998 ShrOp = SPIRV::OpShiftRightLogicalV;
3999 }
4000
4001 // Helper, one swap per step: ((input>>shift)&mask)|((input&mask)<<shift),
4002 // RPN: input shift >> mask & input mask & shift << |
4003 auto SwapBits = [&](const Register Input, const uint64_t Mask,
4004 const unsigned Shift) -> Register {
4005 auto CreateConst = [&](const uint64_t Value) -> Register {
4006 if (N == 1)
4007 return GR.getOrCreateConstInt(
4008 Value, I, GR.retrieveScalarOrVectorIntType(ResType), TII);
4009 return GR.getOrCreateConstVector(Value, I, ResType, TII);
4010 };
4011
4012 Register MaskReg = CreateConst(Mask);
4013 Register ShiftReg = CreateConst(Shift);
4014 Register T1 = MRI->createVirtualRegister(GR.getRegClass(ResType));
4015 Register T2 = MRI->createVirtualRegister(GR.getRegClass(ResType));
4016 Register T3 = MRI->createVirtualRegister(GR.getRegClass(ResType));
4017 Register T4 = MRI->createVirtualRegister(GR.getRegClass(ResType));
4019
4020 if (!selectOpWithSrcs(T1, ResType, I, {Input, ShiftReg}, ShrOp) ||
4021 !selectOpWithSrcs(T2, ResType, I, {T1, MaskReg}, AndOp) ||
4022 !selectOpWithSrcs(T3, ResType, I, {Input, MaskReg}, AndOp) ||
4023 !selectOpWithSrcs(T4, ResType, I, {T3, ShiftReg}, ShlOp) ||
4024 !selectOpWithSrcs(Result, ResType, I, {T2, T4}, OrOp))
4025 return Register();
4026
4027 return Result;
4028 };
4029
4030 unsigned Shift = BitWidth;
4031 Register Result = OpReg;
4032 uint64_t Mask = ~0ull;
4033 while ((Shift >>= 1) > 0) {
4034 Mask ^= (Mask << Shift);
4035 Result = SwapBits(Result, Mask, Shift);
4036 if (!Result.isValid())
4037 return false;
4038 }
4039
4040 return BuildCOPY(ResVReg, Result, I);
4041}
4042
4043bool SPIRVInstructionSelector::selectFreeze(Register ResVReg,
4044 SPIRVTypeInst ResType,
4045 MachineInstr &I) const {
4046 assert(I.getOperand(0).isReg() && I.getOperand(1).isReg() &&
4047 "G_FREEZE must define and use a register");
4048 Register OpReg = I.getOperand(1).getReg();
4049
4050 // With SPV_KHR_poison_freeze, lower `freeze` to OpFreezeKHR.
4051 if (STI.canUseExtension(SPIRV::Extension::SPV_KHR_poison_freeze)) {
4052 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpFreezeKHR))
4053 .addDef(ResVReg)
4054 .addUse(GR.getSPIRVTypeID(ResType))
4055 .addUse(OpReg)
4056 .constrainAllUses(TII, TRI, RBI);
4057 return true;
4058 }
4059
4060 // There is no way to implement `freeze` correctly without support on SPIR-V
4061 // standard side, but we may at least address a simple (static) case when
4062 // undef/poison value presence is obvious. The main benefit of even
4063 // incomplete `freeze` support is preventing of translation from crashing due
4064 // to lack of support on legalization and instruction selection steps.
4065 if (MachineInstr *Def = MRI->getVRegDef(OpReg)) {
4066 if (Def->getOpcode() == TargetOpcode::COPY)
4067 Def = MRI->getVRegDef(Def->getOperand(1).getReg());
4068 Register Reg;
4069 switch (Def->getOpcode()) {
4070 case SPIRV::ASSIGN_TYPE:
4071 if (MachineInstr *AssignToDef =
4072 MRI->getVRegDef(Def->getOperand(1).getReg())) {
4073 if (AssignToDef->getOpcode() == TargetOpcode::G_IMPLICIT_DEF)
4074 Reg = Def->getOperand(2).getReg();
4075 }
4076 break;
4077 case SPIRV::OpUndef:
4078 Reg = Def->getOperand(1).getReg();
4079 break;
4080 }
4081 unsigned DestOpCode;
4082 if (Reg.isValid()) {
4083 DestOpCode = SPIRV::OpConstantNull;
4084 LLVM_DEBUG(dbgs() << "SPV_KHR_poison_freeze is not enabled. freeze of a "
4085 "static undef/poison lowered to OpConstantNull\n");
4086 } else {
4087 DestOpCode = TargetOpcode::COPY;
4088 Reg = OpReg;
4089 LLVM_DEBUG(dbgs() << "SPV_KHR_poison_freeze is not enabled. freeze "
4090 "skipped, lowered as a copy of the operand\n");
4091 }
4092 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(DestOpCode))
4093 .addDef(I.getOperand(0).getReg())
4094 .addUse(Reg)
4095 .constrainAllUses(TII, TRI, RBI);
4096 return true;
4097 }
4098 return false;
4099}
4100
4101bool SPIRVInstructionSelector::selectBuildVector(Register ResVReg,
4102 SPIRVTypeInst ResType,
4103 MachineInstr &I) const {
4104 unsigned N = 0;
4105 if (ResType->getOpcode() == SPIRV::OpTypeVector)
4106 N = GR.getScalarOrVectorComponentCount(ResType);
4107 else if (ResType->getOpcode() == SPIRV::OpTypeArray)
4108 N = getArrayComponentCount(MRI, ResType);
4109 else
4110 report_fatal_error("Cannot select G_BUILD_VECTOR with a non-vector result");
4111 if (I.getNumExplicitOperands() - I.getNumExplicitDefs() != N)
4112 report_fatal_error("G_BUILD_VECTOR and the result type are inconsistent");
4113
4114 // check if we may construct a constant vector
4115 bool IsConst = true;
4116 for (unsigned i = I.getNumExplicitDefs();
4117 i < I.getNumExplicitOperands() && IsConst; ++i)
4118 if (!isConstReg(MRI, I.getOperand(i).getReg()))
4119 IsConst = false;
4120
4121 if (!IsConst && N < 2)
4122 return diagnoseUnsupported(
4123 I, "There must be at least two constituent operands in a vector");
4124
4125 MRI->setRegClass(ResVReg, GR.getRegClass(ResType));
4126
4127 bool IsNullVector = IsConst && !STI.isShader();
4128 for (unsigned i = I.getNumExplicitDefs();
4129 i < I.getNumExplicitOperands() && IsNullVector; ++i) {
4130 MachineInstr *Def = getDef(I.getOperand(i), MRI);
4131 IsNullVector = Def && isNullOrNullSplat(*Def, *MRI);
4132 }
4133
4134 if (IsNullVector) {
4135 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpConstantNull))
4136 .addDef(ResVReg)
4137 .addUse(GR.getSPIRVTypeID(ResType))
4138 .constrainAllUses(TII, TRI, RBI);
4139 return true;
4140 }
4141
4142 auto MIB = BuildMI(*I.getParent(), I, I.getDebugLoc(),
4143 TII.get(IsConst ? SPIRV::OpConstantComposite
4144 : SPIRV::OpCompositeConstruct))
4145 .addDef(ResVReg)
4146 .addUse(GR.getSPIRVTypeID(ResType));
4147 for (unsigned i = I.getNumExplicitDefs(); i < I.getNumExplicitOperands(); ++i)
4148 MIB.addUse(I.getOperand(i).getReg());
4149 MIB.constrainAllUses(TII, TRI, RBI);
4150 return true;
4151}
4152
4153bool SPIRVInstructionSelector::selectSplatVector(Register ResVReg,
4154 SPIRVTypeInst ResType,
4155 MachineInstr &I) const {
4156 unsigned N = 0;
4157 if (ResType->getOpcode() == SPIRV::OpTypeVector)
4158 N = GR.getScalarOrVectorComponentCount(ResType);
4159 else if (ResType->getOpcode() == SPIRV::OpTypeArray)
4160 N = getArrayComponentCount(MRI, ResType);
4161 else
4162 report_fatal_error("Cannot select G_SPLAT_VECTOR with a non-vector result");
4163
4164 unsigned OpIdx = I.getNumExplicitDefs();
4165 if (!I.getOperand(OpIdx).isReg())
4166 report_fatal_error("Unexpected argument in G_SPLAT_VECTOR");
4167
4168 // check if we may construct a constant vector
4169 Register OpReg = I.getOperand(OpIdx).getReg();
4170 bool IsConst = isConstReg(MRI, OpReg);
4171
4172 if (!IsConst && N < 2)
4173 return diagnoseUnsupported(
4174 I, "There must be at least two constituent operands in a vector");
4175
4176 MRI->setRegClass(ResVReg, GR.getRegClass(ResType));
4177 auto MIB = BuildMI(*I.getParent(), I, I.getDebugLoc(),
4178 TII.get(IsConst ? SPIRV::OpConstantComposite
4179 : SPIRV::OpCompositeConstruct))
4180 .addDef(ResVReg)
4181 .addUse(GR.getSPIRVTypeID(ResType));
4182 for (unsigned i = 0; i < N; ++i)
4183 MIB.addUse(OpReg);
4184 MIB.constrainAllUses(TII, TRI, RBI);
4185 return true;
4186}
4187
4188bool SPIRVInstructionSelector::selectConcatVectors(Register ResVReg,
4189 SPIRVTypeInst ResType,
4190 MachineInstr &I) const {
4191 // Implement G_CONCAT_VECTORS using OpCompositeConstruct, which allows vector
4192 // constituents that share the result's component type to be
4193 // concatenated in operand order.
4194 if (ResType->getOpcode() != SPIRV::OpTypeVector)
4196 "Cannot select G_CONCAT_VECTORS with a non-vector result");
4197
4198 auto MIB = BuildMI(*I.getParent(), I, I.getDebugLoc(),
4199 TII.get(SPIRV::OpCompositeConstruct))
4200 .addDef(ResVReg)
4201 .addUse(GR.getSPIRVTypeID(ResType));
4202 for (unsigned OpIdx = I.getNumExplicitDefs();
4204 MIB.addUse(I.getOperand(OpIdx).getReg());
4205 MIB.constrainAllUses(TII, TRI, RBI);
4206 return true;
4207}
4208
4209bool SPIRVInstructionSelector::selectDiscard(Register ResVReg,
4210 SPIRVTypeInst ResType,
4211 MachineInstr &I) const {
4212
4213 unsigned Opcode;
4214
4215 if (STI.canUseExtension(
4216 SPIRV::Extension::SPV_EXT_demote_to_helper_invocation) ||
4217 STI.isAtLeastSPIRVVer(llvm::VersionTuple(1, 6))) {
4218 Opcode = SPIRV::OpDemoteToHelperInvocation;
4219 } else {
4220 Opcode = SPIRV::OpKill;
4221 // OpKill must be the last operation of any basic block.
4222 if (MachineInstr *NextI = I.getNextNode()) {
4223 GR.invalidateMachineInstr(NextI);
4224 NextI->eraseFromParent();
4225 }
4226 }
4227
4228 MachineBasicBlock &BB = *I.getParent();
4229 BuildMI(BB, I, I.getDebugLoc(), TII.get(Opcode))
4230 .constrainAllUses(TII, TRI, RBI);
4231 return true;
4232}
4233
4234bool SPIRVInstructionSelector::selectCmp(Register ResVReg,
4235 SPIRVTypeInst ResType, unsigned CmpOpc,
4236 MachineInstr &I) const {
4237 Register Cmp0 = I.getOperand(2).getReg();
4238 Register Cmp1 = I.getOperand(3).getReg();
4239 assert(GR.getSPIRVTypeForVReg(Cmp0)->getOpcode() ==
4240 GR.getSPIRVTypeForVReg(Cmp1)->getOpcode() &&
4241 "CMP operands should have the same type");
4242 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(CmpOpc))
4243 .addDef(ResVReg)
4244 .addUse(GR.getSPIRVTypeID(ResType))
4245 .addUse(Cmp0)
4246 .addUse(Cmp1)
4247 .setMIFlags(I.getFlags())
4248 .constrainAllUses(TII, TRI, RBI);
4249 return true;
4250}
4251
4252bool SPIRVInstructionSelector::selectICmp(Register ResVReg,
4253 SPIRVTypeInst ResType,
4254 MachineInstr &I) const {
4255 auto Pred = I.getOperand(1).getPredicate();
4256 unsigned CmpOpc;
4257
4258 Register CmpOperand = I.getOperand(2).getReg();
4259 if (GR.isScalarOfType(CmpOperand, SPIRV::OpTypePointer)) {
4260 CmpOpc = getPtrCmpOpcode(Pred);
4261 // OpPtrEqual/OpPtrNotEqual require both operands to share an identical
4262 // pointer type. If they are not OpBitcast is inserted.
4263 Register Op1 = I.getOperand(3).getReg();
4264 SPIRVTypeInst Ty0 = GR.getSPIRVTypeForVReg(CmpOperand);
4265 if (Ty0 != GR.getSPIRVTypeForVReg(Op1)) {
4266 Register NewOp1 = createVirtualRegister(Ty0, &GR, MRI, MRI->getMF());
4267 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpBitcast))
4268 .addDef(NewOp1)
4269 .addUse(GR.getSPIRVTypeID(Ty0))
4270 .addUse(Op1)
4271 .constrainAllUses(TII, TRI, RBI);
4272 I.getOperand(3).setReg(NewOp1);
4273 }
4274 } else if (GR.isScalarOrVectorOfType(CmpOperand, SPIRV::OpTypeBool))
4275 CmpOpc = getBoolCmpOpcode(Pred);
4276 else
4277 CmpOpc = getICmpOpcode(Pred);
4278 return selectCmp(ResVReg, ResType, CmpOpc, I);
4279}
4280
4282SPIRVInstructionSelector::buildI32Constant(uint32_t Val, MachineInstr &I,
4283 SPIRVTypeInst ResType) const {
4284 Type *LLVMTy = IntegerType::get(GR.CurMF->getFunction().getContext(), 32);
4285 SPIRVTypeInst SpvI32Ty =
4286 ResType ? ResType : GR.getOrCreateSPIRVIntegerType(32, I, TII);
4287 // Find a constant in DT or build a new one.
4288 auto ConstInt = ConstantInt::get(LLVMTy, Val);
4289 Register NewReg = GR.find(ConstInt, GR.CurMF);
4290 if (!NewReg.isValid()) {
4291 NewReg = MRI->createGenericVirtualRegister(LLT::scalar(64));
4292 MachineBasicBlock &BB = *I.getParent();
4293 MachineInstr *MI =
4294 Val == 0
4295 ? BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpConstantNull))
4296 .addDef(NewReg)
4297 .addUse(GR.getSPIRVTypeID(SpvI32Ty))
4298 : BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpConstantI))
4299 .addDef(NewReg)
4300 .addUse(GR.getSPIRVTypeID(SpvI32Ty))
4301 .addImm(APInt(32, Val).getZExtValue());
4303 GR.add(ConstInt, MI);
4304 }
4305 return NewReg;
4306}
4307
4308// Like buildI32Constant, but always inserts the constant definition in the
4309// entry block so it dominates all uses regardless of block ordering.
4310Register SPIRVInstructionSelector::buildI32ConstantInEntryBlock(
4311 uint32_t Val, MachineInstr &I, SPIRVTypeInst ResType) const {
4312 Type *LLVMTy = IntegerType::get(GR.CurMF->getFunction().getContext(), 32);
4313 SPIRVTypeInst SpvI32Ty =
4314 ResType ? ResType : GR.getOrCreateSPIRVIntegerType(32, I, TII);
4315 auto *ConstInt = ConstantInt::get(LLVMTy, Val);
4316 Register NewReg = GR.find(ConstInt, GR.CurMF);
4317 if (!NewReg.isValid()) {
4318 NewReg = MRI->createGenericVirtualRegister(LLT::scalar(64));
4319 auto InsertIt = getOpVariableMBBIt(*I.getMF());
4320 MachineBasicBlock &EntryBB = *InsertIt->getParent();
4321 MachineInstr *MI = nullptr;
4322 Register TypeReg = GR.getSPIRVTypeID(SpvI32Ty);
4323 DebugLoc DbgLoc = I.getDebugLoc();
4324 if (Val == 0) {
4325 MI = BuildMI(EntryBB, InsertIt, DbgLoc, TII.get(SPIRV::OpConstantNull))
4326 .addDef(NewReg)
4327 .addUse(TypeReg);
4328 } else {
4329 uint64_t ImmVal = APInt(32, Val).getZExtValue();
4330 MI = BuildMI(EntryBB, InsertIt, DbgLoc, TII.get(SPIRV::OpConstantI))
4331 .addDef(NewReg)
4332 .addUse(TypeReg)
4333 .addImm(ImmVal);
4334 }
4336 GR.add(ConstInt, MI);
4337 }
4338 return NewReg;
4339}
4340
4341bool SPIRVInstructionSelector::selectFCmp(Register ResVReg,
4342 SPIRVTypeInst ResType,
4343 MachineInstr &I) const {
4344 unsigned CmpOp = getFCmpOpcode(I.getOperand(1).getPredicate());
4345 return selectCmp(ResVReg, ResType, CmpOp, I);
4346}
4347
4348bool SPIRVInstructionSelector::selectExp10(Register ResVReg,
4349 SPIRVTypeInst ResType,
4350 MachineInstr &I) const {
4351 if (STI.canUseExtInstSet(SPIRV::InstructionSet::OpenCL_std)) {
4352 return selectExtInst(ResVReg, ResType, I, CL::exp10);
4353 }
4354
4355 if (STI.canUseExtInstSet(SPIRV::InstructionSet::GLSL_std_450)) {
4356 /// There is no exp10 in GLSL. Use exp10(x) = exp2(x * log2(10)) instead
4357 /// log2(10) ~= 3.3219280948874l
4358
4359 if (ResType->getOpcode() != SPIRV::OpTypeVector &&
4360 ResType->getOpcode() != SPIRV::OpTypeFloat)
4361 return false;
4362
4363 MachineIRBuilder MIRBuilder(I);
4364
4365 SPIRVTypeInst SpirvScalarType = GR.getScalarOrVectorComponentType(ResType);
4366
4367 // Match the literal precision to the scalar type so the OpConstant
4368 // literal does not contain non-zero high-order bits that would fail
4369 // SPIR-V validation when the type is narrower than 32 bits (e.g. half).
4370 APFloat ConstVal(3.3219280948873623);
4371 bool LosesInfo;
4372 ConstVal.convert(
4373 getZeroFP(GR.getTypeForSPIRVType(SpirvScalarType)).getSemantics(),
4374 APFloat::rmNearestTiesToEven, &LosesInfo);
4375 Register ConstReg =
4376 GR.buildConstantFP(ConstVal, MIRBuilder, SpirvScalarType);
4377 Register ArgReg = MRI->createVirtualRegister(GR.getRegClass(ResType));
4378 auto Opcode = ResType->getOpcode() == SPIRV::OpTypeVector
4379 ? SPIRV::OpVectorTimesScalar
4380 : SPIRV::OpFMulS;
4381
4382 if (!selectOpWithSrcs(ArgReg, ResType, I,
4383 {I.getOperand(1).getReg(), ConstReg}, Opcode))
4384 return false;
4385 if (!selectExtInst(ResVReg, ResType, I,
4386 {{SPIRV::InstructionSet::GLSL_std_450, GL::Exp2}}, false,
4387 false, {ArgReg}))
4388 return false;
4389
4390 return true;
4391 }
4392
4393 return false;
4394}
4395
4396Register SPIRVInstructionSelector::buildZerosVal(SPIRVTypeInst ResType,
4397 MachineInstr &I) const {
4398 // OpenCL uses nulls for Zero. In HLSL we don't use null constants.
4399 bool ZeroAsNull = !STI.isShader();
4400 if (ResType->getOpcode() == SPIRV::OpTypeVector)
4401 return GR.getOrCreateConstVector(0UL, I, ResType, TII, ZeroAsNull);
4402 return GR.getOrCreateConstInt(0, I, ResType, TII, ZeroAsNull);
4403}
4404
4405bool SPIRVInstructionSelector::isScalarOrVectorIntConstantZero(
4406 Register Reg) const {
4407 SPIRVTypeInst Type = GR.getSPIRVTypeForVReg(Reg);
4408 if (!Type)
4409 return false;
4410 SPIRVTypeInst CompType = GR.getScalarOrVectorComponentType(Type);
4411 if (!CompType || CompType->getOpcode() != SPIRV::OpTypeInt)
4412 return false;
4413
4414 auto IsZero = [this](Register Reg) {
4415 MachineInstr *Def = getDefInstrMaybeConstant(Reg, MRI);
4416 if (!Def)
4417 return false;
4418
4419 if (Def->getOpcode() == SPIRV::OpConstantNull)
4420 return true;
4421
4422 if (Def->getOpcode() == TargetOpcode::G_CONSTANT ||
4423 Def->getOpcode() == SPIRV::OpConstantI)
4424 return getIConstVal(Reg, MRI) == 0;
4425
4426 return false;
4427 };
4428
4429 if (IsZero(Reg))
4430 return true;
4431
4432 MachineInstr *Def = MRI->getVRegDef(Reg);
4433 if (!Def)
4434 return false;
4435
4436 if (Def->getOpcode() == TargetOpcode::G_BUILD_VECTOR ||
4437 (Def->getOpcode() == TargetOpcode::G_INTRINSIC_W_SIDE_EFFECTS &&
4438 cast<GIntrinsic>(Def)->getIntrinsicID() ==
4439 Intrinsic::spv_const_composite)) {
4440 unsigned StartOp = Def->getOpcode() == TargetOpcode::G_BUILD_VECTOR ? 1 : 2;
4441 for (unsigned i = StartOp; i < Def->getNumOperands(); ++i) {
4442 if (!IsZero(Def->getOperand(i).getReg()))
4443 return false;
4444 }
4445 return true;
4446 }
4447
4448 return false;
4449}
4450
4451Register SPIRVInstructionSelector::buildZerosValF(SPIRVTypeInst ResType,
4452 MachineInstr &I) const {
4453 // OpenCL uses nulls for Zero. In HLSL we don't use null constants.
4454 bool ZeroAsNull = !STI.isShader();
4455 APFloat VZero = getZeroFP(GR.getTypeForSPIRVType(ResType));
4456 if (ResType->getOpcode() == SPIRV::OpTypeVector)
4457 return GR.getOrCreateConstVector(VZero, I, ResType, TII, ZeroAsNull);
4458 return GR.getOrCreateConstFP(VZero, I, ResType, TII, ZeroAsNull);
4459}
4460
4461Register SPIRVInstructionSelector::buildOnesValF(SPIRVTypeInst ResType,
4462 MachineInstr &I) const {
4463 // OpenCL uses nulls for Zero. In HLSL we don't use null constants.
4464 bool ZeroAsNull = !STI.isShader();
4465 APFloat VOne = getOneFP(GR.getTypeForSPIRVType(ResType));
4466 if (ResType->getOpcode() == SPIRV::OpTypeVector)
4467 return GR.getOrCreateConstVector(VOne, I, ResType, TII, ZeroAsNull);
4468 return GR.getOrCreateConstFP(VOne, I, ResType, TII, ZeroAsNull);
4469}
4470
4471Register SPIRVInstructionSelector::buildOnesVal(bool AllOnes,
4472 SPIRVTypeInst ResType,
4473 MachineInstr &I) const {
4474 unsigned BitWidth = GR.getScalarOrVectorBitWidth(ResType);
4475 APInt One =
4476 AllOnes ? APInt::getAllOnes(BitWidth) : APInt::getOneBitSet(BitWidth, 0);
4477 if (ResType->getOpcode() == SPIRV::OpTypeVector)
4478 return GR.getOrCreateConstVector(One, I, ResType, TII);
4479 return GR.getOrCreateConstInt(One, I, ResType, TII);
4480}
4481
4482bool SPIRVInstructionSelector::selectSelect(Register ResVReg,
4483 SPIRVTypeInst ResType,
4484 MachineInstr &I) const {
4485 Register SelectFirstArg = I.getOperand(2).getReg();
4486 Register SelectSecondArg = I.getOperand(3).getReg();
4487 assert(ResType == GR.getSPIRVTypeForVReg(SelectFirstArg) &&
4488 ResType == GR.getSPIRVTypeForVReg(SelectSecondArg));
4489
4490 bool IsFloatTy =
4491 GR.isScalarOrVectorOfType(SelectFirstArg, SPIRV::OpTypeFloat);
4492 bool IsPtrTy =
4493 GR.isScalarOrVectorOfType(SelectFirstArg, SPIRV::OpTypePointer);
4494 bool IsVectorTy = GR.getSPIRVTypeForVReg(SelectFirstArg)->getOpcode() ==
4495 SPIRV::OpTypeVector;
4496
4497 bool IsScalarBool =
4498 GR.isScalarOfType(I.getOperand(1).getReg(), SPIRV::OpTypeBool);
4499 unsigned Opcode;
4500 if (IsVectorTy) {
4501 if (IsFloatTy) {
4502 Opcode = IsScalarBool ? SPIRV::OpSelectVFSCond : SPIRV::OpSelectVFVCond;
4503 } else if (IsPtrTy) {
4504 Opcode = IsScalarBool ? SPIRV::OpSelectVPSCond : SPIRV::OpSelectVPVCond;
4505 } else {
4506 Opcode = IsScalarBool ? SPIRV::OpSelectVISCond : SPIRV::OpSelectVIVCond;
4507 }
4508 } else {
4509 assert(IsScalarBool && "OpSelect with a scalar result requires a scalar "
4510 "boolean condition");
4511 if (IsFloatTy) {
4512 Opcode = SPIRV::OpSelectSFSCond;
4513 } else if (IsPtrTy) {
4514 Opcode = SPIRV::OpSelectSPSCond;
4515 } else {
4516 Opcode = SPIRV::OpSelectSISCond;
4517 }
4518 }
4519 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(Opcode))
4520 .addDef(ResVReg)
4521 .addUse(GR.getSPIRVTypeID(ResType))
4522 .addUse(I.getOperand(1).getReg())
4523 .addUse(SelectFirstArg)
4524 .addUse(SelectSecondArg)
4525 .constrainAllUses(TII, TRI, RBI);
4526 return true;
4527}
4528
4529// This function is used to extend a bool or a vector of bools into an integer
4530// or vector of integers.
4531bool SPIRVInstructionSelector::selectBoolToInt(Register ResVReg,
4532 SPIRVTypeInst ResType,
4533 Register BooleanVReg,
4534 MachineInstr &InsertAt,
4535 bool IsSigned) const {
4536 // To extend a bool, we need to use OpSelect between constants.
4537 Register ZeroReg = buildZerosVal(ResType, InsertAt);
4538 Register OneReg = buildOnesVal(IsSigned, ResType, InsertAt);
4539 bool IsScalarBool = GR.isScalarOfType(BooleanVReg, SPIRV::OpTypeBool);
4540 unsigned Opcode =
4541 IsScalarBool ? SPIRV::OpSelectSISCond : SPIRV::OpSelectVIVCond;
4542 BuildMI(*InsertAt.getParent(), InsertAt, InsertAt.getDebugLoc(),
4543 TII.get(Opcode))
4544 .addDef(ResVReg)
4545 .addUse(GR.getSPIRVTypeID(ResType))
4546 .addUse(BooleanVReg)
4547 .addUse(OneReg)
4548 .addUse(ZeroReg)
4549 .constrainAllUses(TII, TRI, RBI);
4550 return true;
4551}
4552
4553bool SPIRVInstructionSelector::selectIToF(Register ResVReg,
4554 SPIRVTypeInst ResType,
4555 MachineInstr &I, bool IsSigned,
4556 unsigned Opcode) const {
4557 Register SrcReg = I.getOperand(1).getReg();
4558 // We can convert bool value directly to float type without OpConvert*ToF,
4559 // however the translator generates OpSelect+OpConvert*ToF, so we do the same.
4560 if (GR.isScalarOrVectorOfType(I.getOperand(1).getReg(), SPIRV::OpTypeBool)) {
4561 unsigned BitWidth = GR.getScalarOrVectorBitWidth(ResType);
4562 SPIRVTypeInst TmpType = GR.getOrCreateSPIRVIntegerType(BitWidth, I, TII);
4563 if (ResType->getOpcode() == SPIRV::OpTypeVector) {
4564 const unsigned NumElts = GR.getScalarOrVectorComponentCount(ResType);
4565 TmpType = GR.getOrCreateSPIRVVectorType(TmpType, NumElts, I, TII);
4566 }
4567 SrcReg = createVirtualRegister(TmpType, &GR, MRI, MRI->getMF());
4568 selectBoolToInt(SrcReg, TmpType, I.getOperand(1).getReg(), I, false);
4569 }
4570 return selectOpWithSrcs(ResVReg, ResType, I, {SrcReg}, Opcode);
4571}
4572
4573bool SPIRVInstructionSelector::selectExt(Register ResVReg,
4574 SPIRVTypeInst ResType, MachineInstr &I,
4575 bool IsSigned) const {
4576 Register SrcReg = I.getOperand(1).getReg();
4577 if (GR.isScalarOrVectorOfType(SrcReg, SPIRV::OpTypeBool))
4578 return selectBoolToInt(ResVReg, ResType, I.getOperand(1).getReg(), I,
4579 IsSigned);
4580
4581 SPIRVTypeInst SrcType = GR.getSPIRVTypeForVReg(SrcReg);
4582 if (ResType == SrcType)
4583 return BuildCOPY(ResVReg, SrcReg, I);
4584
4585 unsigned Opcode = IsSigned ? SPIRV::OpSConvert : SPIRV::OpUConvert;
4586 return selectUnOp(ResVReg, ResType, I, Opcode);
4587}
4588
4589bool SPIRVInstructionSelector::selectSUCmp(Register ResVReg,
4590 SPIRVTypeInst ResType,
4591 MachineInstr &I,
4592 bool IsSigned) const {
4593 MachineIRBuilder MIRBuilder(I);
4594 MachineRegisterInfo *MRI = MIRBuilder.getMRI();
4595 MachineBasicBlock &BB = *I.getParent();
4596 // Ensure we have bool.
4597 SPIRVTypeInst BoolType = GR.getOrCreateSPIRVBoolType(I, TII);
4598 unsigned N = GR.getScalarOrVectorComponentCount(ResType);
4599 if (N > 1)
4600 BoolType = GR.getOrCreateSPIRVVectorType(BoolType, N, I, TII);
4601 Register BoolTypeReg = GR.getSPIRVTypeID(BoolType);
4602 // Build less-than-equal and less-than.
4603 Register IsLessEqReg =
4604 createVirtualRegister(BoolType, &GR, MRI, MIRBuilder.getMF());
4605 BuildMI(BB, I, I.getDebugLoc(),
4606 TII.get(IsSigned ? SPIRV::OpSLessThanEqual : SPIRV::OpULessThanEqual))
4607 .addDef(IsLessEqReg)
4608 .addUse(BoolTypeReg)
4609 .addUse(I.getOperand(1).getReg())
4610 .addUse(I.getOperand(2).getReg())
4611 .constrainAllUses(TII, TRI, RBI);
4612 Register IsLessReg =
4613 createVirtualRegister(BoolType, &GR, MRI, MIRBuilder.getMF());
4614 BuildMI(BB, I, I.getDebugLoc(),
4615 TII.get(IsSigned ? SPIRV::OpSLessThan : SPIRV::OpULessThan))
4616 .addDef(IsLessReg)
4617 .addUse(BoolTypeReg)
4618 .addUse(I.getOperand(1).getReg())
4619 .addUse(I.getOperand(2).getReg())
4620 .constrainAllUses(TII, TRI, RBI);
4621 // Build selects.
4622 Register ResTypeReg = GR.getSPIRVTypeID(ResType);
4623 Register NegOneOrZeroReg =
4624 MRI->createVirtualRegister(GR.getRegClass(ResType));
4625 MRI->setType(NegOneOrZeroReg, LLT::scalar(64));
4626 GR.assignSPIRVTypeToVReg(ResType, NegOneOrZeroReg, MIRBuilder.getMF());
4627 unsigned SelectOpcode =
4628 N > 1 ? SPIRV::OpSelectVIVCond : SPIRV::OpSelectSISCond;
4629 BuildMI(BB, I, I.getDebugLoc(), TII.get(SelectOpcode))
4630 .addDef(NegOneOrZeroReg)
4631 .addUse(ResTypeReg)
4632 .addUse(IsLessReg)
4633 .addUse(buildOnesVal(true, ResType, I)) // -1
4634 .addUse(buildZerosVal(ResType, I))
4635 .constrainAllUses(TII, TRI, RBI);
4636 BuildMI(BB, I, I.getDebugLoc(), TII.get(SelectOpcode))
4637 .addDef(ResVReg)
4638 .addUse(ResTypeReg)
4639 .addUse(IsLessEqReg)
4640 .addUse(NegOneOrZeroReg) // -1 or 0
4641 .addUse(buildOnesVal(false, ResType, I))
4642 .constrainAllUses(TII, TRI, RBI);
4643 return true;
4644}
4645
4646bool SPIRVInstructionSelector::selectIntToBool(Register IntReg,
4647 Register ResVReg,
4648 MachineInstr &I,
4649 SPIRVTypeInst IntTy,
4650 SPIRVTypeInst BoolTy) const {
4651 // To truncate to a bool, we use OpBitwiseAnd 1 and OpINotEqual to zero.
4652 Register BitIntReg = createVirtualRegister(IntTy, &GR, MRI, MRI->getMF());
4653 bool IsVectorTy = IntTy->getOpcode() == SPIRV::OpTypeVector;
4654 unsigned Opcode = IsVectorTy ? SPIRV::OpBitwiseAndV : SPIRV::OpBitwiseAndS;
4655 Register Zero = buildZerosVal(IntTy, I);
4656 Register One = buildOnesVal(false, IntTy, I);
4657 MachineBasicBlock &BB = *I.getParent();
4658 BuildMI(BB, I, I.getDebugLoc(), TII.get(Opcode))
4659 .addDef(BitIntReg)
4660 .addUse(GR.getSPIRVTypeID(IntTy))
4661 .addUse(IntReg)
4662 .addUse(One)
4663 .constrainAllUses(TII, TRI, RBI);
4664 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpINotEqual))
4665 .addDef(ResVReg)
4666 .addUse(GR.getSPIRVTypeID(BoolTy))
4667 .addUse(BitIntReg)
4668 .addUse(Zero)
4669 .constrainAllUses(TII, TRI, RBI);
4670 return true;
4671}
4672
4673bool SPIRVInstructionSelector::selectTrunc(Register ResVReg,
4674 SPIRVTypeInst ResType,
4675 MachineInstr &I) const {
4676 Register IntReg = I.getOperand(1).getReg();
4677 const SPIRVTypeInst ArgType = GR.getSPIRVTypeForVReg(IntReg);
4678 if (GR.isScalarOrVectorOfType(ResVReg, SPIRV::OpTypeBool))
4679 return selectIntToBool(IntReg, ResVReg, I, ArgType, ResType);
4680 if (ArgType == ResType)
4681 return BuildCOPY(ResVReg, IntReg, I);
4682 bool IsSigned = GR.isScalarOrVectorSigned(ResType);
4683 unsigned Opcode = IsSigned ? SPIRV::OpSConvert : SPIRV::OpUConvert;
4684 return selectUnOp(ResVReg, ResType, I, Opcode);
4685}
4686
4687bool SPIRVInstructionSelector::selectConst(Register ResVReg,
4688 SPIRVTypeInst ResType,
4689 MachineInstr &I) const {
4690 unsigned Opcode = I.getOpcode();
4691 unsigned TpOpcode = ResType->getOpcode();
4692 Register Reg;
4693 if (TpOpcode == SPIRV::OpTypePointer || TpOpcode == SPIRV::OpTypeEvent) {
4694 assert(Opcode == TargetOpcode::G_CONSTANT &&
4695 I.getOperand(1).getCImm()->isZero());
4696 MachineBasicBlock &DepMBB = I.getMF()->front();
4697 MachineIRBuilder MIRBuilder(DepMBB, DepMBB.getFirstNonPHI());
4698 Reg = GR.getOrCreateConstNullPtr(MIRBuilder, ResType);
4699 } else if (Opcode == TargetOpcode::G_FCONSTANT) {
4700 Reg = GR.getOrCreateConstFP(I.getOperand(1).getFPImm()->getValue(), I,
4701 ResType, TII, !STI.isShader());
4702 } else {
4703 Reg = GR.getOrCreateConstInt(I.getOperand(1).getCImm()->getValue(), I,
4704 ResType, TII, !STI.isShader());
4705 }
4706 return Reg == ResVReg ? true : BuildCOPY(ResVReg, Reg, I);
4707}
4708
4709bool SPIRVInstructionSelector::selectOpUndef(Register ResVReg,
4710 SPIRVTypeInst ResType,
4711 MachineInstr &I) const {
4712 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpUndef))
4713 .addDef(ResVReg)
4714 .addUse(GR.getSPIRVTypeID(ResType))
4715 .constrainAllUses(TII, TRI, RBI);
4716 return true;
4717}
4718
4719bool SPIRVInstructionSelector::selectInsertVal(Register ResVReg,
4720 SPIRVTypeInst ResType,
4721 MachineInstr &I) const {
4722 MachineBasicBlock &BB = *I.getParent();
4723 auto MIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpCompositeInsert))
4724 .addDef(ResVReg)
4725 .addUse(GR.getSPIRVTypeID(ResType))
4726 // object to insert
4727 .addUse(I.getOperand(3).getReg())
4728 // composite to insert into
4729 .addUse(I.getOperand(2).getReg());
4730 for (unsigned i = 4; i < I.getNumOperands(); i++)
4731 MIB.addImm(foldImm(I.getOperand(i), MRI));
4732 MIB.constrainAllUses(TII, TRI, RBI);
4733 return true;
4734}
4735
4736bool SPIRVInstructionSelector::selectExtractVal(Register ResVReg,
4737 SPIRVTypeInst ResType,
4738 MachineInstr &I) const {
4739 Type *MaybeResTy = nullptr;
4740 StringRef ResName;
4741 if (GR.findValueAttrs(&I, MaybeResTy, ResName) &&
4742 MaybeResTy != GR.getTypeForSPIRVType(ResType)) {
4743 assert((!MaybeResTy || MaybeResTy->isAggregateType()) &&
4744 "Expected aggregate type for extractv instruction");
4745 ResType = GR.getOrCreateSPIRVType(MaybeResTy, I,
4746 SPIRV::AccessQualifier::ReadWrite, false);
4747 GR.assignSPIRVTypeToVReg(ResType, ResVReg, *I.getMF());
4748 }
4749 MachineBasicBlock &BB = *I.getParent();
4750 auto MIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpCompositeExtract))
4751 .addDef(ResVReg)
4752 .addUse(GR.getSPIRVTypeID(ResType))
4753 .addUse(I.getOperand(2).getReg());
4754 for (unsigned i = 3; i < I.getNumOperands(); i++)
4755 MIB.addImm(foldImm(I.getOperand(i), MRI));
4756 MIB.constrainAllUses(TII, TRI, RBI);
4757 return true;
4758}
4759
4760bool SPIRVInstructionSelector::selectInsertElt(Register ResVReg,
4761 SPIRVTypeInst ResType,
4762 MachineInstr &I) const {
4763 if (getImm(I.getOperand(4), MRI))
4764 return selectInsertVal(ResVReg, ResType, I);
4765 MachineBasicBlock &BB = *I.getParent();
4766 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpVectorInsertDynamic))
4767 .addDef(ResVReg)
4768 .addUse(GR.getSPIRVTypeID(ResType))
4769 .addUse(I.getOperand(2).getReg())
4770 .addUse(I.getOperand(3).getReg())
4771 .addUse(I.getOperand(4).getReg())
4772 .constrainAllUses(TII, TRI, RBI);
4773 return true;
4774}
4775
4776bool SPIRVInstructionSelector::selectExtractElt(Register ResVReg,
4777 SPIRVTypeInst ResType,
4778 MachineInstr &I) const {
4779 if (getImm(I.getOperand(3), MRI))
4780 return selectExtractVal(ResVReg, ResType, I);
4781 MachineBasicBlock &BB = *I.getParent();
4782 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpVectorExtractDynamic))
4783 .addDef(ResVReg)
4784 .addUse(GR.getSPIRVTypeID(ResType))
4785 .addUse(I.getOperand(2).getReg())
4786 .addUse(I.getOperand(3).getReg())
4787 .constrainAllUses(TII, TRI, RBI);
4788 return true;
4789}
4790
4791bool SPIRVInstructionSelector::selectGEP(Register ResVReg,
4792 SPIRVTypeInst ResType,
4793 MachineInstr &I) const {
4794 const bool IsGEPInBounds = I.getOperand(2).getImm();
4795
4796 // OpAccessChain could be used for OpenCL, but the SPIRV-LLVM Translator only
4797 // relies on PtrAccessChain, so we'll try not to deviate. For Vulkan however,
4798 // we have to use Op[InBounds]AccessChain.
4799 const unsigned Opcode = STI.isLogicalSPIRV()
4800 ? (IsGEPInBounds ? SPIRV::OpInBoundsAccessChain
4801 : SPIRV::OpAccessChain)
4802 : (IsGEPInBounds ? SPIRV::OpInBoundsPtrAccessChain
4803 : SPIRV::OpPtrAccessChain);
4804
4805 auto Res = BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(Opcode))
4806 .addDef(ResVReg)
4807 .addUse(GR.getSPIRVTypeID(ResType))
4808 // Object to get a pointer to.
4809 .addUse(I.getOperand(3).getReg());
4810 assert(
4811 (Opcode == SPIRV::OpPtrAccessChain ||
4812 Opcode == SPIRV::OpInBoundsPtrAccessChain ||
4813 (getImm(I.getOperand(4), MRI) && foldImm(I.getOperand(4), MRI) == 0)) &&
4814 "Cannot translate GEP to OpAccessChain. First index must be 0.");
4815
4816 // Adding indices.
4817 const unsigned StartingIndex =
4818 (Opcode == SPIRV::OpAccessChain || Opcode == SPIRV::OpInBoundsAccessChain)
4819 ? 5
4820 : 4;
4821 for (unsigned i = StartingIndex; i < I.getNumExplicitOperands(); ++i)
4822 Res.addUse(I.getOperand(i).getReg());
4823 Res.constrainAllUses(TII, TRI, RBI);
4824 return true;
4825}
4826
4827// Maybe wrap a value into OpSpecConstantOp
4828bool SPIRVInstructionSelector::wrapIntoSpecConstantOp(
4829 MachineInstr &I, SmallVector<Register> &CompositeArgs) const {
4830 unsigned Lim = I.getNumExplicitOperands();
4831 for (unsigned i = I.getNumExplicitDefs() + 1; i < Lim; ++i) {
4832 Register OpReg = I.getOperand(i).getReg();
4833 MachineInstr *OpDefine = MRI->getVRegDef(OpReg);
4834 SPIRVTypeInst OpType = GR.getSPIRVTypeForVReg(OpReg);
4835 if (!OpDefine || !OpType || isConstReg(MRI, OpDefine) ||
4836 OpDefine->getOpcode() == TargetOpcode::G_ADDRSPACE_CAST ||
4837 OpDefine->getOpcode() == TargetOpcode::G_INTTOPTR ||
4838 GR.isAggregateType(OpType)) {
4839 // The case of G_ADDRSPACE_CAST inside spv_const_composite() is processed
4840 // by selectAddrSpaceCast(), and G_INTTOPTR is processed by selectUnOp()
4841 CompositeArgs.push_back(OpReg);
4842 continue;
4843 }
4844 MachineFunction *MF = I.getMF();
4845 Register WrapReg = GR.find(OpDefine, MF);
4846 if (WrapReg.isValid()) {
4847 CompositeArgs.push_back(WrapReg);
4848 continue;
4849 }
4850 // Create a new register for the wrapper
4851 WrapReg = MRI->createVirtualRegister(GR.getRegClass(OpType));
4852 CompositeArgs.push_back(WrapReg);
4853 // Decorate the wrapper register and generate a new instruction
4854 MRI->setType(WrapReg, LLT::pointer(0, 64));
4855 GR.assignSPIRVTypeToVReg(OpType, WrapReg, *MF);
4856 auto MIB = BuildMI(*I.getParent(), I, I.getDebugLoc(),
4857 TII.get(SPIRV::OpSpecConstantOp))
4858 .addDef(WrapReg)
4859 .addUse(GR.getSPIRVTypeID(OpType))
4860 .addImm(static_cast<uint32_t>(SPIRV::Opcode::Bitcast))
4861 .addUse(OpReg);
4862 GR.add(OpDefine, MIB);
4863 MIB.constrainAllUses(TII, TRI, RBI);
4864 }
4865 return true;
4866}
4867
4868bool SPIRVInstructionSelector::selectDerivativeInst(
4869 Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I,
4870 const unsigned DPdOpCode) const {
4871 // TODO: This should check specifically for Fragment Execution Model, but STI
4872 // doesn't provide that information yet. See #167562
4873 if (!errorIfInstrOutsideShader(I))
4874 return false;
4875
4876 // If the arg/result types are half then we need to wrap the instr in
4877 // conversions to float
4878 // This case occurs because a half arg/result is legal in HLSL but not spirv.
4879 Register SrcReg = I.getOperand(2).getReg();
4880 SPIRVTypeInst SrcType = GR.getSPIRVTypeForVReg(SrcReg);
4881 unsigned BitWidth = std::min(GR.getScalarOrVectorBitWidth(SrcType),
4882 GR.getScalarOrVectorBitWidth(ResType));
4883 if (BitWidth == 32)
4884 return BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(DPdOpCode))
4885 .addDef(ResVReg)
4886 .addUse(GR.getSPIRVTypeID(ResType))
4887 .addUse(I.getOperand(2).getReg());
4888
4889 MachineIRBuilder MIRBuilder(I);
4890 unsigned componentCount = GR.getScalarOrVectorComponentCount(SrcType);
4891 SPIRVTypeInst F32ConvertTy = GR.getOrCreateSPIRVFloatType(32, I, TII);
4892 if (componentCount != 1)
4893 F32ConvertTy = GR.getOrCreateSPIRVVectorType(F32ConvertTy, componentCount,
4894 MIRBuilder, false);
4895
4896 const TargetRegisterClass *RegClass = GR.getRegClass(SrcType);
4897 Register ConvertToVReg = MRI->createVirtualRegister(RegClass);
4898 Register DpdOpVReg = MRI->createVirtualRegister(RegClass);
4899
4900 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpFConvert))
4901 .addDef(ConvertToVReg)
4902 .addUse(GR.getSPIRVTypeID(F32ConvertTy))
4903 .addUse(SrcReg)
4904 .constrainAllUses(TII, TRI, RBI);
4905 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(DPdOpCode))
4906 .addDef(DpdOpVReg)
4907 .addUse(GR.getSPIRVTypeID(F32ConvertTy))
4908 .addUse(ConvertToVReg)
4909 .constrainAllUses(TII, TRI, RBI);
4910 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpFConvert))
4911 .addDef(ResVReg)
4912 .addUse(GR.getSPIRVTypeID(ResType))
4913 .addUse(DpdOpVReg)
4914 .constrainAllUses(TII, TRI, RBI);
4915 return true;
4916}
4917
4918bool SPIRVInstructionSelector::selectIntrinsic(Register ResVReg,
4919 SPIRVTypeInst ResType,
4920 MachineInstr &I) const {
4921 MachineBasicBlock &BB = *I.getParent();
4922 Intrinsic::ID IID = cast<GIntrinsic>(I).getIntrinsicID();
4923 switch (IID) {
4924 case Intrinsic::spv_load:
4925 return selectLoad(ResVReg, ResType, I);
4926 case Intrinsic::spv_atomic_load:
4927 return selectAtomicLoad(ResVReg, ResType, I);
4928 case Intrinsic::spv_store:
4929 return selectStore(I);
4930 case Intrinsic::spv_atomic_store:
4931 return selectAtomicStore(I);
4932 case Intrinsic::spv_extractv:
4933 return selectExtractVal(ResVReg, ResType, I);
4934 case Intrinsic::spv_insertv:
4935 return selectInsertVal(ResVReg, ResType, I);
4936 case Intrinsic::spv_extractelt:
4937 return selectExtractElt(ResVReg, ResType, I);
4938 case Intrinsic::spv_insertelt:
4939 return selectInsertElt(ResVReg, ResType, I);
4940 case Intrinsic::spv_gep:
4941 return selectGEP(ResVReg, ResType, I);
4942 case Intrinsic::spv_bitcast: {
4943 Register OpReg = I.getOperand(2).getReg();
4944 SPIRVTypeInst OpType =
4945 OpReg.isValid() ? GR.getSPIRVTypeForVReg(OpReg) : nullptr;
4946 if (!GR.isBitcastCompatible(ResType, OpType))
4947 report_fatal_error("incompatible result and operand types in a bitcast");
4948 return selectOpWithSrcs(ResVReg, ResType, I, {OpReg}, SPIRV::OpBitcast);
4949 }
4950 case Intrinsic::spv_unref_global:
4951 case Intrinsic::spv_init_global: {
4952 MachineInstr *MI = MRI->getVRegDef(I.getOperand(1).getReg());
4953 MachineInstr *Init = I.getNumExplicitOperands() > 2
4954 ? MRI->getVRegDef(I.getOperand(2).getReg())
4955 : nullptr;
4956 assert(MI);
4957 Register GVarVReg = MI->getOperand(0).getReg();
4958 if (!selectGlobalValue(GVarVReg, *MI, Init))
4959 return false;
4960 // We violate SSA form by inserting OpVariable and still having a gMIR
4961 // instruction %vreg = G_GLOBAL_VALUE @gvar. We need to fix this by erasing
4962 // the duplicated definition.
4963 if (MI->getOpcode() == TargetOpcode::G_GLOBAL_VALUE) {
4965 MI->eraseFromParent();
4966 }
4967 return true;
4968 }
4969 case Intrinsic::spv_undef: {
4970 auto MIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpUndef))
4971 .addDef(ResVReg)
4972 .addUse(GR.getSPIRVTypeID(ResType));
4973 MIB.constrainAllUses(TII, TRI, RBI);
4974 return true;
4975 }
4976 case Intrinsic::spv_poison:
4977 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpPoisonKHR))
4978 .addDef(ResVReg)
4979 .addUse(GR.getSPIRVTypeID(ResType))
4980 .constrainAllUses(TII, TRI, RBI);
4981 return true;
4982 case Intrinsic::spv_freeze:
4983 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpFreezeKHR))
4984 .addDef(ResVReg)
4985 .addUse(GR.getSPIRVTypeID(ResType))
4986 .addUse(I.getOperand(2).getReg())
4987 .constrainAllUses(TII, TRI, RBI);
4988 return true;
4989 case Intrinsic::spv_named_boolean_spec_constant: {
4990 auto Opcode = I.getOperand(3).getImm() ? SPIRV::OpSpecConstantTrue
4991 : SPIRV::OpSpecConstantFalse;
4992
4993 auto MIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(Opcode))
4994 .addDef(I.getOperand(0).getReg())
4995 .addUse(GR.getSPIRVTypeID(ResType));
4996 MIB.constrainAllUses(TII, TRI, RBI);
4997 unsigned SpecId = I.getOperand(2).getImm();
4998 buildOpDecorate(I.getOperand(0).getReg(), *++MIB->getIterator(), TII,
4999 SPIRV::Decoration::SpecId, {SpecId});
5000
5001 return true;
5002 }
5003 case Intrinsic::spv_const_composite: {
5004 // If no values are attached, the composite is null constant.
5005 bool IsNull = I.getNumExplicitDefs() + 1 == I.getNumExplicitOperands();
5006 SmallVector<Register> CompositeArgs;
5007 MRI->setRegClass(ResVReg, GR.getRegClass(ResType));
5008
5009 // skip type MD node we already used when generated assign.type for this
5010 if (!IsNull) {
5011 if (!wrapIntoSpecConstantOp(I, CompositeArgs))
5012 return false;
5013 std::function<bool(Register)> HasSpecConstOperand =
5014 [&](Register Reg) -> bool {
5015 MachineInstr *Def = MRI->getVRegDef(Reg);
5016 if (!Def)
5017 return false;
5018 if (!isConstReg(MRI, Def))
5019 return true;
5020 // Recurse into not-yet-selected spv_const_composite intrinsics
5021 // to detect transitive spec constant operands.
5022 if (isSpvIntrinsic(*Def, Intrinsic::spv_const_composite)) {
5023 for (unsigned J = Def->getNumExplicitDefs() + 1;
5024 J < Def->getNumExplicitOperands(); ++J) {
5025 if (Def->getOperand(J).isReg() &&
5026 HasSpecConstOperand(Def->getOperand(J).getReg()))
5027 return true;
5028 }
5029 }
5030 return false;
5031 };
5032 bool HasSpecConst = llvm::any_of(CompositeArgs, HasSpecConstOperand);
5033 unsigned CompositeOpc = HasSpecConst ? SPIRV::OpSpecConstantComposite
5034 : SPIRV::OpConstantComposite;
5035 unsigned ContinuedOpc = HasSpecConst
5036 ? SPIRV::OpSpecConstantCompositeContinuedINTEL
5037 : SPIRV::OpConstantCompositeContinuedINTEL;
5038 MachineIRBuilder MIR(I);
5039 SmallVector<MachineInstr *, 4> Instructions = createContinuedInstructions(
5040 MIR, CompositeOpc, 3, ContinuedOpc, CompositeArgs, ResVReg,
5041 GR.getSPIRVTypeID(ResType));
5042 for (auto *Instr : Instructions) {
5043 Instr->setDebugLoc(I.getDebugLoc());
5045 }
5046 return true;
5047 } else {
5048 auto MIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpConstantNull))
5049 .addDef(ResVReg)
5050 .addUse(GR.getSPIRVTypeID(ResType));
5051 MIB.constrainAllUses(TII, TRI, RBI);
5052 return true;
5053 }
5054 }
5055 case Intrinsic::spv_assign_name: {
5056 auto MIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpName));
5057 MIB.addUse(I.getOperand(I.getNumExplicitDefs() + 1).getReg());
5058 for (unsigned i = I.getNumExplicitDefs() + 2;
5059 i < I.getNumExplicitOperands(); ++i) {
5060 MIB.addImm(I.getOperand(i).getImm());
5061 }
5062 MIB.constrainAllUses(TII, TRI, RBI);
5063 return true;
5064 }
5065 case Intrinsic::spv_switch: {
5066 auto MIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpSwitch));
5067 for (unsigned i = 1; i < I.getNumExplicitOperands(); ++i) {
5068 if (I.getOperand(i).isReg())
5069 MIB.addReg(I.getOperand(i).getReg());
5070 else if (I.getOperand(i).isCImm())
5071 addNumImm(I.getOperand(i).getCImm()->getValue(), MIB);
5072 else if (I.getOperand(i).isMBB())
5073 MIB.addMBB(I.getOperand(i).getMBB());
5074 else
5075 llvm_unreachable("Unexpected OpSwitch operand");
5076 }
5077 MIB.constrainAllUses(TII, TRI, RBI);
5078 return true;
5079 }
5080 case Intrinsic::spv_loop_merge: {
5081 auto MIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpLoopMerge));
5082 for (unsigned i = 1; i < I.getNumExplicitOperands(); ++i) {
5083 if (I.getOperand(i).isMBB())
5084 MIB.addMBB(I.getOperand(i).getMBB());
5085 else
5086 MIB.addImm(foldImm(I.getOperand(i), MRI));
5087 }
5088 MIB.constrainAllUses(TII, TRI, RBI);
5089 return true;
5090 }
5091 case Intrinsic::spv_loop_control_intel: {
5092 auto MIB =
5093 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpLoopControlINTEL));
5094 for (unsigned J = 1; J < I.getNumExplicitOperands(); ++J)
5095 MIB.addImm(foldImm(I.getOperand(J), MRI));
5096 MIB.constrainAllUses(TII, TRI, RBI);
5097 return true;
5098 }
5099 case Intrinsic::spv_selection_merge: {
5100 auto MIB =
5101 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpSelectionMerge));
5102 assert(I.getOperand(1).isMBB() &&
5103 "operand 1 to spv_selection_merge must be a basic block");
5104 MIB.addMBB(I.getOperand(1).getMBB());
5105 MIB.addImm(getSelectionOperandForImm(I.getOperand(2).getImm()));
5106 MIB.constrainAllUses(TII, TRI, RBI);
5107 return true;
5108 }
5109 case Intrinsic::spv_cmpxchg:
5110 return selectAtomicCmpXchg(ResVReg, ResType, I);
5111 case Intrinsic::spv_unreachable:
5112 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpUnreachable))
5113 .constrainAllUses(TII, TRI, RBI);
5114 return true;
5115 case Intrinsic::spv_abort:
5116 return selectAbort(I);
5117 case Intrinsic::spv_alloca:
5118 return selectFrameIndex(ResVReg, ResType, I);
5119 case Intrinsic::spv_alloca_array:
5120 return selectAllocaArray(ResVReg, ResType, I);
5121 case Intrinsic::spv_assume:
5122 if (STI.canUseExtension(SPIRV::Extension::SPV_KHR_expect_assume)) {
5123 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpAssumeTrueKHR))
5124 .addUse(I.getOperand(1).getReg())
5125 .constrainAllUses(TII, TRI, RBI);
5126 return true;
5127 }
5128 break;
5129 case Intrinsic::spv_expect:
5130 if (STI.canUseExtension(SPIRV::Extension::SPV_KHR_expect_assume)) {
5131 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpExpectKHR))
5132 .addDef(ResVReg)
5133 .addUse(GR.getSPIRVTypeID(ResType))
5134 .addUse(I.getOperand(2).getReg())
5135 .addUse(I.getOperand(3).getReg())
5136 .constrainAllUses(TII, TRI, RBI);
5137 return true;
5138 }
5139 break;
5140 case Intrinsic::arithmetic_fence:
5141 if (STI.canUseExtension(SPIRV::Extension::SPV_EXT_arithmetic_fence)) {
5142 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpArithmeticFenceEXT))
5143 .addDef(ResVReg)
5144 .addUse(GR.getSPIRVTypeID(ResType))
5145 .addUse(I.getOperand(2).getReg())
5146 .constrainAllUses(TII, TRI, RBI);
5147 return true;
5148 } else
5149 return BuildCOPY(ResVReg, I.getOperand(2).getReg(), I);
5150 break;
5151 case Intrinsic::spv_thread_id:
5152 // The HLSL SV_DispatchThreadID semantic is lowered to llvm.spv.thread.id
5153 // intrinsic in LLVM IR for SPIR-V backend.
5154 //
5155 // In SPIR-V backend, llvm.spv.thread.id is now correctly translated to a
5156 // `GlobalInvocationId` builtin variable
5157 return loadVec3BuiltinInputID(SPIRV::BuiltIn::GlobalInvocationId, ResVReg,
5158 ResType, I);
5159 case Intrinsic::spv_thread_id_in_group:
5160 // The HLSL SV_GroupThreadId semantic is lowered to
5161 // llvm.spv.thread.id.in.group intrinsic in LLVM IR for SPIR-V backend.
5162 //
5163 // In SPIR-V backend, llvm.spv.thread.id.in.group is now correctly
5164 // translated to a `LocalInvocationId` builtin variable
5165 return loadVec3BuiltinInputID(SPIRV::BuiltIn::LocalInvocationId, ResVReg,
5166 ResType, I);
5167 case Intrinsic::spv_group_id:
5168 // The HLSL SV_GroupId semantic is lowered to
5169 // llvm.spv.group.id intrinsic in LLVM IR for SPIR-V backend.
5170 //
5171 // In SPIR-V backend, llvm.spv.group.id is now translated to a `WorkgroupId`
5172 // builtin variable
5173 return loadVec3BuiltinInputID(SPIRV::BuiltIn::WorkgroupId, ResVReg, ResType,
5174 I);
5175 case Intrinsic::spv_flattened_thread_id_in_group:
5176 // The HLSL SV_GroupIndex semantic is lowered to
5177 // llvm.spv.flattened.thread.id.in.group() intrinsic in LLVM IR for SPIR-V
5178 // backend.
5179 //
5180 // In SPIR-V backend, llvm.spv.flattened.thread.id.in.group is translated to
5181 // a `LocalInvocationIndex` builtin variable
5182 return loadBuiltinInputID(SPIRV::BuiltIn::LocalInvocationIndex, ResVReg,
5183 ResType, I);
5184 case Intrinsic::spv_workgroup_size:
5185 return loadVec3BuiltinInputID(SPIRV::BuiltIn::WorkgroupSize, ResVReg,
5186 ResType, I);
5187 case Intrinsic::spv_global_size:
5188 return loadVec3BuiltinInputID(SPIRV::BuiltIn::GlobalSize, ResVReg, ResType,
5189 I);
5190 case Intrinsic::spv_global_offset:
5191 return loadVec3BuiltinInputID(SPIRV::BuiltIn::GlobalOffset, ResVReg,
5192 ResType, I);
5193 case Intrinsic::spv_num_workgroups:
5194 return loadVec3BuiltinInputID(SPIRV::BuiltIn::NumWorkgroups, ResVReg,
5195 ResType, I);
5196 case Intrinsic::spv_subgroup_size:
5197 return loadBuiltinInputID(SPIRV::BuiltIn::SubgroupSize, ResVReg, ResType,
5198 I);
5199 case Intrinsic::spv_num_subgroups:
5200 return loadBuiltinInputID(SPIRV::BuiltIn::NumSubgroups, ResVReg, ResType,
5201 I);
5202 case Intrinsic::spv_subgroup_id:
5203 return loadBuiltinInputID(SPIRV::BuiltIn::SubgroupId, ResVReg, ResType, I);
5204 case Intrinsic::spv_subgroup_local_invocation_id:
5205 return loadBuiltinInputID(SPIRV::BuiltIn::SubgroupLocalInvocationId,
5206 ResVReg, ResType, I);
5207 case Intrinsic::spv_subgroup_max_size:
5208 return loadBuiltinInputID(SPIRV::BuiltIn::SubgroupMaxSize, ResVReg, ResType,
5209 I);
5210 case Intrinsic::spv_fdot:
5211 return selectFloatDot(ResVReg, ResType, I);
5212 case Intrinsic::spv_udot:
5213 case Intrinsic::spv_sdot:
5214 if (STI.canUseExtension(SPIRV::Extension::SPV_KHR_integer_dot_product) ||
5215 STI.isAtLeastSPIRVVer(VersionTuple(1, 6)))
5216 return selectIntegerDot(ResVReg, ResType, I,
5217 /*Signed=*/IID == Intrinsic::spv_sdot);
5218 return selectIntegerDotExpansion(ResVReg, ResType, I);
5219 case Intrinsic::spv_dot4add_i8packed:
5220 if (STI.canUseExtension(SPIRV::Extension::SPV_KHR_integer_dot_product) ||
5221 STI.isAtLeastSPIRVVer(VersionTuple(1, 6)))
5222 return selectDot4AddPacked<true>(ResVReg, ResType, I);
5223 return selectDot4AddPackedExpansion<true>(ResVReg, ResType, I);
5224 case Intrinsic::spv_dot4add_u8packed:
5225 if (STI.canUseExtension(SPIRV::Extension::SPV_KHR_integer_dot_product) ||
5226 STI.isAtLeastSPIRVVer(VersionTuple(1, 6)))
5227 return selectDot4AddPacked<false>(ResVReg, ResType, I);
5228 return selectDot4AddPackedExpansion<false>(ResVReg, ResType, I);
5229 case Intrinsic::spv_all:
5230 return selectAll(ResVReg, ResType, I);
5231 case Intrinsic::spv_any:
5232 return selectAny(ResVReg, ResType, I);
5233 case Intrinsic::spv_cross:
5234 return selectExtInst(ResVReg, ResType, I, CL::cross, GL::Cross);
5235 case Intrinsic::spv_distance:
5236 return selectExtInst(ResVReg, ResType, I, CL::distance, GL::Distance);
5237 case Intrinsic::spv_lerp:
5238 return selectExtInst(ResVReg, ResType, I, CL::mix, GL::FMix);
5239 case Intrinsic::spv_length:
5240 return selectExtInst(ResVReg, ResType, I, CL::length, GL::Length);
5241 case Intrinsic::spv_degrees:
5242 return selectExtInst(ResVReg, ResType, I, CL::degrees, GL::Degrees);
5243 case Intrinsic::spv_faceforward:
5244 return selectExtInst(ResVReg, ResType, I, GL::FaceForward);
5245 case Intrinsic::spv_frac:
5246 return selectExtInst(ResVReg, ResType, I, CL::fract, GL::Fract);
5247 case Intrinsic::spv_isinf:
5248 return selectOpIsInf(ResVReg, ResType, I);
5249 case Intrinsic::spv_isnan:
5250 return selectOpIsNan(ResVReg, ResType, I);
5251 case Intrinsic::spv_isfinite:
5252 return selectOpIsFinite(ResVReg, ResType, I);
5253 case Intrinsic::spv_isnormal:
5254 return selectOpIsNormal(ResVReg, ResType, I);
5255 case Intrinsic::spv_normalize:
5256 return selectExtInst(ResVReg, ResType, I, CL::normalize, GL::Normalize);
5257 case Intrinsic::spv_refract:
5258 return selectExtInst(ResVReg, ResType, I, GL::Refract);
5259 case Intrinsic::spv_reflect:
5260 return selectExtInst(ResVReg, ResType, I, GL::Reflect);
5261 case Intrinsic::spv_rsqrt:
5262 return selectExtInst(ResVReg, ResType, I, CL::rsqrt, GL::InverseSqrt);
5263 case Intrinsic::spv_sign:
5264 return selectSign(ResVReg, ResType, I);
5265 case Intrinsic::spv_smoothstep:
5266 return selectExtInst(ResVReg, ResType, I, CL::smoothstep, GL::SmoothStep);
5267 case Intrinsic::spv_firstbituhigh: // There is no CL equivalent of FindUMsb
5268 return selectFirstBitHigh(ResVReg, ResType, I, /*IsSigned=*/false);
5269 case Intrinsic::spv_firstbitshigh: // There is no CL equivalent of FindSMsb
5270 return selectFirstBitHigh(ResVReg, ResType, I, /*IsSigned=*/true);
5271 case Intrinsic::spv_firstbitlow: // There is no CL equivlent of FindILsb
5272 return selectFirstBitLow(ResVReg, ResType, I);
5273 case Intrinsic::spv_all_memory_barrier:
5274 return selectBarrierInst(I, SPIRV::Scope::Device,
5275 SPIRV::MemorySemantics::UniformMemory |
5276 SPIRV::MemorySemantics::ImageMemory |
5277 SPIRV::MemorySemantics::WorkgroupMemory,
5278 /*WithGroupSync*/ false);
5279 case Intrinsic::spv_all_memory_barrier_with_group_sync:
5280 return selectBarrierInst(I, SPIRV::Scope::Device,
5281 SPIRV::MemorySemantics::UniformMemory |
5282 SPIRV::MemorySemantics::ImageMemory |
5283 SPIRV::MemorySemantics::WorkgroupMemory,
5284 /*WithGroupSync*/ true);
5285 case Intrinsic::spv_device_memory_barrier:
5286 return selectBarrierInst(I, SPIRV::Scope::Device,
5287 SPIRV::MemorySemantics::UniformMemory |
5288 SPIRV::MemorySemantics::ImageMemory,
5289 /*WithGroupSync*/ false);
5290 case Intrinsic::spv_device_memory_barrier_with_group_sync:
5291 return selectBarrierInst(I, SPIRV::Scope::Device,
5292 SPIRV::MemorySemantics::UniformMemory |
5293 SPIRV::MemorySemantics::ImageMemory,
5294 /*WithGroupSync*/ true);
5295 case Intrinsic::spv_group_memory_barrier:
5296 return selectBarrierInst(I, SPIRV::Scope::Workgroup,
5297 SPIRV::MemorySemantics::WorkgroupMemory,
5298 /*WithGroupSync*/ false);
5299 case Intrinsic::spv_group_memory_barrier_with_group_sync:
5300 return selectBarrierInst(I, SPIRV::Scope::Workgroup,
5301 SPIRV::MemorySemantics::WorkgroupMemory,
5302 /*WithGroupSync*/ true);
5303 case Intrinsic::spv_generic_cast_to_ptr_explicit: {
5304 Register PtrReg = I.getOperand(I.getNumExplicitDefs() + 1).getReg();
5305 SPIRV::StorageClass::StorageClass ResSC =
5306 GR.getPointerStorageClass(ResType);
5307 if (!isGenericCastablePtr(ResSC))
5308 return diagnoseUnsupported(I, "The target storage class is not castable "
5309 "from the Generic storage class");
5310 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpGenericCastToPtrExplicit))
5311 .addDef(ResVReg)
5312 .addUse(GR.getSPIRVTypeID(ResType))
5313 .addUse(PtrReg)
5314 .addImm(ResSC)
5315 .constrainAllUses(TII, TRI, RBI);
5316 return true;
5317 }
5318 case Intrinsic::spv_lifetime_start:
5319 case Intrinsic::spv_lifetime_end: {
5320 unsigned Op = IID == Intrinsic::spv_lifetime_start ? SPIRV::OpLifetimeStart
5321 : SPIRV::OpLifetimeStop;
5322 int64_t Size = I.getOperand(I.getNumExplicitDefs() + 1).getImm();
5323 Register PtrReg = I.getOperand(I.getNumExplicitDefs() + 2).getReg();
5324 if (Size == -1)
5325 Size = 0;
5326 BuildMI(BB, I, I.getDebugLoc(), TII.get(Op))
5327 .addUse(PtrReg)
5328 .addImm(Size)
5329 .constrainAllUses(TII, TRI, RBI);
5330 return true;
5331 }
5332 case Intrinsic::spv_saturate:
5333 return selectSaturate(ResVReg, ResType, I);
5334 case Intrinsic::spv_nclamp:
5335 return selectExtInst(ResVReg, ResType, I, CL::fclamp, GL::NClamp);
5336 case Intrinsic::spv_uclamp:
5337 return selectExtInst(ResVReg, ResType, I, CL::u_clamp, GL::UClamp);
5338 case Intrinsic::spv_sclamp:
5339 return selectExtInst(ResVReg, ResType, I, CL::s_clamp, GL::SClamp);
5340 case Intrinsic::spv_subgroup_prefix_bit_count:
5341 return selectWavePrefixBitCount(ResVReg, ResType, I);
5342 case Intrinsic::spv_wave_active_countbits:
5343 return selectWaveActiveCountBits(ResVReg, ResType, I);
5344 case Intrinsic::spv_wave_all_equal:
5345 return selectWaveActiveAllEqual(ResVReg, ResType, I);
5346 case Intrinsic::spv_wave_all:
5347 return selectWaveOpInst(ResVReg, ResType, I, SPIRV::OpGroupNonUniformAll);
5348 case Intrinsic::spv_wave_any:
5349 return selectWaveOpInst(ResVReg, ResType, I, SPIRV::OpGroupNonUniformAny);
5350 case Intrinsic::spv_subgroup_ballot:
5351 return selectWaveOpInst(ResVReg, ResType, I,
5352 SPIRV::OpGroupNonUniformBallot);
5353 case Intrinsic::spv_wave_is_first_lane:
5354 return selectWaveOpInst(ResVReg, ResType, I, SPIRV::OpGroupNonUniformElect);
5355 case Intrinsic::spv_wave_reduce_or:
5356 return selectWaveReduceOp(ResVReg, ResType, I,
5357 SPIRV::OpGroupNonUniformBitwiseOr);
5358 case Intrinsic::spv_wave_reduce_xor:
5359 return selectWaveReduceOp(ResVReg, ResType, I,
5360 SPIRV::OpGroupNonUniformBitwiseXor);
5361 case Intrinsic::spv_wave_reduce_and:
5362 return selectWaveReduceOp(ResVReg, ResType, I,
5363 SPIRV::OpGroupNonUniformBitwiseAnd);
5364 case Intrinsic::spv_interlocked_add:
5365 return selectInterlockedAdd(ResVReg, ResType, I);
5366 case Intrinsic::spv_wave_reduce_umax:
5367 return selectWaveReduceMax(ResVReg, ResType, I, /*IsUnsigned*/ true);
5368 case Intrinsic::spv_wave_reduce_max:
5369 return selectWaveReduceMax(ResVReg, ResType, I, /*IsUnsigned*/ false);
5370 case Intrinsic::spv_wave_reduce_umin:
5371 return selectWaveReduceMin(ResVReg, ResType, I, /*IsUnsigned*/ true);
5372 case Intrinsic::spv_wave_reduce_min:
5373 return selectWaveReduceMin(ResVReg, ResType, I, /*IsUnsigned*/ false);
5374 case Intrinsic::spv_wave_reduce_sum:
5375 return selectWaveReduceSum(ResVReg, ResType, I);
5376 case Intrinsic::spv_wave_product:
5377 return selectWaveReduceProduct(ResVReg, ResType, I);
5378 case Intrinsic::spv_wave_readlane:
5379 return selectWaveOpInst(ResVReg, ResType, I,
5380 SPIRV::OpGroupNonUniformShuffle);
5381 case Intrinsic::spv_wave_prefix_sum:
5382 return selectWaveExclusiveScanSum(ResVReg, ResType, I);
5383 case Intrinsic::spv_wave_prefix_product:
5384 return selectWaveExclusiveScanProduct(ResVReg, ResType, I);
5385 case Intrinsic::spv_quad_read_across_x: {
5386 return selectQuadSwap(ResVReg, ResType, I, /*Direction*/ 0);
5387 }
5388 case Intrinsic::spv_quad_read_across_y: {
5389 return selectQuadSwap(ResVReg, ResType, I, /*Direction*/ 1);
5390 }
5391 case Intrinsic::spv_quad_read_across_diagonal: {
5392 return selectQuadSwap(ResVReg, ResType, I, /*Direction*/ 2);
5393 }
5394 case Intrinsic::spv_step:
5395 return selectExtInst(ResVReg, ResType, I, CL::step, GL::Step);
5396 case Intrinsic::spv_radians:
5397 return selectExtInst(ResVReg, ResType, I, CL::radians, GL::Radians);
5398 // Discard intrinsics which we do not expect to actually represent code after
5399 // lowering or intrinsics which are not implemented but should not crash when
5400 // found in a customer's LLVM IR input.
5401 case Intrinsic::instrprof_increment:
5402 case Intrinsic::instrprof_increment_step:
5403 case Intrinsic::instrprof_value_profile:
5404 break;
5405 // Discard internal intrinsics.
5406 case Intrinsic::spv_value_md:
5407 break;
5408 case Intrinsic::spv_resource_handlefrombinding: {
5409 return selectHandleFromBinding(ResVReg, ResType, I);
5410 }
5411 case Intrinsic::spv_resource_counterhandlefrombinding:
5412 return selectCounterHandleFromBinding(ResVReg, ResType, I);
5413 case Intrinsic::spv_resource_updatecounter:
5414 return selectUpdateCounter(ResVReg, ResType, I);
5415 case Intrinsic::spv_resource_store_typedbuffer: {
5416 return selectImageWriteIntrinsic(I);
5417 }
5418 case Intrinsic::spv_resource_load_typedbuffer: {
5419 return selectReadImageIntrinsic(ResVReg, ResType, I);
5420 }
5421 case Intrinsic::spv_resource_load_level: {
5422 return selectLoadLevelIntrinsic(ResVReg, ResType, I);
5423 }
5424 case Intrinsic::spv_resource_getdimensions_x:
5425 case Intrinsic::spv_resource_getdimensions_xy:
5426 case Intrinsic::spv_resource_getdimensions_xyz: {
5427 return selectGetDimensionsIntrinsic(ResVReg, ResType, I);
5428 }
5429 case Intrinsic::spv_resource_getdimensions_levels_x:
5430 case Intrinsic::spv_resource_getdimensions_levels_xy:
5431 case Intrinsic::spv_resource_getdimensions_levels_xyz: {
5432 return selectGetDimensionsLevelsIntrinsic(ResVReg, ResType, I);
5433 }
5434 case Intrinsic::spv_resource_getdimensions_ms_xy:
5435 case Intrinsic::spv_resource_getdimensions_ms_xyz: {
5436 return selectGetDimensionsMSIntrinsic(ResVReg, ResType, I);
5437 }
5438 case Intrinsic::spv_resource_calculate_lod:
5439 case Intrinsic::spv_resource_calculate_lod_unclamped:
5440 return selectCalculateLodIntrinsic(ResVReg, ResType, I);
5441 case Intrinsic::spv_resource_sample:
5442 case Intrinsic::spv_resource_sample_clamp:
5443 return selectSampleBasicIntrinsic(ResVReg, ResType, I);
5444 case Intrinsic::spv_resource_samplebias:
5445 case Intrinsic::spv_resource_samplebias_clamp:
5446 return selectSampleBiasIntrinsic(ResVReg, ResType, I);
5447 case Intrinsic::spv_resource_samplegrad:
5448 case Intrinsic::spv_resource_samplegrad_clamp:
5449 return selectSampleGradIntrinsic(ResVReg, ResType, I);
5450 case Intrinsic::spv_resource_samplelevel:
5451 return selectSampleLevelIntrinsic(ResVReg, ResType, I);
5452 case Intrinsic::spv_resource_samplecmp:
5453 case Intrinsic::spv_resource_samplecmp_clamp:
5454 return selectSampleCmpIntrinsic(ResVReg, ResType, I);
5455 case Intrinsic::spv_resource_samplecmplevelzero:
5456 return selectSampleCmpLevelZeroIntrinsic(ResVReg, ResType, I);
5457 case Intrinsic::spv_resource_gather:
5458 case Intrinsic::spv_resource_gather_cmp:
5459 return selectGatherIntrinsic(ResVReg, ResType, I);
5460 case Intrinsic::spv_resource_getbasepointer:
5461 case Intrinsic::spv_resource_getpointer: {
5462 return selectResourceGetPointer(ResVReg, ResType, I);
5463 }
5464 case Intrinsic::spv_pushconstant_getpointer: {
5465 return selectPushConstantGetPointer(ResVReg, ResType, I);
5466 }
5467 case Intrinsic::spv_discard: {
5468 return selectDiscard(ResVReg, ResType, I);
5469 }
5470 case Intrinsic::spv_resource_nonuniformindex: {
5471 return selectResourceNonUniformIndex(ResVReg, ResType, I);
5472 }
5473 case Intrinsic::spv_unpackhalf2x16: {
5474 return selectExtInst(ResVReg, ResType, I, GL::UnpackHalf2x16);
5475 }
5476 case Intrinsic::spv_packhalf2x16: {
5477 return selectExtInst(ResVReg, ResType, I, GL::PackHalf2x16);
5478 }
5479 case Intrinsic::spv_ddx:
5480 return selectDerivativeInst(ResVReg, ResType, I, SPIRV::OpDPdx);
5481 case Intrinsic::spv_ddy:
5482 return selectDerivativeInst(ResVReg, ResType, I, SPIRV::OpDPdy);
5483 case Intrinsic::spv_ddx_coarse:
5484 return selectDerivativeInst(ResVReg, ResType, I, SPIRV::OpDPdxCoarse);
5485 case Intrinsic::spv_ddy_coarse:
5486 return selectDerivativeInst(ResVReg, ResType, I, SPIRV::OpDPdyCoarse);
5487 case Intrinsic::spv_ddx_fine:
5488 return selectDerivativeInst(ResVReg, ResType, I, SPIRV::OpDPdxFine);
5489 case Intrinsic::spv_ddy_fine:
5490 return selectDerivativeInst(ResVReg, ResType, I, SPIRV::OpDPdyFine);
5491 case Intrinsic::spv_fwidth:
5492 return selectDerivativeInst(ResVReg, ResType, I, SPIRV::OpFwidth);
5493 case Intrinsic::spv_masked_gather:
5494 if (STI.canUseExtension(SPIRV::Extension::SPV_INTEL_masked_gather_scatter))
5495 return selectMaskedGather(ResVReg, ResType, I);
5496 return diagnoseUnsupported(
5497 I, "llvm.masked.gather requires SPV_INTEL_masked_gather_scatter");
5498 case Intrinsic::spv_masked_scatter:
5499 if (STI.canUseExtension(SPIRV::Extension::SPV_INTEL_masked_gather_scatter))
5500 return selectMaskedScatter(I);
5501 return diagnoseUnsupported(
5502 I, "llvm.masked.scatter requires SPV_INTEL_masked_gather_scatter");
5503 case Intrinsic::returnaddress:
5504 case Intrinsic::frameaddress: {
5505 // SPIR-V does not have a stack or return address. Lower to null.
5506 auto MIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpConstantNull))
5507 .addDef(ResVReg)
5508 .addUse(GR.getSPIRVTypeID(ResType));
5509 MIB.constrainAllUses(TII, TRI, RBI);
5510 return true;
5511 }
5512 default:
5513 return diagnoseUnsupported(I, "intrinsic selection not implemented.");
5514 }
5515 return true;
5516}
5517
5518bool SPIRVInstructionSelector::selectHandleFromBinding(Register &ResVReg,
5519 SPIRVTypeInst ResType,
5520 MachineInstr &I) const {
5521 // The images need to be loaded in the same basic block as their use. We defer
5522 // loading the image to the intrinsic that uses it.
5523 if (ResType->getOpcode() == SPIRV::OpTypeImage)
5524 return true;
5525
5526 return loadHandleBeforePosition(ResVReg, GR.getSPIRVTypeForVReg(ResVReg),
5527 *cast<GIntrinsic>(&I), I);
5528}
5529
5530bool SPIRVInstructionSelector::selectCounterHandleFromBinding(
5531 Register &ResVReg, SPIRVTypeInst ResType, MachineInstr &I) const {
5532 auto &Intr = cast<GIntrinsic>(I);
5533 assert(Intr.getIntrinsicID() ==
5534 Intrinsic::spv_resource_counterhandlefrombinding);
5535
5536 // Extract information from the intrinsic call.
5537 Register MainHandleReg = Intr.getOperand(2).getReg();
5538 auto *MainHandleDef = cast<GIntrinsic>(getVRegDef(*MRI, MainHandleReg));
5539 assert(MainHandleDef->getIntrinsicID() ==
5540 Intrinsic::spv_resource_handlefrombinding);
5541
5542 uint32_t Set = getIConstVal(Intr.getOperand(4).getReg(), MRI);
5543 uint32_t Binding = getIConstVal(Intr.getOperand(3).getReg(), MRI);
5544 uint32_t ArraySize = getIConstVal(MainHandleDef->getOperand(4).getReg(), MRI);
5545 Register IndexReg = MainHandleDef->getOperand(5).getReg();
5546 std::string CounterName =
5547 getStringValueFromReg(MainHandleDef->getOperand(6).getReg(), *MRI) +
5548 ".counter";
5549
5550 // Create the counter variable.
5551 MachineIRBuilder MIRBuilder(I);
5552 Register CounterVarReg =
5553 buildPointerToResource(SPIRVTypeInst(GR.getPointeeType(ResType)),
5554 GR.getPointerStorageClass(ResType), Set, Binding,
5555 ArraySize, IndexReg, CounterName, MIRBuilder);
5556
5557 return BuildCOPY(ResVReg, CounterVarReg, I);
5558}
5559
5560bool SPIRVInstructionSelector::selectUpdateCounter(Register &ResVReg,
5561 SPIRVTypeInst ResType,
5562 MachineInstr &I) const {
5563 auto &Intr = cast<GIntrinsic>(I);
5564 assert(Intr.getIntrinsicID() == Intrinsic::spv_resource_updatecounter);
5565
5566 Register CounterHandleReg = Intr.getOperand(2).getReg();
5567 Register IncrReg = Intr.getOperand(3).getReg();
5568
5569 // The counter handle is a pointer to the counter variable (which is a struct
5570 // containing an i32). We need to get a pointer to that i32 member to do the
5571 // atomic operation.
5572#ifndef NDEBUG
5573 SPIRVTypeInst CounterVarType = GR.getSPIRVTypeForVReg(CounterHandleReg);
5574 SPIRVTypeInst CounterVarPointeeType = GR.getPointeeType(CounterVarType);
5575 assert(CounterVarPointeeType &&
5576 CounterVarPointeeType->getOpcode() == SPIRV::OpTypeStruct &&
5577 "Counter variable must be a struct");
5578 assert(GR.getPointerStorageClass(CounterVarType) ==
5579 SPIRV::StorageClass::StorageBuffer &&
5580 "Counter variable must be in the storage buffer storage class");
5581 assert(CounterVarPointeeType->getNumOperands() == 2 &&
5582 "Counter variable must have exactly 1 member in the struct");
5583 const SPIRVTypeInst MemberType =
5584 GR.getSPIRVTypeForVReg(CounterVarPointeeType->getOperand(1).getReg());
5585 assert(MemberType->getOpcode() == SPIRV::OpTypeInt &&
5586 "Counter variable struct must have a single i32 member");
5587#endif
5588
5589 // The struct has a single i32 member.
5590 MachineIRBuilder MIRBuilder(I);
5591 const Type *LLVMIntType =
5592 Type::getInt32Ty(I.getMF()->getFunction().getContext());
5593
5594 SPIRVTypeInst IntPtrType = GR.getOrCreateSPIRVPointerType(
5595 LLVMIntType, MIRBuilder, SPIRV::StorageClass::StorageBuffer);
5596
5597 Register Zero = buildI32Constant(0, I);
5598
5599 Register PtrToCounter =
5600 MRI->createVirtualRegister(GR.getRegClass(IntPtrType));
5601 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpAccessChain))
5602 .addDef(PtrToCounter)
5603 .addUse(GR.getSPIRVTypeID(IntPtrType))
5604 .addUse(CounterHandleReg)
5605 .addUse(Zero)
5606 .constrainAllUses(TII, TRI, RBI);
5607
5608 // For UAV/SSBO counters, the scope is Device. The counter variable is not
5609 // used as a flag. So the memory semantics can be None.
5610 Register Scope = buildI32Constant(SPIRV::Scope::Device, I);
5611 Register Semantics = buildI32Constant(SPIRV::MemorySemantics::None, I);
5612
5613 int64_t IncrVal = getIConstValSext(IncrReg, MRI);
5614 Register Incr = buildI32Constant(static_cast<uint32_t>(IncrVal), I);
5615
5616 Register AtomicRes = MRI->createVirtualRegister(GR.getRegClass(ResType));
5617 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpAtomicIAdd))
5618 .addDef(AtomicRes)
5619 .addUse(GR.getSPIRVTypeID(ResType))
5620 .addUse(PtrToCounter)
5621 .addUse(Scope)
5622 .addUse(Semantics)
5623 .addUse(Incr)
5624 .constrainAllUses(TII, TRI, RBI);
5625 if (IncrVal >= 0) {
5626 return BuildCOPY(ResVReg, AtomicRes, I);
5627 }
5628
5629 // In HLSL, IncrementCounter returns the value *before* the increment, while
5630 // DecrementCounter returns the value *after* the decrement. Both are lowered
5631 // to the same atomic intrinsic which returns the value *before* the
5632 // operation. So for decrements (negative IncrVal), we must subtract the
5633 // increment value from the result to get the post-decrement value.
5634 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpIAddS))
5635 .addDef(ResVReg)
5636 .addUse(GR.getSPIRVTypeID(ResType))
5637 .addUse(AtomicRes)
5638 .addUse(Incr)
5639 .constrainAllUses(TII, TRI, RBI);
5640 return true;
5641}
5642bool SPIRVInstructionSelector::selectReadImageIntrinsic(Register &ResVReg,
5643 SPIRVTypeInst ResType,
5644 MachineInstr &I) const {
5645
5646 // If the load of the image is in a different basic block, then
5647 // this will generate invalid code. A proper solution is to move
5648 // the OpLoad from selectHandleFromBinding here. However, to do
5649 // that we will need to change the return type of the intrinsic.
5650 // We will do that when we can, but for now trying to move forward with other
5651 // issues.
5652 Register ImageReg = I.getOperand(2).getReg();
5653 auto *ImageDef = cast<GIntrinsic>(getVRegDef(*MRI, ImageReg));
5654 Register NewImageReg = MRI->createVirtualRegister(MRI->getRegClass(ImageReg));
5655 if (!loadHandleBeforePosition(NewImageReg, GR.getSPIRVTypeForVReg(ImageReg),
5656 *ImageDef, I)) {
5657 return false;
5658 }
5659
5660 Register IdxReg = I.getOperand(3).getReg();
5661 DebugLoc Loc = I.getDebugLoc();
5662 MachineInstr &Pos = I;
5663
5664 return generateImageReadOrFetch(ResVReg, ResType, NewImageReg, IdxReg, Loc,
5665 Pos);
5666}
5667
5668bool SPIRVInstructionSelector::generateSampleImage(
5669 Register ResVReg, SPIRVTypeInst ResType, Register ImageReg,
5670 Register SamplerReg, Register CoordinateReg, const ImageOperands &ImOps,
5671 DebugLoc Loc, MachineInstr &Pos) const {
5672 auto *ImageDef = cast<GIntrinsic>(getVRegDef(*MRI, ImageReg));
5673 Register NewImageReg = MRI->createVirtualRegister(MRI->getRegClass(ImageReg));
5674 if (!loadHandleBeforePosition(NewImageReg, GR.getSPIRVTypeForVReg(ImageReg),
5675 *ImageDef, Pos)) {
5676 return false;
5677 }
5678
5679 auto *SamplerDef = cast<GIntrinsic>(getVRegDef(*MRI, SamplerReg));
5680 Register NewSamplerReg =
5681 MRI->createVirtualRegister(MRI->getRegClass(SamplerReg));
5682 if (!loadHandleBeforePosition(NewSamplerReg,
5683 GR.getSPIRVTypeForVReg(SamplerReg), *SamplerDef,
5684 Pos)) {
5685 return false;
5686 }
5687
5688 MachineIRBuilder MIRBuilder(Pos);
5689 SPIRVTypeInst SampledImageType = GR.getOrCreateOpTypeSampledImage(
5690 GR.getSPIRVTypeForVReg(ImageReg), MIRBuilder);
5691 Register SampledImageReg =
5692 MRI->createVirtualRegister(GR.getRegClass(SampledImageType));
5693
5694 BuildMI(*Pos.getParent(), Pos, Loc, TII.get(SPIRV::OpSampledImage))
5695 .addDef(SampledImageReg)
5696 .addUse(GR.getSPIRVTypeID(SampledImageType))
5697 .addUse(NewImageReg)
5698 .addUse(NewSamplerReg)
5699 .constrainAllUses(TII, TRI, RBI);
5700
5701 bool IsExplicitLod = ImOps.GradX.has_value() || ImOps.GradY.has_value() ||
5702 ImOps.Lod.has_value();
5703 unsigned Opcode = IsExplicitLod ? SPIRV::OpImageSampleExplicitLod
5704 : SPIRV::OpImageSampleImplicitLod;
5705 if (ImOps.Compare)
5706 Opcode = IsExplicitLod ? SPIRV::OpImageSampleDrefExplicitLod
5707 : SPIRV::OpImageSampleDrefImplicitLod;
5708
5709 auto MIB = BuildMI(*Pos.getParent(), Pos, Loc, TII.get(Opcode))
5710 .addDef(ResVReg)
5711 .addUse(GR.getSPIRVTypeID(ResType))
5712 .addUse(SampledImageReg)
5713 .addUse(CoordinateReg);
5714
5715 if (ImOps.Compare)
5716 MIB.addUse(*ImOps.Compare);
5717
5718 uint32_t ImageOperands = 0;
5719 if (ImOps.Bias)
5720 ImageOperands |= SPIRV::ImageOperand::Bias;
5721 if (ImOps.Lod)
5722 ImageOperands |= SPIRV::ImageOperand::Lod;
5723 if (ImOps.GradX && ImOps.GradY)
5724 ImageOperands |= SPIRV::ImageOperand::Grad;
5725 if (ImOps.Offset && !isScalarOrVectorIntConstantZero(*ImOps.Offset)) {
5726 if (isConstReg(MRI, *ImOps.Offset))
5727 ImageOperands |= SPIRV::ImageOperand::ConstOffset;
5728 else {
5729 Pos.emitGenericError(
5730 "Non-constant offsets are not supported in sample instructions.");
5731 return false;
5732 }
5733 }
5734 if (ImOps.MinLod)
5735 ImageOperands |= SPIRV::ImageOperand::MinLod;
5736
5737 if (ImageOperands != 0) {
5738 MIB.addImm(ImageOperands);
5739 if (ImageOperands & SPIRV::ImageOperand::Bias)
5740 MIB.addUse(*ImOps.Bias);
5741 if (ImageOperands & SPIRV::ImageOperand::Lod)
5742 MIB.addUse(*ImOps.Lod);
5743 if (ImageOperands & SPIRV::ImageOperand::Grad) {
5744 MIB.addUse(*ImOps.GradX);
5745 MIB.addUse(*ImOps.GradY);
5746 }
5747 if (ImageOperands &
5748 (SPIRV::ImageOperand::ConstOffset | SPIRV::ImageOperand::Offset))
5749 MIB.addUse(*ImOps.Offset);
5750 if (ImageOperands & SPIRV::ImageOperand::MinLod)
5751 MIB.addUse(*ImOps.MinLod);
5752 }
5753
5754 MIB.constrainAllUses(TII, TRI, RBI);
5755 return true;
5756}
5757
5758bool SPIRVInstructionSelector::selectImageQuerySize(
5759 Register ImageReg, Register &ResVReg, MachineInstr &I,
5760 std::optional<Register> LodReg) const {
5761 unsigned Opcode =
5762 LodReg ? SPIRV::OpImageQuerySizeLod : SPIRV::OpImageQuerySize;
5763 SPIRVTypeInst ImageType = GR.getSPIRVTypeForVReg(ImageReg);
5764 assert(ImageType && ImageType->getOpcode() == SPIRV::OpTypeImage &&
5765 "ImageReg is not an image type.");
5766
5767 auto Dim = static_cast<SPIRV::Dim::Dim>(ImageType->getOperand(2).getImm());
5768 bool IsArray = ImageType->getOperand(4).getImm() != 0;
5769 unsigned NumComponents = 0;
5770 switch (Dim) {
5771 case SPIRV::Dim::DIM_1D:
5772 case SPIRV::Dim::DIM_Buffer:
5773 NumComponents = IsArray ? 2 : 1;
5774 break;
5775 case SPIRV::Dim::DIM_2D:
5776 case SPIRV::Dim::DIM_Cube:
5777 case SPIRV::Dim::DIM_Rect:
5778 NumComponents = IsArray ? 3 : 2;
5779 break;
5780 case SPIRV::Dim::DIM_3D:
5781 NumComponents = 3;
5782 break;
5783 default:
5784 I.emitGenericError("Unsupported image dimension for OpImageQuerySize.");
5785 return false;
5786 }
5787
5788 SPIRVTypeInst I32Ty = GR.getOrCreateSPIRVIntegerType(32, I, TII);
5789 SPIRVTypeInst ResType =
5790 NumComponents == 1
5791 ? I32Ty
5792 : GR.getOrCreateSPIRVVectorType(I32Ty, NumComponents, I, TII);
5793
5794 auto MIB = BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(Opcode))
5795 .addDef(ResVReg)
5796 .addUse(GR.getSPIRVTypeID(ResType))
5797 .addUse(ImageReg);
5798 if (LodReg)
5799 MIB.addUse(*LodReg);
5800 MIB.constrainAllUses(TII, TRI, RBI);
5801 return true;
5802}
5803
5804bool SPIRVInstructionSelector::selectGetDimensionsIntrinsic(
5805 Register &ResVReg, SPIRVTypeInst ResType, MachineInstr &I) const {
5806 Register ImageReg = I.getOperand(2).getReg();
5807 auto *ImageDef = cast<GIntrinsic>(getVRegDef(*MRI, ImageReg));
5808 Register NewImageReg = MRI->createVirtualRegister(MRI->getRegClass(ImageReg));
5809 if (!loadHandleBeforePosition(NewImageReg, GR.getSPIRVTypeForVReg(ImageReg),
5810 *ImageDef, I)) {
5811 return false;
5812 }
5813 return selectImageQuerySize(NewImageReg, ResVReg, I);
5814}
5815
5816bool SPIRVInstructionSelector::selectGetDimensionsLevelsIntrinsic(
5817 Register &ResVReg, SPIRVTypeInst ResType, MachineInstr &I) const {
5818 Register ImageReg = I.getOperand(2).getReg();
5819 auto *ImageDef = cast<GIntrinsic>(getVRegDef(*MRI, ImageReg));
5820 Register NewImageReg = MRI->createVirtualRegister(MRI->getRegClass(ImageReg));
5821 if (!loadHandleBeforePosition(NewImageReg, GR.getSPIRVTypeForVReg(ImageReg),
5822 *ImageDef, I)) {
5823 return false;
5824 }
5825
5826 Register SizeReg = MRI->createVirtualRegister(&SPIRV::iIDRegClass);
5827 Register LodReg = I.getOperand(3).getReg();
5828
5829 assert(GR.getSPIRVTypeForVReg(NewImageReg)->getOperand(6).getImm() == 1 &&
5830 "OpImageQuerySizeLod and OpImageQueryLevels require a sampled image");
5831
5832 if (!selectImageQuerySize(NewImageReg, SizeReg, I, LodReg)) {
5833 return false;
5834 }
5835
5836 SPIRVTypeInst I32Ty = GR.getOrCreateSPIRVIntegerType(32, I, TII);
5837 Register LevelsReg = MRI->createVirtualRegister(&SPIRV::iIDRegClass);
5838 BuildMI(*I.getParent(), I, I.getDebugLoc(),
5839 TII.get(SPIRV::OpImageQueryLevels))
5840 .addDef(LevelsReg)
5841 .addUse(GR.getSPIRVTypeID(I32Ty))
5842 .addUse(NewImageReg)
5843 .constrainAllUses(TII, TRI, RBI);
5844
5845 BuildMI(*I.getParent(), I, I.getDebugLoc(),
5846 TII.get(SPIRV::OpCompositeConstruct))
5847 .addDef(ResVReg)
5848 .addUse(GR.getSPIRVTypeID(ResType))
5849 .addUse(SizeReg)
5850 .addUse(LevelsReg)
5851 .constrainAllUses(TII, TRI, RBI);
5852
5853 return true;
5854}
5855
5856bool SPIRVInstructionSelector::selectGetDimensionsMSIntrinsic(
5857 Register &ResVReg, SPIRVTypeInst ResType, MachineInstr &I) const {
5858 Register ImageReg = I.getOperand(2).getReg();
5859 auto *ImageDef = cast<GIntrinsic>(getVRegDef(*MRI, ImageReg));
5860 Register NewImageReg = MRI->createVirtualRegister(MRI->getRegClass(ImageReg));
5861 if (!loadHandleBeforePosition(NewImageReg, GR.getSPIRVTypeForVReg(ImageReg),
5862 *ImageDef, I)) {
5863 return false;
5864 }
5865
5866 Register SizeReg = MRI->createVirtualRegister(&SPIRV::iIDRegClass);
5867
5868 assert(GR.getSPIRVTypeForVReg(NewImageReg)->getOperand(5).getImm() == 1 &&
5869 "OpImageQuerySamples requires a multisampled image");
5870
5871 if (!selectImageQuerySize(NewImageReg, SizeReg, I)) {
5872 return false;
5873 }
5874
5875 Register SamplesReg = MRI->createVirtualRegister(&SPIRV::iIDRegClass);
5876
5877 SPIRVTypeInst I32Ty = GR.getOrCreateSPIRVIntegerType(32, I, TII);
5878 BuildMI(*I.getParent(), I, I.getDebugLoc(),
5879 TII.get(SPIRV::OpImageQuerySamples))
5880 .addDef(SamplesReg)
5881 .addUse(GR.getSPIRVTypeID(I32Ty))
5882 .addUse(NewImageReg)
5883 .constrainAllUses(TII, TRI, RBI);
5884
5885 BuildMI(*I.getParent(), I, I.getDebugLoc(),
5886 TII.get(SPIRV::OpCompositeConstruct))
5887 .addDef(ResVReg)
5888 .addUse(GR.getSPIRVTypeID(ResType))
5889 .addUse(SizeReg)
5890 .addUse(SamplesReg)
5891 .constrainAllUses(TII, TRI, RBI);
5892
5893 return true;
5894}
5895
5896bool SPIRVInstructionSelector::selectCalculateLodIntrinsic(
5897 Register &ResVReg, SPIRVTypeInst ResType, MachineInstr &I) const {
5898 Register ImageReg = I.getOperand(2).getReg();
5899 Register SamplerReg = I.getOperand(3).getReg();
5900 Register CoordinateReg = I.getOperand(4).getReg();
5901
5902 auto *ImageDef = dyn_cast<GIntrinsic>(getVRegDef(*MRI, ImageReg));
5903 if (!ImageDef)
5904 return false;
5905 Register NewImageReg = MRI->createVirtualRegister(MRI->getRegClass(ImageReg));
5906 if (!loadHandleBeforePosition(NewImageReg, GR.getSPIRVTypeForVReg(ImageReg),
5907 *ImageDef, I)) {
5908 return false;
5909 }
5910
5911 auto *SamplerDef = dyn_cast<GIntrinsic>(getVRegDef(*MRI, SamplerReg));
5912 if (!SamplerDef)
5913 return false;
5914 Register NewSamplerReg =
5915 MRI->createVirtualRegister(MRI->getRegClass(SamplerReg));
5916 if (!loadHandleBeforePosition(
5917 NewSamplerReg, GR.getSPIRVTypeForVReg(SamplerReg), *SamplerDef, I)) {
5918 return false;
5919 }
5920
5921 MachineIRBuilder MIRBuilder(I);
5922 SPIRVTypeInst SampledImageType = GR.getOrCreateOpTypeSampledImage(
5923 GR.getSPIRVTypeForVReg(ImageReg), MIRBuilder);
5924 Register SampledImageReg =
5925 MRI->createVirtualRegister(GR.getRegClass(SampledImageType));
5926
5927 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpSampledImage))
5928 .addDef(SampledImageReg)
5929 .addUse(GR.getSPIRVTypeID(SampledImageType))
5930 .addUse(NewImageReg)
5931 .addUse(NewSamplerReg)
5932 .constrainAllUses(TII, TRI, RBI);
5933
5934 SPIRVTypeInst Vec2Ty = GR.getOrCreateSPIRVVectorType(ResType, 2, I, TII);
5935 Register QueryResultReg = MRI->createVirtualRegister(GR.getRegClass(Vec2Ty));
5936
5937 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpImageQueryLod))
5938 .addDef(QueryResultReg)
5939 .addUse(GR.getSPIRVTypeID(Vec2Ty))
5940 .addUse(SampledImageReg)
5941 .addUse(CoordinateReg)
5942 .constrainAllUses(TII, TRI, RBI);
5943
5944 unsigned ExtractedIndex =
5945 cast<GIntrinsic>(I).getIntrinsicID() ==
5946 Intrinsic::spv_resource_calculate_lod_unclamped
5947 ? 1
5948 : 0;
5949
5950 MachineInstrBuilder MIB = BuildMI(*I.getParent(), I, I.getDebugLoc(),
5951 TII.get(SPIRV::OpCompositeExtract))
5952 .addDef(ResVReg)
5953 .addUse(GR.getSPIRVTypeID(ResType))
5954 .addUse(QueryResultReg)
5955 .addImm(ExtractedIndex);
5956
5957 MIB.constrainAllUses(TII, TRI, RBI);
5958 return true;
5959}
5960
5961bool SPIRVInstructionSelector::selectSampleBasicIntrinsic(
5962 Register &ResVReg, SPIRVTypeInst ResType, MachineInstr &I) const {
5963 Register ImageReg = I.getOperand(2).getReg();
5964 Register SamplerReg = I.getOperand(3).getReg();
5965 Register CoordinateReg = I.getOperand(4).getReg();
5966 ImageOperands ImOps;
5967 if (I.getNumOperands() > 5)
5968 ImOps.Offset = I.getOperand(5).getReg();
5969 if (I.getNumOperands() > 6)
5970 ImOps.MinLod = I.getOperand(6).getReg();
5971 return generateSampleImage(ResVReg, ResType, ImageReg, SamplerReg,
5972 CoordinateReg, ImOps, I.getDebugLoc(), I);
5973}
5974
5975bool SPIRVInstructionSelector::selectSampleBiasIntrinsic(
5976 Register &ResVReg, SPIRVTypeInst ResType, MachineInstr &I) const {
5977 Register ImageReg = I.getOperand(2).getReg();
5978 Register SamplerReg = I.getOperand(3).getReg();
5979 Register CoordinateReg = I.getOperand(4).getReg();
5980 ImageOperands ImOps;
5981 ImOps.Bias = I.getOperand(5).getReg();
5982 if (I.getNumOperands() > 6)
5983 ImOps.Offset = I.getOperand(6).getReg();
5984 if (I.getNumOperands() > 7)
5985 ImOps.MinLod = I.getOperand(7).getReg();
5986 return generateSampleImage(ResVReg, ResType, ImageReg, SamplerReg,
5987 CoordinateReg, ImOps, I.getDebugLoc(), I);
5988}
5989
5990bool SPIRVInstructionSelector::selectSampleGradIntrinsic(
5991 Register &ResVReg, SPIRVTypeInst ResType, MachineInstr &I) const {
5992 Register ImageReg = I.getOperand(2).getReg();
5993 Register SamplerReg = I.getOperand(3).getReg();
5994 Register CoordinateReg = I.getOperand(4).getReg();
5995 ImageOperands ImOps;
5996 ImOps.GradX = I.getOperand(5).getReg();
5997 ImOps.GradY = I.getOperand(6).getReg();
5998 if (I.getNumOperands() > 7)
5999 ImOps.Offset = I.getOperand(7).getReg();
6000 if (I.getNumOperands() > 8)
6001 ImOps.MinLod = I.getOperand(8).getReg();
6002 return generateSampleImage(ResVReg, ResType, ImageReg, SamplerReg,
6003 CoordinateReg, ImOps, I.getDebugLoc(), I);
6004}
6005
6006bool SPIRVInstructionSelector::selectSampleLevelIntrinsic(
6007 Register &ResVReg, SPIRVTypeInst ResType, MachineInstr &I) const {
6008 Register ImageReg = I.getOperand(2).getReg();
6009 Register SamplerReg = I.getOperand(3).getReg();
6010 Register CoordinateReg = I.getOperand(4).getReg();
6011 ImageOperands ImOps;
6012 ImOps.Lod = I.getOperand(5).getReg();
6013 if (I.getNumOperands() > 6)
6014 ImOps.Offset = I.getOperand(6).getReg();
6015 return generateSampleImage(ResVReg, ResType, ImageReg, SamplerReg,
6016 CoordinateReg, ImOps, I.getDebugLoc(), I);
6017}
6018
6019bool SPIRVInstructionSelector::selectSampleCmpIntrinsic(Register &ResVReg,
6020 SPIRVTypeInst ResType,
6021 MachineInstr &I) const {
6022 Register ImageReg = I.getOperand(2).getReg();
6023 Register SamplerReg = I.getOperand(3).getReg();
6024 Register CoordinateReg = I.getOperand(4).getReg();
6025 ImageOperands ImOps;
6026 ImOps.Compare = I.getOperand(5).getReg();
6027 if (I.getNumOperands() > 6)
6028 ImOps.Offset = I.getOperand(6).getReg();
6029 if (I.getNumOperands() > 7)
6030 ImOps.MinLod = I.getOperand(7).getReg();
6031 return generateSampleImage(ResVReg, ResType, ImageReg, SamplerReg,
6032 CoordinateReg, ImOps, I.getDebugLoc(), I);
6033}
6034
6035bool SPIRVInstructionSelector::selectLoadLevelIntrinsic(Register &ResVReg,
6036 SPIRVTypeInst ResType,
6037 MachineInstr &I) const {
6038 Register ImageReg = I.getOperand(2).getReg();
6039 Register CoordinateReg = I.getOperand(3).getReg();
6040 Register LodReg = I.getOperand(4).getReg();
6041
6042 ImageOperands ImOps;
6043 ImOps.Lod = LodReg;
6044 if (I.getNumOperands() > 5)
6045 ImOps.Offset = I.getOperand(5).getReg();
6046
6047 auto *ImageDef = dyn_cast<GIntrinsic>(getVRegDef(*MRI, ImageReg));
6048 if (!ImageDef)
6049 return false;
6050
6051 Register NewImageReg = MRI->createVirtualRegister(MRI->getRegClass(ImageReg));
6052 if (!loadHandleBeforePosition(NewImageReg, GR.getSPIRVTypeForVReg(ImageReg),
6053 *ImageDef, I)) {
6054 return false;
6055 }
6056
6057 return generateImageReadOrFetch(ResVReg, ResType, NewImageReg, CoordinateReg,
6058 I.getDebugLoc(), I, &ImOps);
6059}
6060
6061bool SPIRVInstructionSelector::selectSampleCmpLevelZeroIntrinsic(
6062 Register &ResVReg, SPIRVTypeInst ResType, MachineInstr &I) const {
6063 Register ImageReg = I.getOperand(2).getReg();
6064 Register SamplerReg = I.getOperand(3).getReg();
6065 Register CoordinateReg = I.getOperand(4).getReg();
6066 ImageOperands ImOps;
6067 ImOps.Compare = I.getOperand(5).getReg();
6068 if (I.getNumOperands() > 6)
6069 ImOps.Offset = I.getOperand(6).getReg();
6070 SPIRVTypeInst FloatTy = GR.getOrCreateSPIRVFloatType(32, I, TII);
6071 ImOps.Lod = GR.getOrCreateConstFP(APFloat(0.0f), I, FloatTy, TII);
6072 return generateSampleImage(ResVReg, ResType, ImageReg, SamplerReg,
6073 CoordinateReg, ImOps, I.getDebugLoc(), I);
6074}
6075
6076bool SPIRVInstructionSelector::selectGatherIntrinsic(Register &ResVReg,
6077 SPIRVTypeInst ResType,
6078 MachineInstr &I) const {
6079 Register ImageReg = I.getOperand(2).getReg();
6080 Register SamplerReg = I.getOperand(3).getReg();
6081 Register CoordinateReg = I.getOperand(4).getReg();
6082 SPIRVTypeInst ImageType = GR.getSPIRVTypeForVReg(ImageReg);
6083 assert(ImageType && ImageType->getOpcode() == SPIRV::OpTypeImage &&
6084 "ImageReg is not an image type.");
6085
6086 Register ComponentOrCompareReg;
6087 Register OffsetReg;
6088
6089 ComponentOrCompareReg = I.getOperand(5).getReg();
6090 OffsetReg = I.getOperand(6).getReg();
6091 auto *ImageDef = cast<GIntrinsic>(getVRegDef(*MRI, ImageReg));
6092 Register NewImageReg = MRI->createVirtualRegister(MRI->getRegClass(ImageReg));
6093 if (!loadHandleBeforePosition(NewImageReg, ImageType, *ImageDef, I)) {
6094 return false;
6095 }
6096
6097 auto Dim = static_cast<SPIRV::Dim::Dim>(ImageType->getOperand(2).getImm());
6098 if (Dim != SPIRV::Dim::DIM_2D && Dim != SPIRV::Dim::DIM_Cube &&
6099 Dim != SPIRV::Dim::DIM_Rect) {
6100 I.emitGenericError(
6101 "Gather operations are only supported for 2D, Cube, and Rect images.");
6102 return false;
6103 }
6104
6105 auto *SamplerDef = cast<GIntrinsic>(getVRegDef(*MRI, SamplerReg));
6106 Register NewSamplerReg =
6107 MRI->createVirtualRegister(MRI->getRegClass(SamplerReg));
6108 if (!loadHandleBeforePosition(
6109 NewSamplerReg, GR.getSPIRVTypeForVReg(SamplerReg), *SamplerDef, I)) {
6110 return false;
6111 }
6112
6113 MachineIRBuilder MIRBuilder(I);
6114 SPIRVTypeInst SampledImageType =
6115 GR.getOrCreateOpTypeSampledImage(ImageType, MIRBuilder);
6116 Register SampledImageReg =
6117 MRI->createVirtualRegister(GR.getRegClass(SampledImageType));
6118
6119 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpSampledImage))
6120 .addDef(SampledImageReg)
6121 .addUse(GR.getSPIRVTypeID(SampledImageType))
6122 .addUse(NewImageReg)
6123 .addUse(NewSamplerReg)
6124 .constrainAllUses(TII, TRI, RBI);
6125
6126 auto IntrId = cast<GIntrinsic>(I).getIntrinsicID();
6127 bool IsGatherCmp = IntrId == Intrinsic::spv_resource_gather_cmp;
6128 unsigned Opcode =
6129 IsGatherCmp ? SPIRV::OpImageDrefGather : SPIRV::OpImageGather;
6130
6131 auto MIB = BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(Opcode))
6132 .addDef(ResVReg)
6133 .addUse(GR.getSPIRVTypeID(ResType))
6134 .addUse(SampledImageReg)
6135 .addUse(CoordinateReg)
6136 .addUse(ComponentOrCompareReg);
6137
6138 uint32_t ImageOperands = 0;
6139 if (OffsetReg && !isScalarOrVectorIntConstantZero(OffsetReg)) {
6140 if (Dim == SPIRV::Dim::DIM_Cube) {
6141 I.emitGenericError(
6142 "Gather operations with offset are not supported for Cube images.");
6143 return false;
6144 }
6145 if (isConstReg(MRI, OffsetReg))
6146 ImageOperands |= SPIRV::ImageOperand::ConstOffset;
6147 else {
6148 ImageOperands |= SPIRV::ImageOperand::Offset;
6149 }
6150 }
6151
6152 if (ImageOperands != 0) {
6153 MIB.addImm(ImageOperands);
6154 if (ImageOperands &
6155 (SPIRV::ImageOperand::ConstOffset | SPIRV::ImageOperand::Offset))
6156 MIB.addUse(OffsetReg);
6157 }
6158
6159 MIB.constrainAllUses(TII, TRI, RBI);
6160 return true;
6161}
6162
6163bool SPIRVInstructionSelector::generateImageReadOrFetch(
6164 Register &ResVReg, SPIRVTypeInst ResType, Register ImageReg,
6165 Register IdxReg, DebugLoc Loc, MachineInstr &Pos,
6166 const ImageOperands *ImOps) const {
6167 SPIRVTypeInst ImageType = GR.getSPIRVTypeForVReg(ImageReg);
6168 assert(ImageType && ImageType->getOpcode() == SPIRV::OpTypeImage &&
6169 "ImageReg is not an image type.");
6170
6171 bool IsSignedInteger =
6172 sampledTypeIsSignedInteger(GR.getTypeForSPIRVType(ImageType));
6173 // Check if the "sampled" operand of the image type is 1.
6174 // https://registry.khronos.org/SPIR-V/specs/unified1/SPIRV.html#OpImageFetch
6175 auto SampledOp = ImageType->getOperand(6);
6176 bool IsFetch = (SampledOp.getImm() == 1);
6177
6178 auto AddOperands = [&](MachineInstrBuilder &MIB) {
6179 uint32_t ImageOperandsMask = 0;
6180 if (IsSignedInteger)
6181 ImageOperandsMask |= 0x1000; // SignExtend
6182
6183 if (IsFetch && ImOps) {
6184 if (ImOps->Lod)
6185 ImageOperandsMask |= SPIRV::ImageOperand::Lod;
6186 if (ImOps->Offset && !isScalarOrVectorIntConstantZero(*ImOps->Offset)) {
6187 if (isConstReg(MRI, *ImOps->Offset))
6188 ImageOperandsMask |= SPIRV::ImageOperand::ConstOffset;
6189 else
6190 ImageOperandsMask |= SPIRV::ImageOperand::Offset;
6191 }
6192 }
6193
6194 if (ImageOperandsMask != 0) {
6195 MIB.addImm(ImageOperandsMask);
6196 if (IsFetch && ImOps) {
6197 if (ImOps->Lod)
6198 MIB.addUse(*ImOps->Lod);
6199 if (ImOps->Offset &&
6200 (ImageOperandsMask &
6201 (SPIRV::ImageOperand::Offset | SPIRV::ImageOperand::ConstOffset)))
6202 MIB.addUse(*ImOps->Offset);
6203 }
6204 }
6205 };
6206
6207 uint64_t ResultSize = GR.getScalarOrVectorComponentCount(ResType);
6208 if (ResultSize == 4) {
6209 auto BMI =
6210 BuildMI(*Pos.getParent(), Pos, Loc,
6211 TII.get(IsFetch ? SPIRV::OpImageFetch : SPIRV::OpImageRead))
6212 .addDef(ResVReg)
6213 .addUse(GR.getSPIRVTypeID(ResType))
6214 .addUse(ImageReg)
6215 .addUse(IdxReg);
6216
6217 AddOperands(BMI);
6218 BMI.constrainAllUses(TII, TRI, RBI);
6219 return true;
6220 }
6221
6222 SPIRVTypeInst ReadType = widenTypeToVec4(ResType, Pos);
6223 Register ReadReg = MRI->createVirtualRegister(GR.getRegClass(ReadType));
6224 auto BMI =
6225 BuildMI(*Pos.getParent(), Pos, Loc,
6226 TII.get(IsFetch ? SPIRV::OpImageFetch : SPIRV::OpImageRead))
6227 .addDef(ReadReg)
6228 .addUse(GR.getSPIRVTypeID(ReadType))
6229 .addUse(ImageReg)
6230 .addUse(IdxReg);
6231 AddOperands(BMI);
6232 BMI.constrainAllUses(TII, TRI, RBI);
6233
6234 if (ResultSize == 1) {
6235 BuildMI(*Pos.getParent(), Pos, Loc, TII.get(SPIRV::OpCompositeExtract))
6236 .addDef(ResVReg)
6237 .addUse(GR.getSPIRVTypeID(ResType))
6238 .addUse(ReadReg)
6239 .addImm(0)
6240 .constrainAllUses(TII, TRI, RBI);
6241 return true;
6242 }
6243 return extractSubvector(ResVReg, ResType, ReadReg, Pos);
6244}
6245
6246bool SPIRVInstructionSelector::selectResourceGetPointer(Register &ResVReg,
6247 SPIRVTypeInst ResType,
6248 MachineInstr &I) const {
6249 Register ResourcePtr = I.getOperand(2).getReg();
6250 SPIRVTypeInst RegType = GR.getSPIRVTypeForVReg(ResourcePtr, I.getMF());
6251 if (RegType->getOpcode() == SPIRV::OpTypeImage) {
6252 // For texel buffers, the index into the image is part of the OpImageRead or
6253 // OpImageWrite instructions. So we will do nothing in this case. This
6254 // intrinsic will be combined with the load or store when selecting the load
6255 // or store.
6256 return true;
6257 }
6258
6259 assert(ResType->getOpcode() == SPIRV::OpTypePointer);
6260 MachineIRBuilder MIRBuilder(I);
6261
6262 Register ZeroReg =
6263 buildZerosVal(GR.getOrCreateSPIRVIntegerType(32, I, TII), I);
6264 auto MIB =
6265 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpAccessChain))
6266 .addDef(ResVReg)
6267 .addUse(GR.getSPIRVTypeID(ResType))
6268 .addUse(ResourcePtr)
6269 .addUse(ZeroReg);
6270
6271 if (I.getNumExplicitOperands() > 3) {
6272 Register IndexReg = I.getOperand(3).getReg();
6273 MIB.addUse(IndexReg);
6274 }
6275 MIB.constrainAllUses(TII, TRI, RBI);
6276 return true;
6277}
6278
6279bool SPIRVInstructionSelector::selectPushConstantGetPointer(
6280 Register &ResVReg, SPIRVTypeInst ResType, MachineInstr &I) const {
6281 MRI->replaceRegWith(ResVReg, I.getOperand(2).getReg());
6282 return true;
6283}
6284
6285bool SPIRVInstructionSelector::selectResourceNonUniformIndex(
6286 Register &ResVReg, SPIRVTypeInst ResType, MachineInstr &I) const {
6287 Register ObjReg = I.getOperand(2).getReg();
6288 if (!BuildCOPY(ResVReg, ObjReg, I))
6289 return false;
6290
6291 buildOpDecorate(ResVReg, I, TII, SPIRV::Decoration::NonUniformEXT, {});
6292 // Check for the registers that use the index marked as non-uniform
6293 // and recursively mark them as non-uniform.
6294 // Per the spec, it's necessary that the final argument used for
6295 // load/store/sample/atomic must be decorated, so we need to propagate the
6296 // decoration through access chains and copies.
6297 // https://docs.vulkan.org/samples/latest/samples/extensions/descriptor_indexing/README.html#_when_to_use_non_uniform_indexing_qualifier
6298 decorateUsesAsNonUniform(ResVReg);
6299 return true;
6300}
6301
6302void SPIRVInstructionSelector::decorateUsesAsNonUniform(
6303 Register &NonUniformReg) const {
6304 llvm::SmallVector<Register> WorkList = {NonUniformReg};
6305 while (WorkList.size() > 0) {
6306 Register CurrentReg = WorkList.back();
6307 WorkList.pop_back();
6308
6309 bool IsDecorated = false;
6310 for (MachineInstr &Use : MRI->use_instructions(CurrentReg)) {
6311 if (Use.getOpcode() == SPIRV::OpDecorate &&
6312 Use.getOperand(1).getImm() == SPIRV::Decoration::NonUniformEXT) {
6313 IsDecorated = true;
6314 continue;
6315 }
6316 // Check if the instruction has the result register and add it to the
6317 // worklist.
6318 if (Use.getOperand(0).isReg() && Use.getOperand(0).isDef()) {
6319 Register ResultReg = Use.getOperand(0).getReg();
6320 if (ResultReg == CurrentReg)
6321 continue;
6322 WorkList.push_back(ResultReg);
6323 }
6324 }
6325
6326 if (!IsDecorated) {
6327 buildOpDecorate(CurrentReg, *MRI->getVRegDef(CurrentReg), TII,
6328 SPIRV::Decoration::NonUniformEXT, {});
6329 }
6330 }
6331}
6332
6333bool SPIRVInstructionSelector::extractSubvector(
6334 Register &ResVReg, SPIRVTypeInst ResType, Register &ReadReg,
6335 MachineInstr &InsertionPoint) const {
6336 SPIRVTypeInst InputType = GR.getResultType(ReadReg);
6337 [[maybe_unused]] uint64_t InputSize =
6338 GR.getScalarOrVectorComponentCount(InputType);
6339 uint64_t ResultSize = GR.getScalarOrVectorComponentCount(ResType);
6340 assert(InputSize > 1 && "The input must be a vector.");
6341 assert(ResultSize > 1 && "The result must be a vector.");
6342 assert(ResultSize < InputSize &&
6343 "Cannot extract more element than there are in the input.");
6344 SmallVector<Register> ComponentRegisters;
6345 SPIRVTypeInst ScalarType = GR.getScalarOrVectorComponentType(ResType);
6346 const TargetRegisterClass *ScalarRegClass = GR.getRegClass(ScalarType);
6347 for (uint64_t I = 0; I < ResultSize; I++) {
6348 Register ComponentReg = MRI->createVirtualRegister(ScalarRegClass);
6349 BuildMI(*InsertionPoint.getParent(), InsertionPoint,
6350 InsertionPoint.getDebugLoc(), TII.get(SPIRV::OpCompositeExtract))
6351 .addDef(ComponentReg)
6352 .addUse(ScalarType->getOperand(0).getReg())
6353 .addUse(ReadReg)
6354 .addImm(I)
6355 .constrainAllUses(TII, TRI, RBI);
6356 ComponentRegisters.emplace_back(ComponentReg);
6357 }
6358
6359 MachineInstrBuilder MIB = BuildMI(*InsertionPoint.getParent(), InsertionPoint,
6360 InsertionPoint.getDebugLoc(),
6361 TII.get(SPIRV::OpCompositeConstruct))
6362 .addDef(ResVReg)
6363 .addUse(GR.getSPIRVTypeID(ResType));
6364
6365 for (Register ComponentReg : ComponentRegisters)
6366 MIB.addUse(ComponentReg);
6367 MIB.constrainAllUses(TII, TRI, RBI);
6368 return true;
6369}
6370
6371bool SPIRVInstructionSelector::selectImageWriteIntrinsic(
6372 MachineInstr &I) const {
6373 // If the load of the image is in a different basic block, then
6374 // this will generate invalid code. A proper solution is to move
6375 // the OpLoad from selectHandleFromBinding here. However, to do
6376 // that we will need to change the return type of the intrinsic.
6377 // We will do that when we can, but for now trying to move forward with other
6378 // issues.
6379 Register ImageReg = I.getOperand(1).getReg();
6380 auto *ImageDef = cast<GIntrinsic>(getVRegDef(*MRI, ImageReg));
6381 Register NewImageReg = MRI->createVirtualRegister(MRI->getRegClass(ImageReg));
6382 if (!loadHandleBeforePosition(NewImageReg, GR.getSPIRVTypeForVReg(ImageReg),
6383 *ImageDef, I)) {
6384 return false;
6385 }
6386
6387 Register CoordinateReg = I.getOperand(2).getReg();
6388 Register DataReg = I.getOperand(3).getReg();
6389 assert(GR.getResultType(DataReg)->getOpcode() == SPIRV::OpTypeVector);
6391 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpImageWrite))
6392 .addUse(NewImageReg)
6393 .addUse(CoordinateReg)
6394 .addUse(DataReg)
6395 .constrainAllUses(TII, TRI, RBI);
6396 return true;
6397}
6398
6399Register SPIRVInstructionSelector::buildPointerToResource(
6400 SPIRVTypeInst SpirvResType, SPIRV::StorageClass::StorageClass SC,
6401 uint32_t Set, uint32_t Binding, uint32_t ArraySize, Register IndexReg,
6402 StringRef Name, MachineIRBuilder MIRBuilder) const {
6403 const Type *ResType = GR.getTypeForSPIRVType(SpirvResType);
6404 if (ArraySize == 1) {
6405 SPIRVTypeInst PtrType =
6406 GR.getOrCreateSPIRVPointerType(ResType, MIRBuilder, SC);
6407 assert(GR.getPointeeType(PtrType) == SpirvResType &&
6408 "SpirvResType did not have an explicit layout.");
6409 return GR.getOrCreateGlobalVariableWithBinding(PtrType, Set, Binding, Name,
6410 MIRBuilder);
6411 }
6412
6413 const Type *VarType = ArrayType::get(const_cast<Type *>(ResType), ArraySize);
6414 SPIRVTypeInst VarPointerType =
6415 GR.getOrCreateSPIRVPointerType(VarType, MIRBuilder, SC);
6417 VarPointerType, Set, Binding, Name, MIRBuilder);
6418
6419 SPIRVTypeInst ResPointerType =
6420 GR.getOrCreateSPIRVPointerType(ResType, MIRBuilder, SC);
6421 Register AcReg = MRI->createVirtualRegister(GR.getRegClass(ResPointerType));
6422
6423 MIRBuilder.buildInstr(SPIRV::OpAccessChain)
6424 .addDef(AcReg)
6425 .addUse(GR.getSPIRVTypeID(ResPointerType))
6426 .addUse(VarReg)
6427 .addUse(IndexReg);
6428
6429 return AcReg;
6430}
6431
6432bool SPIRVInstructionSelector::selectFirstBitSet16(
6433 Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I,
6434 unsigned ExtendOpcode, unsigned BitSetOpcode) const {
6435 Register ExtReg = MRI->createVirtualRegister(GR.getRegClass(ResType));
6436 if (!selectOpWithSrcs(ExtReg, ResType, I, {I.getOperand(2).getReg()},
6437 ExtendOpcode))
6438 return false;
6439
6440 return selectFirstBitSet32(ResVReg, ResType, I, ExtReg, BitSetOpcode);
6441}
6442
6443bool SPIRVInstructionSelector::selectFirstBitSet32(
6444 Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I, Register SrcReg,
6445 unsigned BitSetOpcode) const {
6446 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpExtInst))
6447 .addDef(ResVReg)
6448 .addUse(GR.getSPIRVTypeID(ResType))
6449 .addImm(static_cast<uint32_t>(SPIRV::InstructionSet::GLSL_std_450))
6450 .addImm(BitSetOpcode)
6451 .addUse(SrcReg)
6452 .constrainAllUses(TII, TRI, RBI);
6453 return true;
6454}
6455
6456bool SPIRVInstructionSelector::selectFirstBitSet64(
6457 Register ResVReg, SPIRVTypeInst ResType, MachineInstr &I, Register SrcReg,
6458 unsigned BitSetOpcode, bool SwapPrimarySide) const {
6459 unsigned ComponentCount = GR.getScalarOrVectorComponentCount(ResType);
6460 SPIRVTypeInst BaseType = GR.retrieveScalarOrVectorIntType(ResType);
6461 bool ZeroAsNull = !STI.isShader();
6462 Register ConstIntZero =
6463 GR.getOrCreateConstInt(0, I, BaseType, TII, ZeroAsNull);
6464 Register ConstIntOne =
6465 GR.getOrCreateConstInt(1, I, BaseType, TII, ZeroAsNull);
6466
6467 // SPIRV doesn't support vectors with more than 4 components. Since the
6468 // algoritm below converts i64 -> i32x2 and i64x4 -> i32x8 it can only
6469 // operate on vectors with 2 or less components. When largers vectors are
6470 // seen. Split them, recurse, then recombine them.
6471 if (ComponentCount > 2) {
6472 auto Func = [this, SwapPrimarySide](Register ResVReg, SPIRVTypeInst ResType,
6473 MachineInstr &I, Register SrcReg,
6474 unsigned Opcode) -> bool {
6475 return this->selectFirstBitSet64(ResVReg, ResType, I, SrcReg, Opcode,
6476 SwapPrimarySide);
6477 };
6478
6479 return handle64BitOverflow(ResVReg, ResType, I, SrcReg, BitSetOpcode, Func);
6480 }
6481
6482 // 1. Split int64 into 2 pieces using a bitcast
6483 MachineIRBuilder MIRBuilder(I);
6484 SPIRVTypeInst PostCastType = GR.getOrCreateSPIRVVectorType(
6485 BaseType, 2 * ComponentCount, MIRBuilder, false);
6486 Register BitcastReg =
6487 MRI->createVirtualRegister(GR.getRegClass(PostCastType));
6488
6489 if (!selectOpWithSrcs(BitcastReg, PostCastType, I, {SrcReg},
6490 SPIRV::OpBitcast))
6491 return false;
6492
6493 // 2. Find the first set bit from the primary side for all the pieces in #1
6494 Register FBSReg = MRI->createVirtualRegister(GR.getRegClass(PostCastType));
6495 if (!selectFirstBitSet32(FBSReg, PostCastType, I, BitcastReg, BitSetOpcode))
6496 return false;
6497
6498 // 3. Split result vector into high bits and low bits
6499 Register HighReg = MRI->createVirtualRegister(GR.getRegClass(ResType));
6500 Register LowReg = MRI->createVirtualRegister(GR.getRegClass(ResType));
6501
6502 bool IsScalarRes = ResType->getOpcode() != SPIRV::OpTypeVector;
6503 if (IsScalarRes) {
6504 // if scalar do a vector extract
6505 if (!selectOpWithSrcs(HighReg, ResType, I, {FBSReg, ConstIntOne},
6506 SPIRV::OpVectorExtractDynamic))
6507 return false;
6508 if (!selectOpWithSrcs(LowReg, ResType, I, {FBSReg, ConstIntZero},
6509 SPIRV::OpVectorExtractDynamic))
6510 return false;
6511 } else {
6512 // if vector do a shufflevector
6513 auto MIB = BuildMI(*I.getParent(), I, I.getDebugLoc(),
6514 TII.get(SPIRV::OpVectorShuffle))
6515 .addDef(HighReg)
6516 .addUse(GR.getSPIRVTypeID(ResType))
6517 .addUse(FBSReg)
6518 // Per the spec, repeat the vector if only one vec is needed
6519 .addUse(FBSReg);
6520
6521 // high bits are stored in even natural indexes. Extract them from FBSReg
6522 for (unsigned J = 1; J < ComponentCount * 2; J += 2) {
6523 MIB.addImm(J);
6524 }
6525
6526 MIB.constrainAllUses(TII, TRI, RBI);
6527
6528 MIB = BuildMI(*I.getParent(), I, I.getDebugLoc(),
6529 TII.get(SPIRV::OpVectorShuffle))
6530 .addDef(LowReg)
6531 .addUse(GR.getSPIRVTypeID(ResType))
6532 .addUse(FBSReg)
6533 // Per the spec, repeat the vector if only one vec is needed
6534 .addUse(FBSReg);
6535
6536 // low bits are stored in odd natural indices. Extract them from FBSReg
6537 for (unsigned J = 0; J < ComponentCount * 2; J += 2) {
6538 MIB.addImm(J);
6539 }
6540 MIB.constrainAllUses(TII, TRI, RBI);
6541 }
6542
6543 // 4. Check the result. When primary bits == -1 use secondary, otherwise use
6544 // primary
6545 SPIRVTypeInst BoolType = GR.getOrCreateSPIRVBoolType(I, TII);
6546 Register NegOneReg;
6547 Register Reg0;
6548 Register Reg32;
6549 unsigned SelectOp;
6550 unsigned AddOp;
6551
6552 if (IsScalarRes) {
6553 NegOneReg =
6554 GR.getOrCreateConstInt((unsigned)-1, I, ResType, TII, ZeroAsNull);
6555 Reg0 = GR.getOrCreateConstInt(0, I, ResType, TII, ZeroAsNull);
6556 Reg32 = GR.getOrCreateConstInt(32, I, ResType, TII, ZeroAsNull);
6557 SelectOp = SPIRV::OpSelectSISCond;
6558 AddOp = SPIRV::OpIAddS;
6559 } else {
6560 BoolType = GR.getOrCreateSPIRVVectorType(BoolType, ComponentCount,
6561 MIRBuilder, false);
6562 NegOneReg =
6563 GR.getOrCreateConstVector((unsigned)-1, I, ResType, TII, ZeroAsNull);
6564 Reg0 = GR.getOrCreateConstVector(0, I, ResType, TII, ZeroAsNull);
6565 Reg32 = GR.getOrCreateConstVector(32, I, ResType, TII, ZeroAsNull);
6566 SelectOp = SPIRV::OpSelectVIVCond;
6567 AddOp = SPIRV::OpIAddV;
6568 }
6569
6570 Register PrimaryReg = HighReg;
6571 Register SecondaryReg = LowReg;
6572 Register RegPrimaryOffset = Reg32;
6573 Register RegSecondaryOffset = Reg0;
6574
6575 // By default the emitted opcodes check for the set bit from the MSB side.
6576 // Setting SwapPrimarySide checks the set bit from the LSB side
6577 if (SwapPrimarySide) {
6578 PrimaryReg = LowReg;
6579 SecondaryReg = HighReg;
6580 RegPrimaryOffset = Reg0;
6581 RegSecondaryOffset = Reg32;
6582 }
6583
6584 Register RegSecondaryHasVal =
6585 MRI->createVirtualRegister(GR.getRegClass(BoolType));
6586 if (!selectOpWithSrcs(RegSecondaryHasVal, BoolType, I,
6587 {SecondaryReg, NegOneReg}, SPIRV::OpINotEqual))
6588 return false;
6589
6590 Register RegPrimaryHasVal =
6591 MRI->createVirtualRegister(GR.getRegClass(BoolType));
6592 if (!selectOpWithSrcs(RegPrimaryHasVal, BoolType, I, {PrimaryReg, NegOneReg},
6593 SPIRV::OpINotEqual))
6594 return false;
6595
6596 // Pass 1: seed with secondary (lower-priority fallback)
6597 // ReturnBits = secondaryHasVal ? SecondaryBits : -1
6598 // Add = secondaryHasVal ? SecondaryOffset : 0
6599 Register RegReturnBits = MRI->createVirtualRegister(GR.getRegClass(ResType));
6600 if (!selectOpWithSrcs(RegReturnBits, ResType, I,
6601 {RegSecondaryHasVal, SecondaryReg, NegOneReg},
6602 SelectOp))
6603 return false;
6604
6605 Register RegAdd;
6606 if (SwapPrimarySide) {
6607 RegAdd = MRI->createVirtualRegister(GR.getRegClass(ResType));
6608 if (!selectOpWithSrcs(RegAdd, ResType, I,
6609 {RegSecondaryHasVal, RegSecondaryOffset, Reg0},
6610 SelectOp))
6611 return false;
6612 } else {
6613 RegAdd = Reg0;
6614 }
6615
6616 // Pass 2: override with primary (higher priority) if it has a valid result
6617 // ReturnBits2 = primaryHasVal ? PrimaryBits : ReturnBits
6618 // Add2 = primaryHasVal ? PrimaryOffset : Add
6619 Register RegReturnBits2 = MRI->createVirtualRegister(GR.getRegClass(ResType));
6620 if (!selectOpWithSrcs(RegReturnBits2, ResType, I,
6621 {RegPrimaryHasVal, PrimaryReg, RegReturnBits},
6622 SelectOp))
6623 return false;
6624
6625 Register RegAdd2 = MRI->createVirtualRegister(GR.getRegClass(ResType));
6626 if (!selectOpWithSrcs(RegAdd2, ResType, I,
6627 {RegPrimaryHasVal, RegPrimaryOffset, RegAdd}, SelectOp))
6628 return false;
6629
6630 return selectOpWithSrcs(ResVReg, ResType, I, {RegReturnBits2, RegAdd2},
6631 AddOp);
6632}
6633
6634bool SPIRVInstructionSelector::selectFirstBitHigh(Register ResVReg,
6635 SPIRVTypeInst ResType,
6636 MachineInstr &I,
6637 bool IsSigned) const {
6638 // FindUMsb and FindSMsb intrinsics only support 32 bit integers
6639 Register OpReg = I.getOperand(2).getReg();
6640 SPIRVTypeInst OpType = GR.getSPIRVTypeForVReg(OpReg);
6641 // zero or sign extend
6642 unsigned ExtendOpcode = IsSigned ? SPIRV::OpSConvert : SPIRV::OpUConvert;
6643 unsigned BitSetOpcode = IsSigned ? GL::FindSMsb : GL::FindUMsb;
6644
6645 switch (GR.getScalarOrVectorBitWidth(OpType)) {
6646 case 16:
6647 return selectFirstBitSet16(ResVReg, ResType, I, ExtendOpcode, BitSetOpcode);
6648 case 32:
6649 return selectFirstBitSet32(ResVReg, ResType, I, OpReg, BitSetOpcode);
6650 case 64:
6651 return selectFirstBitSet64(ResVReg, ResType, I, OpReg, BitSetOpcode,
6652 /*SwapPrimarySide=*/false);
6653 default:
6654 return diagnoseUnsupported(
6655 I,
6656 "spv_firstbituhigh and spv_firstbitshigh only support 16,32,64 bits.");
6657 }
6658}
6659
6660bool SPIRVInstructionSelector::selectFirstBitLow(Register ResVReg,
6661 SPIRVTypeInst ResType,
6662 MachineInstr &I) const {
6663 // FindILsb intrinsic only supports 32 bit integers
6664 Register OpReg = I.getOperand(2).getReg();
6665 SPIRVTypeInst OpType = GR.getSPIRVTypeForVReg(OpReg);
6666 // OpUConvert treats the operand bits as an unsigned i16 and zero extends it
6667 // to an unsigned i32. As this leaves all the least significant bits unchanged
6668 // so the first set bit from the LSB side doesn't change.
6669 unsigned ExtendOpcode = SPIRV::OpUConvert;
6670 unsigned BitSetOpcode = GL::FindILsb;
6671
6672 switch (GR.getScalarOrVectorBitWidth(OpType)) {
6673 case 16:
6674 return selectFirstBitSet16(ResVReg, ResType, I, ExtendOpcode, BitSetOpcode);
6675 case 32:
6676 return selectFirstBitSet32(ResVReg, ResType, I, OpReg, BitSetOpcode);
6677 case 64:
6678 return selectFirstBitSet64(ResVReg, ResType, I, OpReg, BitSetOpcode,
6679 /*SwapPrimarySide=*/true);
6680 default:
6681 return diagnoseUnsupported(I,
6682 "spv_firstbitlow only supports 16,32,64 bits.");
6683 }
6684}
6685
6686bool SPIRVInstructionSelector::selectAllocaArray(Register ResVReg,
6687 SPIRVTypeInst ResType,
6688 MachineInstr &I) const {
6689 // there was an allocation size parameter to the allocation instruction
6690 // that is not 1
6691 MachineBasicBlock &BB = *I.getParent();
6692 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpVariableLengthArrayINTEL))
6693 .addDef(ResVReg)
6694 .addUse(GR.getSPIRVTypeID(ResType))
6695 .addUse(I.getOperand(2).getReg())
6696 .constrainAllUses(TII, TRI, RBI);
6697 if (!STI.isShader()) {
6698 unsigned Alignment = I.getOperand(3).getImm();
6699 buildOpDecorate(ResVReg, I, TII, SPIRV::Decoration::Alignment, {Alignment});
6700 }
6701 return true;
6702}
6703
6704// Returns true iff `Ty` is a concrete SPIR-V type per the SPV_KHR_abort
6705// definition: a numerical scalar (int/float), a (physical) pointer, a vector,
6706// matrix or any aggregate (array/struct) recursively containing only such
6707// types. OpTypeBool, OpTypeVoid, opaque handles and similar abstract
6708// non-concrete types are rejected.
6710 const SPIRVGlobalRegistry &GR) {
6711 SmallVector<SPIRVTypeInst, 4> Worklist{Ty};
6712 while (!Worklist.empty()) {
6713 SPIRVTypeInst T = Worklist.pop_back_val();
6714 switch (T->getOpcode()) {
6715 case SPIRV::OpTypeInt:
6716 case SPIRV::OpTypeFloat:
6717 case SPIRV::OpTypePointer:
6718 break;
6719 case SPIRV::OpTypeVector:
6720 case SPIRV::OpTypeMatrix:
6721 case SPIRV::OpTypeArray: {
6722 Register OperandReg = T->getOperand(1).getReg();
6723 SPIRVTypeInst ElementT = GR.getSPIRVTypeForVReg(OperandReg);
6724 Worklist.push_back(ElementT);
6725 } break;
6726 case SPIRV::OpTypeStruct:
6727 for (unsigned Idx = 1, E = T->getNumOperands(); Idx < E; ++Idx) {
6728 Register OperandReg = T->getOperand(Idx).getReg();
6729 SPIRVTypeInst ElementT = GR.getSPIRVTypeForVReg(OperandReg);
6730 Worklist.push_back(ElementT);
6731 }
6732 break;
6733 default:
6734 return false;
6735 }
6736 }
6737 return true;
6738}
6739
6740bool SPIRVInstructionSelector::selectAbort(MachineInstr &I) const {
6741 assert(I.getNumExplicitOperands() == 2);
6742
6743 Register MsgReg = I.getOperand(1).getReg();
6744 SPIRVTypeInst MsgType = GR.getSPIRVTypeForVReg(MsgReg);
6745 assert(MsgType && "Message argument of llvm.spv.abort has no SPIR-V type");
6746
6747 if (!isConcreteSPIRVType(MsgType, GR))
6748 return diagnoseUnsupported(
6749 I,
6750 "llvm.spv.abort message type must be a concrete SPIR-V type (numerical "
6751 "scalar, pointer, vector, matrix, or aggregate of such types)");
6752
6753 MachineBasicBlock &BB = *I.getParent();
6754 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpAbortKHR))
6755 .addUse(GR.getSPIRVTypeID(MsgType))
6756 .addUse(MsgReg)
6757 .constrainAllUses(TII, TRI, RBI);
6758 return true;
6759}
6760
6761bool SPIRVInstructionSelector::selectTrap(MachineInstr &I) const {
6762 // When the SPV_KHR_abort extension is disabled, drop the G_TRAP and
6763 // G_UBSANTRAP silently.
6764 if (!STI.canUseExtension(SPIRV::Extension::SPV_KHR_abort))
6765 return true;
6766
6767 // Use the 32-bit integer constant for the abort "message" argument:
6768 // - G_UBSANTRAP operand is zero-extended to 32 bits.
6769 // - "All ones" constant is used for G_TRAP.
6770 uint32_t MsgVal = ~0u;
6771 if (I.getOpcode() == TargetOpcode::G_UBSANTRAP)
6772 MsgVal = static_cast<uint32_t>(I.getOperand(0).getImm());
6773
6774 SPIRVTypeInst MsgType = GR.getOrCreateSPIRVIntegerType(32, I, TII);
6775 Register MsgReg = buildI32ConstantInEntryBlock(MsgVal, I, MsgType);
6776
6777 MachineBasicBlock &BB = *I.getParent();
6778 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpAbortKHR))
6779 .addUse(GR.getSPIRVTypeID(MsgType))
6780 .addUse(MsgReg)
6781 .constrainAllUses(TII, TRI, RBI);
6782 return true;
6783}
6784
6785bool SPIRVInstructionSelector::selectFrameIndex(Register ResVReg,
6786 SPIRVTypeInst ResType,
6787 MachineInstr &I) const {
6788 // Change order of instructions if needed: all OpVariable instructions in a
6789 // function must be the first instructions in the first block
6790 auto It = getOpVariableMBBIt(*I.getMF());
6791 BuildMI(*It->getParent(), It, It->getDebugLoc(), TII.get(SPIRV::OpVariable))
6792 .addDef(ResVReg)
6793 .addUse(GR.getSPIRVTypeID(ResType))
6794 .addImm(static_cast<uint32_t>(SPIRV::StorageClass::Function))
6795 .constrainAllUses(TII, TRI, RBI);
6796 if (!STI.isShader()) {
6797 unsigned Alignment = I.getOperand(2).getImm();
6798 buildOpDecorate(ResVReg, *It, TII, SPIRV::Decoration::Alignment,
6799 {Alignment});
6800 }
6801 return true;
6802}
6803
6804bool SPIRVInstructionSelector::selectBranch(MachineInstr &I) const {
6805 // InstructionSelector walks backwards through the instructions. We can use
6806 // both a G_BR and a G_BRCOND to create an OpBranchConditional. We hit G_BR
6807 // first, so can generate an OpBranchConditional here. If there is no
6808 // G_BRCOND, we just use OpBranch for a regular unconditional branch.
6809 const MachineInstr *PrevI = I.getPrevNode();
6810 MachineBasicBlock &MBB = *I.getParent();
6811 if (PrevI != nullptr && PrevI->getOpcode() == TargetOpcode::G_BRCOND) {
6812 BuildMI(MBB, I, I.getDebugLoc(), TII.get(SPIRV::OpBranchConditional))
6813 .addUse(PrevI->getOperand(0).getReg())
6814 .addMBB(PrevI->getOperand(1).getMBB())
6815 .addMBB(I.getOperand(0).getMBB())
6816 .constrainAllUses(TII, TRI, RBI);
6817 return true;
6818 }
6819 BuildMI(MBB, I, I.getDebugLoc(), TII.get(SPIRV::OpBranch))
6820 .addMBB(I.getOperand(0).getMBB())
6821 .constrainAllUses(TII, TRI, RBI);
6822 return true;
6823}
6824
6825bool SPIRVInstructionSelector::selectBranchCond(MachineInstr &I) const {
6826 // InstructionSelector walks backwards through the instructions. For an
6827 // explicit conditional branch with no fallthrough, we use both a G_BR and a
6828 // G_BRCOND to create an OpBranchConditional. We should hit G_BR first, and
6829 // generate the OpBranchConditional in selectBranch above.
6830 //
6831 // If an OpBranchConditional has been generated, we simply return, as the work
6832 // is alread done. If there is no OpBranchConditional, LLVM must be relying on
6833 // implicit fallthrough to the next basic block, so we need to create an
6834 // OpBranchConditional with an explicit "false" argument pointing to the next
6835 // basic block that LLVM would fall through to.
6836 const MachineInstr *NextI = I.getNextNode();
6837 // Check if this has already been successfully selected.
6838 if (NextI != nullptr && NextI->getOpcode() == SPIRV::OpBranchConditional)
6839 return true;
6840 // Must be relying on implicit block fallthrough, so generate an
6841 // OpBranchConditional with the "next" basic block as the "false" target.
6842 MachineBasicBlock &MBB = *I.getParent();
6843 unsigned NextMBBNum = MBB.getNextNode()->getNumber();
6844 MachineBasicBlock *NextMBB = I.getMF()->getBlockNumbered(NextMBBNum);
6845 BuildMI(MBB, I, I.getDebugLoc(), TII.get(SPIRV::OpBranchConditional))
6846 .addUse(I.getOperand(0).getReg())
6847 .addMBB(I.getOperand(1).getMBB())
6848 .addMBB(NextMBB)
6849 .constrainAllUses(TII, TRI, RBI);
6850 return true;
6851}
6852
6853bool SPIRVInstructionSelector::selectPhi(Register ResVReg,
6854 MachineInstr &I) const {
6855 auto MIB =
6856 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(TargetOpcode::PHI))
6857 .addDef(ResVReg);
6858 const unsigned NumOps = I.getNumOperands();
6859 for (unsigned i = 1; i < NumOps; i += 2) {
6860 MIB.addUse(I.getOperand(i + 0).getReg());
6861 MIB.addMBB(I.getOperand(i + 1).getMBB());
6862 }
6863 MIB.constrainAllUses(TII, TRI, RBI);
6864 return true;
6865}
6866
6867bool SPIRVInstructionSelector::selectGlobalValue(
6868 Register ResVReg, MachineInstr &I, const MachineInstr *Init) const {
6869 // FIXME: don't use MachineIRBuilder here, replace it with BuildMI.
6870 MachineIRBuilder MIRBuilder(I);
6871 const GlobalValue *GV = I.getOperand(1).getGlobal();
6873
6874 std::string GlobalIdent;
6875 if (!GV->hasName()) {
6876 unsigned &ID = UnnamedGlobalIDs[GV];
6877 if (ID == 0)
6878 ID = UnnamedGlobalIDs.size();
6879 GlobalIdent = "__unnamed_" + Twine(ID).str();
6880 } else {
6881 GlobalIdent = GV->getName();
6882 }
6883
6884 // Behaviour of functions as operands depends on availability of the
6885 // corresponding extension (SPV_INTEL_function_pointers):
6886 // - If there is an extension to operate with functions as operands:
6887 // We create a proper constant operand and evaluate a correct type for a
6888 // function pointer.
6889 // - Without the required extension:
6890 // We have functions as operands in tests with blocks of instruction e.g. in
6891 // transcoding/global_block.ll. These operands are not used and should be
6892 // substituted by zero constants. Their type is expected to be always
6893 // OpTypePointer Function %uchar.
6894 if (isa<Function>(GV)) {
6895 const Constant *ConstVal = GV;
6896 MachineBasicBlock &BB = *I.getParent();
6897 Register NewReg = GR.find(ConstVal, GR.CurMF);
6898 if (!NewReg.isValid()) {
6899 const Function *GVFun =
6900 STI.canUseExtension(SPIRV::Extension::SPV_INTEL_function_pointers)
6901 ? dyn_cast<Function>(GV)
6902 : nullptr;
6903 SPIRVTypeInst ResType = GR.getOrCreateSPIRVPointerType(
6904 GVType, I,
6905 GVFun ? SPIRV::StorageClass::CodeSectionINTEL
6907 if (GVFun) {
6908 // References to a function via function pointers generate virtual
6909 // registers without a definition. We will resolve it later, during
6910 // module analysis stage.
6911 Register ResTypeReg = GR.getSPIRVTypeID(ResType);
6912 MachineRegisterInfo *MRI = MIRBuilder.getMRI();
6913 Register FuncVReg =
6914 MRI->createGenericVirtualRegister(GR.getRegType(ResType));
6915 MRI->setRegClass(FuncVReg, &SPIRV::pIDRegClass);
6916 GR.assignSPIRVTypeToVReg(ResType, FuncVReg, *GR.CurMF);
6917 MachineInstrBuilder MIB1 =
6918 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpUndef))
6919 .addDef(FuncVReg)
6920 .addUse(ResTypeReg);
6921 MachineInstrBuilder MIB2 =
6922 BuildMI(BB, I, I.getDebugLoc(),
6923 TII.get(SPIRV::OpConstantFunctionPointerINTEL))
6924 .addDef(ResVReg)
6925 .addUse(ResTypeReg)
6926 .addUse(FuncVReg);
6927 GR.add(ConstVal, MIB2);
6928 // mapping the function pointer to the used Function
6929 GR.recordFunctionPointer(&MIB2.getInstr()->getOperand(2), GVFun);
6930 GR.assignSPIRVTypeToVReg(ResType, ResVReg, *GR.CurMF);
6931 MIB1.constrainAllUses(TII, TRI, RBI);
6932 MIB2.constrainAllUses(TII, TRI, RBI);
6933 return true;
6934 }
6935 MachineInstrBuilder MIB3 =
6936 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpUndef))
6937 .addDef(ResVReg)
6938 .addUse(GR.getSPIRVTypeID(ResType));
6939 GR.add(ConstVal, MIB3);
6941 cast<Function>(GV));
6942 MIB3.constrainAllUses(TII, TRI, RBI);
6943 return true;
6944 }
6945 assert(NewReg != ResVReg);
6946 return BuildCOPY(ResVReg, NewReg, I);
6947 }
6949 assert(GlobalVar->getName() != "llvm.global.annotations");
6950
6951 // Skip empty declaration for GVs with initializers till we get the decl with
6952 // passed initializer.
6953 if (hasInitializer(GlobalVar) && !Init)
6954 return true;
6955
6956 const std::optional<SPIRV::LinkageType::LinkageType> LnkType =
6957 getSpirvLinkageTypeFor(STI, *GV);
6958
6959 if (LnkType && *LnkType == SPIRV::LinkageType::Import)
6960 Init = nullptr;
6961
6962 const unsigned AddrSpace = GV->getAddressSpace();
6963 SPIRV::StorageClass::StorageClass StorageClass =
6964 addressSpaceToStorageClass(AddrSpace, STI);
6965 SPIRVTypeInst ResType =
6968 ResVReg, ResType, GlobalIdent, GV, StorageClass, Init,
6969 GlobalVar->isConstant(), LnkType, MIRBuilder, true);
6970 // TODO: For AMDGCN, we pipe externally_initialized through via
6971 // HostAccessINTEL, with ReadWrite (3) access, which is we then handle during
6972 // reverse translation. We should remove this once SPIR-V gains the ability to
6973 // express the concept.
6974 if (GlobalVar->isExternallyInitialized() &&
6975 STI.getTargetTriple().getVendor() == Triple::AMD) {
6976 constexpr unsigned ReadWriteINTEL = 3u;
6977 buildOpDecorate(Reg, MIRBuilder, SPIRV::Decoration::HostAccessINTEL,
6978 {ReadWriteINTEL});
6979 MachineInstrBuilder MIB(*MF, --MIRBuilder.getInsertPt());
6980 addStringImm(GV->getName(), MIB);
6981 }
6982 return Reg.isValid();
6983}
6984
6985bool SPIRVInstructionSelector::selectLog10(Register ResVReg,
6986 SPIRVTypeInst ResType,
6987 MachineInstr &I) const {
6988 if (STI.canUseExtInstSet(SPIRV::InstructionSet::OpenCL_std)) {
6989 return selectExtInst(ResVReg, ResType, I, CL::log10);
6990 }
6991
6992 // There is no log10 instruction in the GLSL Extended Instruction set, so it
6993 // is implemented as:
6994 // log10(x) = log2(x) * (1 / log2(10))
6995 // = log2(x) * 0.30103
6996
6997 MachineIRBuilder MIRBuilder(I);
6998 MachineBasicBlock &BB = *I.getParent();
6999
7000 // Build log2(x).
7001 Register VarReg = MRI->createVirtualRegister(GR.getRegClass(ResType));
7002 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpExtInst))
7003 .addDef(VarReg)
7004 .addUse(GR.getSPIRVTypeID(ResType))
7005 .addImm(static_cast<uint32_t>(SPIRV::InstructionSet::GLSL_std_450))
7006 .addImm(GL::Log2)
7007 .add(I.getOperand(1))
7008 .constrainAllUses(TII, TRI, RBI);
7009
7010 // Build 0.30103.
7011 assert(ResType->getOpcode() == SPIRV::OpTypeVector ||
7012 ResType->getOpcode() == SPIRV::OpTypeFloat);
7013 // TODO: Add matrix implementation once supported by the HLSL frontend.
7014 SPIRVTypeInst SpirvScalarType = GR.getScalarOrVectorComponentType(ResType);
7015 // The literal must match the precision of the scalar type, otherwise the
7016 // OpConstant will contain non-zero high-order bits and fail SPIR-V
7017 // validation when the type is narrower than 32 bits (e.g. half).
7018 APFloat ScaleVal(0.30103);
7019 bool LosesInfo;
7020 ScaleVal.convert(
7021 getZeroFP(GR.getTypeForSPIRVType(SpirvScalarType)).getSemantics(),
7022 APFloat::rmNearestTiesToEven, &LosesInfo);
7023 Register ScaleReg = GR.buildConstantFP(ScaleVal, MIRBuilder, SpirvScalarType);
7024
7025 // Multiply log2(x) by 0.30103 to get log10(x) result.
7026 auto Opcode = ResType->getOpcode() == SPIRV::OpTypeVector
7027 ? SPIRV::OpVectorTimesScalar
7028 : SPIRV::OpFMulS;
7029 BuildMI(BB, I, I.getDebugLoc(), TII.get(Opcode))
7030 .addDef(ResVReg)
7031 .addUse(GR.getSPIRVTypeID(ResType))
7032 .addUse(VarReg)
7033 .addUse(ScaleReg)
7034 .constrainAllUses(TII, TRI, RBI);
7035 return true;
7036}
7037
7038bool SPIRVInstructionSelector::selectFpowi(Register ResVReg,
7039 SPIRVTypeInst ResType,
7040 MachineInstr &I) const {
7041 // On OpenCL targets, pown(gentype x, intn n) maps directly.
7042 if (STI.canUseExtInstSet(SPIRV::InstructionSet::OpenCL_std))
7043 return selectExtInst(ResVReg, ResType, I, CL::pown);
7044
7045 // On GLSL (Vulkan) targets, there is no integer-exponent power instruction.
7046 // Lower as: Pow(base, OpConvertSToF(exp)).
7047 if (STI.canUseExtInstSet(SPIRV::InstructionSet::GLSL_std_450)) {
7048 Register BaseReg = I.getOperand(1).getReg();
7049 Register ExpReg = I.getOperand(2).getReg();
7050 Register FloatExpReg = MRI->createVirtualRegister(GR.getRegClass(ResType));
7051 if (!selectOpWithSrcs(FloatExpReg, ResType, I, {ExpReg},
7052 SPIRV::OpConvertSToF))
7053 return false;
7054 return selectExtInst(ResVReg, ResType, I, GL::Pow,
7055 /*setMIFlags=*/true, /*useMISrc=*/false,
7056 {BaseReg, FloatExpReg});
7057 }
7058 return false;
7059}
7060
7061bool SPIRVInstructionSelector::selectModf(Register ResVReg,
7062 SPIRVTypeInst ResType,
7063 MachineInstr &I) const {
7064 // llvm.modf has a single arg --the number to be decomposed-- and returns a
7065 // struct { restype, restype }, while OpenCLLIB::modf has two args --the
7066 // number to be decomposed and a pointer--, returns the fractional part and
7067 // the integral part is stored in the pointer argument. Therefore, we can't
7068 // use directly the OpenCLLIB::modf intrinsic. However, we can do some
7069 // scaffolding to make it work. The idea is to create an alloca instruction
7070 // to get a ptr, pass this ptr to OpenCL::modf, and then load the value
7071 // from this ptr to place it in the struct. llvm.modf returns the fractional
7072 // part as the first element of the result, and the integral part as the
7073 // second element of the result.
7074
7075 // At this point, the return type is not a struct anymore, but rather two
7076 // independent elements of SPIRVResType. We can get each independent element
7077 // from I.getDefs() or I.getOperands().
7078 if (STI.canUseExtInstSet(SPIRV::InstructionSet::OpenCL_std)) {
7079 MachineIRBuilder MIRBuilder(I);
7080 SPIRVTypeInst FloatType =
7081 GR.getSPIRVTypeForVReg(I.getOperand(I.getNumExplicitDefs()).getReg());
7082 // Get pointer type for alloca variable.
7083 const SPIRVTypeInst PtrType = GR.getOrCreateSPIRVPointerType(
7084 FloatType, MIRBuilder, SPIRV::StorageClass::Function);
7085 // Create new register for the pointer type of alloca variable.
7086 Register PtrTyReg =
7087 MIRBuilder.getMRI()->createVirtualRegister(&SPIRV::iIDRegClass);
7088 MIRBuilder.getMRI()->setType(
7089 PtrTyReg,
7090 LLT::pointer(storageClassToAddressSpace(SPIRV::StorageClass::Function),
7091 GR.getPointerSize()));
7092
7093 // Assign SPIR-V type of the pointer type of the alloca variable to the
7094 // new register.
7095 GR.assignSPIRVTypeToVReg(PtrType, PtrTyReg, MIRBuilder.getMF());
7097 MachineBasicBlock &EntryBB = I.getMF()->front();
7098 auto AllocaMIB =
7099 BuildMI(EntryBB, VarPos, I.getDebugLoc(), TII.get(SPIRV::OpVariable))
7100 .addDef(PtrTyReg)
7101 .addUse(GR.getSPIRVTypeID(PtrType))
7102 .addImm(static_cast<uint32_t>(SPIRV::StorageClass::Function));
7103 Register Variable = AllocaMIB->getOperand(0).getReg();
7104
7105 MachineBasicBlock &BB = *I.getParent();
7106 // Create the OpenCLLIB::modf instruction.
7107 auto MIB =
7108 BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpExtInst))
7109 .addDef(ResVReg)
7110 .addUse(GR.getSPIRVTypeID(FloatType))
7111 .addImm(static_cast<uint32_t>(SPIRV::InstructionSet::OpenCL_std))
7112 .addImm(CL::modf)
7113 .setMIFlags(I.getFlags())
7114 .add(I.getOperand(I.getNumExplicitDefs())) // Floating point value.
7115 .addUse(Variable); // Pointer to integral part.
7116 // Assign the integral part stored in the ptr to the second element of the
7117 // result.
7118 Register IntegralPartReg = I.getOperand(1).getReg();
7119 if (IntegralPartReg.isValid() && !MRI->use_nodbg_empty(IntegralPartReg)) {
7120 // Load the value from the pointer to integral part.
7121 auto LoadMIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpLoad))
7122 .addDef(IntegralPartReg)
7123 .addUse(GR.getSPIRVTypeID(FloatType))
7124 .addUse(Variable);
7125 LoadMIB.constrainAllUses(TII, TRI, RBI);
7126 }
7127
7128 MIB.constrainAllUses(TII, TRI, RBI);
7129 return true;
7130 } else if (STI.canUseExtInstSet(SPIRV::InstructionSet::GLSL_std_450)) {
7131 assert(false && "GLSL::Modf is deprecated.");
7132 // FIXME: GL::Modf is deprecated, use Modfstruct instead.
7133 return false;
7134 }
7135 return false;
7136}
7137
7138// Generate the instructions to load 3-element vector builtin input
7139// IDs/Indices.
7140// Like: GlobalInvocationId, LocalInvocationId, etc....
7141
7142bool SPIRVInstructionSelector::loadVec3BuiltinInputID(
7143 SPIRV::BuiltIn::BuiltIn BuiltInValue, Register ResVReg,
7144 SPIRVTypeInst ResType, MachineInstr &I) const {
7145 MachineIRBuilder MIRBuilder(I);
7146 const SPIRVTypeInst Vec3Ty =
7147 GR.getOrCreateSPIRVVectorType(ResType, 3, MIRBuilder, false);
7148 const SPIRVTypeInst PtrType = GR.getOrCreateSPIRVPointerType(
7149 Vec3Ty, MIRBuilder, SPIRV::StorageClass::Input);
7150
7151 // Create new register for the input ID builtin variable.
7152 Register NewRegister =
7153 MIRBuilder.getMRI()->createVirtualRegister(&SPIRV::iIDRegClass);
7154 MIRBuilder.getMRI()->setType(NewRegister, LLT::pointer(0, 64));
7155 GR.assignSPIRVTypeToVReg(PtrType, NewRegister, MIRBuilder.getMF());
7156
7157 // Build global variable with the necessary decorations for the input ID
7158 // builtin variable.
7160 NewRegister, PtrType, getLinkStringForBuiltIn(BuiltInValue), nullptr,
7161 SPIRV::StorageClass::Input, nullptr, true, std::nullopt, MIRBuilder,
7162 false);
7163
7164 // Create new register for loading value.
7165 MachineRegisterInfo *MRI = MIRBuilder.getMRI();
7166 Register LoadedRegister = MRI->createVirtualRegister(&SPIRV::iIDRegClass);
7167 MIRBuilder.getMRI()->setType(LoadedRegister, LLT::pointer(0, 64));
7168 GR.assignSPIRVTypeToVReg(Vec3Ty, LoadedRegister, MIRBuilder.getMF());
7169
7170 // Load v3uint value from the global variable.
7171 BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpLoad))
7172 .addDef(LoadedRegister)
7173 .addUse(GR.getSPIRVTypeID(Vec3Ty))
7174 .addUse(Variable);
7175
7176 // Get the input ID index. Expecting operand is a constant immediate value,
7177 // wrapped in a type assignment.
7178 assert(I.getOperand(2).isReg());
7179 const uint32_t ThreadId = foldImm(I.getOperand(2), MRI);
7180
7181 // Extract the input ID from the loaded vector value.
7182 MachineBasicBlock &BB = *I.getParent();
7183 auto MIB = BuildMI(BB, I, I.getDebugLoc(), TII.get(SPIRV::OpCompositeExtract))
7184 .addDef(ResVReg)
7185 .addUse(GR.getSPIRVTypeID(ResType))
7186 .addUse(LoadedRegister)
7187 .addImm(ThreadId);
7188 MIB.constrainAllUses(TII, TRI, RBI);
7189 return true;
7190}
7191
7192// Generate the instructions to load 32-bit integer builtin input IDs/Indices.
7193// Like LocalInvocationIndex
7194bool SPIRVInstructionSelector::loadBuiltinInputID(
7195 SPIRV::BuiltIn::BuiltIn BuiltInValue, Register ResVReg,
7196 SPIRVTypeInst ResType, MachineInstr &I) const {
7197 MachineIRBuilder MIRBuilder(I);
7198 const SPIRVTypeInst PtrType = GR.getOrCreateSPIRVPointerType(
7199 ResType, MIRBuilder, SPIRV::StorageClass::Input);
7200
7201 // Create new register for the input ID builtin variable.
7202 Register NewRegister =
7203 MIRBuilder.getMRI()->createVirtualRegister(GR.getRegClass(PtrType));
7204 MIRBuilder.getMRI()->setType(
7205 NewRegister,
7206 LLT::pointer(storageClassToAddressSpace(SPIRV::StorageClass::Input),
7207 GR.getPointerSize()));
7208 GR.assignSPIRVTypeToVReg(PtrType, NewRegister, MIRBuilder.getMF());
7209
7210 // Build global variable with the necessary decorations for the input ID
7211 // builtin variable.
7213 NewRegister, PtrType, getLinkStringForBuiltIn(BuiltInValue), nullptr,
7214 SPIRV::StorageClass::Input, nullptr, true, std::nullopt, MIRBuilder,
7215 false);
7216
7217 // Load uint value from the global variable.
7218 auto MIB = BuildMI(*I.getParent(), I, I.getDebugLoc(), TII.get(SPIRV::OpLoad))
7219 .addDef(ResVReg)
7220 .addUse(GR.getSPIRVTypeID(ResType))
7221 .addUse(Variable);
7222
7223 MIB.constrainAllUses(TII, TRI, RBI);
7224 return true;
7225}
7226
7227SPIRVTypeInst SPIRVInstructionSelector::widenTypeToVec4(SPIRVTypeInst Type,
7228 MachineInstr &I) const {
7229 MachineIRBuilder MIRBuilder(I);
7230 if (Type->getOpcode() != SPIRV::OpTypeVector)
7231 return GR.getOrCreateSPIRVVectorType(Type, 4, MIRBuilder, false);
7232
7234 return Type;
7235
7236 SPIRVTypeInst ScalarType = GR.getScalarOrVectorComponentType(Type);
7237 return GR.getOrCreateSPIRVVectorType(ScalarType, 4, MIRBuilder, false);
7238}
7239
7240bool SPIRVInstructionSelector::loadHandleBeforePosition(
7241 Register &HandleReg, SPIRVTypeInst ResType, GIntrinsic &HandleDef,
7242 MachineInstr &Pos) const {
7243
7244 assert(HandleDef.getIntrinsicID() ==
7245 Intrinsic::spv_resource_handlefrombinding);
7246 uint32_t Set = foldImm(HandleDef.getOperand(2), MRI);
7247 uint32_t Binding = foldImm(HandleDef.getOperand(3), MRI);
7248 uint32_t ArraySize = foldImm(HandleDef.getOperand(4), MRI);
7249 Register IndexReg = HandleDef.getOperand(5).getReg();
7250 std::string Name =
7251 getStringValueFromReg(HandleDef.getOperand(6).getReg(), *MRI);
7252
7253 bool IsStructuredBuffer = ResType->getOpcode() == SPIRV::OpTypePointer;
7254 MachineIRBuilder MIRBuilder(HandleDef);
7255 SPIRVTypeInst VarType = ResType;
7256 SPIRV::StorageClass::StorageClass SC = SPIRV::StorageClass::UniformConstant;
7257
7258 if (IsStructuredBuffer) {
7259 VarType = GR.getPointeeType(ResType);
7260 SC = GR.getPointerStorageClass(ResType);
7261 }
7262
7263 if (ResType->getOpcode() == SPIRV::OpTypeImage && ArraySize == 0)
7264 MIRBuilder.buildInstr(SPIRV::OpCapability)
7265 .addImm(SPIRV::Capability::RuntimeDescriptorArrayEXT);
7266
7267 Register VarReg =
7268 buildPointerToResource(SPIRVTypeInst(VarType), SC, Set, Binding,
7269 ArraySize, IndexReg, Name, MIRBuilder);
7270
7271 // The handle for the buffer is the pointer to the resource. For an image, the
7272 // handle is the image object. So images get an extra load.
7273 uint32_t LoadOpcode =
7274 IsStructuredBuffer ? SPIRV::OpCopyObject : SPIRV::OpLoad;
7275 GR.assignSPIRVTypeToVReg(ResType, HandleReg, *Pos.getMF());
7276 BuildMI(*Pos.getParent(), Pos, HandleDef.getDebugLoc(), TII.get(LoadOpcode))
7277 .addDef(HandleReg)
7278 .addUse(GR.getSPIRVTypeID(ResType))
7279 .addUse(VarReg)
7280 .constrainAllUses(TII, TRI, RBI);
7281 return true;
7282}
7283
7284bool SPIRVInstructionSelector::errorIfInstrOutsideShader(
7285 MachineInstr &I) const {
7286 if (!STI.isShader())
7287 return diagnoseUnsupported(
7288 I, "this instruction is only supported in shaders.");
7289 return true;
7290}
7291
7292namespace llvm {
7293InstructionSelector *
7295 const SPIRVSubtarget &Subtarget,
7296 const RegisterBankInfo &RBI) {
7297 return new SPIRVInstructionSelector(TM, Subtarget, RBI);
7298}
7299} // namespace llvm
MachineInstrBuilder & UseMI
#define GET_GLOBALISEL_PREDICATES_INIT
#define GET_GLOBALISEL_TEMPORARIES_INIT
@ Generic
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
This file declares a class to represent arbitrary precision floating point values and provide a varie...
static bool selectUnmergeValues(MachineInstrBuilder &MIB, const ARMBaseInstrInfo &TII, MachineRegisterInfo &MRI, const TargetRegisterInfo &TRI, const RegisterBankInfo &RBI)
MachineBasicBlock & MBB
MachineBasicBlock MachineBasicBlock::iterator DebugLoc DL
static uint8_t SwapBits(uint8_t Val)
basic Basic Alias true
#define X(NUM, ENUM, NAME)
Definition ELF.h:853
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
DXIL Resource Implicit Binding
#define DEBUG_TYPE
Declares convenience wrapper classes for interpreting MachineInstr instances as specific generic oper...
const HexagonInstrInfo * TII
IRTranslator LLVM IR MI
LLVMTypeRef LLVMIntType(unsigned NumBits)
Definition Core.cpp:729
const size_t AbstractManglingParser< Derived, Alloc >::NumOps
Loop::LoopBounds::Direction Direction
Definition LoopInfo.cpp:253
#define F(x, y, z)
Definition MD5.cpp:54
#define I(x, y, z)
Definition MD5.cpp:57
Register Reg
Register const TargetRegisterInfo * TRI
Promote Memory to Register
Definition Mem2Reg.cpp:110
#define T
#define T1
MachineInstr unsigned OpIdx
uint64_t High
uint64_t IntrinsicInst * II
static StringRef getName(Value *V)
static unsigned getFCmpOpcode(CmpInst::Predicate Pred, unsigned Size)
static bool isConcreteSPIRVType(SPIRVTypeInst Ty, const SPIRVGlobalRegistry &GR)
static APFloat getOneFP(const Type *LLVMFloatTy)
static bool isUSMStorageClass(SPIRV::StorageClass::StorageClass SC)
static bool isASCastInGVar(MachineRegisterInfo *MRI, Register ResVReg)
static bool mayApplyGenericSelection(unsigned Opcode)
static APFloat getZeroFP(const Type *LLVMFloatTy)
std::vector< std::pair< SPIRV::InstructionSet::InstructionSet, uint32_t > > ExtInstList
static bool intrinsicHasSideEffects(Intrinsic::ID ID)
static unsigned getBoolCmpOpcode(unsigned PredNum)
static unsigned getICmpOpcode(unsigned PredNum)
static bool isOpcodeWithNoSideEffects(unsigned Opcode)
static void addMemoryOperands(MachineMemOperand *MemOp, MachineInstrBuilder &MIB, MachineIRBuilder &MIRBuilder, SPIRVGlobalRegistry &GR)
static bool isConstReg(MachineRegisterInfo *MRI, MachineInstr *OpDef)
static unsigned getPtrCmpOpcode(unsigned Pred)
bool isDead(const MachineInstr &MI, const MachineRegisterInfo &MRI)
spirv structurize SPIRV
BaseType
A given derived pointer can have multiple base pointers through phi/selects.
This file contains some functions that are useful when dealing with strings.
#define LLVM_DEBUG(...)
Definition Debug.h:119
static TableGen::Emitter::Opt Y("gen-skeleton-entry", EmitSkeleton, "Generate example skeleton entry")
static ManagedStatic< cl::opt< FnT >, OptCreatorT > CallbackFunction
BinaryOperator * Mul
static const fltSemantics & IEEEsingle()
Definition APFloat.h:297
static const fltSemantics & IEEEdouble()
Definition APFloat.h:298
static const fltSemantics & IEEEhalf()
Definition APFloat.h:295
const fltSemantics & getSemantics() const
Definition APFloat.h:1552
static APFloat getOne(const fltSemantics &Sem, bool Negative=false)
Factory for Positive and Negative One.
Definition APFloat.h:1153
static APFloat getZero(const fltSemantics &Sem, bool Negative=false)
Factory for Positive and Negative Zero.
Definition APFloat.h:1144
static APInt getAllOnes(unsigned numBits)
Return an APInt of a specified width with all bits set.
Definition APInt.h:235
Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:40
BlockFrequencyInfo pass uses BlockFrequencyInfoImpl implementation to estimate IR basic block frequen...
Predicate
This enumeration lists the possible predicates for CmpInst subclasses.
Definition InstrTypes.h:740
@ FCMP_OEQ
0 0 0 1 True if ordered and equal
Definition InstrTypes.h:743
@ ICMP_SLT
signed less than
Definition InstrTypes.h:769
@ ICMP_SLE
signed less or equal
Definition InstrTypes.h:770
@ FCMP_OLT
0 1 0 0 True if ordered and less than
Definition InstrTypes.h:746
@ FCMP_ULE
1 1 0 1 True if unordered, less than, or equal
Definition InstrTypes.h:755
@ FCMP_OGT
0 0 1 0 True if ordered and greater than
Definition InstrTypes.h:744
@ FCMP_OGE
0 0 1 1 True if ordered and greater than or equal
Definition InstrTypes.h:745
@ ICMP_UGE
unsigned greater or equal
Definition InstrTypes.h:764
@ ICMP_UGT
unsigned greater than
Definition InstrTypes.h:763
@ ICMP_SGT
signed greater than
Definition InstrTypes.h:767
@ FCMP_ULT
1 1 0 0 True if unordered or less than
Definition InstrTypes.h:754
@ FCMP_ONE
0 1 1 0 True if ordered and operands are unequal
Definition InstrTypes.h:748
@ FCMP_UEQ
1 0 0 1 True if unordered or equal
Definition InstrTypes.h:751
@ ICMP_ULT
unsigned less than
Definition InstrTypes.h:765
@ FCMP_UGT
1 0 1 0 True if unordered or greater than
Definition InstrTypes.h:752
@ FCMP_OLE
0 1 0 1 True if ordered and less than or equal
Definition InstrTypes.h:747
@ FCMP_ORD
0 1 1 1 True if ordered (no nans)
Definition InstrTypes.h:749
@ ICMP_NE
not equal
Definition InstrTypes.h:762
@ ICMP_SGE
signed greater or equal
Definition InstrTypes.h:768
@ FCMP_UNE
1 1 1 0 True if unordered or not equal
Definition InstrTypes.h:756
@ ICMP_ULE
unsigned less or equal
Definition InstrTypes.h:766
@ FCMP_UGE
1 0 1 1 True if unordered, greater than, or equal
Definition InstrTypes.h:753
@ FCMP_UNO
1 0 0 0 True if unordered: isnan(X) | isnan(Y)
Definition InstrTypes.h:750
static LLVM_ABI Constant * getNullValue(Type *Ty)
Constructor to create a '0' constant of arbitrary type.
unsigned size() const
Definition DenseMap.h:174
LLVMContext & getContext() const
getContext - Return a reference to the LLVMContext associated with this function.
Definition Function.cpp:354
Represents a call to an intrinsic.
Intrinsic::ID getIntrinsicID() const
unsigned getAddressSpace() const
Module * getParent()
Get the module that this global value is contained inside of...
@ InternalLinkage
Rename collisions when linking (static functions).
Definition GlobalValue.h:60
static LLVM_ABI IntegerType * get(LLVMContext &C, unsigned NumBits)
This static method is the primary way of constructing an IntegerType.
Definition Type.cpp:350
static constexpr LLT scalar(unsigned SizeInBits)
Get a low-level scalar or aggregate "bag of bits".
constexpr bool isValid() const
constexpr uint16_t getNumElements() const
Returns the number of elements in a vector LLT.
constexpr bool isVector() const
static constexpr LLT pointer(unsigned AddressSpace, unsigned SizeInBits)
Get a low-level pointer in the given address space.
static constexpr LLT fixed_vector(unsigned NumElements, unsigned ScalarSizeInBits)
Get a low-level fixed-width vector of some number of elements and element width.
int getNumber() const
MachineBasicBlocks are uniquely numbered at the function level, unless they're not in a MachineFuncti...
LLVM_ABI iterator getFirstNonPHI()
Returns a pointer to the first instruction in this block that is not a PHINode instruction.
const MachineFunction * getParent() const
Return the MachineFunction containing this basic block.
MachineInstrBundleIterator< MachineInstr > iterator
MachineRegisterInfo & getRegInfo()
getRegInfo - Return information about the registers currently in use.
Function & getFunction()
Return the LLVM function that this machine code represents.
Helper class to build MachineInstr.
MachineBasicBlock::iterator getInsertPt()
Current insertion point for new instructions.
MachineInstrBuilder buildInstr(unsigned Opcode)
Build and insert <empty> = Opcode <empty>.
MachineFunction & getMF()
Getter for the function we currently build.
MachineRegisterInfo * getMRI()
Getter for MRI.
void constrainAllUses(const TargetInstrInfo &TII, const TargetRegisterInfo &TRI, const RegisterBankInfo &RBI) const
const MachineInstrBuilder & addUse(Register RegNo, RegState Flags={}, unsigned SubReg=0) const
Add a virtual register use operand.
const MachineInstrBuilder & addReg(Register RegNo, RegState Flags={}, unsigned SubReg=0) const
Add a new virtual register operand.
const MachineInstrBuilder & addImm(int64_t Val) const
Add a new immediate operand.
const MachineInstrBuilder & add(const MachineOperand &MO) const
const MachineInstrBuilder & addMBB(MachineBasicBlock *MBB, unsigned TargetFlags=0) const
const MachineInstrBuilder & addDef(Register RegNo, RegState Flags={}, unsigned SubReg=0) const
Add a virtual register definition operand.
const MachineInstrBuilder & setMIFlags(unsigned Flags) const
MachineInstr * getInstr() const
If conversion operators fail, use this method to get the MachineInstr explicitly.
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 unsigned getNumExplicitOperands() const
Returns the number of non-implicit operands.
LLVM_ABI unsigned getNumExplicitDefs() const
Returns the number of non-implicit definitions.
LLVM_ABI void emitGenericError(const Twine &ErrMsg) const
LLVM_ABI const MachineFunction * getMF() const
Return the function that contains the basic block that this instruction belongs to.
const DebugLoc & getDebugLoc() const
Returns the debug location id of this MachineInstr.
const MachineOperand & getOperand(unsigned i) const
A description of a memory reference used in the backend.
@ MOVolatile
The memory access is volatile.
@ MONonTemporal
The memory access is non-temporal.
int64_t getImm() const
bool isReg() const
isReg - Tests if this is a MO_Register operand.
MachineBasicBlock * getMBB() const
Register getReg() const
getReg - Returns the register number.
MachineRegisterInfo - Keep track of information for virtual and physical registers,...
defusechain_instr_iterator< true, false, false, true > use_instr_iterator
use_instr_iterator/use_instr_begin/use_instr_end - Walk all uses of the specified register,...
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 ...
use_instr_iterator use_instr_begin(Register RegNo) const
bool use_nodbg_empty(Register RegNo) const
use_nodbg_empty - Return true if there are no non-Debug instructions using the specified register.
static def_instr_iterator def_instr_end()
defusechain_instr_iterator< false, true, false, true > def_instr_iterator
def_instr_iterator/def_instr_begin/def_instr_end - Walk all defs of the specified register,...
LLVM_ABI Register createVirtualRegister(const TargetRegisterClass *RegClass, StringRef Name="")
createVirtualRegister - Create and return a new virtual register in the function with the specified r...
def_instr_iterator def_instr_begin(Register RegNo) const
LLT getType(Register Reg) const
Get the low-level type of Reg or LLT{} if Reg is not a generic (target independent) virtual register.
static use_instr_iterator use_instr_end()
iterator_range< use_instr_nodbg_iterator > use_nodbg_instructions(Register Reg) const
LLVM_ABI void setType(Register VReg, LLT Ty)
Set the low-level type of VReg to Ty.
const MachineFunction & getMF() const
LLVM_ABI void setRegClass(Register Reg, const TargetRegisterClass *RC)
setRegClass - Set the register class of the specified virtual register.
LLVM_ABI Register createGenericVirtualRegister(LLT Ty, StringRef Name="")
Create and return a new generic virtual register with low-level type Ty.
const TargetRegisterClass * getRegClassOrNull(Register Reg) const
Return the register class of Reg, or null if Reg has not been assigned a register class yet.
iterator_range< use_instr_iterator > use_instructions(Register Reg) const
unsigned getNumVirtRegs() const
getNumVirtRegs - Return the number of virtual registers created.
LLVM_ABI void replaceRegWith(Register FromReg, Register ToReg)
replaceRegWith - Replace all instances of FromReg with ToReg in the machine function.
Analysis providing profile information.
Holds all the information related to register banks.
Wrapper class representing virtual and physical registers.
Definition Register.h:20
constexpr bool isValid() const
Definition Register.h:112
constexpr bool isPhysical() const
Return true if the specified register number is in the physical register namespace.
Definition Register.h:83
bool isScalarOrVectorSigned(SPIRVTypeInst Type) const
SPIRVTypeInst getOrCreateOpTypeSampledImage(SPIRVTypeInst ImageType, MachineIRBuilder &MIRBuilder)
void assignSPIRVTypeToVReg(SPIRVTypeInst Type, Register VReg, const MachineFunction &MF)
const TargetRegisterClass * getRegClass(SPIRVTypeInst SpvType) const
MachineInstr * getOrAddMemAliasingINTELInst(MachineIRBuilder &MIRBuilder, const MDNode *AliasingListMD)
bool isAggregateType(SPIRVTypeInst Type) const
unsigned getScalarOrVectorBitWidth(SPIRVTypeInst Type) const
SPIRVTypeInst getOrCreateSPIRVIntegerType(unsigned BitWidth, MachineIRBuilder &MIRBuilder)
SPIRVTypeInst getOrCreateSPIRVVectorType(SPIRVTypeInst BaseType, unsigned NumElements, MachineIRBuilder &MIRBuilder, bool EmitIR)
Register buildGlobalVariable(Register Reg, SPIRVTypeInst BaseType, StringRef Name, const GlobalValue *GV, SPIRV::StorageClass::StorageClass Storage, const MachineInstr *Init, bool IsConst, const std::optional< SPIRV::LinkageType::LinkageType > &LinkageType, MachineIRBuilder &MIRBuilder, bool IsInstSelector)
SPIRVTypeInst getResultType(Register VReg, MachineFunction *MF=nullptr)
unsigned getScalarOrVectorComponentCount(Register VReg) const
const Type * getTypeForSPIRVType(SPIRVTypeInst Ty) const
bool isBitcastCompatible(SPIRVTypeInst Type1, SPIRVTypeInst Type2) const
Register getOrCreateConstFP(APFloat Val, MachineInstr &I, SPIRVTypeInst SpvType, const SPIRVInstrInfo &TII, bool ZeroAsNull=true)
LLT getRegType(SPIRVTypeInst SpvType) const
void invalidateMachineInstr(MachineInstr *MI)
SPIRVTypeInst getOrCreateSPIRVBoolType(MachineIRBuilder &MIRBuilder, bool EmitIR)
SPIRVTypeInst getOrCreateSPIRVPointerType(const Type *BaseType, MachineIRBuilder &MIRBuilder, SPIRV::StorageClass::StorageClass SC)
bool isScalarOfType(Register VReg, unsigned TypeOpcode) const
Register getSPIRVTypeID(SPIRVTypeInst SpirvType) const
Register getOrCreateConstInt(uint64_t Val, MachineInstr &I, SPIRVTypeInst SpvType, const SPIRVInstrInfo &TII, bool ZeroAsNull=true)
Register getOrCreateConstIntArray(uint64_t Val, size_t Num, MachineInstr &I, SPIRVTypeInst SpvType, const SPIRVInstrInfo &TII)
bool findValueAttrs(const MachineInstr *Key, Type *&Ty, StringRef &Name)
SPIRVTypeInst retrieveScalarOrVectorIntType(SPIRVTypeInst Type) const
Register getOrCreateGlobalVariableWithBinding(SPIRVTypeInst VarType, uint32_t Set, uint32_t Binding, StringRef Name, MachineIRBuilder &MIRBuilder)
SPIRVTypeInst changePointerStorageClass(SPIRVTypeInst PtrType, SPIRV::StorageClass::StorageClass SC, MachineInstr &I)
Register getOrCreateConstVector(uint64_t Val, MachineInstr &I, SPIRVTypeInst SpvType, const SPIRVInstrInfo &TII, bool ZeroAsNull=true)
Register buildConstantFP(APFloat Val, MachineIRBuilder &MIRBuilder, SPIRVTypeInst SpvType=nullptr)
void addGlobalObject(const Value *V, const MachineFunction *MF, Register R)
SPIRVTypeInst getScalarOrVectorComponentType(SPIRVTypeInst Type) const
void recordFunctionPointer(const MachineOperand *MO, const Function *F)
SPIRVTypeInst getOrCreateSPIRVFloatType(unsigned BitWidth, MachineInstr &I, const SPIRVInstrInfo &TII)
SPIRVTypeInst getPointeeType(SPIRVTypeInst PtrType)
SPIRVTypeInst getOrCreateSPIRVType(const Type *Type, MachineInstr &I, SPIRV::AccessQualifier::AccessQualifier AQ, bool EmitIR)
bool isScalarOrVectorOfType(Register VReg, unsigned TypeOpcode) const
MachineFunction * setCurrentFunc(MachineFunction &MF)
Register getOrCreateConstNullPtr(MachineIRBuilder &MIRBuilder, SPIRVTypeInst SpvType)
SPIRVTypeInst getSPIRVTypeForVReg(Register VReg, const MachineFunction *MF=nullptr) const
Type * getDeducedGlobalValueType(const GlobalValue *Global)
Register getOrCreateUndef(MachineInstr &I, SPIRVTypeInst SpvType, const SPIRVInstrInfo &TII)
SPIRV::StorageClass::StorageClass getPointerStorageClass(Register VReg) const
bool erase(const MachineInstr *MI)
bool add(SPIRV::IRHandle Handle, const MachineInstr *MI)
Register find(SPIRV::IRHandle Handle, const MachineFunction *MF)
bool isPhysicalSPIRV() const
bool isAtLeastSPIRVVer(VersionTuple VerToCompareTo) const
bool canUseExtInstSet(SPIRV::InstructionSet::InstructionSet E) const
bool isLogicalSPIRV() const
bool canUseExtension(SPIRV::Extension::Extension E) const
bool isTypeIntOrFloat() const
bool erase(PtrType Ptr)
Remove pointer from the set.
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
bool contains(ConstPtrType Ptr) const
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
reference emplace_back(ArgTypes &&... Args)
void reserve(size_type N)
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
constexpr size_t size() const
Get the string size.
Definition StringRef.h:144
static LLVM_ABI StructType * get(LLVMContext &Context, ArrayRef< Type * > Elements, bool isPacked=false)
This static method is the primary way to create a literal StructType.
Definition Type.cpp:479
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition Twine.h:82
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:46
@ HalfTyID
16-bit floating point type
Definition Type.h:57
@ FloatTyID
32-bit floating point type
Definition Type.h:59
@ DoubleTyID
64-bit floating point type
Definition Type.h:60
Type * getScalarType() const
If this is a vector type, return the element type, otherwise return 'this'.
Definition Type.h:368
bool isStructTy() const
True if this is an instance of StructType.
Definition Type.h:276
bool isAggregateType() const
Return true if the type is an aggregate type.
Definition Type.h:319
TypeID getTypeID() const
Return the type id for the type.
Definition Type.h:138
Value * getOperand(unsigned i) const
Definition User.h:207
bool hasName() const
Definition Value.h:261
LLVM_ABI StringRef getName() const
Return a constant reference to the value's name.
Definition Value.cpp:319
self_iterator getIterator()
Definition ilist_node.h:123
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 char IsConst[]
Key for Kernel::Arg::Metadata::mIsConst.
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.
unsigned ID
LLVM IR allows to use arbitrary numbers as calling convention identifiers.
Definition CallingConv.h:24
NodeAddr< DefNode * > Def
Definition RDFGraph.h:384
NodeAddr< InstrNode * > Instr
Definition RDFGraph.h:389
NodeAddr< UseNode * > Use
Definition RDFGraph.h:385
NodeAddr< FuncNode * > Func
Definition RDFGraph.h:393
BaseReg
Stack frame base register. Bit 0 of FREInfo.Info.
Definition SFrame.h:77
This is an optimization pass for GlobalISel generic memory operations.
void buildOpName(Register Target, const StringRef &Name, MachineIRBuilder &MIRBuilder)
@ Low
Lower the current thread's priority such that it does not affect foreground tasks significantly.
Definition Threading.h:280
@ Offset
Definition DWP.cpp:558
FunctionAddr VTableAddr Value
Definition InstrProf.h:137
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
MachineBasicBlock::iterator getOpVariableMBBIt(MachineFunction &MF)
int64_t getIConstValSext(Register ConstReg, const MachineRegisterInfo *MRI)
MachineInstrBuilder BuildMI(MachineFunction &MF, const MIMetadata &MIMD, const MCInstrDesc &MCID)
Builder interface. Specify how to create the initial instruction itself.
bool isTypeFoldingSupported(unsigned Opcode)
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:643
MachineInstr * getDef(const MachineOperand &MO, const MachineRegisterInfo *MRI)
FunctionAddr VTableAddr uintptr_t uintptr_t Int32Ty
Definition InstrProf.h:328
void addNumImm(const APInt &Imm, MachineInstrBuilder &MIB)
LLVM_ABI void salvageDebugInfo(const MachineRegisterInfo &MRI, MachineInstr &MI)
Assuming the instruction MI is going to be deleted, attempt to salvage debug users of MI by writing t...
Definition Utils.cpp:1690
LLVM_ABI void constrainSelectedInstRegOperands(MachineInstr &I, const TargetInstrInfo &TII, const TargetRegisterInfo &TRI, const RegisterBankInfo &RBI)
Mutate the newly-selected instruction I to constrain its (possibly generic) virtual register operands...
Definition Utils.cpp:159
bool isPreISelGenericOpcode(unsigned Opcode)
Check whether the given Opcode is a generic opcode that is not supposed to appear after ISel.
Register createVirtualRegister(SPIRVTypeInst SpvType, SPIRVGlobalRegistry *GR, MachineRegisterInfo *MRI, const MachineFunction &MF)
unsigned getArrayComponentCount(const MachineRegisterInfo *MRI, const MachineInstr *ResType)
void buildOpDecorate(Register Reg, MachineIRBuilder &MIRBuilder, SPIRV::Decoration::Decoration Dec, ArrayRef< uint32_t > DecArgs, StringRef StrImm)
LLVM_ABI bool isNullOrNullSplat(const MachineInstr &MI, const MachineRegisterInfo &MRI, bool AllowUndefs=false)
Return true if the value is a constant 0 integer or a splatted vector of a constant 0 integer (with n...
Definition Utils.cpp:1554
uint64_t getIConstVal(Register ConstReg, const MachineRegisterInfo *MRI)
SmallVector< MachineInstr *, 4 > createContinuedInstructions(MachineIRBuilder &MIRBuilder, unsigned Opcode, unsigned MinWC, unsigned ContinuedOpcode, ArrayRef< Register > Args, Register ReturnRegister, Register TypeID)
SPIRV::MemorySemantics::MemorySemantics getMemSemanticsForStorageClass(SPIRV::StorageClass::StorageClass SC)
constexpr unsigned storageClassToAddressSpace(SPIRV::StorageClass::StorageClass SC)
Definition SPIRVUtils.h:247
bool any_of(R &&range, UnaryPredicate P)
Provide wrappers to std::any_of which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1745
MachineInstr * getImm(const MachineOperand &MO, const MachineRegisterInfo *MRI)
constexpr bool isPowerOf2_32(uint32_t Value)
Return true if the argument is a power of two > 0.
Definition MathExtras.h:279
Type * toTypedPointer(Type *Ty)
Definition SPIRVUtils.h:473
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
constexpr bool isGenericCastablePtr(SPIRV::StorageClass::StorageClass SC)
Definition SPIRVUtils.h:231
class LLVM_GSL_OWNER SmallVector
Forward declaration of SmallVector so that calculateSmallVectorDefaultInlinedElements can reference s...
MachineInstr * passCopy(MachineInstr *Def, const MachineRegisterInfo *MRI)
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
Definition Casting.h:547
std::optional< SPIRV::LinkageType::LinkageType > getSpirvLinkageTypeFor(const SPIRVSubtarget &ST, const GlobalValue &GV)
LLVM_ABI raw_fd_ostream & errs()
This returns a reference to a raw_ostream for standard error.
SPIRV::StorageClass::StorageClass addressSpaceToStorageClass(unsigned AddrSpace, const SPIRVSubtarget &STI)
AtomicOrdering
Atomic ordering for LLVM's memory model.
SPIRV::Scope::Scope getMemScope(LLVMContext &Ctx, SyncScope::ID Id)
InstructionSelector * createSPIRVInstructionSelector(const SPIRVTargetMachine &TM, const SPIRVSubtarget &Subtarget, const RegisterBankInfo &RBI)
std::string getStringValueFromReg(Register Reg, MachineRegisterInfo &MRI)
int64_t foldImm(const MachineOperand &MO, const MachineRegisterInfo *MRI)
DWARFExpression::Operation Op
ArrayRef(const T &OneElt) -> ArrayRef< T >
MachineInstr * getDefInstrMaybeConstant(Register &ConstReg, const MachineRegisterInfo *MRI)
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 hasInitializer(const GlobalVariable *GV)
Definition SPIRVUtils.h:358
bool isSpvIntrinsic(const MachineInstr &MI, Intrinsic::ID IntrinsicID)
void addStringImm(const StringRef &Str, MCInst &Inst)
MachineInstr * getVRegDef(MachineRegisterInfo &MRI, Register Reg)
SPIRV::MemorySemantics::MemorySemantics getMemSemantics(AtomicOrdering Ord)
std::string getLinkStringForBuiltIn(SPIRV::BuiltIn::BuiltIn BuiltInValue)
LLVM_ABI bool isTriviallyDead(const MachineInstr &MI, const MachineRegisterInfo &MRI)
Check whether an instruction MI is dead: it only defines dead virtual registers, and doesn't have oth...
Definition Utils.cpp:224
#define N