xref: /llvm-project/mlir/lib/Conversion/GPUToROCDL/LowerGpuOpsToROCDLOps.cpp (revision 1d909c9a35713bef7badcbf17e7e75d6335c070b)
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 = {/*useBarePtrCallConv =*/false,
58                                   /*emitCWrappers =*/true,
59                                   /*indexBitwidth =*/indexBitwidth,
60                                   /*useAlignedAlloc =*/false};
61     LLVMTypeConverter converter(m.getContext(), options);
62 
63     OwningRewritePatternList patterns(m.getContext());
64     OwningRewritePatternList llvmPatterns(m.getContext());
65 
66     populateGpuRewritePatterns(patterns);
67     (void)applyPatternsAndFoldGreedily(m, std::move(patterns));
68 
69     populateVectorToLLVMConversionPatterns(converter, llvmPatterns);
70     populateVectorToROCDLConversionPatterns(converter, llvmPatterns);
71     populateStdToLLVMConversionPatterns(converter, llvmPatterns);
72     populateGpuToROCDLConversionPatterns(converter, llvmPatterns);
73     LLVMConversionTarget target(getContext());
74     configureGpuToROCDLConversionLegality(target);
75     if (failed(applyPartialConversion(m, target, std::move(llvmPatterns))))
76       signalPassFailure();
77   }
78 };
79 
80 } // anonymous namespace
81 
82 void mlir::configureGpuToROCDLConversionLegality(ConversionTarget &target) {
83   target.addIllegalOp<FuncOp>();
84   target.addLegalDialect<::mlir::LLVM::LLVMDialect>();
85   target.addLegalDialect<ROCDL::ROCDLDialect>();
86   target.addIllegalDialect<gpu::GPUDialect>();
87   target.addIllegalOp<LLVM::CosOp, LLVM::ExpOp, LLVM::FAbsOp, LLVM::FCeilOp,
88                       LLVM::FFloorOp, LLVM::LogOp, LLVM::Log10Op, LLVM::Log2Op,
89                       LLVM::PowOp, LLVM::SinOp, LLVM::SqrtOp>();
90 
91   // TODO: Remove once we support replacing non-root ops.
92   target.addLegalOp<gpu::YieldOp, gpu::GPUModuleOp, gpu::ModuleEndOp>();
93 }
94 
95 void mlir::populateGpuToROCDLConversionPatterns(
96     LLVMTypeConverter &converter, OwningRewritePatternList &patterns) {
97   populateWithGenerated(patterns);
98   patterns.insert<
99       GPUIndexIntrinsicOpLowering<gpu::ThreadIdOp, ROCDL::ThreadIdXOp,
100                                   ROCDL::ThreadIdYOp, ROCDL::ThreadIdZOp>,
101       GPUIndexIntrinsicOpLowering<gpu::BlockDimOp, ROCDL::BlockDimXOp,
102                                   ROCDL::BlockDimYOp, ROCDL::BlockDimZOp>,
103       GPUIndexIntrinsicOpLowering<gpu::BlockIdOp, ROCDL::BlockIdXOp,
104                                   ROCDL::BlockIdYOp, ROCDL::BlockIdZOp>,
105       GPUIndexIntrinsicOpLowering<gpu::GridDimOp, ROCDL::GridDimXOp,
106                                   ROCDL::GridDimYOp, ROCDL::GridDimZOp>,
107       GPUReturnOpLowering>(converter);
108   patterns.insert<GPUFuncOpLowering>(
109       converter, /*allocaAddrSpace=*/5,
110       Identifier::get(ROCDL::ROCDLDialect::getKernelFuncAttrName(),
111                       &converter.getContext()));
112   patterns.insert<OpToFuncCallLowering<AbsFOp>>(converter, "__ocml_fabs_f32",
113                                                 "__ocml_fabs_f64");
114   patterns.insert<OpToFuncCallLowering<math::AtanOp>>(
115       converter, "__ocml_atan_f32", "__ocml_atan_f64");
116   patterns.insert<OpToFuncCallLowering<math::Atan2Op>>(
117       converter, "__ocml_atan2_f32", "__ocml_atan2_f64");
118   patterns.insert<OpToFuncCallLowering<CeilFOp>>(converter, "__ocml_ceil_f32",
119                                                  "__ocml_ceil_f64");
120   patterns.insert<OpToFuncCallLowering<math::CosOp>>(
121       converter, "__ocml_cos_f32", "__ocml_cos_f64");
122   patterns.insert<OpToFuncCallLowering<math::ExpOp>>(
123       converter, "__ocml_exp_f32", "__ocml_exp_f64");
124   patterns.insert<OpToFuncCallLowering<math::ExpM1Op>>(
125       converter, "__ocml_expm1_f32", "__ocml_expm1_f64");
126   patterns.insert<OpToFuncCallLowering<FloorFOp>>(converter, "__ocml_floor_f32",
127                                                   "__ocml_floor_f64");
128   patterns.insert<OpToFuncCallLowering<math::LogOp>>(
129       converter, "__ocml_log_f32", "__ocml_log_f64");
130   patterns.insert<OpToFuncCallLowering<math::Log10Op>>(
131       converter, "__ocml_log10_f32", "__ocml_log10_f64");
132   patterns.insert<OpToFuncCallLowering<math::Log1pOp>>(
133       converter, "__ocml_log1p_f32", "__ocml_log1p_f64");
134   patterns.insert<OpToFuncCallLowering<math::Log2Op>>(
135       converter, "__ocml_log2_f32", "__ocml_log2_f64");
136   patterns.insert<OpToFuncCallLowering<math::PowFOp>>(
137       converter, "__ocml_pow_f32", "__ocml_pow_f64");
138   patterns.insert<OpToFuncCallLowering<math::RsqrtOp>>(
139       converter, "__ocml_rsqrt_f32", "__ocml_rsqrt_f64");
140   patterns.insert<OpToFuncCallLowering<math::SinOp>>(
141       converter, "__ocml_sin_f32", "__ocml_sin_f64");
142   patterns.insert<OpToFuncCallLowering<math::SqrtOp>>(
143       converter, "__ocml_sqrt_f32", "__ocml_sqrt_f64");
144   patterns.insert<OpToFuncCallLowering<math::TanhOp>>(
145       converter, "__ocml_tanh_f32", "__ocml_tanh_f64");
146 }
147 
148 std::unique_ptr<OperationPass<gpu::GPUModuleOp>>
149 mlir::createLowerGpuOpsToROCDLOpsPass(unsigned indexBitwidth) {
150   return std::make_unique<LowerGpuOpsToROCDLOpsPass>(indexBitwidth);
151 }
152