15c0c51a9SNicolas Vasilache //===- VectorToLLVM.cpp - Conversion from Vector to the LLVM dialect ------===//
25c0c51a9SNicolas Vasilache //
330857107SMehdi Amini // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
456222a06SMehdi Amini // See https://llvm.org/LICENSE.txt for license information.
556222a06SMehdi Amini // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
65c0c51a9SNicolas Vasilache //
756222a06SMehdi Amini //===----------------------------------------------------------------------===//
85c0c51a9SNicolas Vasilache 
965678d93SNicolas Vasilache #include "mlir/Conversion/VectorToLLVM/ConvertVectorToLLVM.h"
10870c1fd4SAlex Zinenko 
111834ad4aSRiver Riddle #include "../PassDetail.h"
125c0c51a9SNicolas Vasilache #include "mlir/Conversion/StandardToLLVM/ConvertStandardToLLVM.h"
135c0c51a9SNicolas Vasilache #include "mlir/Conversion/StandardToLLVM/ConvertStandardToLLVMPass.h"
145c0c51a9SNicolas Vasilache #include "mlir/Dialect/LLVMIR/LLVMDialect.h"
1569d757c0SRob Suderman #include "mlir/Dialect/StandardOps/IR/Ops.h"
164d60f47bSRob Suderman #include "mlir/Dialect/Vector/VectorOps.h"
175c0c51a9SNicolas Vasilache #include "mlir/IR/Attributes.h"
185c0c51a9SNicolas Vasilache #include "mlir/IR/Builders.h"
195c0c51a9SNicolas Vasilache #include "mlir/IR/MLIRContext.h"
205c0c51a9SNicolas Vasilache #include "mlir/IR/Module.h"
215c0c51a9SNicolas Vasilache #include "mlir/IR/Operation.h"
225c0c51a9SNicolas Vasilache #include "mlir/IR/PatternMatch.h"
235c0c51a9SNicolas Vasilache #include "mlir/IR/StandardTypes.h"
245c0c51a9SNicolas Vasilache #include "mlir/IR/Types.h"
255c0c51a9SNicolas Vasilache #include "mlir/Transforms/DialectConversion.h"
265c0c51a9SNicolas Vasilache #include "mlir/Transforms/Passes.h"
275c0c51a9SNicolas Vasilache #include "llvm/IR/DerivedTypes.h"
285c0c51a9SNicolas Vasilache #include "llvm/IR/Module.h"
295c0c51a9SNicolas Vasilache #include "llvm/IR/Type.h"
305c0c51a9SNicolas Vasilache #include "llvm/Support/Allocator.h"
315c0c51a9SNicolas Vasilache #include "llvm/Support/ErrorHandling.h"
325c0c51a9SNicolas Vasilache 
335c0c51a9SNicolas Vasilache using namespace mlir;
3465678d93SNicolas Vasilache using namespace mlir::vector;
355c0c51a9SNicolas Vasilache 
365c0c51a9SNicolas Vasilache template <typename T>
375c0c51a9SNicolas Vasilache static LLVM::LLVMType getPtrToElementType(T containerType,
380f04384dSAlex Zinenko                                           LLVMTypeConverter &typeConverter) {
390f04384dSAlex Zinenko   return typeConverter.convertType(containerType.getElementType())
405c0c51a9SNicolas Vasilache       .template cast<LLVM::LLVMType>()
415c0c51a9SNicolas Vasilache       .getPointerTo();
425c0c51a9SNicolas Vasilache }
435c0c51a9SNicolas Vasilache 
449826fe5cSAart Bik // Helper to reduce vector type by one rank at front.
459826fe5cSAart Bik static VectorType reducedVectorTypeFront(VectorType tp) {
469826fe5cSAart Bik   assert((tp.getRank() > 1) && "unlowerable vector type");
479826fe5cSAart Bik   return VectorType::get(tp.getShape().drop_front(), tp.getElementType());
489826fe5cSAart Bik }
499826fe5cSAart Bik 
509826fe5cSAart Bik // Helper to reduce vector type by *all* but one rank at back.
519826fe5cSAart Bik static VectorType reducedVectorTypeBack(VectorType tp) {
529826fe5cSAart Bik   assert((tp.getRank() > 1) && "unlowerable vector type");
539826fe5cSAart Bik   return VectorType::get(tp.getShape().take_back(), tp.getElementType());
549826fe5cSAart Bik }
559826fe5cSAart Bik 
561c81adf3SAart Bik // Helper that picks the proper sequence for inserting.
57e62a6956SRiver Riddle static Value insertOne(ConversionPatternRewriter &rewriter,
580f04384dSAlex Zinenko                        LLVMTypeConverter &typeConverter, Location loc,
590f04384dSAlex Zinenko                        Value val1, Value val2, Type llvmType, int64_t rank,
600f04384dSAlex Zinenko                        int64_t pos) {
611c81adf3SAart Bik   if (rank == 1) {
621c81adf3SAart Bik     auto idxType = rewriter.getIndexType();
631c81adf3SAart Bik     auto constant = rewriter.create<LLVM::ConstantOp>(
640f04384dSAlex Zinenko         loc, typeConverter.convertType(idxType),
651c81adf3SAart Bik         rewriter.getIntegerAttr(idxType, pos));
661c81adf3SAart Bik     return rewriter.create<LLVM::InsertElementOp>(loc, llvmType, val1, val2,
671c81adf3SAart Bik                                                   constant);
681c81adf3SAart Bik   }
691c81adf3SAart Bik   return rewriter.create<LLVM::InsertValueOp>(loc, llvmType, val1, val2,
701c81adf3SAart Bik                                               rewriter.getI64ArrayAttr(pos));
711c81adf3SAart Bik }
721c81adf3SAart Bik 
732d515e49SNicolas Vasilache // Helper that picks the proper sequence for inserting.
742d515e49SNicolas Vasilache static Value insertOne(PatternRewriter &rewriter, Location loc, Value from,
752d515e49SNicolas Vasilache                        Value into, int64_t offset) {
762d515e49SNicolas Vasilache   auto vectorType = into.getType().cast<VectorType>();
772d515e49SNicolas Vasilache   if (vectorType.getRank() > 1)
782d515e49SNicolas Vasilache     return rewriter.create<InsertOp>(loc, from, into, offset);
792d515e49SNicolas Vasilache   return rewriter.create<vector::InsertElementOp>(
802d515e49SNicolas Vasilache       loc, vectorType, from, into,
812d515e49SNicolas Vasilache       rewriter.create<ConstantIndexOp>(loc, offset));
822d515e49SNicolas Vasilache }
832d515e49SNicolas Vasilache 
841c81adf3SAart Bik // Helper that picks the proper sequence for extracting.
85e62a6956SRiver Riddle static Value extractOne(ConversionPatternRewriter &rewriter,
860f04384dSAlex Zinenko                         LLVMTypeConverter &typeConverter, Location loc,
870f04384dSAlex Zinenko                         Value val, Type llvmType, int64_t rank, int64_t pos) {
881c81adf3SAart Bik   if (rank == 1) {
891c81adf3SAart Bik     auto idxType = rewriter.getIndexType();
901c81adf3SAart Bik     auto constant = rewriter.create<LLVM::ConstantOp>(
910f04384dSAlex Zinenko         loc, typeConverter.convertType(idxType),
921c81adf3SAart Bik         rewriter.getIntegerAttr(idxType, pos));
931c81adf3SAart Bik     return rewriter.create<LLVM::ExtractElementOp>(loc, llvmType, val,
941c81adf3SAart Bik                                                    constant);
951c81adf3SAart Bik   }
961c81adf3SAart Bik   return rewriter.create<LLVM::ExtractValueOp>(loc, llvmType, val,
971c81adf3SAart Bik                                                rewriter.getI64ArrayAttr(pos));
981c81adf3SAart Bik }
991c81adf3SAart Bik 
1002d515e49SNicolas Vasilache // Helper that picks the proper sequence for extracting.
1012d515e49SNicolas Vasilache static Value extractOne(PatternRewriter &rewriter, Location loc, Value vector,
1022d515e49SNicolas Vasilache                         int64_t offset) {
1032d515e49SNicolas Vasilache   auto vectorType = vector.getType().cast<VectorType>();
1042d515e49SNicolas Vasilache   if (vectorType.getRank() > 1)
1052d515e49SNicolas Vasilache     return rewriter.create<ExtractOp>(loc, vector, offset);
1062d515e49SNicolas Vasilache   return rewriter.create<vector::ExtractElementOp>(
1072d515e49SNicolas Vasilache       loc, vectorType.getElementType(), vector,
1082d515e49SNicolas Vasilache       rewriter.create<ConstantIndexOp>(loc, offset));
1092d515e49SNicolas Vasilache }
1102d515e49SNicolas Vasilache 
1112d515e49SNicolas Vasilache // Helper that returns a subset of `arrayAttr` as a vector of int64_t.
1122d515e49SNicolas Vasilache // TODO(rriddle): Better support for attribute subtype forwarding + slicing.
1132d515e49SNicolas Vasilache static SmallVector<int64_t, 4> getI64SubArray(ArrayAttr arrayAttr,
1142d515e49SNicolas Vasilache                                               unsigned dropFront = 0,
1152d515e49SNicolas Vasilache                                               unsigned dropBack = 0) {
1162d515e49SNicolas Vasilache   assert(arrayAttr.size() > dropFront + dropBack && "Out of bounds");
1172d515e49SNicolas Vasilache   auto range = arrayAttr.getAsRange<IntegerAttr>();
1182d515e49SNicolas Vasilache   SmallVector<int64_t, 4> res;
1192d515e49SNicolas Vasilache   res.reserve(arrayAttr.size() - dropFront - dropBack);
1202d515e49SNicolas Vasilache   for (auto it = range.begin() + dropFront, eit = range.end() - dropBack;
1212d515e49SNicolas Vasilache        it != eit; ++it)
1222d515e49SNicolas Vasilache     res.push_back((*it).getValue().getSExtValue());
1232d515e49SNicolas Vasilache   return res;
1242d515e49SNicolas Vasilache }
1252d515e49SNicolas Vasilache 
12690c01357SBenjamin Kramer namespace {
127e83b7b99Saartbik 
128870c1fd4SAlex Zinenko class VectorBroadcastOpConversion : public ConvertToLLVMPattern {
129b36aaeafSAart Bik public:
130b36aaeafSAart Bik   explicit VectorBroadcastOpConversion(MLIRContext *context,
131b36aaeafSAart Bik                                        LLVMTypeConverter &typeConverter)
132870c1fd4SAlex Zinenko       : ConvertToLLVMPattern(vector::BroadcastOp::getOperationName(), context,
133b36aaeafSAart Bik                              typeConverter) {}
134b36aaeafSAart Bik 
1353145427dSRiver Riddle   LogicalResult
136e62a6956SRiver Riddle   matchAndRewrite(Operation *op, ArrayRef<Value> operands,
137b36aaeafSAart Bik                   ConversionPatternRewriter &rewriter) const override {
138b36aaeafSAart Bik     auto broadcastOp = cast<vector::BroadcastOp>(op);
139b36aaeafSAart Bik     VectorType dstVectorType = broadcastOp.getVectorType();
1400f04384dSAlex Zinenko     if (typeConverter.convertType(dstVectorType) == nullptr)
1413145427dSRiver Riddle       return failure();
142b36aaeafSAart Bik     // Rewrite when the full vector type can be lowered (which
143b36aaeafSAart Bik     // implies all 'reduced' types can be lowered too).
1441c81adf3SAart Bik     auto adaptor = vector::BroadcastOpOperandAdaptor(operands);
145b36aaeafSAart Bik     VectorType srcVectorType =
146b36aaeafSAart Bik         broadcastOp.getSourceType().dyn_cast<VectorType>();
147b36aaeafSAart Bik     rewriter.replaceOp(
1481c81adf3SAart Bik         op, expandRanks(adaptor.source(), // source value to be expanded
149b36aaeafSAart Bik                         op->getLoc(),     // location of original broadcast
150b36aaeafSAart Bik                         srcVectorType, dstVectorType, rewriter));
1513145427dSRiver Riddle     return success();
152b36aaeafSAart Bik   }
153b36aaeafSAart Bik 
154b36aaeafSAart Bik private:
155b36aaeafSAart Bik   // Expands the given source value over all the ranks, as defined
156b36aaeafSAart Bik   // by the source and destination type (a null source type denotes
157b36aaeafSAart Bik   // expansion from a scalar value into a vector).
158b36aaeafSAart Bik   //
159b36aaeafSAart Bik   // TODO(ajcbik): consider replacing this one-pattern lowering
160b36aaeafSAart Bik   //               with a two-pattern lowering using other vector
161b36aaeafSAart Bik   //               ops once all insert/extract/shuffle operations
162fc817b09SKazuaki Ishizaki   //               are available with lowering implementation.
163b36aaeafSAart Bik   //
164e62a6956SRiver Riddle   Value expandRanks(Value value, Location loc, VectorType srcVectorType,
165b36aaeafSAart Bik                     VectorType dstVectorType,
166b36aaeafSAart Bik                     ConversionPatternRewriter &rewriter) const {
167b36aaeafSAart Bik     assert((dstVectorType != nullptr) && "invalid result type in broadcast");
168b36aaeafSAart Bik     // Determine rank of source and destination.
169b36aaeafSAart Bik     int64_t srcRank = srcVectorType ? srcVectorType.getRank() : 0;
170b36aaeafSAart Bik     int64_t dstRank = dstVectorType.getRank();
171b36aaeafSAart Bik     int64_t curDim = dstVectorType.getDimSize(0);
172b36aaeafSAart Bik     if (srcRank < dstRank)
173b36aaeafSAart Bik       // Duplicate this rank.
174b36aaeafSAart Bik       return duplicateOneRank(value, loc, srcVectorType, dstVectorType, dstRank,
175b36aaeafSAart Bik                               curDim, rewriter);
176b36aaeafSAart Bik     // If all trailing dimensions are the same, the broadcast consists of
177b36aaeafSAart Bik     // simply passing through the source value and we are done. Otherwise,
178b36aaeafSAart Bik     // any non-matching dimension forces a stretch along this rank.
179b36aaeafSAart Bik     assert((srcVectorType != nullptr) && (srcRank > 0) &&
180b36aaeafSAart Bik            (srcRank == dstRank) && "invalid rank in broadcast");
181b36aaeafSAart Bik     for (int64_t r = 0; r < dstRank; r++) {
182b36aaeafSAart Bik       if (srcVectorType.getDimSize(r) != dstVectorType.getDimSize(r)) {
183b36aaeafSAart Bik         return stretchOneRank(value, loc, srcVectorType, dstVectorType, dstRank,
184b36aaeafSAart Bik                               curDim, rewriter);
185b36aaeafSAart Bik       }
186b36aaeafSAart Bik     }
187b36aaeafSAart Bik     return value;
188b36aaeafSAart Bik   }
189b36aaeafSAart Bik 
190b36aaeafSAart Bik   // Picks the best way to duplicate a single rank. For the 1-D case, a
191b36aaeafSAart Bik   // single insert-elt/shuffle is the most efficient expansion. For higher
192b36aaeafSAart Bik   // dimensions, however, we need dim x insert-values on a new broadcast
193b36aaeafSAart Bik   // with one less leading dimension, which will be lowered "recursively"
194b36aaeafSAart Bik   // to matching LLVM IR.
195b36aaeafSAart Bik   // For example:
196b36aaeafSAart Bik   //   v = broadcast s : f32 to vector<4x2xf32>
197b36aaeafSAart Bik   // becomes:
198b36aaeafSAart Bik   //   x = broadcast s : f32 to vector<2xf32>
199b36aaeafSAart Bik   //   v = [x,x,x,x]
200b36aaeafSAart Bik   // becomes:
201b36aaeafSAart Bik   //   x = [s,s]
202b36aaeafSAart Bik   //   v = [x,x,x,x]
203e62a6956SRiver Riddle   Value duplicateOneRank(Value value, Location loc, VectorType srcVectorType,
204e62a6956SRiver Riddle                          VectorType dstVectorType, int64_t rank, int64_t dim,
205b36aaeafSAart Bik                          ConversionPatternRewriter &rewriter) const {
2060f04384dSAlex Zinenko     Type llvmType = typeConverter.convertType(dstVectorType);
207b36aaeafSAart Bik     assert((llvmType != nullptr) && "unlowerable vector type");
208b36aaeafSAart Bik     if (rank == 1) {
209e62a6956SRiver Riddle       Value undef = rewriter.create<LLVM::UndefOp>(loc, llvmType);
2100f04384dSAlex Zinenko       Value expand = insertOne(rewriter, typeConverter, loc, undef, value,
2110f04384dSAlex Zinenko                                llvmType, rank, 0);
212b36aaeafSAart Bik       SmallVector<int32_t, 4> zeroValues(dim, 0);
213b36aaeafSAart Bik       return rewriter.create<LLVM::ShuffleVectorOp>(
214b36aaeafSAart Bik           loc, expand, undef, rewriter.getI32ArrayAttr(zeroValues));
215b36aaeafSAart Bik     }
216e62a6956SRiver Riddle     Value expand = expandRanks(value, loc, srcVectorType,
2179826fe5cSAart Bik                                reducedVectorTypeFront(dstVectorType), rewriter);
218e62a6956SRiver Riddle     Value result = rewriter.create<LLVM::UndefOp>(loc, llvmType);
219b36aaeafSAart Bik     for (int64_t d = 0; d < dim; ++d) {
2200f04384dSAlex Zinenko       result = insertOne(rewriter, typeConverter, loc, result, expand, llvmType,
2210f04384dSAlex Zinenko                          rank, d);
222b36aaeafSAart Bik     }
223b36aaeafSAart Bik     return result;
224b36aaeafSAart Bik   }
225b36aaeafSAart Bik 
226b36aaeafSAart Bik   // Picks the best way to stretch a single rank. For the 1-D case, a
227b36aaeafSAart Bik   // single insert-elt/shuffle is the most efficient expansion when at
228b36aaeafSAart Bik   // a stretch. Otherwise, every dimension needs to be expanded
229b36aaeafSAart Bik   // individually and individually inserted in the resulting vector.
230b36aaeafSAart Bik   // For example:
231b36aaeafSAart Bik   //   v = broadcast w : vector<4x1x2xf32> to vector<4x2x2xf32>
232b36aaeafSAart Bik   // becomes:
233b36aaeafSAart Bik   //   a = broadcast w[0] : vector<1x2xf32> to vector<2x2xf32>
234b36aaeafSAart Bik   //   b = broadcast w[1] : vector<1x2xf32> to vector<2x2xf32>
235b36aaeafSAart Bik   //   c = broadcast w[2] : vector<1x2xf32> to vector<2x2xf32>
236b36aaeafSAart Bik   //   d = broadcast w[3] : vector<1x2xf32> to vector<2x2xf32>
237b36aaeafSAart Bik   //   v = [a,b,c,d]
238b36aaeafSAart Bik   // becomes:
239b36aaeafSAart Bik   //   x = broadcast w[0][0] : vector<2xf32> to vector <2x2xf32>
240b36aaeafSAart Bik   //   y = broadcast w[1][0] : vector<2xf32> to vector <2x2xf32>
241b36aaeafSAart Bik   //   a = [x, y]
242b36aaeafSAart Bik   //   etc.
243e62a6956SRiver Riddle   Value stretchOneRank(Value value, Location loc, VectorType srcVectorType,
244e62a6956SRiver Riddle                        VectorType dstVectorType, int64_t rank, int64_t dim,
245b36aaeafSAart Bik                        ConversionPatternRewriter &rewriter) const {
2460f04384dSAlex Zinenko     Type llvmType = typeConverter.convertType(dstVectorType);
247b36aaeafSAart Bik     assert((llvmType != nullptr) && "unlowerable vector type");
248e62a6956SRiver Riddle     Value result = rewriter.create<LLVM::UndefOp>(loc, llvmType);
249b36aaeafSAart Bik     bool atStretch = dim != srcVectorType.getDimSize(0);
250b36aaeafSAart Bik     if (rank == 1) {
2511c81adf3SAart Bik       assert(atStretch);
2520f04384dSAlex Zinenko       Type redLlvmType =
2530f04384dSAlex Zinenko           typeConverter.convertType(dstVectorType.getElementType());
254e62a6956SRiver Riddle       Value one =
2550f04384dSAlex Zinenko           extractOne(rewriter, typeConverter, loc, value, redLlvmType, rank, 0);
2560f04384dSAlex Zinenko       Value expand = insertOne(rewriter, typeConverter, loc, result, one,
2570f04384dSAlex Zinenko                                llvmType, rank, 0);
258b36aaeafSAart Bik       SmallVector<int32_t, 4> zeroValues(dim, 0);
259b36aaeafSAart Bik       return rewriter.create<LLVM::ShuffleVectorOp>(
260b36aaeafSAart Bik           loc, expand, result, rewriter.getI32ArrayAttr(zeroValues));
261b36aaeafSAart Bik     }
2629826fe5cSAart Bik     VectorType redSrcType = reducedVectorTypeFront(srcVectorType);
2639826fe5cSAart Bik     VectorType redDstType = reducedVectorTypeFront(dstVectorType);
2640f04384dSAlex Zinenko     Type redLlvmType = typeConverter.convertType(redSrcType);
265b36aaeafSAart Bik     for (int64_t d = 0; d < dim; ++d) {
266b36aaeafSAart Bik       int64_t pos = atStretch ? 0 : d;
2670f04384dSAlex Zinenko       Value one = extractOne(rewriter, typeConverter, loc, value, redLlvmType,
2680f04384dSAlex Zinenko                              rank, pos);
269e62a6956SRiver Riddle       Value expand = expandRanks(one, loc, redSrcType, redDstType, rewriter);
2700f04384dSAlex Zinenko       result = insertOne(rewriter, typeConverter, loc, result, expand, llvmType,
2710f04384dSAlex Zinenko                          rank, d);
272b36aaeafSAart Bik     }
273b36aaeafSAart Bik     return result;
274b36aaeafSAart Bik   }
2751c81adf3SAart Bik };
276b36aaeafSAart Bik 
27763b683a8SNicolas Vasilache /// Conversion pattern for a vector.matrix_multiply.
27863b683a8SNicolas Vasilache /// This is lowered directly to the proper llvm.intr.matrix.multiply.
27963b683a8SNicolas Vasilache class VectorMatmulOpConversion : public ConvertToLLVMPattern {
28063b683a8SNicolas Vasilache public:
28163b683a8SNicolas Vasilache   explicit VectorMatmulOpConversion(MLIRContext *context,
28263b683a8SNicolas Vasilache                                     LLVMTypeConverter &typeConverter)
28363b683a8SNicolas Vasilache       : ConvertToLLVMPattern(vector::MatmulOp::getOperationName(), context,
28463b683a8SNicolas Vasilache                              typeConverter) {}
28563b683a8SNicolas Vasilache 
2863145427dSRiver Riddle   LogicalResult
28763b683a8SNicolas Vasilache   matchAndRewrite(Operation *op, ArrayRef<Value> operands,
28863b683a8SNicolas Vasilache                   ConversionPatternRewriter &rewriter) const override {
28963b683a8SNicolas Vasilache     auto matmulOp = cast<vector::MatmulOp>(op);
29063b683a8SNicolas Vasilache     auto adaptor = vector::MatmulOpOperandAdaptor(operands);
29163b683a8SNicolas Vasilache     rewriter.replaceOpWithNewOp<LLVM::MatrixMultiplyOp>(
29263b683a8SNicolas Vasilache         op, typeConverter.convertType(matmulOp.res().getType()), adaptor.lhs(),
29363b683a8SNicolas Vasilache         adaptor.rhs(), matmulOp.lhs_rows(), matmulOp.lhs_columns(),
29463b683a8SNicolas Vasilache         matmulOp.rhs_columns());
2953145427dSRiver Riddle     return success();
29663b683a8SNicolas Vasilache   }
29763b683a8SNicolas Vasilache };
29863b683a8SNicolas Vasilache 
299870c1fd4SAlex Zinenko class VectorReductionOpConversion : public ConvertToLLVMPattern {
300e83b7b99Saartbik public:
301e83b7b99Saartbik   explicit VectorReductionOpConversion(MLIRContext *context,
302e83b7b99Saartbik                                        LLVMTypeConverter &typeConverter)
303870c1fd4SAlex Zinenko       : ConvertToLLVMPattern(vector::ReductionOp::getOperationName(), context,
304e83b7b99Saartbik                              typeConverter) {}
305e83b7b99Saartbik 
3063145427dSRiver Riddle   LogicalResult
307e83b7b99Saartbik   matchAndRewrite(Operation *op, ArrayRef<Value> operands,
308e83b7b99Saartbik                   ConversionPatternRewriter &rewriter) const override {
309e83b7b99Saartbik     auto reductionOp = cast<vector::ReductionOp>(op);
310e83b7b99Saartbik     auto kind = reductionOp.kind();
311e83b7b99Saartbik     Type eltType = reductionOp.dest().getType();
3120f04384dSAlex Zinenko     Type llvmType = typeConverter.convertType(eltType);
31335b68527SLei Zhang     if (eltType.isSignlessInteger(32) || eltType.isSignlessInteger(64)) {
314e83b7b99Saartbik       // Integer reductions: add/mul/min/max/and/or/xor.
315e83b7b99Saartbik       if (kind == "add")
316e83b7b99Saartbik         rewriter.replaceOpWithNewOp<LLVM::experimental_vector_reduce_add>(
317e83b7b99Saartbik             op, llvmType, operands[0]);
318e83b7b99Saartbik       else if (kind == "mul")
319e83b7b99Saartbik         rewriter.replaceOpWithNewOp<LLVM::experimental_vector_reduce_mul>(
320e83b7b99Saartbik             op, llvmType, operands[0]);
321e83b7b99Saartbik       else if (kind == "min")
322e83b7b99Saartbik         rewriter.replaceOpWithNewOp<LLVM::experimental_vector_reduce_smin>(
323e83b7b99Saartbik             op, llvmType, operands[0]);
324e83b7b99Saartbik       else if (kind == "max")
325e83b7b99Saartbik         rewriter.replaceOpWithNewOp<LLVM::experimental_vector_reduce_smax>(
326e83b7b99Saartbik             op, llvmType, operands[0]);
327e83b7b99Saartbik       else if (kind == "and")
328e83b7b99Saartbik         rewriter.replaceOpWithNewOp<LLVM::experimental_vector_reduce_and>(
329e83b7b99Saartbik             op, llvmType, operands[0]);
330e83b7b99Saartbik       else if (kind == "or")
331e83b7b99Saartbik         rewriter.replaceOpWithNewOp<LLVM::experimental_vector_reduce_or>(
332e83b7b99Saartbik             op, llvmType, operands[0]);
333e83b7b99Saartbik       else if (kind == "xor")
334e83b7b99Saartbik         rewriter.replaceOpWithNewOp<LLVM::experimental_vector_reduce_xor>(
335e83b7b99Saartbik             op, llvmType, operands[0]);
336e83b7b99Saartbik       else
3373145427dSRiver Riddle         return failure();
3383145427dSRiver Riddle       return success();
339e83b7b99Saartbik 
340e83b7b99Saartbik     } else if (eltType.isF32() || eltType.isF64()) {
341e83b7b99Saartbik       // Floating-point reductions: add/mul/min/max
342e83b7b99Saartbik       if (kind == "add") {
3430d924700Saartbik         // Optional accumulator (or zero).
3440d924700Saartbik         Value acc = operands.size() > 1 ? operands[1]
3450d924700Saartbik                                         : rewriter.create<LLVM::ConstantOp>(
3460d924700Saartbik                                               op->getLoc(), llvmType,
3470d924700Saartbik                                               rewriter.getZeroAttr(eltType));
348e83b7b99Saartbik         rewriter.replaceOpWithNewOp<LLVM::experimental_vector_reduce_v2_fadd>(
3490d924700Saartbik             op, llvmType, acc, operands[0]);
350e83b7b99Saartbik       } else if (kind == "mul") {
3510d924700Saartbik         // Optional accumulator (or one).
3520d924700Saartbik         Value acc = operands.size() > 1
3530d924700Saartbik                         ? operands[1]
3540d924700Saartbik                         : rewriter.create<LLVM::ConstantOp>(
3550d924700Saartbik                               op->getLoc(), llvmType,
3560d924700Saartbik                               rewriter.getFloatAttr(eltType, 1.0));
357e83b7b99Saartbik         rewriter.replaceOpWithNewOp<LLVM::experimental_vector_reduce_v2_fmul>(
3580d924700Saartbik             op, llvmType, acc, operands[0]);
359e83b7b99Saartbik       } else if (kind == "min")
360e83b7b99Saartbik         rewriter.replaceOpWithNewOp<LLVM::experimental_vector_reduce_fmin>(
361e83b7b99Saartbik             op, llvmType, operands[0]);
362e83b7b99Saartbik       else if (kind == "max")
363e83b7b99Saartbik         rewriter.replaceOpWithNewOp<LLVM::experimental_vector_reduce_fmax>(
364e83b7b99Saartbik             op, llvmType, operands[0]);
365e83b7b99Saartbik       else
3663145427dSRiver Riddle         return failure();
3673145427dSRiver Riddle       return success();
368e83b7b99Saartbik     }
3693145427dSRiver Riddle     return failure();
370e83b7b99Saartbik   }
371e83b7b99Saartbik };
372e83b7b99Saartbik 
373870c1fd4SAlex Zinenko class VectorShuffleOpConversion : public ConvertToLLVMPattern {
3741c81adf3SAart Bik public:
3751c81adf3SAart Bik   explicit VectorShuffleOpConversion(MLIRContext *context,
3761c81adf3SAart Bik                                      LLVMTypeConverter &typeConverter)
377870c1fd4SAlex Zinenko       : ConvertToLLVMPattern(vector::ShuffleOp::getOperationName(), context,
3781c81adf3SAart Bik                              typeConverter) {}
3791c81adf3SAart Bik 
3803145427dSRiver Riddle   LogicalResult
381e62a6956SRiver Riddle   matchAndRewrite(Operation *op, ArrayRef<Value> operands,
3821c81adf3SAart Bik                   ConversionPatternRewriter &rewriter) const override {
3831c81adf3SAart Bik     auto loc = op->getLoc();
3841c81adf3SAart Bik     auto adaptor = vector::ShuffleOpOperandAdaptor(operands);
3851c81adf3SAart Bik     auto shuffleOp = cast<vector::ShuffleOp>(op);
3861c81adf3SAart Bik     auto v1Type = shuffleOp.getV1VectorType();
3871c81adf3SAart Bik     auto v2Type = shuffleOp.getV2VectorType();
3881c81adf3SAart Bik     auto vectorType = shuffleOp.getVectorType();
3890f04384dSAlex Zinenko     Type llvmType = typeConverter.convertType(vectorType);
3901c81adf3SAart Bik     auto maskArrayAttr = shuffleOp.mask();
3911c81adf3SAart Bik 
3921c81adf3SAart Bik     // Bail if result type cannot be lowered.
3931c81adf3SAart Bik     if (!llvmType)
3943145427dSRiver Riddle       return failure();
3951c81adf3SAart Bik 
3961c81adf3SAart Bik     // Get rank and dimension sizes.
3971c81adf3SAart Bik     int64_t rank = vectorType.getRank();
3981c81adf3SAart Bik     assert(v1Type.getRank() == rank);
3991c81adf3SAart Bik     assert(v2Type.getRank() == rank);
4001c81adf3SAart Bik     int64_t v1Dim = v1Type.getDimSize(0);
4011c81adf3SAart Bik 
4021c81adf3SAart Bik     // For rank 1, where both operands have *exactly* the same vector type,
4031c81adf3SAart Bik     // there is direct shuffle support in LLVM. Use it!
4041c81adf3SAart Bik     if (rank == 1 && v1Type == v2Type) {
405e62a6956SRiver Riddle       Value shuffle = rewriter.create<LLVM::ShuffleVectorOp>(
4061c81adf3SAart Bik           loc, adaptor.v1(), adaptor.v2(), maskArrayAttr);
4071c81adf3SAart Bik       rewriter.replaceOp(op, shuffle);
4083145427dSRiver Riddle       return success();
409b36aaeafSAart Bik     }
410b36aaeafSAart Bik 
4111c81adf3SAart Bik     // For all other cases, insert the individual values individually.
412e62a6956SRiver Riddle     Value insert = rewriter.create<LLVM::UndefOp>(loc, llvmType);
4131c81adf3SAart Bik     int64_t insPos = 0;
4141c81adf3SAart Bik     for (auto en : llvm::enumerate(maskArrayAttr)) {
4151c81adf3SAart Bik       int64_t extPos = en.value().cast<IntegerAttr>().getInt();
416e62a6956SRiver Riddle       Value value = adaptor.v1();
4171c81adf3SAart Bik       if (extPos >= v1Dim) {
4181c81adf3SAart Bik         extPos -= v1Dim;
4191c81adf3SAart Bik         value = adaptor.v2();
420b36aaeafSAart Bik       }
4210f04384dSAlex Zinenko       Value extract = extractOne(rewriter, typeConverter, loc, value, llvmType,
4220f04384dSAlex Zinenko                                  rank, extPos);
4230f04384dSAlex Zinenko       insert = insertOne(rewriter, typeConverter, loc, insert, extract,
4240f04384dSAlex Zinenko                          llvmType, rank, insPos++);
4251c81adf3SAart Bik     }
4261c81adf3SAart Bik     rewriter.replaceOp(op, insert);
4273145427dSRiver Riddle     return success();
428b36aaeafSAart Bik   }
429b36aaeafSAart Bik };
430b36aaeafSAart Bik 
431870c1fd4SAlex Zinenko class VectorExtractElementOpConversion : public ConvertToLLVMPattern {
432cd5dab8aSAart Bik public:
433cd5dab8aSAart Bik   explicit VectorExtractElementOpConversion(MLIRContext *context,
434cd5dab8aSAart Bik                                             LLVMTypeConverter &typeConverter)
435870c1fd4SAlex Zinenko       : ConvertToLLVMPattern(vector::ExtractElementOp::getOperationName(),
436870c1fd4SAlex Zinenko                              context, typeConverter) {}
437cd5dab8aSAart Bik 
4383145427dSRiver Riddle   LogicalResult
439e62a6956SRiver Riddle   matchAndRewrite(Operation *op, ArrayRef<Value> operands,
440cd5dab8aSAart Bik                   ConversionPatternRewriter &rewriter) const override {
441cd5dab8aSAart Bik     auto adaptor = vector::ExtractElementOpOperandAdaptor(operands);
442cd5dab8aSAart Bik     auto extractEltOp = cast<vector::ExtractElementOp>(op);
443cd5dab8aSAart Bik     auto vectorType = extractEltOp.getVectorType();
4440f04384dSAlex Zinenko     auto llvmType = typeConverter.convertType(vectorType.getElementType());
445cd5dab8aSAart Bik 
446cd5dab8aSAart Bik     // Bail if result type cannot be lowered.
447cd5dab8aSAart Bik     if (!llvmType)
4483145427dSRiver Riddle       return failure();
449cd5dab8aSAart Bik 
450cd5dab8aSAart Bik     rewriter.replaceOpWithNewOp<LLVM::ExtractElementOp>(
451cd5dab8aSAart Bik         op, llvmType, adaptor.vector(), adaptor.position());
4523145427dSRiver Riddle     return success();
453cd5dab8aSAart Bik   }
454cd5dab8aSAart Bik };
455cd5dab8aSAart Bik 
456870c1fd4SAlex Zinenko class VectorExtractOpConversion : public ConvertToLLVMPattern {
4575c0c51a9SNicolas Vasilache public:
4589826fe5cSAart Bik   explicit VectorExtractOpConversion(MLIRContext *context,
4595c0c51a9SNicolas Vasilache                                      LLVMTypeConverter &typeConverter)
460870c1fd4SAlex Zinenko       : ConvertToLLVMPattern(vector::ExtractOp::getOperationName(), context,
4615c0c51a9SNicolas Vasilache                              typeConverter) {}
4625c0c51a9SNicolas Vasilache 
4633145427dSRiver Riddle   LogicalResult
464e62a6956SRiver Riddle   matchAndRewrite(Operation *op, ArrayRef<Value> operands,
4655c0c51a9SNicolas Vasilache                   ConversionPatternRewriter &rewriter) const override {
4665c0c51a9SNicolas Vasilache     auto loc = op->getLoc();
467d37f2725SAart Bik     auto adaptor = vector::ExtractOpOperandAdaptor(operands);
468d37f2725SAart Bik     auto extractOp = cast<vector::ExtractOp>(op);
4699826fe5cSAart Bik     auto vectorType = extractOp.getVectorType();
4702bdf33ccSRiver Riddle     auto resultType = extractOp.getResult().getType();
4710f04384dSAlex Zinenko     auto llvmResultType = typeConverter.convertType(resultType);
4725c0c51a9SNicolas Vasilache     auto positionArrayAttr = extractOp.position();
4739826fe5cSAart Bik 
4749826fe5cSAart Bik     // Bail if result type cannot be lowered.
4759826fe5cSAart Bik     if (!llvmResultType)
4763145427dSRiver Riddle       return failure();
4779826fe5cSAart Bik 
4785c0c51a9SNicolas Vasilache     // One-shot extraction of vector from array (only requires extractvalue).
4795c0c51a9SNicolas Vasilache     if (resultType.isa<VectorType>()) {
480e62a6956SRiver Riddle       Value extracted = rewriter.create<LLVM::ExtractValueOp>(
4815c0c51a9SNicolas Vasilache           loc, llvmResultType, adaptor.vector(), positionArrayAttr);
4825c0c51a9SNicolas Vasilache       rewriter.replaceOp(op, extracted);
4833145427dSRiver Riddle       return success();
4845c0c51a9SNicolas Vasilache     }
4855c0c51a9SNicolas Vasilache 
4869826fe5cSAart Bik     // Potential extraction of 1-D vector from array.
4875c0c51a9SNicolas Vasilache     auto *context = op->getContext();
488e62a6956SRiver Riddle     Value extracted = adaptor.vector();
4895c0c51a9SNicolas Vasilache     auto positionAttrs = positionArrayAttr.getValue();
4905c0c51a9SNicolas Vasilache     if (positionAttrs.size() > 1) {
4919826fe5cSAart Bik       auto oneDVectorType = reducedVectorTypeBack(vectorType);
4925c0c51a9SNicolas Vasilache       auto nMinusOnePositionAttrs =
4935c0c51a9SNicolas Vasilache           ArrayAttr::get(positionAttrs.drop_back(), context);
4945c0c51a9SNicolas Vasilache       extracted = rewriter.create<LLVM::ExtractValueOp>(
4950f04384dSAlex Zinenko           loc, typeConverter.convertType(oneDVectorType), extracted,
4965c0c51a9SNicolas Vasilache           nMinusOnePositionAttrs);
4975c0c51a9SNicolas Vasilache     }
4985c0c51a9SNicolas Vasilache 
4995c0c51a9SNicolas Vasilache     // Remaining extraction of element from 1-D LLVM vector
5005c0c51a9SNicolas Vasilache     auto position = positionAttrs.back().cast<IntegerAttr>();
5010f04384dSAlex Zinenko     auto i64Type = LLVM::LLVMType::getInt64Ty(typeConverter.getDialect());
5021d47564aSAart Bik     auto constant = rewriter.create<LLVM::ConstantOp>(loc, i64Type, position);
5035c0c51a9SNicolas Vasilache     extracted =
5045c0c51a9SNicolas Vasilache         rewriter.create<LLVM::ExtractElementOp>(loc, extracted, constant);
5055c0c51a9SNicolas Vasilache     rewriter.replaceOp(op, extracted);
5065c0c51a9SNicolas Vasilache 
5073145427dSRiver Riddle     return success();
5085c0c51a9SNicolas Vasilache   }
5095c0c51a9SNicolas Vasilache };
5105c0c51a9SNicolas Vasilache 
511681f929fSNicolas Vasilache /// Conversion pattern that turns a vector.fma on a 1-D vector
512681f929fSNicolas Vasilache /// into an llvm.intr.fmuladd. This is a trivial 1-1 conversion.
513681f929fSNicolas Vasilache /// This does not match vectors of n >= 2 rank.
514681f929fSNicolas Vasilache ///
515681f929fSNicolas Vasilache /// Example:
516681f929fSNicolas Vasilache /// ```
517681f929fSNicolas Vasilache ///  vector.fma %a, %a, %a : vector<8xf32>
518681f929fSNicolas Vasilache /// ```
519681f929fSNicolas Vasilache /// is converted to:
520681f929fSNicolas Vasilache /// ```
521681f929fSNicolas Vasilache ///  llvm.intr.fma %va, %va, %va:
522681f929fSNicolas Vasilache ///    (!llvm<"<8 x float>">, !llvm<"<8 x float>">, !llvm<"<8 x float>">)
523681f929fSNicolas Vasilache ///    -> !llvm<"<8 x float>">
524681f929fSNicolas Vasilache /// ```
525870c1fd4SAlex Zinenko class VectorFMAOp1DConversion : public ConvertToLLVMPattern {
526681f929fSNicolas Vasilache public:
527681f929fSNicolas Vasilache   explicit VectorFMAOp1DConversion(MLIRContext *context,
528681f929fSNicolas Vasilache                                    LLVMTypeConverter &typeConverter)
529870c1fd4SAlex Zinenko       : ConvertToLLVMPattern(vector::FMAOp::getOperationName(), context,
530681f929fSNicolas Vasilache                              typeConverter) {}
531681f929fSNicolas Vasilache 
5323145427dSRiver Riddle   LogicalResult
533681f929fSNicolas Vasilache   matchAndRewrite(Operation *op, ArrayRef<Value> operands,
534681f929fSNicolas Vasilache                   ConversionPatternRewriter &rewriter) const override {
535681f929fSNicolas Vasilache     auto adaptor = vector::FMAOpOperandAdaptor(operands);
536681f929fSNicolas Vasilache     vector::FMAOp fmaOp = cast<vector::FMAOp>(op);
537681f929fSNicolas Vasilache     VectorType vType = fmaOp.getVectorType();
538681f929fSNicolas Vasilache     if (vType.getRank() != 1)
5393145427dSRiver Riddle       return failure();
540681f929fSNicolas Vasilache     rewriter.replaceOpWithNewOp<LLVM::FMAOp>(op, adaptor.lhs(), adaptor.rhs(),
541681f929fSNicolas Vasilache                                              adaptor.acc());
5423145427dSRiver Riddle     return success();
543681f929fSNicolas Vasilache   }
544681f929fSNicolas Vasilache };
545681f929fSNicolas Vasilache 
546870c1fd4SAlex Zinenko class VectorInsertElementOpConversion : public ConvertToLLVMPattern {
547cd5dab8aSAart Bik public:
548cd5dab8aSAart Bik   explicit VectorInsertElementOpConversion(MLIRContext *context,
549cd5dab8aSAart Bik                                            LLVMTypeConverter &typeConverter)
550870c1fd4SAlex Zinenko       : ConvertToLLVMPattern(vector::InsertElementOp::getOperationName(),
551870c1fd4SAlex Zinenko                              context, typeConverter) {}
552cd5dab8aSAart Bik 
5533145427dSRiver Riddle   LogicalResult
554e62a6956SRiver Riddle   matchAndRewrite(Operation *op, ArrayRef<Value> operands,
555cd5dab8aSAart Bik                   ConversionPatternRewriter &rewriter) const override {
556cd5dab8aSAart Bik     auto adaptor = vector::InsertElementOpOperandAdaptor(operands);
557cd5dab8aSAart Bik     auto insertEltOp = cast<vector::InsertElementOp>(op);
558cd5dab8aSAart Bik     auto vectorType = insertEltOp.getDestVectorType();
5590f04384dSAlex Zinenko     auto llvmType = typeConverter.convertType(vectorType);
560cd5dab8aSAart Bik 
561cd5dab8aSAart Bik     // Bail if result type cannot be lowered.
562cd5dab8aSAart Bik     if (!llvmType)
5633145427dSRiver Riddle       return failure();
564cd5dab8aSAart Bik 
565cd5dab8aSAart Bik     rewriter.replaceOpWithNewOp<LLVM::InsertElementOp>(
566cd5dab8aSAart Bik         op, llvmType, adaptor.dest(), adaptor.source(), adaptor.position());
5673145427dSRiver Riddle     return success();
568cd5dab8aSAart Bik   }
569cd5dab8aSAart Bik };
570cd5dab8aSAart Bik 
571870c1fd4SAlex Zinenko class VectorInsertOpConversion : public ConvertToLLVMPattern {
5729826fe5cSAart Bik public:
5739826fe5cSAart Bik   explicit VectorInsertOpConversion(MLIRContext *context,
5749826fe5cSAart Bik                                     LLVMTypeConverter &typeConverter)
575870c1fd4SAlex Zinenko       : ConvertToLLVMPattern(vector::InsertOp::getOperationName(), context,
5769826fe5cSAart Bik                              typeConverter) {}
5779826fe5cSAart Bik 
5783145427dSRiver Riddle   LogicalResult
579e62a6956SRiver Riddle   matchAndRewrite(Operation *op, ArrayRef<Value> operands,
5809826fe5cSAart Bik                   ConversionPatternRewriter &rewriter) const override {
5819826fe5cSAart Bik     auto loc = op->getLoc();
5829826fe5cSAart Bik     auto adaptor = vector::InsertOpOperandAdaptor(operands);
5839826fe5cSAart Bik     auto insertOp = cast<vector::InsertOp>(op);
5849826fe5cSAart Bik     auto sourceType = insertOp.getSourceType();
5859826fe5cSAart Bik     auto destVectorType = insertOp.getDestVectorType();
5860f04384dSAlex Zinenko     auto llvmResultType = typeConverter.convertType(destVectorType);
5879826fe5cSAart Bik     auto positionArrayAttr = insertOp.position();
5889826fe5cSAart Bik 
5899826fe5cSAart Bik     // Bail if result type cannot be lowered.
5909826fe5cSAart Bik     if (!llvmResultType)
5913145427dSRiver Riddle       return failure();
5929826fe5cSAart Bik 
5939826fe5cSAart Bik     // One-shot insertion of a vector into an array (only requires insertvalue).
5949826fe5cSAart Bik     if (sourceType.isa<VectorType>()) {
595e62a6956SRiver Riddle       Value inserted = rewriter.create<LLVM::InsertValueOp>(
5969826fe5cSAart Bik           loc, llvmResultType, adaptor.dest(), adaptor.source(),
5979826fe5cSAart Bik           positionArrayAttr);
5989826fe5cSAart Bik       rewriter.replaceOp(op, inserted);
5993145427dSRiver Riddle       return success();
6009826fe5cSAart Bik     }
6019826fe5cSAart Bik 
6029826fe5cSAart Bik     // Potential extraction of 1-D vector from array.
6039826fe5cSAart Bik     auto *context = op->getContext();
604e62a6956SRiver Riddle     Value extracted = adaptor.dest();
6059826fe5cSAart Bik     auto positionAttrs = positionArrayAttr.getValue();
6069826fe5cSAart Bik     auto position = positionAttrs.back().cast<IntegerAttr>();
6079826fe5cSAart Bik     auto oneDVectorType = destVectorType;
6089826fe5cSAart Bik     if (positionAttrs.size() > 1) {
6099826fe5cSAart Bik       oneDVectorType = reducedVectorTypeBack(destVectorType);
6109826fe5cSAart Bik       auto nMinusOnePositionAttrs =
6119826fe5cSAart Bik           ArrayAttr::get(positionAttrs.drop_back(), context);
6129826fe5cSAart Bik       extracted = rewriter.create<LLVM::ExtractValueOp>(
6130f04384dSAlex Zinenko           loc, typeConverter.convertType(oneDVectorType), extracted,
6149826fe5cSAart Bik           nMinusOnePositionAttrs);
6159826fe5cSAart Bik     }
6169826fe5cSAart Bik 
6179826fe5cSAart Bik     // Insertion of an element into a 1-D LLVM vector.
6180f04384dSAlex Zinenko     auto i64Type = LLVM::LLVMType::getInt64Ty(typeConverter.getDialect());
6191d47564aSAart Bik     auto constant = rewriter.create<LLVM::ConstantOp>(loc, i64Type, position);
620e62a6956SRiver Riddle     Value inserted = rewriter.create<LLVM::InsertElementOp>(
6210f04384dSAlex Zinenko         loc, typeConverter.convertType(oneDVectorType), extracted,
6220f04384dSAlex Zinenko         adaptor.source(), constant);
6239826fe5cSAart Bik 
6249826fe5cSAart Bik     // Potential insertion of resulting 1-D vector into array.
6259826fe5cSAart Bik     if (positionAttrs.size() > 1) {
6269826fe5cSAart Bik       auto nMinusOnePositionAttrs =
6279826fe5cSAart Bik           ArrayAttr::get(positionAttrs.drop_back(), context);
6289826fe5cSAart Bik       inserted = rewriter.create<LLVM::InsertValueOp>(loc, llvmResultType,
6299826fe5cSAart Bik                                                       adaptor.dest(), inserted,
6309826fe5cSAart Bik                                                       nMinusOnePositionAttrs);
6319826fe5cSAart Bik     }
6329826fe5cSAart Bik 
6339826fe5cSAart Bik     rewriter.replaceOp(op, inserted);
6343145427dSRiver Riddle     return success();
6359826fe5cSAart Bik   }
6369826fe5cSAart Bik };
6379826fe5cSAart Bik 
638681f929fSNicolas Vasilache /// Rank reducing rewrite for n-D FMA into (n-1)-D FMA where n > 1.
639681f929fSNicolas Vasilache ///
640681f929fSNicolas Vasilache /// Example:
641681f929fSNicolas Vasilache /// ```
642681f929fSNicolas Vasilache ///   %d = vector.fma %a, %b, %c : vector<2x4xf32>
643681f929fSNicolas Vasilache /// ```
644681f929fSNicolas Vasilache /// is rewritten into:
645681f929fSNicolas Vasilache /// ```
646681f929fSNicolas Vasilache ///  %r = splat %f0: vector<2x4xf32>
647681f929fSNicolas Vasilache ///  %va = vector.extractvalue %a[0] : vector<2x4xf32>
648681f929fSNicolas Vasilache ///  %vb = vector.extractvalue %b[0] : vector<2x4xf32>
649681f929fSNicolas Vasilache ///  %vc = vector.extractvalue %c[0] : vector<2x4xf32>
650681f929fSNicolas Vasilache ///  %vd = vector.fma %va, %vb, %vc : vector<4xf32>
651681f929fSNicolas Vasilache ///  %r2 = vector.insertvalue %vd, %r[0] : vector<4xf32> into vector<2x4xf32>
652681f929fSNicolas Vasilache ///  %va2 = vector.extractvalue %a2[1] : vector<2x4xf32>
653681f929fSNicolas Vasilache ///  %vb2 = vector.extractvalue %b2[1] : vector<2x4xf32>
654681f929fSNicolas Vasilache ///  %vc2 = vector.extractvalue %c2[1] : vector<2x4xf32>
655681f929fSNicolas Vasilache ///  %vd2 = vector.fma %va2, %vb2, %vc2 : vector<4xf32>
656681f929fSNicolas Vasilache ///  %r3 = vector.insertvalue %vd2, %r2[1] : vector<4xf32> into vector<2x4xf32>
657681f929fSNicolas Vasilache ///  // %r3 holds the final value.
658681f929fSNicolas Vasilache /// ```
659681f929fSNicolas Vasilache class VectorFMAOpNDRewritePattern : public OpRewritePattern<FMAOp> {
660681f929fSNicolas Vasilache public:
661681f929fSNicolas Vasilache   using OpRewritePattern<FMAOp>::OpRewritePattern;
662681f929fSNicolas Vasilache 
6633145427dSRiver Riddle   LogicalResult matchAndRewrite(FMAOp op,
664681f929fSNicolas Vasilache                                 PatternRewriter &rewriter) const override {
665681f929fSNicolas Vasilache     auto vType = op.getVectorType();
666681f929fSNicolas Vasilache     if (vType.getRank() < 2)
6673145427dSRiver Riddle       return failure();
668681f929fSNicolas Vasilache 
669681f929fSNicolas Vasilache     auto loc = op.getLoc();
670681f929fSNicolas Vasilache     auto elemType = vType.getElementType();
671681f929fSNicolas Vasilache     Value zero = rewriter.create<ConstantOp>(loc, elemType,
672681f929fSNicolas Vasilache                                              rewriter.getZeroAttr(elemType));
673681f929fSNicolas Vasilache     Value desc = rewriter.create<SplatOp>(loc, vType, zero);
674681f929fSNicolas Vasilache     for (int64_t i = 0, e = vType.getShape().front(); i != e; ++i) {
675681f929fSNicolas Vasilache       Value extrLHS = rewriter.create<ExtractOp>(loc, op.lhs(), i);
676681f929fSNicolas Vasilache       Value extrRHS = rewriter.create<ExtractOp>(loc, op.rhs(), i);
677681f929fSNicolas Vasilache       Value extrACC = rewriter.create<ExtractOp>(loc, op.acc(), i);
678681f929fSNicolas Vasilache       Value fma = rewriter.create<FMAOp>(loc, extrLHS, extrRHS, extrACC);
679681f929fSNicolas Vasilache       desc = rewriter.create<InsertOp>(loc, fma, desc, i);
680681f929fSNicolas Vasilache     }
681681f929fSNicolas Vasilache     rewriter.replaceOp(op, desc);
6823145427dSRiver Riddle     return success();
683681f929fSNicolas Vasilache   }
684681f929fSNicolas Vasilache };
685681f929fSNicolas Vasilache 
6862d515e49SNicolas Vasilache // When ranks are different, InsertStridedSlice needs to extract a properly
6872d515e49SNicolas Vasilache // ranked vector from the destination vector into which to insert. This pattern
6882d515e49SNicolas Vasilache // only takes care of this part and forwards the rest of the conversion to
6892d515e49SNicolas Vasilache // another pattern that converts InsertStridedSlice for operands of the same
6902d515e49SNicolas Vasilache // rank.
6912d515e49SNicolas Vasilache //
6922d515e49SNicolas Vasilache // RewritePattern for InsertStridedSliceOp where source and destination vectors
6932d515e49SNicolas Vasilache // have different ranks. In this case:
6942d515e49SNicolas Vasilache //   1. the proper subvector is extracted from the destination vector
6952d515e49SNicolas Vasilache //   2. a new InsertStridedSlice op is created to insert the source in the
6962d515e49SNicolas Vasilache //   destination subvector
6972d515e49SNicolas Vasilache //   3. the destination subvector is inserted back in the proper place
6982d515e49SNicolas Vasilache //   4. the op is replaced by the result of step 3.
6992d515e49SNicolas Vasilache // The new InsertStridedSlice from step 2. will be picked up by a
7002d515e49SNicolas Vasilache // `VectorInsertStridedSliceOpSameRankRewritePattern`.
7012d515e49SNicolas Vasilache class VectorInsertStridedSliceOpDifferentRankRewritePattern
7022d515e49SNicolas Vasilache     : public OpRewritePattern<InsertStridedSliceOp> {
7032d515e49SNicolas Vasilache public:
7042d515e49SNicolas Vasilache   using OpRewritePattern<InsertStridedSliceOp>::OpRewritePattern;
7052d515e49SNicolas Vasilache 
7063145427dSRiver Riddle   LogicalResult matchAndRewrite(InsertStridedSliceOp op,
7072d515e49SNicolas Vasilache                                 PatternRewriter &rewriter) const override {
7082d515e49SNicolas Vasilache     auto srcType = op.getSourceVectorType();
7092d515e49SNicolas Vasilache     auto dstType = op.getDestVectorType();
7102d515e49SNicolas Vasilache 
7112d515e49SNicolas Vasilache     if (op.offsets().getValue().empty())
7123145427dSRiver Riddle       return failure();
7132d515e49SNicolas Vasilache 
7142d515e49SNicolas Vasilache     auto loc = op.getLoc();
7152d515e49SNicolas Vasilache     int64_t rankDiff = dstType.getRank() - srcType.getRank();
7162d515e49SNicolas Vasilache     assert(rankDiff >= 0);
7172d515e49SNicolas Vasilache     if (rankDiff == 0)
7183145427dSRiver Riddle       return failure();
7192d515e49SNicolas Vasilache 
7202d515e49SNicolas Vasilache     int64_t rankRest = dstType.getRank() - rankDiff;
7212d515e49SNicolas Vasilache     // Extract / insert the subvector of matching rank and InsertStridedSlice
7222d515e49SNicolas Vasilache     // on it.
7232d515e49SNicolas Vasilache     Value extracted =
7242d515e49SNicolas Vasilache         rewriter.create<ExtractOp>(loc, op.dest(),
7252d515e49SNicolas Vasilache                                    getI64SubArray(op.offsets(), /*dropFront=*/0,
7262d515e49SNicolas Vasilache                                                   /*dropFront=*/rankRest));
7272d515e49SNicolas Vasilache     // A different pattern will kick in for InsertStridedSlice with matching
7282d515e49SNicolas Vasilache     // ranks.
7292d515e49SNicolas Vasilache     auto stridedSliceInnerOp = rewriter.create<InsertStridedSliceOp>(
7302d515e49SNicolas Vasilache         loc, op.source(), extracted,
7312d515e49SNicolas Vasilache         getI64SubArray(op.offsets(), /*dropFront=*/rankDiff),
732c8fc76a9Saartbik         getI64SubArray(op.strides(), /*dropFront=*/0));
7332d515e49SNicolas Vasilache     rewriter.replaceOpWithNewOp<InsertOp>(
7342d515e49SNicolas Vasilache         op, stridedSliceInnerOp.getResult(), op.dest(),
7352d515e49SNicolas Vasilache         getI64SubArray(op.offsets(), /*dropFront=*/0,
7362d515e49SNicolas Vasilache                        /*dropFront=*/rankRest));
7373145427dSRiver Riddle     return success();
7382d515e49SNicolas Vasilache   }
7392d515e49SNicolas Vasilache };
7402d515e49SNicolas Vasilache 
7412d515e49SNicolas Vasilache // RewritePattern for InsertStridedSliceOp where source and destination vectors
7422d515e49SNicolas Vasilache // have the same rank. In this case, we reduce
7432d515e49SNicolas Vasilache //   1. the proper subvector is extracted from the destination vector
7442d515e49SNicolas Vasilache //   2. a new InsertStridedSlice op is created to insert the source in the
7452d515e49SNicolas Vasilache //   destination subvector
7462d515e49SNicolas Vasilache //   3. the destination subvector is inserted back in the proper place
7472d515e49SNicolas Vasilache //   4. the op is replaced by the result of step 3.
7482d515e49SNicolas Vasilache // The new InsertStridedSlice from step 2. will be picked up by a
7492d515e49SNicolas Vasilache // `VectorInsertStridedSliceOpSameRankRewritePattern`.
7502d515e49SNicolas Vasilache class VectorInsertStridedSliceOpSameRankRewritePattern
7512d515e49SNicolas Vasilache     : public OpRewritePattern<InsertStridedSliceOp> {
7522d515e49SNicolas Vasilache public:
7532d515e49SNicolas Vasilache   using OpRewritePattern<InsertStridedSliceOp>::OpRewritePattern;
7542d515e49SNicolas Vasilache 
7553145427dSRiver Riddle   LogicalResult matchAndRewrite(InsertStridedSliceOp op,
7562d515e49SNicolas Vasilache                                 PatternRewriter &rewriter) const override {
7572d515e49SNicolas Vasilache     auto srcType = op.getSourceVectorType();
7582d515e49SNicolas Vasilache     auto dstType = op.getDestVectorType();
7592d515e49SNicolas Vasilache 
7602d515e49SNicolas Vasilache     if (op.offsets().getValue().empty())
7613145427dSRiver Riddle       return failure();
7622d515e49SNicolas Vasilache 
7632d515e49SNicolas Vasilache     int64_t rankDiff = dstType.getRank() - srcType.getRank();
7642d515e49SNicolas Vasilache     assert(rankDiff >= 0);
7652d515e49SNicolas Vasilache     if (rankDiff != 0)
7663145427dSRiver Riddle       return failure();
7672d515e49SNicolas Vasilache 
7682d515e49SNicolas Vasilache     if (srcType == dstType) {
7692d515e49SNicolas Vasilache       rewriter.replaceOp(op, op.source());
7703145427dSRiver Riddle       return success();
7712d515e49SNicolas Vasilache     }
7722d515e49SNicolas Vasilache 
7732d515e49SNicolas Vasilache     int64_t offset =
7742d515e49SNicolas Vasilache         op.offsets().getValue().front().cast<IntegerAttr>().getInt();
7752d515e49SNicolas Vasilache     int64_t size = srcType.getShape().front();
7762d515e49SNicolas Vasilache     int64_t stride =
7772d515e49SNicolas Vasilache         op.strides().getValue().front().cast<IntegerAttr>().getInt();
7782d515e49SNicolas Vasilache 
7792d515e49SNicolas Vasilache     auto loc = op.getLoc();
7802d515e49SNicolas Vasilache     Value res = op.dest();
7812d515e49SNicolas Vasilache     // For each slice of the source vector along the most major dimension.
7822d515e49SNicolas Vasilache     for (int64_t off = offset, e = offset + size * stride, idx = 0; off < e;
7832d515e49SNicolas Vasilache          off += stride, ++idx) {
7842d515e49SNicolas Vasilache       // 1. extract the proper subvector (or element) from source
7852d515e49SNicolas Vasilache       Value extractedSource = extractOne(rewriter, loc, op.source(), idx);
7862d515e49SNicolas Vasilache       if (extractedSource.getType().isa<VectorType>()) {
7872d515e49SNicolas Vasilache         // 2. If we have a vector, extract the proper subvector from destination
7882d515e49SNicolas Vasilache         // Otherwise we are at the element level and no need to recurse.
7892d515e49SNicolas Vasilache         Value extractedDest = extractOne(rewriter, loc, op.dest(), off);
7902d515e49SNicolas Vasilache         // 3. Reduce the problem to lowering a new InsertStridedSlice op with
7912d515e49SNicolas Vasilache         // smaller rank.
792*bd1ccfe6SRiver Riddle         extractedSource = rewriter.create<InsertStridedSliceOp>(
7932d515e49SNicolas Vasilache             loc, extractedSource, extractedDest,
7942d515e49SNicolas Vasilache             getI64SubArray(op.offsets(), /* dropFront=*/1),
7952d515e49SNicolas Vasilache             getI64SubArray(op.strides(), /* dropFront=*/1));
7962d515e49SNicolas Vasilache       }
7972d515e49SNicolas Vasilache       // 4. Insert the extractedSource into the res vector.
7982d515e49SNicolas Vasilache       res = insertOne(rewriter, loc, extractedSource, res, off);
7992d515e49SNicolas Vasilache     }
8002d515e49SNicolas Vasilache 
8012d515e49SNicolas Vasilache     rewriter.replaceOp(op, res);
8023145427dSRiver Riddle     return success();
8032d515e49SNicolas Vasilache   }
804*bd1ccfe6SRiver Riddle   /// This pattern creates recursive InsertStridedSliceOp, but the recursion is
805*bd1ccfe6SRiver Riddle   /// bounded as the rank is strictly decreasing.
806*bd1ccfe6SRiver Riddle   bool hasBoundedRewriteRecursion() const final { return true; }
8072d515e49SNicolas Vasilache };
8082d515e49SNicolas Vasilache 
809870c1fd4SAlex Zinenko class VectorTypeCastOpConversion : public ConvertToLLVMPattern {
8105c0c51a9SNicolas Vasilache public:
8115c0c51a9SNicolas Vasilache   explicit VectorTypeCastOpConversion(MLIRContext *context,
8125c0c51a9SNicolas Vasilache                                       LLVMTypeConverter &typeConverter)
813870c1fd4SAlex Zinenko       : ConvertToLLVMPattern(vector::TypeCastOp::getOperationName(), context,
8145c0c51a9SNicolas Vasilache                              typeConverter) {}
8155c0c51a9SNicolas Vasilache 
8163145427dSRiver Riddle   LogicalResult
817e62a6956SRiver Riddle   matchAndRewrite(Operation *op, ArrayRef<Value> operands,
8185c0c51a9SNicolas Vasilache                   ConversionPatternRewriter &rewriter) const override {
8195c0c51a9SNicolas Vasilache     auto loc = op->getLoc();
8205c0c51a9SNicolas Vasilache     vector::TypeCastOp castOp = cast<vector::TypeCastOp>(op);
8215c0c51a9SNicolas Vasilache     MemRefType sourceMemRefType =
8222bdf33ccSRiver Riddle         castOp.getOperand().getType().cast<MemRefType>();
8235c0c51a9SNicolas Vasilache     MemRefType targetMemRefType =
8242bdf33ccSRiver Riddle         castOp.getResult().getType().cast<MemRefType>();
8255c0c51a9SNicolas Vasilache 
8265c0c51a9SNicolas Vasilache     // Only static shape casts supported atm.
8275c0c51a9SNicolas Vasilache     if (!sourceMemRefType.hasStaticShape() ||
8285c0c51a9SNicolas Vasilache         !targetMemRefType.hasStaticShape())
8293145427dSRiver Riddle       return failure();
8305c0c51a9SNicolas Vasilache 
8315c0c51a9SNicolas Vasilache     auto llvmSourceDescriptorTy =
8322bdf33ccSRiver Riddle         operands[0].getType().dyn_cast<LLVM::LLVMType>();
8335c0c51a9SNicolas Vasilache     if (!llvmSourceDescriptorTy || !llvmSourceDescriptorTy.isStructTy())
8343145427dSRiver Riddle       return failure();
8355c0c51a9SNicolas Vasilache     MemRefDescriptor sourceMemRef(operands[0]);
8365c0c51a9SNicolas Vasilache 
8370f04384dSAlex Zinenko     auto llvmTargetDescriptorTy = typeConverter.convertType(targetMemRefType)
8385c0c51a9SNicolas Vasilache                                       .dyn_cast_or_null<LLVM::LLVMType>();
8395c0c51a9SNicolas Vasilache     if (!llvmTargetDescriptorTy || !llvmTargetDescriptorTy.isStructTy())
8403145427dSRiver Riddle       return failure();
8415c0c51a9SNicolas Vasilache 
8425c0c51a9SNicolas Vasilache     int64_t offset;
8435c0c51a9SNicolas Vasilache     SmallVector<int64_t, 4> strides;
8445c0c51a9SNicolas Vasilache     auto successStrides =
8455c0c51a9SNicolas Vasilache         getStridesAndOffset(sourceMemRefType, strides, offset);
8465c0c51a9SNicolas Vasilache     bool isContiguous = (strides.back() == 1);
8475c0c51a9SNicolas Vasilache     if (isContiguous) {
8485c0c51a9SNicolas Vasilache       auto sizes = sourceMemRefType.getShape();
8495c0c51a9SNicolas Vasilache       for (int index = 0, e = strides.size() - 2; index < e; ++index) {
8505c0c51a9SNicolas Vasilache         if (strides[index] != strides[index + 1] * sizes[index + 1]) {
8515c0c51a9SNicolas Vasilache           isContiguous = false;
8525c0c51a9SNicolas Vasilache           break;
8535c0c51a9SNicolas Vasilache         }
8545c0c51a9SNicolas Vasilache       }
8555c0c51a9SNicolas Vasilache     }
8565c0c51a9SNicolas Vasilache     // Only contiguous source tensors supported atm.
8575c0c51a9SNicolas Vasilache     if (failed(successStrides) || !isContiguous)
8583145427dSRiver Riddle       return failure();
8595c0c51a9SNicolas Vasilache 
8600f04384dSAlex Zinenko     auto int64Ty = LLVM::LLVMType::getInt64Ty(typeConverter.getDialect());
8615c0c51a9SNicolas Vasilache 
8625c0c51a9SNicolas Vasilache     // Create descriptor.
8635c0c51a9SNicolas Vasilache     auto desc = MemRefDescriptor::undef(rewriter, loc, llvmTargetDescriptorTy);
8645c0c51a9SNicolas Vasilache     Type llvmTargetElementTy = desc.getElementType();
8655c0c51a9SNicolas Vasilache     // Set allocated ptr.
866e62a6956SRiver Riddle     Value allocated = sourceMemRef.allocatedPtr(rewriter, loc);
8675c0c51a9SNicolas Vasilache     allocated =
8685c0c51a9SNicolas Vasilache         rewriter.create<LLVM::BitcastOp>(loc, llvmTargetElementTy, allocated);
8695c0c51a9SNicolas Vasilache     desc.setAllocatedPtr(rewriter, loc, allocated);
8705c0c51a9SNicolas Vasilache     // Set aligned ptr.
871e62a6956SRiver Riddle     Value ptr = sourceMemRef.alignedPtr(rewriter, loc);
8725c0c51a9SNicolas Vasilache     ptr = rewriter.create<LLVM::BitcastOp>(loc, llvmTargetElementTy, ptr);
8735c0c51a9SNicolas Vasilache     desc.setAlignedPtr(rewriter, loc, ptr);
8745c0c51a9SNicolas Vasilache     // Fill offset 0.
8755c0c51a9SNicolas Vasilache     auto attr = rewriter.getIntegerAttr(rewriter.getIndexType(), 0);
8765c0c51a9SNicolas Vasilache     auto zero = rewriter.create<LLVM::ConstantOp>(loc, int64Ty, attr);
8775c0c51a9SNicolas Vasilache     desc.setOffset(rewriter, loc, zero);
8785c0c51a9SNicolas Vasilache 
8795c0c51a9SNicolas Vasilache     // Fill size and stride descriptors in memref.
8805c0c51a9SNicolas Vasilache     for (auto indexedSize : llvm::enumerate(targetMemRefType.getShape())) {
8815c0c51a9SNicolas Vasilache       int64_t index = indexedSize.index();
8825c0c51a9SNicolas Vasilache       auto sizeAttr =
8835c0c51a9SNicolas Vasilache           rewriter.getIntegerAttr(rewriter.getIndexType(), indexedSize.value());
8845c0c51a9SNicolas Vasilache       auto size = rewriter.create<LLVM::ConstantOp>(loc, int64Ty, sizeAttr);
8855c0c51a9SNicolas Vasilache       desc.setSize(rewriter, loc, index, size);
8865c0c51a9SNicolas Vasilache       auto strideAttr =
8875c0c51a9SNicolas Vasilache           rewriter.getIntegerAttr(rewriter.getIndexType(), strides[index]);
8885c0c51a9SNicolas Vasilache       auto stride = rewriter.create<LLVM::ConstantOp>(loc, int64Ty, strideAttr);
8895c0c51a9SNicolas Vasilache       desc.setStride(rewriter, loc, index, stride);
8905c0c51a9SNicolas Vasilache     }
8915c0c51a9SNicolas Vasilache 
8925c0c51a9SNicolas Vasilache     rewriter.replaceOp(op, {desc});
8933145427dSRiver Riddle     return success();
8945c0c51a9SNicolas Vasilache   }
8955c0c51a9SNicolas Vasilache };
8965c0c51a9SNicolas Vasilache 
897870c1fd4SAlex Zinenko class VectorPrintOpConversion : public ConvertToLLVMPattern {
898d9b500d3SAart Bik public:
899d9b500d3SAart Bik   explicit VectorPrintOpConversion(MLIRContext *context,
900d9b500d3SAart Bik                                    LLVMTypeConverter &typeConverter)
901870c1fd4SAlex Zinenko       : ConvertToLLVMPattern(vector::PrintOp::getOperationName(), context,
902d9b500d3SAart Bik                              typeConverter) {}
903d9b500d3SAart Bik 
904d9b500d3SAart Bik   // Proof-of-concept lowering implementation that relies on a small
905d9b500d3SAart Bik   // runtime support library, which only needs to provide a few
906d9b500d3SAart Bik   // printing methods (single value for all data types, opening/closing
907d9b500d3SAart Bik   // bracket, comma, newline). The lowering fully unrolls a vector
908d9b500d3SAart Bik   // in terms of these elementary printing operations. The advantage
909d9b500d3SAart Bik   // of this approach is that the library can remain unaware of all
910d9b500d3SAart Bik   // low-level implementation details of vectors while still supporting
911d9b500d3SAart Bik   // output of any shaped and dimensioned vector. Due to full unrolling,
912d9b500d3SAart Bik   // this approach is less suited for very large vectors though.
913d9b500d3SAart Bik   //
914d9b500d3SAart Bik   // TODO(ajcbik): rely solely on libc in future? something else?
915d9b500d3SAart Bik   //
9163145427dSRiver Riddle   LogicalResult
917e62a6956SRiver Riddle   matchAndRewrite(Operation *op, ArrayRef<Value> operands,
918d9b500d3SAart Bik                   ConversionPatternRewriter &rewriter) const override {
919d9b500d3SAart Bik     auto printOp = cast<vector::PrintOp>(op);
920d9b500d3SAart Bik     auto adaptor = vector::PrintOpOperandAdaptor(operands);
921d9b500d3SAart Bik     Type printType = printOp.getPrintType();
922d9b500d3SAart Bik 
9230f04384dSAlex Zinenko     if (typeConverter.convertType(printType) == nullptr)
9243145427dSRiver Riddle       return failure();
925d9b500d3SAart Bik 
926d9b500d3SAart Bik     // Make sure element type has runtime support (currently just Float/Double).
927d9b500d3SAart Bik     VectorType vectorType = printType.dyn_cast<VectorType>();
928d9b500d3SAart Bik     Type eltType = vectorType ? vectorType.getElementType() : printType;
929d9b500d3SAart Bik     int64_t rank = vectorType ? vectorType.getRank() : 0;
930d9b500d3SAart Bik     Operation *printer;
93135b68527SLei Zhang     if (eltType.isSignlessInteger(32))
932e52414b1Saartbik       printer = getPrintI32(op);
93335b68527SLei Zhang     else if (eltType.isSignlessInteger(64))
934e52414b1Saartbik       printer = getPrintI64(op);
935e52414b1Saartbik     else if (eltType.isF32())
936d9b500d3SAart Bik       printer = getPrintFloat(op);
937d9b500d3SAart Bik     else if (eltType.isF64())
938d9b500d3SAart Bik       printer = getPrintDouble(op);
939d9b500d3SAart Bik     else
9403145427dSRiver Riddle       return failure();
941d9b500d3SAart Bik 
942d9b500d3SAart Bik     // Unroll vector into elementary print calls.
943d9b500d3SAart Bik     emitRanks(rewriter, op, adaptor.source(), vectorType, printer, rank);
944d9b500d3SAart Bik     emitCall(rewriter, op->getLoc(), getPrintNewline(op));
945d9b500d3SAart Bik     rewriter.eraseOp(op);
9463145427dSRiver Riddle     return success();
947d9b500d3SAart Bik   }
948d9b500d3SAart Bik 
949d9b500d3SAart Bik private:
950d9b500d3SAart Bik   void emitRanks(ConversionPatternRewriter &rewriter, Operation *op,
951e62a6956SRiver Riddle                  Value value, VectorType vectorType, Operation *printer,
952d9b500d3SAart Bik                  int64_t rank) const {
953d9b500d3SAart Bik     Location loc = op->getLoc();
954d9b500d3SAart Bik     if (rank == 0) {
955d9b500d3SAart Bik       emitCall(rewriter, loc, printer, value);
956d9b500d3SAart Bik       return;
957d9b500d3SAart Bik     }
958d9b500d3SAart Bik 
959d9b500d3SAart Bik     emitCall(rewriter, loc, getPrintOpen(op));
960d9b500d3SAart Bik     Operation *printComma = getPrintComma(op);
961d9b500d3SAart Bik     int64_t dim = vectorType.getDimSize(0);
962d9b500d3SAart Bik     for (int64_t d = 0; d < dim; ++d) {
963d9b500d3SAart Bik       auto reducedType =
964d9b500d3SAart Bik           rank > 1 ? reducedVectorTypeFront(vectorType) : nullptr;
9650f04384dSAlex Zinenko       auto llvmType = typeConverter.convertType(
966d9b500d3SAart Bik           rank > 1 ? reducedType : vectorType.getElementType());
967e62a6956SRiver Riddle       Value nestedVal =
9680f04384dSAlex Zinenko           extractOne(rewriter, typeConverter, loc, value, llvmType, rank, d);
969d9b500d3SAart Bik       emitRanks(rewriter, op, nestedVal, reducedType, printer, rank - 1);
970d9b500d3SAart Bik       if (d != dim - 1)
971d9b500d3SAart Bik         emitCall(rewriter, loc, printComma);
972d9b500d3SAart Bik     }
973d9b500d3SAart Bik     emitCall(rewriter, loc, getPrintClose(op));
974d9b500d3SAart Bik   }
975d9b500d3SAart Bik 
976d9b500d3SAart Bik   // Helper to emit a call.
977d9b500d3SAart Bik   static void emitCall(ConversionPatternRewriter &rewriter, Location loc,
978d9b500d3SAart Bik                        Operation *ref, ValueRange params = ValueRange()) {
979d9b500d3SAart Bik     rewriter.create<LLVM::CallOp>(loc, ArrayRef<Type>{},
980d9b500d3SAart Bik                                   rewriter.getSymbolRefAttr(ref), params);
981d9b500d3SAart Bik   }
982d9b500d3SAart Bik 
983d9b500d3SAart Bik   // Helper for printer method declaration (first hit) and lookup.
984d9b500d3SAart Bik   static Operation *getPrint(Operation *op, LLVM::LLVMDialect *dialect,
985d9b500d3SAart Bik                              StringRef name, ArrayRef<LLVM::LLVMType> params) {
986d9b500d3SAart Bik     auto module = op->getParentOfType<ModuleOp>();
987d9b500d3SAart Bik     auto func = module.lookupSymbol<LLVM::LLVMFuncOp>(name);
988d9b500d3SAart Bik     if (func)
989d9b500d3SAart Bik       return func;
990d9b500d3SAart Bik     OpBuilder moduleBuilder(module.getBodyRegion());
991d9b500d3SAart Bik     return moduleBuilder.create<LLVM::LLVMFuncOp>(
992d9b500d3SAart Bik         op->getLoc(), name,
993d9b500d3SAart Bik         LLVM::LLVMType::getFunctionTy(LLVM::LLVMType::getVoidTy(dialect),
994d9b500d3SAart Bik                                       params, /*isVarArg=*/false));
995d9b500d3SAart Bik   }
996d9b500d3SAart Bik 
997d9b500d3SAart Bik   // Helpers for method names.
998e52414b1Saartbik   Operation *getPrintI32(Operation *op) const {
9990f04384dSAlex Zinenko     LLVM::LLVMDialect *dialect = typeConverter.getDialect();
1000e52414b1Saartbik     return getPrint(op, dialect, "print_i32",
1001e52414b1Saartbik                     LLVM::LLVMType::getInt32Ty(dialect));
1002e52414b1Saartbik   }
1003e52414b1Saartbik   Operation *getPrintI64(Operation *op) const {
10040f04384dSAlex Zinenko     LLVM::LLVMDialect *dialect = typeConverter.getDialect();
1005e52414b1Saartbik     return getPrint(op, dialect, "print_i64",
1006e52414b1Saartbik                     LLVM::LLVMType::getInt64Ty(dialect));
1007e52414b1Saartbik   }
1008d9b500d3SAart Bik   Operation *getPrintFloat(Operation *op) const {
10090f04384dSAlex Zinenko     LLVM::LLVMDialect *dialect = typeConverter.getDialect();
1010d9b500d3SAart Bik     return getPrint(op, dialect, "print_f32",
1011d9b500d3SAart Bik                     LLVM::LLVMType::getFloatTy(dialect));
1012d9b500d3SAart Bik   }
1013d9b500d3SAart Bik   Operation *getPrintDouble(Operation *op) const {
10140f04384dSAlex Zinenko     LLVM::LLVMDialect *dialect = typeConverter.getDialect();
1015d9b500d3SAart Bik     return getPrint(op, dialect, "print_f64",
1016d9b500d3SAart Bik                     LLVM::LLVMType::getDoubleTy(dialect));
1017d9b500d3SAart Bik   }
1018d9b500d3SAart Bik   Operation *getPrintOpen(Operation *op) const {
10190f04384dSAlex Zinenko     return getPrint(op, typeConverter.getDialect(), "print_open", {});
1020d9b500d3SAart Bik   }
1021d9b500d3SAart Bik   Operation *getPrintClose(Operation *op) const {
10220f04384dSAlex Zinenko     return getPrint(op, typeConverter.getDialect(), "print_close", {});
1023d9b500d3SAart Bik   }
1024d9b500d3SAart Bik   Operation *getPrintComma(Operation *op) const {
10250f04384dSAlex Zinenko     return getPrint(op, typeConverter.getDialect(), "print_comma", {});
1026d9b500d3SAart Bik   }
1027d9b500d3SAart Bik   Operation *getPrintNewline(Operation *op) const {
10280f04384dSAlex Zinenko     return getPrint(op, typeConverter.getDialect(), "print_newline", {});
1029d9b500d3SAart Bik   }
1030d9b500d3SAart Bik };
1031d9b500d3SAart Bik 
103265678d93SNicolas Vasilache /// Progressive lowering of StridedSliceOp to either:
103365678d93SNicolas Vasilache ///   1. extractelement + insertelement for the 1-D case
103465678d93SNicolas Vasilache ///   2. extract + optional strided_slice + insert for the n-D case.
10352d515e49SNicolas Vasilache class VectorStridedSliceOpConversion : public OpRewritePattern<StridedSliceOp> {
103665678d93SNicolas Vasilache public:
103765678d93SNicolas Vasilache   using OpRewritePattern<StridedSliceOp>::OpRewritePattern;
103865678d93SNicolas Vasilache 
10393145427dSRiver Riddle   LogicalResult matchAndRewrite(StridedSliceOp op,
104065678d93SNicolas Vasilache                                 PatternRewriter &rewriter) const override {
104165678d93SNicolas Vasilache     auto dstType = op.getResult().getType().cast<VectorType>();
104265678d93SNicolas Vasilache 
104365678d93SNicolas Vasilache     assert(!op.offsets().getValue().empty() && "Unexpected empty offsets");
104465678d93SNicolas Vasilache 
104565678d93SNicolas Vasilache     int64_t offset =
104665678d93SNicolas Vasilache         op.offsets().getValue().front().cast<IntegerAttr>().getInt();
104765678d93SNicolas Vasilache     int64_t size = op.sizes().getValue().front().cast<IntegerAttr>().getInt();
104865678d93SNicolas Vasilache     int64_t stride =
104965678d93SNicolas Vasilache         op.strides().getValue().front().cast<IntegerAttr>().getInt();
105065678d93SNicolas Vasilache 
105165678d93SNicolas Vasilache     auto loc = op.getLoc();
105265678d93SNicolas Vasilache     auto elemType = dstType.getElementType();
105335b68527SLei Zhang     assert(elemType.isSignlessIntOrIndexOrFloat());
105465678d93SNicolas Vasilache     Value zero = rewriter.create<ConstantOp>(loc, elemType,
105565678d93SNicolas Vasilache                                              rewriter.getZeroAttr(elemType));
105665678d93SNicolas Vasilache     Value res = rewriter.create<SplatOp>(loc, dstType, zero);
105765678d93SNicolas Vasilache     for (int64_t off = offset, e = offset + size * stride, idx = 0; off < e;
105865678d93SNicolas Vasilache          off += stride, ++idx) {
105965678d93SNicolas Vasilache       Value extracted = extractOne(rewriter, loc, op.vector(), off);
106065678d93SNicolas Vasilache       if (op.offsets().getValue().size() > 1) {
1061*bd1ccfe6SRiver Riddle         extracted = rewriter.create<StridedSliceOp>(
106265678d93SNicolas Vasilache             loc, extracted, getI64SubArray(op.offsets(), /* dropFront=*/1),
106365678d93SNicolas Vasilache             getI64SubArray(op.sizes(), /* dropFront=*/1),
106465678d93SNicolas Vasilache             getI64SubArray(op.strides(), /* dropFront=*/1));
106565678d93SNicolas Vasilache       }
106665678d93SNicolas Vasilache       res = insertOne(rewriter, loc, extracted, res, idx);
106765678d93SNicolas Vasilache     }
106865678d93SNicolas Vasilache     rewriter.replaceOp(op, {res});
10693145427dSRiver Riddle     return success();
107065678d93SNicolas Vasilache   }
1071*bd1ccfe6SRiver Riddle   /// This pattern creates recursive StridedSliceOp, but the recursion is
1072*bd1ccfe6SRiver Riddle   /// bounded as the rank is strictly decreasing.
1073*bd1ccfe6SRiver Riddle   bool hasBoundedRewriteRecursion() const final { return true; }
107465678d93SNicolas Vasilache };
107565678d93SNicolas Vasilache 
1076df186507SBenjamin Kramer } // namespace
1077df186507SBenjamin Kramer 
10785c0c51a9SNicolas Vasilache /// Populate the given list with patterns that convert from Vector to LLVM.
10795c0c51a9SNicolas Vasilache void mlir::populateVectorToLLVMConversionPatterns(
10805c0c51a9SNicolas Vasilache     LLVMTypeConverter &converter, OwningRewritePatternList &patterns) {
108165678d93SNicolas Vasilache   MLIRContext *ctx = converter.getDialect()->getContext();
1082681f929fSNicolas Vasilache   patterns.insert<VectorFMAOpNDRewritePattern,
1083681f929fSNicolas Vasilache                   VectorInsertStridedSliceOpDifferentRankRewritePattern,
10842d515e49SNicolas Vasilache                   VectorInsertStridedSliceOpSameRankRewritePattern,
10852d515e49SNicolas Vasilache                   VectorStridedSliceOpConversion>(ctx);
1086e83b7b99Saartbik   patterns.insert<VectorBroadcastOpConversion, VectorReductionOpConversion,
10870d924700Saartbik                   VectorShuffleOpConversion, VectorExtractElementOpConversion,
10880d924700Saartbik                   VectorExtractOpConversion, VectorFMAOp1DConversion,
10890d924700Saartbik                   VectorInsertElementOpConversion, VectorInsertOpConversion,
1090a213ece3Saartbik                   VectorTypeCastOpConversion, VectorPrintOpConversion>(
1091a213ece3Saartbik       ctx, converter);
10925c0c51a9SNicolas Vasilache }
10935c0c51a9SNicolas Vasilache 
109463b683a8SNicolas Vasilache void mlir::populateVectorToLLVMMatrixConversionPatterns(
109563b683a8SNicolas Vasilache     LLVMTypeConverter &converter, OwningRewritePatternList &patterns) {
109663b683a8SNicolas Vasilache   MLIRContext *ctx = converter.getDialect()->getContext();
109763b683a8SNicolas Vasilache   patterns.insert<VectorMatmulOpConversion>(ctx, converter);
109863b683a8SNicolas Vasilache }
109963b683a8SNicolas Vasilache 
11005c0c51a9SNicolas Vasilache namespace {
1101722f909fSRiver Riddle struct LowerVectorToLLVMPass
11021834ad4aSRiver Riddle     : public ConvertVectorToLLVMBase<LowerVectorToLLVMPass> {
1103722f909fSRiver Riddle   void runOnOperation() override;
11045c0c51a9SNicolas Vasilache };
11055c0c51a9SNicolas Vasilache } // namespace
11065c0c51a9SNicolas Vasilache 
1107722f909fSRiver Riddle void LowerVectorToLLVMPass::runOnOperation() {
1108078776a6Saartbik   // Perform progressive lowering of operations on slices and
1109b21c7999Saartbik   // all contraction operations. Also applies folding and DCE.
1110459cf6e5Saartbik   {
11115c0c51a9SNicolas Vasilache     OwningRewritePatternList patterns;
1112459cf6e5Saartbik     populateVectorSlicesLoweringPatterns(patterns, &getContext());
1113b21c7999Saartbik     populateVectorContractLoweringPatterns(patterns, &getContext());
1114722f909fSRiver Riddle     applyPatternsGreedily(getOperation(), patterns);
1115459cf6e5Saartbik   }
1116459cf6e5Saartbik 
1117459cf6e5Saartbik   // Convert to the LLVM IR dialect.
11185c0c51a9SNicolas Vasilache   LLVMTypeConverter converter(&getContext());
1119459cf6e5Saartbik   OwningRewritePatternList patterns;
112063b683a8SNicolas Vasilache   populateVectorToLLVMMatrixConversionPatterns(converter, patterns);
11215c0c51a9SNicolas Vasilache   populateVectorToLLVMConversionPatterns(converter, patterns);
1122bbf3ef85SNicolas Vasilache   populateVectorToLLVMMatrixConversionPatterns(converter, patterns);
11235c0c51a9SNicolas Vasilache   populateStdToLLVMConversionPatterns(converter, patterns);
11245c0c51a9SNicolas Vasilache 
11252a00ae39STim Shen   LLVMConversionTarget target(getContext());
11265c0c51a9SNicolas Vasilache   target.addDynamicallyLegalOp<FuncOp>(
11275c0c51a9SNicolas Vasilache       [&](FuncOp op) { return converter.isSignatureLegal(op.getType()); });
1128722f909fSRiver Riddle   if (failed(applyPartialConversion(getOperation(), target, patterns,
1129722f909fSRiver Riddle                                     &converter))) {
11305c0c51a9SNicolas Vasilache     signalPassFailure();
11315c0c51a9SNicolas Vasilache   }
11325c0c51a9SNicolas Vasilache }
11335c0c51a9SNicolas Vasilache 
113480aca1eaSRiver Riddle std::unique_ptr<OperationPass<ModuleOp>> mlir::createConvertVectorToLLVMPass() {
11352fae7878SNicolas Vasilache   return std::make_unique<LowerVectorToLLVMPass>();
11365c0c51a9SNicolas Vasilache }
1137