1//===- ConvertToSPIRVPass.cpp - MLIR SPIR-V Conversion --------------------===//
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#include "mlir/Conversion/ArithCommon/CeilFloorDivExpansion.h"
10#include "mlir/Conversion/ArithToSPIRV/ArithToSPIRV.h"
11#include "mlir/Conversion/ControlFlowToSPIRV/ControlFlowToSPIRV.h"
12#include "mlir/Conversion/FuncToSPIRV/FuncToSPIRV.h"
13#include "mlir/Conversion/GPUToSPIRV/GPUToSPIRV.h"
14#include "mlir/Conversion/IndexToSPIRV/IndexToSPIRV.h"
15#include "mlir/Conversion/MathToSPIRV/MathToSPIRV.h"
16#include "mlir/Conversion/MemRefToSPIRV/MemRefToSPIRV.h"
17#include "mlir/Conversion/SCFToSPIRV/SCFToSPIRV.h"
18#include "mlir/Conversion/UBToSPIRV/UBToSPIRV.h"
19#include "mlir/Conversion/VectorToSPIRV/VectorToSPIRV.h"
20#include "mlir/Dialect/Arith/Transforms/Passes.h"
21#include "mlir/Dialect/GPU/IR/GPUDialect.h"
22#include "mlir/Dialect/SPIRV/IR/SPIRVAttributes.h"
23#include "mlir/Dialect/SPIRV/Transforms/SPIRVConversion.h"
24#include "mlir/Dialect/Vector/IR/VectorOps.h"
25#include "mlir/Dialect/Vector/Transforms/LoweringPatterns.h"
26#include "mlir/Dialect/Vector/Transforms/VectorRewritePatterns.h"
27#include "mlir/IR/PatternMatch.h"
28#include "mlir/Pass/Pass.h"
29#include "mlir/Pass/PassOptions.h"
30#include "mlir/Rewrite/FrozenRewritePatternSet.h"
31#include "mlir/Transforms/DialectConversion.h"
32#include <memory>
33
34#define DEBUG_TYPE "test-convert-to-spirv"
35
36using namespace mlir;
37
38namespace {
39
40/// Map memRef memory space to SPIR-V storage class.
41void mapToMemRef(Operation *op, spirv::TargetEnvAttr &targetAttr) {
42 spirv::TargetEnv targetEnv(targetAttr);
43 bool targetEnvSupportsKernelCapability =
44 targetEnv.allows(spirv::Capability::Kernel);
45 spirv::MemorySpaceToStorageClassMap memorySpaceMap =
46 targetEnvSupportsKernelCapability
47 ? spirv::mapMemorySpaceToOpenCLStorageClass
48 : spirv::mapMemorySpaceToVulkanStorageClass;
49 spirv::MemorySpaceToStorageClassConverter converter(memorySpaceMap);
50 spirv::convertMemRefTypesAndAttrs(op, typeConverter&: converter);
51}
52
53/// Populate patterns for each dialect.
54void populateConvertToSPIRVPatterns(const SPIRVTypeConverter &typeConverter,
55 ScfToSPIRVContext &scfToSPIRVContext,
56 RewritePatternSet &patterns) {
57 arith::populateCeilFloorDivExpandOpsPatterns(patterns);
58 arith::populateArithToSPIRVPatterns(typeConverter, patterns);
59 cf::populateControlFlowToSPIRVPatterns(typeConverter, patterns);
60 populateBuiltinFuncToSPIRVPatterns(typeConverter, patterns);
61 populateFuncToSPIRVPatterns(typeConverter, patterns);
62 populateGPUToSPIRVPatterns(typeConverter, patterns);
63 index::populateIndexToSPIRVPatterns(converter: typeConverter, patterns);
64 populateMathToSPIRVPatterns(typeConverter, patterns);
65 populateMemRefToSPIRVPatterns(typeConverter, patterns);
66 populateVectorToSPIRVPatterns(typeConverter, patterns);
67 populateSCFToSPIRVPatterns(typeConverter, scfToSPIRVContext, patterns);
68 ub::populateUBToSPIRVConversionPatterns(converter: typeConverter, patterns);
69}
70
71/// A pass to perform the SPIR-V conversion.
72struct TestConvertToSPIRVPass final
73 : PassWrapper<TestConvertToSPIRVPass, OperationPass<>> {
74 Option<bool> runSignatureConversion{
75 *this, "run-signature-conversion",
76 llvm::cl::desc(
77 "Run function signature conversion to convert vector types"),
78 llvm::cl::init(Val: true)};
79 Option<bool> runVectorUnrolling{
80 *this, "run-vector-unrolling",
81 llvm::cl::desc(
82 "Run vector unrolling to convert vector types in function bodies"),
83 llvm::cl::init(Val: true)};
84 Option<bool> convertGPUModules{
85 *this, "convert-gpu-modules",
86 llvm::cl::desc("Clone and convert GPU modules"), llvm::cl::init(Val: false)};
87 Option<bool> nestInGPUModule{
88 *this, "nest-in-gpu-module",
89 llvm::cl::desc("Put converted SPIR-V module inside the gpu.module "
90 "instead of alongside it."),
91 llvm::cl::init(Val: false)};
92
93 MLIR_DEFINE_EXPLICIT_INTERNAL_INLINE_TYPE_ID(TestConvertToSPIRVPass)
94
95 StringRef getArgument() const final { return "test-convert-to-spirv"; }
96 StringRef getDescription() const final {
97 return "Conversion to SPIR-V pass only used for internal tests.";
98 }
99 void getDependentDialects(DialectRegistry &registry) const override {
100 registry.insert<spirv::SPIRVDialect>();
101 registry.insert<vector::VectorDialect>();
102 }
103
104 TestConvertToSPIRVPass() = default;
105 TestConvertToSPIRVPass(bool convertGPUModules, bool nestInGPUModule) {
106 this->convertGPUModules = convertGPUModules;
107 this->nestInGPUModule = nestInGPUModule;
108 };
109 TestConvertToSPIRVPass(const TestConvertToSPIRVPass &) {}
110
111 void runOnOperation() override {
112 Operation *op = getOperation();
113 MLIRContext *context = &getContext();
114
115 // Unroll vectors in function signatures to native size.
116 if (runSignatureConversion && failed(Result: spirv::unrollVectorsInSignatures(op)))
117 return signalPassFailure();
118
119 // Unroll vectors in function bodies to native size.
120 if (runVectorUnrolling && failed(Result: spirv::unrollVectorsInFuncBodies(op)))
121 return signalPassFailure();
122
123 // Generic conversion.
124 if (!convertGPUModules) {
125 spirv::TargetEnvAttr targetAttr = spirv::lookupTargetEnvOrDefault(op);
126 std::unique_ptr<ConversionTarget> target =
127 SPIRVConversionTarget::get(targetAttr);
128 SPIRVTypeConverter typeConverter(targetAttr);
129 RewritePatternSet patterns(context);
130 ScfToSPIRVContext scfToSPIRVContext;
131 mapToMemRef(op, targetAttr);
132 populateConvertToSPIRVPatterns(typeConverter, scfToSPIRVContext,
133 patterns);
134 if (failed(Result: applyPartialConversion(op, target: *target, patterns: std::move(patterns))))
135 return signalPassFailure();
136 return;
137 }
138
139 // Clone each GPU kernel module for conversion, given that the GPU
140 // launch op still needs the original GPU kernel module.
141 SmallVector<Operation *, 1> gpuModules;
142 OpBuilder builder(context);
143 op->walk(callback: [&](gpu::GPUModuleOp gpuModule) {
144 if (nestInGPUModule)
145 builder.setInsertionPointToStart(gpuModule.getBody());
146 else
147 builder.setInsertionPoint(gpuModule);
148 gpuModules.push_back(Elt: builder.clone(op&: *gpuModule));
149 });
150 // Run conversion for each module independently as they can have
151 // different TargetEnv attributes.
152 for (Operation *gpuModule : gpuModules) {
153 spirv::TargetEnvAttr targetAttr =
154 spirv::lookupTargetEnvOrDefault(op: gpuModule);
155 std::unique_ptr<ConversionTarget> target =
156 SPIRVConversionTarget::get(targetAttr);
157 SPIRVTypeConverter typeConverter(targetAttr);
158 RewritePatternSet patterns(context);
159 ScfToSPIRVContext scfToSPIRVContext;
160 mapToMemRef(op: gpuModule, targetAttr);
161 populateConvertToSPIRVPatterns(typeConverter, scfToSPIRVContext,
162 patterns);
163 if (failed(Result: applyFullConversion(op: gpuModule, target: *target, patterns: std::move(patterns))))
164 return signalPassFailure();
165 }
166 }
167};
168
169} // namespace
170
171namespace mlir::test {
172void registerTestConvertToSPIRVPass() {
173 PassRegistration<TestConvertToSPIRVPass>();
174}
175std::unique_ptr<Pass> createTestConvertToSPIRVPass(bool convertGPUModules,
176 bool nestInGPUModule) {
177 return std::make_unique<TestConvertToSPIRVPass>(args&: convertGPUModules,
178 args&: nestInGPUModule);
179}
180} // namespace mlir::test
181