MLIR  22.0.0git
ComplexToROCDLLibraryCalls.cpp
Go to the documentation of this file.
1 //=== ComplexToROCDLLibraryCalls.cpp - convert from Complex to ROCDL calls ===//
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 
13 #include "mlir/IR/PatternMatch.h"
14 #include "mlir/IR/TypeUtilities.h"
16 
17 namespace mlir {
18 #define GEN_PASS_DEF_CONVERTCOMPLEXTOROCDLLIBRARYCALLS
19 #include "mlir/Conversion/Passes.h.inc"
20 } // namespace mlir
21 
22 using namespace mlir;
23 
24 namespace {
25 
26 template <typename Op, typename FloatTy>
27 // Pattern to convert Complex ops to ROCDL function calls.
28 struct ComplexOpToROCDLLibraryCalls : public OpRewritePattern<Op> {
30  ComplexOpToROCDLLibraryCalls(MLIRContext *context, StringRef funcName,
31  PatternBenefit benefit = 1)
32  : OpRewritePattern<Op>(context, benefit), funcName(funcName) {}
33 
34  LogicalResult matchAndRewrite(Op op, PatternRewriter &rewriter) const final {
36  Type resType = op.getType();
37  if (auto complexType = dyn_cast<ComplexType>(resType))
38  resType = complexType.getElementType();
39  if (!isa<FloatTy>(resType))
40  return failure();
41 
42  auto opFunc = dyn_cast_or_null<SymbolOpInterface>(
43  SymbolTable::lookupSymbolIn(symTable, funcName));
44  if (!opFunc) {
45  OpBuilder::InsertionGuard guard(rewriter);
46  rewriter.setInsertionPointToStart(&symTable->getRegion(0).front());
47  auto funcTy = FunctionType::get(
48  rewriter.getContext(), op->getOperandTypes(), op->getResultTypes());
49  opFunc = func::FuncOp::create(rewriter, rewriter.getUnknownLoc(),
50  funcName, funcTy);
51  opFunc.setPrivate();
52  }
53  rewriter.replaceOpWithNewOp<func::CallOp>(op, funcName, op.getType(),
54  op->getOperands());
55  return success();
56  }
57 
58 private:
59  std::string funcName;
60 };
61 
62 // Rewrite complex.pow(z, w) -> complex.exp(w * complex.log(z))
63 struct PowOpToROCDLLibraryCalls : public OpRewritePattern<complex::PowOp> {
65 
66  LogicalResult matchAndRewrite(complex::PowOp op,
67  PatternRewriter &rewriter) const final {
68  Location loc = op.getLoc();
69  auto fastmath = op.getFastmathAttr();
70  Value logBase =
71  complex::LogOp::create(rewriter, loc, op.getLhs(), fastmath);
72  Value mul =
73  complex::MulOp::create(rewriter, loc, op.getRhs(), logBase, fastmath);
74  Value exp = complex::ExpOp::create(rewriter, loc, mul, fastmath);
75  rewriter.replaceOp(op, exp);
76  return success();
77  }
78 };
79 
80 // Rewrite complex.powi(z, n) -> complex.pow(z, complex(float(n), 0))
81 struct PowiOpToROCDLLibraryCalls : public OpRewritePattern<complex::PowiOp> {
83 
84  LogicalResult matchAndRewrite(complex::PowiOp op,
85  PatternRewriter &rewriter) const final {
86  auto complexType = cast<ComplexType>(getElementTypeOrSelf(op.getType()));
87  Type elementType = complexType.getElementType();
88 
89  Type exponentType = op.getRhs().getType();
90  Type exponentFloatType = elementType;
91  if (auto shapedType = dyn_cast<ShapedType>(exponentType))
92  exponentFloatType = shapedType.cloneWith(std::nullopt, elementType);
93 
94  Location loc = op.getLoc();
95  Value exponentReal =
96  rewriter.create<arith::SIToFPOp>(loc, exponentFloatType, op.getRhs());
97  Value zeroImag = rewriter.create<arith::ConstantOp>(
98  loc, rewriter.getZeroAttr(exponentFloatType));
99  Value exponent = rewriter.create<complex::CreateOp>(
100  loc, op.getLhs().getType(), exponentReal, zeroImag);
101 
102  rewriter.replaceOpWithNewOp<complex::PowOp>(op, op.getType(), op.getLhs(),
103  exponent, op.getFastmathAttr());
104  return success();
105  }
106 };
107 } // namespace
108 
111  patterns.add<PowiOpToROCDLLibraryCalls>(patterns.getContext());
112  patterns.add<PowOpToROCDLLibraryCalls>(patterns.getContext());
113  patterns.add<ComplexOpToROCDLLibraryCalls<complex::AbsOp, Float32Type>>(
114  patterns.getContext(), "__ocml_cabs_f32");
115  patterns.add<ComplexOpToROCDLLibraryCalls<complex::AbsOp, Float64Type>>(
116  patterns.getContext(), "__ocml_cabs_f64");
117  patterns.add<ComplexOpToROCDLLibraryCalls<complex::CosOp, Float32Type>>(
118  patterns.getContext(), "__ocml_ccos_f32");
119  patterns.add<ComplexOpToROCDLLibraryCalls<complex::CosOp, Float64Type>>(
120  patterns.getContext(), "__ocml_ccos_f64");
121  patterns.add<ComplexOpToROCDLLibraryCalls<complex::ExpOp, Float32Type>>(
122  patterns.getContext(), "__ocml_cexp_f32");
123  patterns.add<ComplexOpToROCDLLibraryCalls<complex::ExpOp, Float64Type>>(
124  patterns.getContext(), "__ocml_cexp_f64");
125  patterns.add<ComplexOpToROCDLLibraryCalls<complex::LogOp, Float32Type>>(
126  patterns.getContext(), "__ocml_clog_f32");
127  patterns.add<ComplexOpToROCDLLibraryCalls<complex::LogOp, Float64Type>>(
128  patterns.getContext(), "__ocml_clog_f64");
129  patterns.add<ComplexOpToROCDLLibraryCalls<complex::SinOp, Float32Type>>(
130  patterns.getContext(), "__ocml_csin_f32");
131  patterns.add<ComplexOpToROCDLLibraryCalls<complex::SinOp, Float64Type>>(
132  patterns.getContext(), "__ocml_csin_f64");
133  patterns.add<ComplexOpToROCDLLibraryCalls<complex::SqrtOp, Float32Type>>(
134  patterns.getContext(), "__ocml_csqrt_f32");
135  patterns.add<ComplexOpToROCDLLibraryCalls<complex::SqrtOp, Float64Type>>(
136  patterns.getContext(), "__ocml_csqrt_f64");
137  patterns.add<ComplexOpToROCDLLibraryCalls<complex::TanOp, Float32Type>>(
138  patterns.getContext(), "__ocml_ctan_f32");
139  patterns.add<ComplexOpToROCDLLibraryCalls<complex::TanOp, Float64Type>>(
140  patterns.getContext(), "__ocml_ctan_f64");
141  patterns.add<ComplexOpToROCDLLibraryCalls<complex::TanhOp, Float32Type>>(
142  patterns.getContext(), "__ocml_ctanh_f32");
143  patterns.add<ComplexOpToROCDLLibraryCalls<complex::TanhOp, Float64Type>>(
144  patterns.getContext(), "__ocml_ctanh_f64");
145 }
146 
147 namespace {
148 struct ConvertComplexToROCDLLibraryCallsPass
149  : public impl::ConvertComplexToROCDLLibraryCallsBase<
150  ConvertComplexToROCDLLibraryCallsPass> {
151  void runOnOperation() override;
152 };
153 } // namespace
154 
155 void ConvertComplexToROCDLLibraryCallsPass::runOnOperation() {
156  Operation *op = getOperation();
157 
160 
161  ConversionTarget target(getContext());
162  target.addLegalDialect<arith::ArithDialect, func::FuncDialect>();
163  target.addLegalOp<complex::CreateOp, complex::MulOp>();
164  target.addIllegalOp<complex::AbsOp, complex::CosOp, complex::ExpOp,
165  complex::LogOp, complex::PowOp, complex::PowiOp,
166  complex::SinOp, complex::SqrtOp, complex::TanOp,
167  complex::TanhOp>();
168  if (failed(applyPartialConversion(op, target, std::move(patterns))))
169  signalPassFailure();
170 }
static MLIRContext * getContext(OpFoldResult val)
MLIRContext * getContext() const
Definition: Builders.h:56
Location getUnknownLoc()
Definition: Builders.cpp:25
This class describes a specific conversion target.
This class defines the main interface for locations in MLIR and acts as a non-nullable wrapper around...
Definition: Location.h:76
MLIRContext is the top-level object for a collection of MLIR operations.
Definition: MLIRContext.h:63
RAII guard to reset the insertion point of the builder when destroyed.
Definition: Builders.h:348
void setInsertionPointToStart(Block *block)
Sets the insertion point to the start of the specified block.
Definition: Builders.h:431
This provides public APIs that all operations should have.
Operation is the basic unit of execution within MLIR.
Definition: Operation.h:88
Region & getRegion(unsigned index)
Returns the region held by this operation at position 'index'.
Definition: Operation.h:686
This class represents the benefit of a pattern match in a unitless scheme that ranges from 0 (very li...
Definition: PatternMatch.h:34
A special type of RewriterBase that coordinates the application of a rewrite pattern on the current I...
Definition: PatternMatch.h:793
Block & front()
Definition: Region.h:65
OpTy replaceOpWithNewOp(Operation *op, Args &&...args)
Replace the results of the given (original) op with a new op that is created without verification (re...
Definition: PatternMatch.h:529
static Operation * lookupSymbolIn(Operation *op, StringAttr symbol)
Returns the operation registered with the given symbol name with the regions of 'symbolTableOp'.
static Operation * getNearestSymbolTable(Operation *from)
Returns the nearest symbol table from a given operation from.
Instances of the Type class are uniqued, have an immutable identifier and an optional mutable compone...
Definition: Types.h:74
This class represents an instance of an SSA value in the MLIR system, representing a computable value...
Definition: Value.h:96
detail::InFlightRemark failed(Location loc, RemarkOpts opts)
Report an optimization remark that failed.
Definition: Remarks.h:491
Include the generated interface declarations.
void populateComplexToROCDLLibraryCallsConversionPatterns(RewritePatternSet &patterns)
Populate the given list with patterns that convert from Complex to ROCDL calls.
Type getElementTypeOrSelf(Type type)
Return the element type or return the type itself.
const FrozenRewritePatternSet & patterns
auto get(MLIRContext *context, Ts &&...params)
Helper method that injects context only if needed, this helps unify some of the attribute constructio...
LogicalResult applyPartialConversion(ArrayRef< Operation * > ops, const ConversionTarget &target, const FrozenRewritePatternSet &patterns, ConversionConfig config=ConversionConfig())
Below we define several entry points for operation conversion.
OpRewritePattern is a wrapper around RewritePattern that allows for matching and rewriting against an...
Definition: PatternMatch.h:314