1 //===- SPIRVToLLVM.cpp - SPIR-V to LLVM Patterns --------------------------===//
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 patterns to convert SPIR-V dialect to LLVM dialect.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "mlir/Conversion/SPIRVToLLVM/SPIRVToLLVM.h"
14 #include "mlir/Conversion/StandardToLLVM/ConvertStandardToLLVM.h"
15 #include "mlir/Conversion/StandardToLLVM/ConvertStandardToLLVMPass.h"
16 #include "mlir/Dialect/LLVMIR/LLVMDialect.h"
17 #include "mlir/Dialect/SPIRV/IR/SPIRVDialect.h"
18 #include "mlir/Dialect/SPIRV/IR/SPIRVOps.h"
19 #include "mlir/Dialect/SPIRV/Utils/LayoutUtils.h"
20 #include "mlir/Dialect/StandardOps/IR/Ops.h"
21 #include "mlir/IR/BuiltinOps.h"
22 #include "mlir/IR/PatternMatch.h"
23 #include "mlir/Support/LogicalResult.h"
24 #include "mlir/Transforms/DialectConversion.h"
25 #include "llvm/Support/Debug.h"
26 #include "llvm/Support/FormatVariadic.h"
27 
28 #define DEBUG_TYPE "spirv-to-llvm-pattern"
29 
30 using namespace mlir;
31 
32 //===----------------------------------------------------------------------===//
33 // Utility functions
34 //===----------------------------------------------------------------------===//
35 
36 /// Returns true if the given type is a signed integer or vector type.
37 static bool isSignedIntegerOrVector(Type type) {
38   if (type.isSignedInteger())
39     return true;
40   if (auto vecType = type.dyn_cast<VectorType>())
41     return vecType.getElementType().isSignedInteger();
42   return false;
43 }
44 
45 /// Returns true if the given type is an unsigned integer or vector type
46 static bool isUnsignedIntegerOrVector(Type type) {
47   if (type.isUnsignedInteger())
48     return true;
49   if (auto vecType = type.dyn_cast<VectorType>())
50     return vecType.getElementType().isUnsignedInteger();
51   return false;
52 }
53 
54 /// Returns the bit width of integer, float or vector of float or integer values
55 static unsigned getBitWidth(Type type) {
56   assert((type.isIntOrFloat() || type.isa<VectorType>()) &&
57          "bitwidth is not supported for this type");
58   if (type.isIntOrFloat())
59     return type.getIntOrFloatBitWidth();
60   auto vecType = type.dyn_cast<VectorType>();
61   auto elementType = vecType.getElementType();
62   assert(elementType.isIntOrFloat() &&
63          "only integers and floats have a bitwidth");
64   return elementType.getIntOrFloatBitWidth();
65 }
66 
67 /// Returns the bit width of LLVMType integer or vector.
68 static unsigned getLLVMTypeBitWidth(Type type) {
69   return (LLVM::isCompatibleVectorType(type) ? LLVM::getVectorElementType(type)
70                                              : type)
71       .cast<IntegerType>()
72       .getWidth();
73 }
74 
75 /// Creates `IntegerAttribute` with all bits set for given type
76 static IntegerAttr minusOneIntegerAttribute(Type type, Builder builder) {
77   if (auto vecType = type.dyn_cast<VectorType>()) {
78     auto integerType = vecType.getElementType().cast<IntegerType>();
79     return builder.getIntegerAttr(integerType, -1);
80   }
81   auto integerType = type.cast<IntegerType>();
82   return builder.getIntegerAttr(integerType, -1);
83 }
84 
85 /// Creates `llvm.mlir.constant` with all bits set for the given type.
86 static Value createConstantAllBitsSet(Location loc, Type srcType, Type dstType,
87                                       PatternRewriter &rewriter) {
88   if (srcType.isa<VectorType>()) {
89     return rewriter.create<LLVM::ConstantOp>(
90         loc, dstType,
91         SplatElementsAttr::get(srcType.cast<ShapedType>(),
92                                minusOneIntegerAttribute(srcType, rewriter)));
93   }
94   return rewriter.create<LLVM::ConstantOp>(
95       loc, dstType, minusOneIntegerAttribute(srcType, rewriter));
96 }
97 
98 /// Creates `llvm.mlir.constant` with a floating-point scalar or vector value.
99 static Value createFPConstant(Location loc, Type srcType, Type dstType,
100                               PatternRewriter &rewriter, double value) {
101   if (auto vecType = srcType.dyn_cast<VectorType>()) {
102     auto floatType = vecType.getElementType().cast<FloatType>();
103     return rewriter.create<LLVM::ConstantOp>(
104         loc, dstType,
105         SplatElementsAttr::get(vecType,
106                                rewriter.getFloatAttr(floatType, value)));
107   }
108   auto floatType = srcType.cast<FloatType>();
109   return rewriter.create<LLVM::ConstantOp>(
110       loc, dstType, rewriter.getFloatAttr(floatType, value));
111 }
112 
113 /// Utility function for bitfield ops:
114 ///   - `BitFieldInsert`
115 ///   - `BitFieldSExtract`
116 ///   - `BitFieldUExtract`
117 /// Truncates or extends the value. If the bitwidth of the value is the same as
118 /// `llvmType` bitwidth, the value remains unchanged.
119 static Value optionallyTruncateOrExtend(Location loc, Value value,
120                                         Type llvmType,
121                                         PatternRewriter &rewriter) {
122   auto srcType = value.getType();
123   unsigned targetBitWidth = getLLVMTypeBitWidth(llvmType);
124   unsigned valueBitWidth = LLVM::isCompatibleType(srcType)
125                                ? getLLVMTypeBitWidth(srcType)
126                                : getBitWidth(srcType);
127 
128   if (valueBitWidth < targetBitWidth)
129     return rewriter.create<LLVM::ZExtOp>(loc, llvmType, value);
130   // If the bit widths of `Count` and `Offset` are greater than the bit width
131   // of the target type, they are truncated. Truncation is safe since `Count`
132   // and `Offset` must be no more than 64 for op behaviour to be defined. Hence,
133   // both values can be expressed in 8 bits.
134   if (valueBitWidth > targetBitWidth)
135     return rewriter.create<LLVM::TruncOp>(loc, llvmType, value);
136   return value;
137 }
138 
139 /// Broadcasts the value to vector with `numElements` number of elements.
140 static Value broadcast(Location loc, Value toBroadcast, unsigned numElements,
141                        LLVMTypeConverter &typeConverter,
142                        ConversionPatternRewriter &rewriter) {
143   auto vectorType = VectorType::get(numElements, toBroadcast.getType());
144   auto llvmVectorType = typeConverter.convertType(vectorType);
145   auto llvmI32Type = typeConverter.convertType(rewriter.getIntegerType(32));
146   Value broadcasted = rewriter.create<LLVM::UndefOp>(loc, llvmVectorType);
147   for (unsigned i = 0; i < numElements; ++i) {
148     auto index = rewriter.create<LLVM::ConstantOp>(
149         loc, llvmI32Type, rewriter.getI32IntegerAttr(i));
150     broadcasted = rewriter.create<LLVM::InsertElementOp>(
151         loc, llvmVectorType, broadcasted, toBroadcast, index);
152   }
153   return broadcasted;
154 }
155 
156 /// Broadcasts the value. If `srcType` is a scalar, the value remains unchanged.
157 static Value optionallyBroadcast(Location loc, Value value, Type srcType,
158                                  LLVMTypeConverter &typeConverter,
159                                  ConversionPatternRewriter &rewriter) {
160   if (auto vectorType = srcType.dyn_cast<VectorType>()) {
161     unsigned numElements = vectorType.getNumElements();
162     return broadcast(loc, value, numElements, typeConverter, rewriter);
163   }
164   return value;
165 }
166 
167 /// Utility function for bitfield ops: `BitFieldInsert`, `BitFieldSExtract` and
168 /// `BitFieldUExtract`.
169 /// Broadcast `Offset` and `Count` to match the type of `Base`. If `Base` is of
170 /// a vector type, construct a vector that has:
171 ///  - same number of elements as `Base`
172 ///  - each element has the type that is the same as the type of `Offset` or
173 ///    `Count`
174 ///  - each element has the same value as `Offset` or `Count`
175 /// Then cast `Offset` and `Count` if their bit width is different
176 /// from `Base` bit width.
177 static Value processCountOrOffset(Location loc, Value value, Type srcType,
178                                   Type dstType, LLVMTypeConverter &converter,
179                                   ConversionPatternRewriter &rewriter) {
180   Value broadcasted =
181       optionallyBroadcast(loc, value, srcType, converter, rewriter);
182   return optionallyTruncateOrExtend(loc, broadcasted, dstType, rewriter);
183 }
184 
185 /// Converts SPIR-V struct with a regular (according to `VulkanLayoutUtils`)
186 /// offset to LLVM struct. Otherwise, the conversion is not supported.
187 static Optional<Type>
188 convertStructTypeWithOffset(spirv::StructType type,
189                             LLVMTypeConverter &converter) {
190   if (type != VulkanLayoutUtils::decorateType(type))
191     return llvm::None;
192 
193   auto elementsVector = llvm::to_vector<8>(
194       llvm::map_range(type.getElementTypes(), [&](Type elementType) {
195         return converter.convertType(elementType);
196       }));
197   return LLVM::LLVMStructType::getLiteral(type.getContext(), elementsVector,
198                                           /*isPacked=*/false);
199 }
200 
201 /// Converts SPIR-V struct with no offset to packed LLVM struct.
202 static Type convertStructTypePacked(spirv::StructType type,
203                                     LLVMTypeConverter &converter) {
204   auto elementsVector = llvm::to_vector<8>(
205       llvm::map_range(type.getElementTypes(), [&](Type elementType) {
206         return converter.convertType(elementType);
207       }));
208   return LLVM::LLVMStructType::getLiteral(type.getContext(), elementsVector,
209                                           /*isPacked=*/true);
210 }
211 
212 /// Creates LLVM dialect constant with the given value.
213 static Value createI32ConstantOf(Location loc, PatternRewriter &rewriter,
214                                  unsigned value) {
215   return rewriter.create<LLVM::ConstantOp>(
216       loc, IntegerType::get(rewriter.getContext(), 32),
217       rewriter.getIntegerAttr(rewriter.getI32Type(), value));
218 }
219 
220 /// Utility for `spv.Load` and `spv.Store` conversion.
221 static LogicalResult replaceWithLoadOrStore(Operation *op,
222                                             ConversionPatternRewriter &rewriter,
223                                             LLVMTypeConverter &typeConverter,
224                                             unsigned alignment, bool isVolatile,
225                                             bool isNonTemporal) {
226   if (auto loadOp = dyn_cast<spirv::LoadOp>(op)) {
227     auto dstType = typeConverter.convertType(loadOp.getType());
228     if (!dstType)
229       return failure();
230     rewriter.replaceOpWithNewOp<LLVM::LoadOp>(
231         loadOp, dstType, loadOp.ptr(), alignment, isVolatile, isNonTemporal);
232     return success();
233   }
234   auto storeOp = cast<spirv::StoreOp>(op);
235   rewriter.replaceOpWithNewOp<LLVM::StoreOp>(storeOp, storeOp.value(),
236                                              storeOp.ptr(), alignment,
237                                              isVolatile, isNonTemporal);
238   return success();
239 }
240 
241 //===----------------------------------------------------------------------===//
242 // Type conversion
243 //===----------------------------------------------------------------------===//
244 
245 /// Converts SPIR-V array type to LLVM array. Natural stride (according to
246 /// `VulkanLayoutUtils`) is also mapped to LLVM array. This has to be respected
247 /// when converting ops that manipulate array types.
248 static Optional<Type> convertArrayType(spirv::ArrayType type,
249                                        TypeConverter &converter) {
250   unsigned stride = type.getArrayStride();
251   Type elementType = type.getElementType();
252   auto sizeInBytes = elementType.cast<spirv::SPIRVType>().getSizeInBytes();
253   if (stride != 0 &&
254       !(sizeInBytes.hasValue() && sizeInBytes.getValue() == stride))
255     return llvm::None;
256 
257   auto llvmElementType = converter.convertType(elementType);
258   unsigned numElements = type.getNumElements();
259   return LLVM::LLVMArrayType::get(llvmElementType, numElements);
260 }
261 
262 /// Converts SPIR-V pointer type to LLVM pointer. Pointer's storage class is not
263 /// modelled at the moment.
264 static Type convertPointerType(spirv::PointerType type,
265                                TypeConverter &converter) {
266   auto pointeeType = converter.convertType(type.getPointeeType());
267   return LLVM::LLVMPointerType::get(pointeeType);
268 }
269 
270 /// Converts SPIR-V runtime array to LLVM array. Since LLVM allows indexing over
271 /// the bounds, the runtime array is converted to a 0-sized LLVM array. There is
272 /// no modelling of array stride at the moment.
273 static Optional<Type> convertRuntimeArrayType(spirv::RuntimeArrayType type,
274                                               TypeConverter &converter) {
275   if (type.getArrayStride() != 0)
276     return llvm::None;
277   auto elementType = converter.convertType(type.getElementType());
278   return LLVM::LLVMArrayType::get(elementType, 0);
279 }
280 
281 /// Converts SPIR-V struct to LLVM struct. There is no support of structs with
282 /// member decorations. Also, only natural offset is supported.
283 static Optional<Type> convertStructType(spirv::StructType type,
284                                         LLVMTypeConverter &converter) {
285   SmallVector<spirv::StructType::MemberDecorationInfo, 4> memberDecorations;
286   type.getMemberDecorations(memberDecorations);
287   if (!memberDecorations.empty())
288     return llvm::None;
289   if (type.hasOffset())
290     return convertStructTypeWithOffset(type, converter);
291   return convertStructTypePacked(type, converter);
292 }
293 
294 //===----------------------------------------------------------------------===//
295 // Operation conversion
296 //===----------------------------------------------------------------------===//
297 
298 namespace {
299 
300 class AccessChainPattern : public SPIRVToLLVMConversion<spirv::AccessChainOp> {
301 public:
302   using SPIRVToLLVMConversion<spirv::AccessChainOp>::SPIRVToLLVMConversion;
303 
304   LogicalResult
305   matchAndRewrite(spirv::AccessChainOp op, ArrayRef<Value> operands,
306                   ConversionPatternRewriter &rewriter) const override {
307     auto dstType = typeConverter.convertType(op.component_ptr().getType());
308     if (!dstType)
309       return failure();
310     // To use GEP we need to add a first 0 index to go through the pointer.
311     auto indices = llvm::to_vector<4>(op.indices());
312     Type indexType = op.indices().front().getType();
313     auto llvmIndexType = typeConverter.convertType(indexType);
314     if (!llvmIndexType)
315       return failure();
316     Value zero = rewriter.create<LLVM::ConstantOp>(
317         op.getLoc(), llvmIndexType, rewriter.getIntegerAttr(indexType, 0));
318     indices.insert(indices.begin(), zero);
319     rewriter.replaceOpWithNewOp<LLVM::GEPOp>(op, dstType, op.base_ptr(),
320                                              indices);
321     return success();
322   }
323 };
324 
325 class AddressOfPattern : public SPIRVToLLVMConversion<spirv::AddressOfOp> {
326 public:
327   using SPIRVToLLVMConversion<spirv::AddressOfOp>::SPIRVToLLVMConversion;
328 
329   LogicalResult
330   matchAndRewrite(spirv::AddressOfOp op, ArrayRef<Value> operands,
331                   ConversionPatternRewriter &rewriter) const override {
332     auto dstType = typeConverter.convertType(op.pointer().getType());
333     if (!dstType)
334       return failure();
335     rewriter.replaceOpWithNewOp<LLVM::AddressOfOp>(op, dstType, op.variable());
336     return success();
337   }
338 };
339 
340 class BitFieldInsertPattern
341     : public SPIRVToLLVMConversion<spirv::BitFieldInsertOp> {
342 public:
343   using SPIRVToLLVMConversion<spirv::BitFieldInsertOp>::SPIRVToLLVMConversion;
344 
345   LogicalResult
346   matchAndRewrite(spirv::BitFieldInsertOp op, ArrayRef<Value> operands,
347                   ConversionPatternRewriter &rewriter) const override {
348     auto srcType = op.getType();
349     auto dstType = typeConverter.convertType(srcType);
350     if (!dstType)
351       return failure();
352     Location loc = op.getLoc();
353 
354     // Process `Offset` and `Count`: broadcast and extend/truncate if needed.
355     Value offset = processCountOrOffset(loc, op.offset(), srcType, dstType,
356                                         typeConverter, rewriter);
357     Value count = processCountOrOffset(loc, op.count(), srcType, dstType,
358                                        typeConverter, rewriter);
359 
360     // Create a mask with bits set outside [Offset, Offset + Count - 1].
361     Value minusOne = createConstantAllBitsSet(loc, srcType, dstType, rewriter);
362     Value maskShiftedByCount =
363         rewriter.create<LLVM::ShlOp>(loc, dstType, minusOne, count);
364     Value negated = rewriter.create<LLVM::XOrOp>(loc, dstType,
365                                                  maskShiftedByCount, minusOne);
366     Value maskShiftedByCountAndOffset =
367         rewriter.create<LLVM::ShlOp>(loc, dstType, negated, offset);
368     Value mask = rewriter.create<LLVM::XOrOp>(
369         loc, dstType, maskShiftedByCountAndOffset, minusOne);
370 
371     // Extract unchanged bits from the `Base`  that are outside of
372     // [Offset, Offset + Count - 1]. Then `or` with shifted `Insert`.
373     Value baseAndMask =
374         rewriter.create<LLVM::AndOp>(loc, dstType, op.base(), mask);
375     Value insertShiftedByOffset =
376         rewriter.create<LLVM::ShlOp>(loc, dstType, op.insert(), offset);
377     rewriter.replaceOpWithNewOp<LLVM::OrOp>(op, dstType, baseAndMask,
378                                             insertShiftedByOffset);
379     return success();
380   }
381 };
382 
383 /// Converts SPIR-V ConstantOp with scalar or vector type.
384 class ConstantScalarAndVectorPattern
385     : public SPIRVToLLVMConversion<spirv::ConstantOp> {
386 public:
387   using SPIRVToLLVMConversion<spirv::ConstantOp>::SPIRVToLLVMConversion;
388 
389   LogicalResult
390   matchAndRewrite(spirv::ConstantOp constOp, ArrayRef<Value> operands,
391                   ConversionPatternRewriter &rewriter) const override {
392     auto srcType = constOp.getType();
393     if (!srcType.isa<VectorType>() && !srcType.isIntOrFloat())
394       return failure();
395 
396     auto dstType = typeConverter.convertType(srcType);
397     if (!dstType)
398       return failure();
399 
400     // SPIR-V constant can be a signed/unsigned integer, which has to be
401     // casted to signless integer when converting to LLVM dialect. Removing the
402     // sign bit may have unexpected behaviour. However, it is better to handle
403     // it case-by-case, given that the purpose of the conversion is not to
404     // cover all possible corner cases.
405     if (isSignedIntegerOrVector(srcType) ||
406         isUnsignedIntegerOrVector(srcType)) {
407       auto signlessType = rewriter.getIntegerType(getBitWidth(srcType));
408 
409       if (srcType.isa<VectorType>()) {
410         auto dstElementsAttr = constOp.value().cast<DenseIntElementsAttr>();
411         rewriter.replaceOpWithNewOp<LLVM::ConstantOp>(
412             constOp, dstType,
413             dstElementsAttr.mapValues(
414                 signlessType, [&](const APInt &value) { return value; }));
415         return success();
416       }
417       auto srcAttr = constOp.value().cast<IntegerAttr>();
418       auto dstAttr = rewriter.getIntegerAttr(signlessType, srcAttr.getValue());
419       rewriter.replaceOpWithNewOp<LLVM::ConstantOp>(constOp, dstType, dstAttr);
420       return success();
421     }
422     rewriter.replaceOpWithNewOp<LLVM::ConstantOp>(constOp, dstType, operands,
423                                                   constOp->getAttrs());
424     return success();
425   }
426 };
427 
428 class BitFieldSExtractPattern
429     : public SPIRVToLLVMConversion<spirv::BitFieldSExtractOp> {
430 public:
431   using SPIRVToLLVMConversion<spirv::BitFieldSExtractOp>::SPIRVToLLVMConversion;
432 
433   LogicalResult
434   matchAndRewrite(spirv::BitFieldSExtractOp op, ArrayRef<Value> operands,
435                   ConversionPatternRewriter &rewriter) const override {
436     auto srcType = op.getType();
437     auto dstType = typeConverter.convertType(srcType);
438     if (!dstType)
439       return failure();
440     Location loc = op.getLoc();
441 
442     // Process `Offset` and `Count`: broadcast and extend/truncate if needed.
443     Value offset = processCountOrOffset(loc, op.offset(), srcType, dstType,
444                                         typeConverter, rewriter);
445     Value count = processCountOrOffset(loc, op.count(), srcType, dstType,
446                                        typeConverter, rewriter);
447 
448     // Create a constant that holds the size of the `Base`.
449     IntegerType integerType;
450     if (auto vecType = srcType.dyn_cast<VectorType>())
451       integerType = vecType.getElementType().cast<IntegerType>();
452     else
453       integerType = srcType.cast<IntegerType>();
454 
455     auto baseSize = rewriter.getIntegerAttr(integerType, getBitWidth(srcType));
456     Value size =
457         srcType.isa<VectorType>()
458             ? rewriter.create<LLVM::ConstantOp>(
459                   loc, dstType,
460                   SplatElementsAttr::get(srcType.cast<ShapedType>(), baseSize))
461             : rewriter.create<LLVM::ConstantOp>(loc, dstType, baseSize);
462 
463     // Shift `Base` left by [sizeof(Base) - (Count + Offset)], so that the bit
464     // at Offset + Count - 1 is the most significant bit now.
465     Value countPlusOffset =
466         rewriter.create<LLVM::AddOp>(loc, dstType, count, offset);
467     Value amountToShiftLeft =
468         rewriter.create<LLVM::SubOp>(loc, dstType, size, countPlusOffset);
469     Value baseShiftedLeft = rewriter.create<LLVM::ShlOp>(
470         loc, dstType, op.base(), amountToShiftLeft);
471 
472     // Shift the result right, filling the bits with the sign bit.
473     Value amountToShiftRight =
474         rewriter.create<LLVM::AddOp>(loc, dstType, offset, amountToShiftLeft);
475     rewriter.replaceOpWithNewOp<LLVM::AShrOp>(op, dstType, baseShiftedLeft,
476                                               amountToShiftRight);
477     return success();
478   }
479 };
480 
481 class BitFieldUExtractPattern
482     : public SPIRVToLLVMConversion<spirv::BitFieldUExtractOp> {
483 public:
484   using SPIRVToLLVMConversion<spirv::BitFieldUExtractOp>::SPIRVToLLVMConversion;
485 
486   LogicalResult
487   matchAndRewrite(spirv::BitFieldUExtractOp op, ArrayRef<Value> operands,
488                   ConversionPatternRewriter &rewriter) const override {
489     auto srcType = op.getType();
490     auto dstType = typeConverter.convertType(srcType);
491     if (!dstType)
492       return failure();
493     Location loc = op.getLoc();
494 
495     // Process `Offset` and `Count`: broadcast and extend/truncate if needed.
496     Value offset = processCountOrOffset(loc, op.offset(), srcType, dstType,
497                                         typeConverter, rewriter);
498     Value count = processCountOrOffset(loc, op.count(), srcType, dstType,
499                                        typeConverter, rewriter);
500 
501     // Create a mask with bits set at [0, Count - 1].
502     Value minusOne = createConstantAllBitsSet(loc, srcType, dstType, rewriter);
503     Value maskShiftedByCount =
504         rewriter.create<LLVM::ShlOp>(loc, dstType, minusOne, count);
505     Value mask = rewriter.create<LLVM::XOrOp>(loc, dstType, maskShiftedByCount,
506                                               minusOne);
507 
508     // Shift `Base` by `Offset` and apply the mask on it.
509     Value shiftedBase =
510         rewriter.create<LLVM::LShrOp>(loc, dstType, op.base(), offset);
511     rewriter.replaceOpWithNewOp<LLVM::AndOp>(op, dstType, shiftedBase, mask);
512     return success();
513   }
514 };
515 
516 class BranchConversionPattern : public SPIRVToLLVMConversion<spirv::BranchOp> {
517 public:
518   using SPIRVToLLVMConversion<spirv::BranchOp>::SPIRVToLLVMConversion;
519 
520   LogicalResult
521   matchAndRewrite(spirv::BranchOp branchOp, ArrayRef<Value> operands,
522                   ConversionPatternRewriter &rewriter) const override {
523     rewriter.replaceOpWithNewOp<LLVM::BrOp>(branchOp, operands,
524                                             branchOp.getTarget());
525     return success();
526   }
527 };
528 
529 class BranchConditionalConversionPattern
530     : public SPIRVToLLVMConversion<spirv::BranchConditionalOp> {
531 public:
532   using SPIRVToLLVMConversion<
533       spirv::BranchConditionalOp>::SPIRVToLLVMConversion;
534 
535   LogicalResult
536   matchAndRewrite(spirv::BranchConditionalOp op, ArrayRef<Value> operands,
537                   ConversionPatternRewriter &rewriter) const override {
538     // If branch weights exist, map them to 32-bit integer vector.
539     ElementsAttr branchWeights = nullptr;
540     if (auto weights = op.branch_weights()) {
541       VectorType weightType = VectorType::get(2, rewriter.getI32Type());
542       branchWeights =
543           DenseElementsAttr::get(weightType, weights.getValue().getValue());
544     }
545 
546     rewriter.replaceOpWithNewOp<LLVM::CondBrOp>(
547         op, op.condition(), op.getTrueBlockArguments(),
548         op.getFalseBlockArguments(), branchWeights, op.getTrueBlock(),
549         op.getFalseBlock());
550     return success();
551   }
552 };
553 
554 /// Converts `spv.CompositeExtract` to `llvm.extractvalue` if the container type
555 /// is an aggregate type (struct or array). Otherwise, converts to
556 /// `llvm.extractelement` that operates on vectors.
557 class CompositeExtractPattern
558     : public SPIRVToLLVMConversion<spirv::CompositeExtractOp> {
559 public:
560   using SPIRVToLLVMConversion<spirv::CompositeExtractOp>::SPIRVToLLVMConversion;
561 
562   LogicalResult
563   matchAndRewrite(spirv::CompositeExtractOp op, ArrayRef<Value> operands,
564                   ConversionPatternRewriter &rewriter) const override {
565     auto dstType = this->typeConverter.convertType(op.getType());
566     if (!dstType)
567       return failure();
568 
569     Type containerType = op.composite().getType();
570     if (containerType.isa<VectorType>()) {
571       Location loc = op.getLoc();
572       IntegerAttr value = op.indices()[0].cast<IntegerAttr>();
573       Value index = createI32ConstantOf(loc, rewriter, value.getInt());
574       rewriter.replaceOpWithNewOp<LLVM::ExtractElementOp>(
575           op, dstType, op.composite(), index);
576       return success();
577     }
578     rewriter.replaceOpWithNewOp<LLVM::ExtractValueOp>(
579         op, dstType, op.composite(), op.indices());
580     return success();
581   }
582 };
583 
584 /// Converts `spv.CompositeInsert` to `llvm.insertvalue` if the container type
585 /// is an aggregate type (struct or array). Otherwise, converts to
586 /// `llvm.insertelement` that operates on vectors.
587 class CompositeInsertPattern
588     : public SPIRVToLLVMConversion<spirv::CompositeInsertOp> {
589 public:
590   using SPIRVToLLVMConversion<spirv::CompositeInsertOp>::SPIRVToLLVMConversion;
591 
592   LogicalResult
593   matchAndRewrite(spirv::CompositeInsertOp op, ArrayRef<Value> operands,
594                   ConversionPatternRewriter &rewriter) const override {
595     auto dstType = this->typeConverter.convertType(op.getType());
596     if (!dstType)
597       return failure();
598 
599     Type containerType = op.composite().getType();
600     if (containerType.isa<VectorType>()) {
601       Location loc = op.getLoc();
602       IntegerAttr value = op.indices()[0].cast<IntegerAttr>();
603       Value index = createI32ConstantOf(loc, rewriter, value.getInt());
604       rewriter.replaceOpWithNewOp<LLVM::InsertElementOp>(
605           op, dstType, op.composite(), op.object(), index);
606       return success();
607     }
608     rewriter.replaceOpWithNewOp<LLVM::InsertValueOp>(
609         op, dstType, op.composite(), op.object(), op.indices());
610     return success();
611   }
612 };
613 
614 /// Converts SPIR-V operations that have straightforward LLVM equivalent
615 /// into LLVM dialect operations.
616 template <typename SPIRVOp, typename LLVMOp>
617 class DirectConversionPattern : public SPIRVToLLVMConversion<SPIRVOp> {
618 public:
619   using SPIRVToLLVMConversion<SPIRVOp>::SPIRVToLLVMConversion;
620 
621   LogicalResult
622   matchAndRewrite(SPIRVOp operation, ArrayRef<Value> operands,
623                   ConversionPatternRewriter &rewriter) const override {
624     auto dstType = this->typeConverter.convertType(operation.getType());
625     if (!dstType)
626       return failure();
627     rewriter.template replaceOpWithNewOp<LLVMOp>(operation, dstType, operands,
628                                                  operation->getAttrs());
629     return success();
630   }
631 };
632 
633 /// Converts `spv.ExecutionMode` into a global struct constant that holds
634 /// execution mode information.
635 class ExecutionModePattern
636     : public SPIRVToLLVMConversion<spirv::ExecutionModeOp> {
637 public:
638   using SPIRVToLLVMConversion<spirv::ExecutionModeOp>::SPIRVToLLVMConversion;
639 
640   LogicalResult
641   matchAndRewrite(spirv::ExecutionModeOp op, ArrayRef<Value> operands,
642                   ConversionPatternRewriter &rewriter) const override {
643     // First, create the global struct's name that would be associated with
644     // this entry point's execution mode. We set it to be:
645     //   __spv__{SPIR-V module name}_{function name}_execution_mode_info
646     ModuleOp module = op->getParentOfType<ModuleOp>();
647     std::string moduleName;
648     if (module.getName().hasValue())
649       moduleName = "_" + module.getName().getValue().str();
650     else
651       moduleName = "";
652     std::string executionModeInfoName = llvm::formatv(
653         "__spv_{0}_{1}_execution_mode_info", moduleName, op.fn().str());
654 
655     MLIRContext *context = rewriter.getContext();
656     OpBuilder::InsertionGuard guard(rewriter);
657     rewriter.setInsertionPointToStart(module.getBody());
658 
659     // Create a struct type, corresponding to the C struct below.
660     // struct {
661     //   int32_t executionMode;
662     //   int32_t values[];          // optional values
663     // };
664     auto llvmI32Type = IntegerType::get(context, 32);
665     SmallVector<Type, 2> fields;
666     fields.push_back(llvmI32Type);
667     ArrayAttr values = op.values();
668     if (!values.empty()) {
669       auto arrayType = LLVM::LLVMArrayType::get(llvmI32Type, values.size());
670       fields.push_back(arrayType);
671     }
672     auto structType = LLVM::LLVMStructType::getLiteral(context, fields);
673 
674     // Create `llvm.mlir.global` with initializer region containing one block.
675     auto global = rewriter.create<LLVM::GlobalOp>(
676         UnknownLoc::get(context), structType, /*isConstant=*/true,
677         LLVM::Linkage::External, executionModeInfoName, Attribute());
678     Location loc = global.getLoc();
679     Region &region = global.getInitializerRegion();
680     Block *block = rewriter.createBlock(&region);
681 
682     // Initialize the struct and set the execution mode value.
683     rewriter.setInsertionPoint(block, block->begin());
684     Value structValue = rewriter.create<LLVM::UndefOp>(loc, structType);
685     IntegerAttr executionModeAttr = op.execution_modeAttr();
686     Value executionMode =
687         rewriter.create<LLVM::ConstantOp>(loc, llvmI32Type, executionModeAttr);
688     structValue = rewriter.create<LLVM::InsertValueOp>(
689         loc, structType, structValue, executionMode,
690         ArrayAttr::get(context,
691                        {rewriter.getIntegerAttr(rewriter.getI32Type(), 0)}));
692 
693     // Insert extra operands if they exist into execution mode info struct.
694     for (unsigned i = 0, e = values.size(); i < e; ++i) {
695       auto attr = values.getValue()[i];
696       Value entry = rewriter.create<LLVM::ConstantOp>(loc, llvmI32Type, attr);
697       structValue = rewriter.create<LLVM::InsertValueOp>(
698           loc, structType, structValue, entry,
699           ArrayAttr::get(context,
700                          {rewriter.getIntegerAttr(rewriter.getI32Type(), 1),
701                           rewriter.getIntegerAttr(rewriter.getI32Type(), i)}));
702     }
703     rewriter.create<LLVM::ReturnOp>(loc, ArrayRef<Value>({structValue}));
704     rewriter.eraseOp(op);
705     return success();
706   }
707 };
708 
709 /// Converts `spv.GlobalVariable` to `llvm.mlir.global`. Note that SPIR-V global
710 /// returns a pointer, whereas in LLVM dialect the global holds an actual value.
711 /// This difference is handled by `spv.mlir.addressof` and
712 /// `llvm.mlir.addressof`ops that both return a pointer.
713 class GlobalVariablePattern
714     : public SPIRVToLLVMConversion<spirv::GlobalVariableOp> {
715 public:
716   using SPIRVToLLVMConversion<spirv::GlobalVariableOp>::SPIRVToLLVMConversion;
717 
718   LogicalResult
719   matchAndRewrite(spirv::GlobalVariableOp op, ArrayRef<Value> operands,
720                   ConversionPatternRewriter &rewriter) const override {
721     // Currently, there is no support of initialization with a constant value in
722     // SPIR-V dialect. Specialization constants are not considered as well.
723     if (op.initializer())
724       return failure();
725 
726     auto srcType = op.type().cast<spirv::PointerType>();
727     auto dstType = typeConverter.convertType(srcType.getPointeeType());
728     if (!dstType)
729       return failure();
730 
731     // Limit conversion to the current invocation only or `StorageBuffer`
732     // required by SPIR-V runner.
733     // This is okay because multiple invocations are not supported yet.
734     auto storageClass = srcType.getStorageClass();
735     if (storageClass != spirv::StorageClass::Input &&
736         storageClass != spirv::StorageClass::Private &&
737         storageClass != spirv::StorageClass::Output &&
738         storageClass != spirv::StorageClass::StorageBuffer) {
739       return failure();
740     }
741 
742     // LLVM dialect spec: "If the global value is a constant, storing into it is
743     // not allowed.". This corresponds to SPIR-V 'Input' storage class that is
744     // read-only.
745     bool isConstant = storageClass == spirv::StorageClass::Input;
746     // SPIR-V spec: "By default, functions and global variables are private to a
747     // module and cannot be accessed by other modules. However, a module may be
748     // written to export or import functions and global (module scope)
749     // variables.". Therefore, map 'Private' storage class to private linkage,
750     // 'Input' and 'Output' to external linkage.
751     auto linkage = storageClass == spirv::StorageClass::Private
752                        ? LLVM::Linkage::Private
753                        : LLVM::Linkage::External;
754     rewriter.replaceOpWithNewOp<LLVM::GlobalOp>(
755         op, dstType, isConstant, linkage, op.sym_name(), Attribute());
756     return success();
757   }
758 };
759 
760 /// Converts SPIR-V cast ops that do not have straightforward LLVM
761 /// equivalent in LLVM dialect.
762 template <typename SPIRVOp, typename LLVMExtOp, typename LLVMTruncOp>
763 class IndirectCastPattern : public SPIRVToLLVMConversion<SPIRVOp> {
764 public:
765   using SPIRVToLLVMConversion<SPIRVOp>::SPIRVToLLVMConversion;
766 
767   LogicalResult
768   matchAndRewrite(SPIRVOp operation, ArrayRef<Value> operands,
769                   ConversionPatternRewriter &rewriter) const override {
770 
771     Type fromType = operation.operand().getType();
772     Type toType = operation.getType();
773 
774     auto dstType = this->typeConverter.convertType(toType);
775     if (!dstType)
776       return failure();
777 
778     if (getBitWidth(fromType) < getBitWidth(toType)) {
779       rewriter.template replaceOpWithNewOp<LLVMExtOp>(operation, dstType,
780                                                       operands);
781       return success();
782     }
783     if (getBitWidth(fromType) > getBitWidth(toType)) {
784       rewriter.template replaceOpWithNewOp<LLVMTruncOp>(operation, dstType,
785                                                         operands);
786       return success();
787     }
788     return failure();
789   }
790 };
791 
792 class FunctionCallPattern
793     : public SPIRVToLLVMConversion<spirv::FunctionCallOp> {
794 public:
795   using SPIRVToLLVMConversion<spirv::FunctionCallOp>::SPIRVToLLVMConversion;
796 
797   LogicalResult
798   matchAndRewrite(spirv::FunctionCallOp callOp, ArrayRef<Value> operands,
799                   ConversionPatternRewriter &rewriter) const override {
800     if (callOp.getNumResults() == 0) {
801       rewriter.replaceOpWithNewOp<LLVM::CallOp>(callOp, llvm::None, operands,
802                                                 callOp->getAttrs());
803       return success();
804     }
805 
806     // Function returns a single result.
807     auto dstType = typeConverter.convertType(callOp.getType(0));
808     rewriter.replaceOpWithNewOp<LLVM::CallOp>(callOp, dstType, operands,
809                                               callOp->getAttrs());
810     return success();
811   }
812 };
813 
814 /// Converts SPIR-V floating-point comparisons to llvm.fcmp "predicate"
815 template <typename SPIRVOp, LLVM::FCmpPredicate predicate>
816 class FComparePattern : public SPIRVToLLVMConversion<SPIRVOp> {
817 public:
818   using SPIRVToLLVMConversion<SPIRVOp>::SPIRVToLLVMConversion;
819 
820   LogicalResult
821   matchAndRewrite(SPIRVOp operation, ArrayRef<Value> operands,
822                   ConversionPatternRewriter &rewriter) const override {
823 
824     auto dstType = this->typeConverter.convertType(operation.getType());
825     if (!dstType)
826       return failure();
827 
828     rewriter.template replaceOpWithNewOp<LLVM::FCmpOp>(
829         operation, dstType, predicate, operation.operand1(),
830         operation.operand2());
831     return success();
832   }
833 };
834 
835 /// Converts SPIR-V integer comparisons to llvm.icmp "predicate"
836 template <typename SPIRVOp, LLVM::ICmpPredicate predicate>
837 class IComparePattern : public SPIRVToLLVMConversion<SPIRVOp> {
838 public:
839   using SPIRVToLLVMConversion<SPIRVOp>::SPIRVToLLVMConversion;
840 
841   LogicalResult
842   matchAndRewrite(SPIRVOp operation, ArrayRef<Value> operands,
843                   ConversionPatternRewriter &rewriter) const override {
844 
845     auto dstType = this->typeConverter.convertType(operation.getType());
846     if (!dstType)
847       return failure();
848 
849     rewriter.template replaceOpWithNewOp<LLVM::ICmpOp>(
850         operation, dstType, predicate, operation.operand1(),
851         operation.operand2());
852     return success();
853   }
854 };
855 
856 class InverseSqrtPattern
857     : public SPIRVToLLVMConversion<spirv::GLSLInverseSqrtOp> {
858 public:
859   using SPIRVToLLVMConversion<spirv::GLSLInverseSqrtOp>::SPIRVToLLVMConversion;
860 
861   LogicalResult
862   matchAndRewrite(spirv::GLSLInverseSqrtOp op, ArrayRef<Value> operands,
863                   ConversionPatternRewriter &rewriter) const override {
864     auto srcType = op.getType();
865     auto dstType = typeConverter.convertType(srcType);
866     if (!dstType)
867       return failure();
868 
869     Location loc = op.getLoc();
870     Value one = createFPConstant(loc, srcType, dstType, rewriter, 1.0);
871     Value sqrt = rewriter.create<LLVM::SqrtOp>(loc, dstType, op.operand());
872     rewriter.replaceOpWithNewOp<LLVM::FDivOp>(op, dstType, one, sqrt);
873     return success();
874   }
875 };
876 
877 /// Converts `spv.Load` and `spv.Store` to LLVM dialect.
878 template <typename SPIRVop>
879 class LoadStorePattern : public SPIRVToLLVMConversion<SPIRVop> {
880 public:
881   using SPIRVToLLVMConversion<SPIRVop>::SPIRVToLLVMConversion;
882 
883   LogicalResult
884   matchAndRewrite(SPIRVop op, ArrayRef<Value> operands,
885                   ConversionPatternRewriter &rewriter) const override {
886 
887     if (!op.memory_access().hasValue()) {
888       return replaceWithLoadOrStore(
889           op, rewriter, this->typeConverter, /*alignment=*/0,
890           /*isVolatile=*/false, /*isNonTemporal=*/false);
891     }
892     auto memoryAccess = op.memory_access().getValue();
893     switch (memoryAccess) {
894     case spirv::MemoryAccess::Aligned:
895     case spirv::MemoryAccess::None:
896     case spirv::MemoryAccess::Nontemporal:
897     case spirv::MemoryAccess::Volatile: {
898       unsigned alignment =
899           memoryAccess == spirv::MemoryAccess::Aligned ? *op.alignment() : 0;
900       bool isNonTemporal = memoryAccess == spirv::MemoryAccess::Nontemporal;
901       bool isVolatile = memoryAccess == spirv::MemoryAccess::Volatile;
902       return replaceWithLoadOrStore(op, rewriter, this->typeConverter,
903                                     alignment, isVolatile, isNonTemporal);
904     }
905     default:
906       // There is no support of other memory access attributes.
907       return failure();
908     }
909   }
910 };
911 
912 /// Converts `spv.Not` and `spv.LogicalNot` into LLVM dialect.
913 template <typename SPIRVOp>
914 class NotPattern : public SPIRVToLLVMConversion<SPIRVOp> {
915 public:
916   using SPIRVToLLVMConversion<SPIRVOp>::SPIRVToLLVMConversion;
917 
918   LogicalResult
919   matchAndRewrite(SPIRVOp notOp, ArrayRef<Value> operands,
920                   ConversionPatternRewriter &rewriter) const override {
921 
922     auto srcType = notOp.getType();
923     auto dstType = this->typeConverter.convertType(srcType);
924     if (!dstType)
925       return failure();
926 
927     Location loc = notOp.getLoc();
928     IntegerAttr minusOne = minusOneIntegerAttribute(srcType, rewriter);
929     auto mask = srcType.template isa<VectorType>()
930                     ? rewriter.create<LLVM::ConstantOp>(
931                           loc, dstType,
932                           SplatElementsAttr::get(
933                               srcType.template cast<VectorType>(), minusOne))
934                     : rewriter.create<LLVM::ConstantOp>(loc, dstType, minusOne);
935     rewriter.template replaceOpWithNewOp<LLVM::XOrOp>(notOp, dstType,
936                                                       notOp.operand(), mask);
937     return success();
938   }
939 };
940 
941 /// A template pattern that erases the given `SPIRVOp`.
942 template <typename SPIRVOp>
943 class ErasePattern : public SPIRVToLLVMConversion<SPIRVOp> {
944 public:
945   using SPIRVToLLVMConversion<SPIRVOp>::SPIRVToLLVMConversion;
946 
947   LogicalResult
948   matchAndRewrite(SPIRVOp op, ArrayRef<Value> operands,
949                   ConversionPatternRewriter &rewriter) const override {
950     rewriter.eraseOp(op);
951     return success();
952   }
953 };
954 
955 class ReturnPattern : public SPIRVToLLVMConversion<spirv::ReturnOp> {
956 public:
957   using SPIRVToLLVMConversion<spirv::ReturnOp>::SPIRVToLLVMConversion;
958 
959   LogicalResult
960   matchAndRewrite(spirv::ReturnOp returnOp, ArrayRef<Value> operands,
961                   ConversionPatternRewriter &rewriter) const override {
962     rewriter.replaceOpWithNewOp<LLVM::ReturnOp>(returnOp, ArrayRef<Type>(),
963                                                 ArrayRef<Value>());
964     return success();
965   }
966 };
967 
968 class ReturnValuePattern : public SPIRVToLLVMConversion<spirv::ReturnValueOp> {
969 public:
970   using SPIRVToLLVMConversion<spirv::ReturnValueOp>::SPIRVToLLVMConversion;
971 
972   LogicalResult
973   matchAndRewrite(spirv::ReturnValueOp returnValueOp, ArrayRef<Value> operands,
974                   ConversionPatternRewriter &rewriter) const override {
975     rewriter.replaceOpWithNewOp<LLVM::ReturnOp>(returnValueOp, ArrayRef<Type>(),
976                                                 operands);
977     return success();
978   }
979 };
980 
981 /// Converts `spv.mlir.loop` to LLVM dialect. All blocks within selection should
982 /// be reachable for conversion to succeed. The structure of the loop in LLVM
983 /// dialect will be the following:
984 ///
985 ///      +------------------------------------+
986 ///      | <code before spv.mlir.loop>        |
987 ///      | llvm.br ^header                    |
988 ///      +------------------------------------+
989 ///                           |
990 ///   +----------------+      |
991 ///   |                |      |
992 ///   |                V      V
993 ///   |  +------------------------------------+
994 ///   |  | ^header:                           |
995 ///   |  |   <header code>                    |
996 ///   |  |   llvm.cond_br %cond, ^body, ^exit |
997 ///   |  +------------------------------------+
998 ///   |                    |
999 ///   |                    |----------------------+
1000 ///   |                    |                      |
1001 ///   |                    V                      |
1002 ///   |  +------------------------------------+   |
1003 ///   |  | ^body:                             |   |
1004 ///   |  |   <body code>                      |   |
1005 ///   |  |   llvm.br ^continue                |   |
1006 ///   |  +------------------------------------+   |
1007 ///   |                    |                      |
1008 ///   |                    V                      |
1009 ///   |  +------------------------------------+   |
1010 ///   |  | ^continue:                         |   |
1011 ///   |  |   <continue code>                  |   |
1012 ///   |  |   llvm.br ^header                  |   |
1013 ///   |  +------------------------------------+   |
1014 ///   |               |                           |
1015 ///   +---------------+    +----------------------+
1016 ///                        |
1017 ///                        V
1018 ///      +------------------------------------+
1019 ///      | ^exit:                             |
1020 ///      |   llvm.br ^remaining               |
1021 ///      +------------------------------------+
1022 ///                        |
1023 ///                        V
1024 ///      +------------------------------------+
1025 ///      | ^remaining:                        |
1026 ///      |   <code after spv.mlir.loop>       |
1027 ///      +------------------------------------+
1028 ///
1029 class LoopPattern : public SPIRVToLLVMConversion<spirv::LoopOp> {
1030 public:
1031   using SPIRVToLLVMConversion<spirv::LoopOp>::SPIRVToLLVMConversion;
1032 
1033   LogicalResult
1034   matchAndRewrite(spirv::LoopOp loopOp, ArrayRef<Value> operands,
1035                   ConversionPatternRewriter &rewriter) const override {
1036     // There is no support of loop control at the moment.
1037     if (loopOp.loop_control() != spirv::LoopControl::None)
1038       return failure();
1039 
1040     Location loc = loopOp.getLoc();
1041 
1042     // Split the current block after `spv.mlir.loop`. The remaining ops will be
1043     // used in `endBlock`.
1044     Block *currentBlock = rewriter.getBlock();
1045     auto position = Block::iterator(loopOp);
1046     Block *endBlock = rewriter.splitBlock(currentBlock, position);
1047 
1048     // Remove entry block and create a branch in the current block going to the
1049     // header block.
1050     Block *entryBlock = loopOp.getEntryBlock();
1051     assert(entryBlock->getOperations().size() == 1);
1052     auto brOp = dyn_cast<spirv::BranchOp>(entryBlock->getOperations().front());
1053     if (!brOp)
1054       return failure();
1055     Block *headerBlock = loopOp.getHeaderBlock();
1056     rewriter.setInsertionPointToEnd(currentBlock);
1057     rewriter.create<LLVM::BrOp>(loc, brOp.getBlockArguments(), headerBlock);
1058     rewriter.eraseBlock(entryBlock);
1059 
1060     // Branch from merge block to end block.
1061     Block *mergeBlock = loopOp.getMergeBlock();
1062     Operation *terminator = mergeBlock->getTerminator();
1063     ValueRange terminatorOperands = terminator->getOperands();
1064     rewriter.setInsertionPointToEnd(mergeBlock);
1065     rewriter.create<LLVM::BrOp>(loc, terminatorOperands, endBlock);
1066 
1067     rewriter.inlineRegionBefore(loopOp.body(), endBlock);
1068     rewriter.replaceOp(loopOp, endBlock->getArguments());
1069     return success();
1070   }
1071 };
1072 
1073 /// Converts `spv.mlir.selection` with `spv.BranchConditional` in its header
1074 /// block. All blocks within selection should be reachable for conversion to
1075 /// succeed.
1076 class SelectionPattern : public SPIRVToLLVMConversion<spirv::SelectionOp> {
1077 public:
1078   using SPIRVToLLVMConversion<spirv::SelectionOp>::SPIRVToLLVMConversion;
1079 
1080   LogicalResult
1081   matchAndRewrite(spirv::SelectionOp op, ArrayRef<Value> operands,
1082                   ConversionPatternRewriter &rewriter) const override {
1083     // There is no support for `Flatten` or `DontFlatten` selection control at
1084     // the moment. This are just compiler hints and can be performed during the
1085     // optimization passes.
1086     if (op.selection_control() != spirv::SelectionControl::None)
1087       return failure();
1088 
1089     // `spv.mlir.selection` should have at least two blocks: one selection
1090     // header block and one merge block. If no blocks are present, or control
1091     // flow branches straight to merge block (two blocks are present), the op is
1092     // redundant and it is erased.
1093     if (op.body().getBlocks().size() <= 2) {
1094       rewriter.eraseOp(op);
1095       return success();
1096     }
1097 
1098     Location loc = op.getLoc();
1099 
1100     // Split the current block after `spv.mlir.selection`. The remaining ops
1101     // will be used in `continueBlock`.
1102     auto *currentBlock = rewriter.getInsertionBlock();
1103     rewriter.setInsertionPointAfter(op);
1104     auto position = rewriter.getInsertionPoint();
1105     auto *continueBlock = rewriter.splitBlock(currentBlock, position);
1106 
1107     // Extract conditional branch information from the header block. By SPIR-V
1108     // dialect spec, it should contain `spv.BranchConditional` or `spv.Switch`
1109     // op. Note that `spv.Switch op` is not supported at the moment in the
1110     // SPIR-V dialect. Remove this block when finished.
1111     auto *headerBlock = op.getHeaderBlock();
1112     assert(headerBlock->getOperations().size() == 1);
1113     auto condBrOp = dyn_cast<spirv::BranchConditionalOp>(
1114         headerBlock->getOperations().front());
1115     if (!condBrOp)
1116       return failure();
1117     rewriter.eraseBlock(headerBlock);
1118 
1119     // Branch from merge block to continue block.
1120     auto *mergeBlock = op.getMergeBlock();
1121     Operation *terminator = mergeBlock->getTerminator();
1122     ValueRange terminatorOperands = terminator->getOperands();
1123     rewriter.setInsertionPointToEnd(mergeBlock);
1124     rewriter.create<LLVM::BrOp>(loc, terminatorOperands, continueBlock);
1125 
1126     // Link current block to `true` and `false` blocks within the selection.
1127     Block *trueBlock = condBrOp.getTrueBlock();
1128     Block *falseBlock = condBrOp.getFalseBlock();
1129     rewriter.setInsertionPointToEnd(currentBlock);
1130     rewriter.create<LLVM::CondBrOp>(loc, condBrOp.condition(), trueBlock,
1131                                     condBrOp.trueTargetOperands(), falseBlock,
1132                                     condBrOp.falseTargetOperands());
1133 
1134     rewriter.inlineRegionBefore(op.body(), continueBlock);
1135     rewriter.replaceOp(op, continueBlock->getArguments());
1136     return success();
1137   }
1138 };
1139 
1140 /// Converts SPIR-V shift ops to LLVM shift ops. Since LLVM dialect
1141 /// puts a restriction on `Shift` and `Base` to have the same bit width,
1142 /// `Shift` is zero or sign extended to match this specification. Cases when
1143 /// `Shift` bit width > `Base` bit width are considered to be illegal.
1144 template <typename SPIRVOp, typename LLVMOp>
1145 class ShiftPattern : public SPIRVToLLVMConversion<SPIRVOp> {
1146 public:
1147   using SPIRVToLLVMConversion<SPIRVOp>::SPIRVToLLVMConversion;
1148 
1149   LogicalResult
1150   matchAndRewrite(SPIRVOp operation, ArrayRef<Value> operands,
1151                   ConversionPatternRewriter &rewriter) const override {
1152 
1153     auto dstType = this->typeConverter.convertType(operation.getType());
1154     if (!dstType)
1155       return failure();
1156 
1157     Type op1Type = operation.operand1().getType();
1158     Type op2Type = operation.operand2().getType();
1159 
1160     if (op1Type == op2Type) {
1161       rewriter.template replaceOpWithNewOp<LLVMOp>(operation, dstType,
1162                                                    operands);
1163       return success();
1164     }
1165 
1166     Location loc = operation.getLoc();
1167     Value extended;
1168     if (isUnsignedIntegerOrVector(op2Type)) {
1169       extended = rewriter.template create<LLVM::ZExtOp>(loc, dstType,
1170                                                         operation.operand2());
1171     } else {
1172       extended = rewriter.template create<LLVM::SExtOp>(loc, dstType,
1173                                                         operation.operand2());
1174     }
1175     Value result = rewriter.template create<LLVMOp>(
1176         loc, dstType, operation.operand1(), extended);
1177     rewriter.replaceOp(operation, result);
1178     return success();
1179   }
1180 };
1181 
1182 class TanPattern : public SPIRVToLLVMConversion<spirv::GLSLTanOp> {
1183 public:
1184   using SPIRVToLLVMConversion<spirv::GLSLTanOp>::SPIRVToLLVMConversion;
1185 
1186   LogicalResult
1187   matchAndRewrite(spirv::GLSLTanOp tanOp, ArrayRef<Value> operands,
1188                   ConversionPatternRewriter &rewriter) const override {
1189     auto dstType = typeConverter.convertType(tanOp.getType());
1190     if (!dstType)
1191       return failure();
1192 
1193     Location loc = tanOp.getLoc();
1194     Value sin = rewriter.create<LLVM::SinOp>(loc, dstType, tanOp.operand());
1195     Value cos = rewriter.create<LLVM::CosOp>(loc, dstType, tanOp.operand());
1196     rewriter.replaceOpWithNewOp<LLVM::FDivOp>(tanOp, dstType, sin, cos);
1197     return success();
1198   }
1199 };
1200 
1201 /// Convert `spv.Tanh` to
1202 ///
1203 ///   exp(2x) - 1
1204 ///   -----------
1205 ///   exp(2x) + 1
1206 ///
1207 class TanhPattern : public SPIRVToLLVMConversion<spirv::GLSLTanhOp> {
1208 public:
1209   using SPIRVToLLVMConversion<spirv::GLSLTanhOp>::SPIRVToLLVMConversion;
1210 
1211   LogicalResult
1212   matchAndRewrite(spirv::GLSLTanhOp tanhOp, ArrayRef<Value> operands,
1213                   ConversionPatternRewriter &rewriter) const override {
1214     auto srcType = tanhOp.getType();
1215     auto dstType = typeConverter.convertType(srcType);
1216     if (!dstType)
1217       return failure();
1218 
1219     Location loc = tanhOp.getLoc();
1220     Value two = createFPConstant(loc, srcType, dstType, rewriter, 2.0);
1221     Value multiplied =
1222         rewriter.create<LLVM::FMulOp>(loc, dstType, two, tanhOp.operand());
1223     Value exponential = rewriter.create<LLVM::ExpOp>(loc, dstType, multiplied);
1224     Value one = createFPConstant(loc, srcType, dstType, rewriter, 1.0);
1225     Value numerator =
1226         rewriter.create<LLVM::FSubOp>(loc, dstType, exponential, one);
1227     Value denominator =
1228         rewriter.create<LLVM::FAddOp>(loc, dstType, exponential, one);
1229     rewriter.replaceOpWithNewOp<LLVM::FDivOp>(tanhOp, dstType, numerator,
1230                                               denominator);
1231     return success();
1232   }
1233 };
1234 
1235 class VariablePattern : public SPIRVToLLVMConversion<spirv::VariableOp> {
1236 public:
1237   using SPIRVToLLVMConversion<spirv::VariableOp>::SPIRVToLLVMConversion;
1238 
1239   LogicalResult
1240   matchAndRewrite(spirv::VariableOp varOp, ArrayRef<Value> operands,
1241                   ConversionPatternRewriter &rewriter) const override {
1242     auto srcType = varOp.getType();
1243     // Initialization is supported for scalars and vectors only.
1244     auto pointerTo = srcType.cast<spirv::PointerType>().getPointeeType();
1245     auto init = varOp.initializer();
1246     if (init && !pointerTo.isIntOrFloat() && !pointerTo.isa<VectorType>())
1247       return failure();
1248 
1249     auto dstType = typeConverter.convertType(srcType);
1250     if (!dstType)
1251       return failure();
1252 
1253     Location loc = varOp.getLoc();
1254     Value size = createI32ConstantOf(loc, rewriter, 1);
1255     if (!init) {
1256       rewriter.replaceOpWithNewOp<LLVM::AllocaOp>(varOp, dstType, size);
1257       return success();
1258     }
1259     Value allocated = rewriter.create<LLVM::AllocaOp>(loc, dstType, size);
1260     rewriter.create<LLVM::StoreOp>(loc, init, allocated);
1261     rewriter.replaceOp(varOp, allocated);
1262     return success();
1263   }
1264 };
1265 
1266 //===----------------------------------------------------------------------===//
1267 // FuncOp conversion
1268 //===----------------------------------------------------------------------===//
1269 
1270 class FuncConversionPattern : public SPIRVToLLVMConversion<spirv::FuncOp> {
1271 public:
1272   using SPIRVToLLVMConversion<spirv::FuncOp>::SPIRVToLLVMConversion;
1273 
1274   LogicalResult
1275   matchAndRewrite(spirv::FuncOp funcOp, ArrayRef<Value> operands,
1276                   ConversionPatternRewriter &rewriter) const override {
1277 
1278     // Convert function signature. At the moment LLVMType converter is enough
1279     // for currently supported types.
1280     auto funcType = funcOp.getType();
1281     TypeConverter::SignatureConversion signatureConverter(
1282         funcType.getNumInputs());
1283     auto llvmType = typeConverter.convertFunctionSignature(
1284         funcOp.getType(), /*isVariadic=*/false, signatureConverter);
1285     if (!llvmType)
1286       return failure();
1287 
1288     // Create a new `LLVMFuncOp`
1289     Location loc = funcOp.getLoc();
1290     StringRef name = funcOp.getName();
1291     auto newFuncOp = rewriter.create<LLVM::LLVMFuncOp>(loc, name, llvmType);
1292 
1293     // Convert SPIR-V Function Control to equivalent LLVM function attribute
1294     MLIRContext *context = funcOp.getContext();
1295     switch (funcOp.function_control()) {
1296 #define DISPATCH(functionControl, llvmAttr)                                    \
1297   case functionControl:                                                        \
1298     newFuncOp->setAttr("passthrough", ArrayAttr::get(context, {llvmAttr}));    \
1299     break;
1300 
1301       DISPATCH(spirv::FunctionControl::Inline,
1302                StringAttr::get(context, "alwaysinline"));
1303       DISPATCH(spirv::FunctionControl::DontInline,
1304                StringAttr::get(context, "noinline"));
1305       DISPATCH(spirv::FunctionControl::Pure,
1306                StringAttr::get(context, "readonly"));
1307       DISPATCH(spirv::FunctionControl::Const,
1308                StringAttr::get(context, "readnone"));
1309 
1310 #undef DISPATCH
1311 
1312     // Default: if `spirv::FunctionControl::None`, then no attributes are
1313     // needed.
1314     default:
1315       break;
1316     }
1317 
1318     rewriter.inlineRegionBefore(funcOp.getBody(), newFuncOp.getBody(),
1319                                 newFuncOp.end());
1320     if (failed(rewriter.convertRegionTypes(&newFuncOp.getBody(), typeConverter,
1321                                            &signatureConverter))) {
1322       return failure();
1323     }
1324     rewriter.eraseOp(funcOp);
1325     return success();
1326   }
1327 };
1328 
1329 //===----------------------------------------------------------------------===//
1330 // ModuleOp conversion
1331 //===----------------------------------------------------------------------===//
1332 
1333 class ModuleConversionPattern : public SPIRVToLLVMConversion<spirv::ModuleOp> {
1334 public:
1335   using SPIRVToLLVMConversion<spirv::ModuleOp>::SPIRVToLLVMConversion;
1336 
1337   LogicalResult
1338   matchAndRewrite(spirv::ModuleOp spvModuleOp, ArrayRef<Value> operands,
1339                   ConversionPatternRewriter &rewriter) const override {
1340 
1341     auto newModuleOp =
1342         rewriter.create<ModuleOp>(spvModuleOp.getLoc(), spvModuleOp.getName());
1343     rewriter.inlineRegionBefore(spvModuleOp.body(), newModuleOp.getBody());
1344 
1345     // Remove the terminator block that was automatically added by builder
1346     rewriter.eraseBlock(&newModuleOp.getBodyRegion().back());
1347     rewriter.eraseOp(spvModuleOp);
1348     return success();
1349   }
1350 };
1351 
1352 class ModuleEndConversionPattern
1353     : public SPIRVToLLVMConversion<spirv::ModuleEndOp> {
1354 public:
1355   using SPIRVToLLVMConversion<spirv::ModuleEndOp>::SPIRVToLLVMConversion;
1356 
1357   LogicalResult
1358   matchAndRewrite(spirv::ModuleEndOp moduleEndOp, ArrayRef<Value> operands,
1359                   ConversionPatternRewriter &rewriter) const override {
1360 
1361     rewriter.eraseOp(moduleEndOp);
1362     return success();
1363   }
1364 };
1365 
1366 } // namespace
1367 
1368 //===----------------------------------------------------------------------===//
1369 // Pattern population
1370 //===----------------------------------------------------------------------===//
1371 
1372 void mlir::populateSPIRVToLLVMTypeConversion(LLVMTypeConverter &typeConverter) {
1373   typeConverter.addConversion([&](spirv::ArrayType type) {
1374     return convertArrayType(type, typeConverter);
1375   });
1376   typeConverter.addConversion([&](spirv::PointerType type) {
1377     return convertPointerType(type, typeConverter);
1378   });
1379   typeConverter.addConversion([&](spirv::RuntimeArrayType type) {
1380     return convertRuntimeArrayType(type, typeConverter);
1381   });
1382   typeConverter.addConversion([&](spirv::StructType type) {
1383     return convertStructType(type, typeConverter);
1384   });
1385 }
1386 
1387 void mlir::populateSPIRVToLLVMConversionPatterns(
1388     LLVMTypeConverter &typeConverter, RewritePatternSet &patterns) {
1389   patterns.add<
1390       // Arithmetic ops
1391       DirectConversionPattern<spirv::IAddOp, LLVM::AddOp>,
1392       DirectConversionPattern<spirv::IMulOp, LLVM::MulOp>,
1393       DirectConversionPattern<spirv::ISubOp, LLVM::SubOp>,
1394       DirectConversionPattern<spirv::FAddOp, LLVM::FAddOp>,
1395       DirectConversionPattern<spirv::FDivOp, LLVM::FDivOp>,
1396       DirectConversionPattern<spirv::FMulOp, LLVM::FMulOp>,
1397       DirectConversionPattern<spirv::FNegateOp, LLVM::FNegOp>,
1398       DirectConversionPattern<spirv::FRemOp, LLVM::FRemOp>,
1399       DirectConversionPattern<spirv::FSubOp, LLVM::FSubOp>,
1400       DirectConversionPattern<spirv::SDivOp, LLVM::SDivOp>,
1401       DirectConversionPattern<spirv::SRemOp, LLVM::SRemOp>,
1402       DirectConversionPattern<spirv::UDivOp, LLVM::UDivOp>,
1403       DirectConversionPattern<spirv::UModOp, LLVM::URemOp>,
1404 
1405       // Bitwise ops
1406       BitFieldInsertPattern, BitFieldUExtractPattern, BitFieldSExtractPattern,
1407       DirectConversionPattern<spirv::BitCountOp, LLVM::CtPopOp>,
1408       DirectConversionPattern<spirv::BitReverseOp, LLVM::BitReverseOp>,
1409       DirectConversionPattern<spirv::BitwiseAndOp, LLVM::AndOp>,
1410       DirectConversionPattern<spirv::BitwiseOrOp, LLVM::OrOp>,
1411       DirectConversionPattern<spirv::BitwiseXorOp, LLVM::XOrOp>,
1412       NotPattern<spirv::NotOp>,
1413 
1414       // Cast ops
1415       DirectConversionPattern<spirv::BitcastOp, LLVM::BitcastOp>,
1416       DirectConversionPattern<spirv::ConvertFToSOp, LLVM::FPToSIOp>,
1417       DirectConversionPattern<spirv::ConvertFToUOp, LLVM::FPToUIOp>,
1418       DirectConversionPattern<spirv::ConvertSToFOp, LLVM::SIToFPOp>,
1419       DirectConversionPattern<spirv::ConvertUToFOp, LLVM::UIToFPOp>,
1420       IndirectCastPattern<spirv::FConvertOp, LLVM::FPExtOp, LLVM::FPTruncOp>,
1421       IndirectCastPattern<spirv::SConvertOp, LLVM::SExtOp, LLVM::TruncOp>,
1422       IndirectCastPattern<spirv::UConvertOp, LLVM::ZExtOp, LLVM::TruncOp>,
1423 
1424       // Comparison ops
1425       IComparePattern<spirv::IEqualOp, LLVM::ICmpPredicate::eq>,
1426       IComparePattern<spirv::INotEqualOp, LLVM::ICmpPredicate::ne>,
1427       FComparePattern<spirv::FOrdEqualOp, LLVM::FCmpPredicate::oeq>,
1428       FComparePattern<spirv::FOrdGreaterThanOp, LLVM::FCmpPredicate::ogt>,
1429       FComparePattern<spirv::FOrdGreaterThanEqualOp, LLVM::FCmpPredicate::oge>,
1430       FComparePattern<spirv::FOrdLessThanEqualOp, LLVM::FCmpPredicate::ole>,
1431       FComparePattern<spirv::FOrdLessThanOp, LLVM::FCmpPredicate::olt>,
1432       FComparePattern<spirv::FOrdNotEqualOp, LLVM::FCmpPredicate::one>,
1433       FComparePattern<spirv::FUnordEqualOp, LLVM::FCmpPredicate::ueq>,
1434       FComparePattern<spirv::FUnordGreaterThanOp, LLVM::FCmpPredicate::ugt>,
1435       FComparePattern<spirv::FUnordGreaterThanEqualOp,
1436                       LLVM::FCmpPredicate::uge>,
1437       FComparePattern<spirv::FUnordLessThanEqualOp, LLVM::FCmpPredicate::ule>,
1438       FComparePattern<spirv::FUnordLessThanOp, LLVM::FCmpPredicate::ult>,
1439       FComparePattern<spirv::FUnordNotEqualOp, LLVM::FCmpPredicate::une>,
1440       IComparePattern<spirv::SGreaterThanOp, LLVM::ICmpPredicate::sgt>,
1441       IComparePattern<spirv::SGreaterThanEqualOp, LLVM::ICmpPredicate::sge>,
1442       IComparePattern<spirv::SLessThanEqualOp, LLVM::ICmpPredicate::sle>,
1443       IComparePattern<spirv::SLessThanOp, LLVM::ICmpPredicate::slt>,
1444       IComparePattern<spirv::UGreaterThanOp, LLVM::ICmpPredicate::ugt>,
1445       IComparePattern<spirv::UGreaterThanEqualOp, LLVM::ICmpPredicate::uge>,
1446       IComparePattern<spirv::ULessThanEqualOp, LLVM::ICmpPredicate::ule>,
1447       IComparePattern<spirv::ULessThanOp, LLVM::ICmpPredicate::ult>,
1448 
1449       // Constant op
1450       ConstantScalarAndVectorPattern,
1451 
1452       // Control Flow ops
1453       BranchConversionPattern, BranchConditionalConversionPattern,
1454       FunctionCallPattern, LoopPattern, SelectionPattern,
1455       ErasePattern<spirv::MergeOp>,
1456 
1457       // Entry points and execution mode are handled separately.
1458       ErasePattern<spirv::EntryPointOp>, ExecutionModePattern,
1459 
1460       // GLSL extended instruction set ops
1461       DirectConversionPattern<spirv::GLSLCeilOp, LLVM::FCeilOp>,
1462       DirectConversionPattern<spirv::GLSLCosOp, LLVM::CosOp>,
1463       DirectConversionPattern<spirv::GLSLExpOp, LLVM::ExpOp>,
1464       DirectConversionPattern<spirv::GLSLFAbsOp, LLVM::FAbsOp>,
1465       DirectConversionPattern<spirv::GLSLFloorOp, LLVM::FFloorOp>,
1466       DirectConversionPattern<spirv::GLSLFMaxOp, LLVM::MaxNumOp>,
1467       DirectConversionPattern<spirv::GLSLFMinOp, LLVM::MinNumOp>,
1468       DirectConversionPattern<spirv::GLSLLogOp, LLVM::LogOp>,
1469       DirectConversionPattern<spirv::GLSLSinOp, LLVM::SinOp>,
1470       DirectConversionPattern<spirv::GLSLSMaxOp, LLVM::SMaxOp>,
1471       DirectConversionPattern<spirv::GLSLSMinOp, LLVM::SMinOp>,
1472       DirectConversionPattern<spirv::GLSLSqrtOp, LLVM::SqrtOp>,
1473       InverseSqrtPattern, TanPattern, TanhPattern,
1474 
1475       // Logical ops
1476       DirectConversionPattern<spirv::LogicalAndOp, LLVM::AndOp>,
1477       DirectConversionPattern<spirv::LogicalOrOp, LLVM::OrOp>,
1478       IComparePattern<spirv::LogicalEqualOp, LLVM::ICmpPredicate::eq>,
1479       IComparePattern<spirv::LogicalNotEqualOp, LLVM::ICmpPredicate::ne>,
1480       NotPattern<spirv::LogicalNotOp>,
1481 
1482       // Memory ops
1483       AccessChainPattern, AddressOfPattern, GlobalVariablePattern,
1484       LoadStorePattern<spirv::LoadOp>, LoadStorePattern<spirv::StoreOp>,
1485       VariablePattern,
1486 
1487       // Miscellaneous ops
1488       CompositeExtractPattern, CompositeInsertPattern,
1489       DirectConversionPattern<spirv::SelectOp, LLVM::SelectOp>,
1490       DirectConversionPattern<spirv::UndefOp, LLVM::UndefOp>,
1491 
1492       // Shift ops
1493       ShiftPattern<spirv::ShiftRightArithmeticOp, LLVM::AShrOp>,
1494       ShiftPattern<spirv::ShiftRightLogicalOp, LLVM::LShrOp>,
1495       ShiftPattern<spirv::ShiftLeftLogicalOp, LLVM::ShlOp>,
1496 
1497       // Return ops
1498       ReturnPattern, ReturnValuePattern>(patterns.getContext(), typeConverter);
1499 }
1500 
1501 void mlir::populateSPIRVToLLVMFunctionConversionPatterns(
1502     LLVMTypeConverter &typeConverter, RewritePatternSet &patterns) {
1503   patterns.add<FuncConversionPattern>(patterns.getContext(), typeConverter);
1504 }
1505 
1506 void mlir::populateSPIRVToLLVMModuleConversionPatterns(
1507     LLVMTypeConverter &typeConverter, RewritePatternSet &patterns) {
1508   patterns.add<ModuleConversionPattern, ModuleEndConversionPattern>(
1509       patterns.getContext(), typeConverter);
1510 }
1511 
1512 //===----------------------------------------------------------------------===//
1513 // Pre-conversion hooks
1514 //===----------------------------------------------------------------------===//
1515 
1516 /// Hook for descriptor set and binding number encoding.
1517 static constexpr StringRef kBinding = "binding";
1518 static constexpr StringRef kDescriptorSet = "descriptor_set";
1519 void mlir::encodeBindAttribute(ModuleOp module) {
1520   auto spvModules = module.getOps<spirv::ModuleOp>();
1521   for (auto spvModule : spvModules) {
1522     spvModule.walk([&](spirv::GlobalVariableOp op) {
1523       IntegerAttr descriptorSet =
1524           op->getAttrOfType<IntegerAttr>(kDescriptorSet);
1525       IntegerAttr binding = op->getAttrOfType<IntegerAttr>(kBinding);
1526       // For every global variable in the module, get the ones with descriptor
1527       // set and binding numbers.
1528       if (descriptorSet && binding) {
1529         // Encode these numbers into the variable's symbolic name. If the
1530         // SPIR-V module has a name, add it at the beginning.
1531         auto moduleAndName = spvModule.getName().hasValue()
1532                                  ? spvModule.getName().getValue().str() + "_" +
1533                                        op.sym_name().str()
1534                                  : op.sym_name().str();
1535         std::string name =
1536             llvm::formatv("{0}_descriptor_set{1}_binding{2}", moduleAndName,
1537                           std::to_string(descriptorSet.getInt()),
1538                           std::to_string(binding.getInt()));
1539 
1540         // Replace all symbol uses and set the new symbol name. Finally, remove
1541         // descriptor set and binding attributes.
1542         if (failed(SymbolTable::replaceAllSymbolUses(op, name, spvModule)))
1543           op.emitError("unable to replace all symbol uses for ") << name;
1544         SymbolTable::setSymbolName(op, name);
1545         op->removeAttr(kDescriptorSet);
1546         op->removeAttr(kBinding);
1547       }
1548     });
1549   }
1550 }
1551