1 //===- LowerGpuOpsToROCDLOps.cpp - MLIR GPU to ROCDL lowering passes ------===//
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 a pass to generate ROCDLIR operations for higher-level
10 // GPU operations.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "mlir/Conversion/GPUToROCDL/GPUToROCDLPass.h"
15 
16 #include "mlir/Conversion/StandardToLLVM/ConvertStandardToLLVMPass.h"
17 #include "mlir/Conversion/VectorToLLVM/ConvertVectorToLLVM.h"
18 #include "mlir/Conversion/VectorToROCDL/VectorToROCDL.h"
19 #include "mlir/Dialect/GPU/GPUDialect.h"
20 #include "mlir/Dialect/GPU/Passes.h"
21 #include "mlir/Dialect/LLVMIR/ROCDLDialect.h"
22 #include "mlir/Dialect/Math/IR/Math.h"
23 #include "mlir/Dialect/Vector/VectorOps.h"
24 #include "mlir/Pass/Pass.h"
25 #include "mlir/Transforms/DialectConversion.h"
26 #include "mlir/Transforms/GreedyPatternRewriteDriver.h"
27 #include "llvm/Support/FormatVariadic.h"
28 
29 #include "../GPUCommon/GPUOpsLowering.h"
30 #include "../GPUCommon/IndexIntrinsicsOpLowering.h"
31 #include "../GPUCommon/OpToFuncCallLowering.h"
32 #include "../PassDetail.h"
33 
34 using namespace mlir;
35 
36 namespace {
37 
38 /// Import the GPU Ops to ROCDL Patterns.
39 #include "GPUToROCDL.cpp.inc"
40 
41 // A pass that replaces all occurrences of GPU device operations with their
42 // corresponding ROCDL equivalent.
43 //
44 // This pass only handles device code and is not meant to be run on GPU host
45 // code.
46 struct LowerGpuOpsToROCDLOpsPass
47     : public ConvertGpuOpsToROCDLOpsBase<LowerGpuOpsToROCDLOpsPass> {
48   LowerGpuOpsToROCDLOpsPass() = default;
49   LowerGpuOpsToROCDLOpsPass(unsigned indexBitwidth) {
50     this->indexBitwidth = indexBitwidth;
51   }
52 
53   void runOnOperation() override {
54     gpu::GPUModuleOp m = getOperation();
55 
56     /// Customize the bitwidth used for the device side index computations.
57     LowerToLLVMOptions options(
58         m.getContext(),
59         DataLayout(cast<DataLayoutOpInterface>(m.getOperation())));
60     options.emitCWrappers = true;
61     if (indexBitwidth != kDeriveIndexBitwidthFromDataLayout)
62       options.overrideIndexBitwidth(indexBitwidth);
63     LLVMTypeConverter converter(m.getContext(), options);
64 
65     RewritePatternSet patterns(m.getContext());
66     RewritePatternSet llvmPatterns(m.getContext());
67 
68     populateGpuRewritePatterns(patterns);
69     (void)applyPatternsAndFoldGreedily(m, std::move(patterns));
70 
71     populateVectorToLLVMConversionPatterns(converter, llvmPatterns);
72     populateVectorToROCDLConversionPatterns(converter, llvmPatterns);
73     populateStdToLLVMConversionPatterns(converter, llvmPatterns);
74     populateGpuToROCDLConversionPatterns(converter, llvmPatterns);
75     LLVMConversionTarget target(getContext());
76     configureGpuToROCDLConversionLegality(target);
77     if (failed(applyPartialConversion(m, target, std::move(llvmPatterns))))
78       signalPassFailure();
79   }
80 };
81 
82 } // anonymous namespace
83 
84 void mlir::configureGpuToROCDLConversionLegality(ConversionTarget &target) {
85   target.addIllegalOp<FuncOp>();
86   target.addLegalDialect<::mlir::LLVM::LLVMDialect>();
87   target.addLegalDialect<ROCDL::ROCDLDialect>();
88   target.addIllegalDialect<gpu::GPUDialect>();
89   target.addIllegalOp<LLVM::CosOp, LLVM::ExpOp, LLVM::FAbsOp, LLVM::FCeilOp,
90                       LLVM::FFloorOp, LLVM::LogOp, LLVM::Log10Op, LLVM::Log2Op,
91                       LLVM::PowOp, LLVM::SinOp, LLVM::SqrtOp>();
92 
93   // TODO: Remove once we support replacing non-root ops.
94   target.addLegalOp<gpu::YieldOp, gpu::GPUModuleOp, gpu::ModuleEndOp>();
95 }
96 
97 void mlir::populateGpuToROCDLConversionPatterns(LLVMTypeConverter &converter,
98                                                 RewritePatternSet &patterns) {
99   populateWithGenerated(patterns);
100   patterns
101       .add<GPUIndexIntrinsicOpLowering<gpu::ThreadIdOp, ROCDL::ThreadIdXOp,
102                                        ROCDL::ThreadIdYOp, ROCDL::ThreadIdZOp>,
103            GPUIndexIntrinsicOpLowering<gpu::BlockDimOp, ROCDL::BlockDimXOp,
104                                        ROCDL::BlockDimYOp, ROCDL::BlockDimZOp>,
105            GPUIndexIntrinsicOpLowering<gpu::BlockIdOp, ROCDL::BlockIdXOp,
106                                        ROCDL::BlockIdYOp, ROCDL::BlockIdZOp>,
107            GPUIndexIntrinsicOpLowering<gpu::GridDimOp, ROCDL::GridDimXOp,
108                                        ROCDL::GridDimYOp, ROCDL::GridDimZOp>,
109            GPUReturnOpLowering>(converter);
110   patterns.add<GPUFuncOpLowering>(
111       converter, /*allocaAddrSpace=*/5,
112       Identifier::get(ROCDL::ROCDLDialect::getKernelFuncAttrName(),
113                       &converter.getContext()));
114   patterns.add<OpToFuncCallLowering<AbsFOp>>(converter, "__ocml_fabs_f32",
115                                              "__ocml_fabs_f64");
116   patterns.add<OpToFuncCallLowering<math::AtanOp>>(converter, "__ocml_atan_f32",
117                                                    "__ocml_atan_f64");
118   patterns.add<OpToFuncCallLowering<math::Atan2Op>>(
119       converter, "__ocml_atan2_f32", "__ocml_atan2_f64");
120   patterns.add<OpToFuncCallLowering<CeilFOp>>(converter, "__ocml_ceil_f32",
121                                               "__ocml_ceil_f64");
122   patterns.add<OpToFuncCallLowering<math::CosOp>>(converter, "__ocml_cos_f32",
123                                                   "__ocml_cos_f64");
124   patterns.add<OpToFuncCallLowering<math::ExpOp>>(converter, "__ocml_exp_f32",
125                                                   "__ocml_exp_f64");
126   patterns.add<OpToFuncCallLowering<math::ExpM1Op>>(
127       converter, "__ocml_expm1_f32", "__ocml_expm1_f64");
128   patterns.add<OpToFuncCallLowering<FloorFOp>>(converter, "__ocml_floor_f32",
129                                                "__ocml_floor_f64");
130   patterns.add<OpToFuncCallLowering<math::LogOp>>(converter, "__ocml_log_f32",
131                                                   "__ocml_log_f64");
132   patterns.add<OpToFuncCallLowering<math::Log10Op>>(
133       converter, "__ocml_log10_f32", "__ocml_log10_f64");
134   patterns.add<OpToFuncCallLowering<math::Log1pOp>>(
135       converter, "__ocml_log1p_f32", "__ocml_log1p_f64");
136   patterns.add<OpToFuncCallLowering<math::Log2Op>>(converter, "__ocml_log2_f32",
137                                                    "__ocml_log2_f64");
138   patterns.add<OpToFuncCallLowering<math::PowFOp>>(converter, "__ocml_pow_f32",
139                                                    "__ocml_pow_f64");
140   patterns.add<OpToFuncCallLowering<math::RsqrtOp>>(
141       converter, "__ocml_rsqrt_f32", "__ocml_rsqrt_f64");
142   patterns.add<OpToFuncCallLowering<math::SinOp>>(converter, "__ocml_sin_f32",
143                                                   "__ocml_sin_f64");
144   patterns.add<OpToFuncCallLowering<math::SqrtOp>>(converter, "__ocml_sqrt_f32",
145                                                    "__ocml_sqrt_f64");
146   patterns.add<OpToFuncCallLowering<math::TanhOp>>(converter, "__ocml_tanh_f32",
147                                                    "__ocml_tanh_f64");
148 }
149 
150 std::unique_ptr<OperationPass<gpu::GPUModuleOp>>
151 mlir::createLowerGpuOpsToROCDLOpsPass(unsigned indexBitwidth) {
152   return std::make_unique<LowerGpuOpsToROCDLOpsPass>(indexBitwidth);
153 }
154