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