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 
1175e5f0aaSAlex Zinenko #include "mlir/Conversion/LLVMCommon/VectorPattern.h"
12a54f4eaeSMogball #include "mlir/Dialect/Arithmetic/IR/Arithmetic.h"
13*a75a46dbSJavier Setoain #include "mlir/Dialect/Arithmetic/Utils/Utils.h"
14e332c22cSNicolas Vasilache #include "mlir/Dialect/LLVMIR/FunctionCallUtils.h"
155c0c51a9SNicolas Vasilache #include "mlir/Dialect/LLVMIR/LLVMDialect.h"
16e2310704SJulian Gross #include "mlir/Dialect/MemRef/IR/MemRef.h"
1799ef9eebSMatthias Springer #include "mlir/Dialect/Vector/Transforms/VectorTransforms.h"
1809f7a55fSRiver Riddle #include "mlir/IR/BuiltinTypes.h"
1929a50c58SStephen Neuendorffer #include "mlir/Support/MathExtras.h"
20929189a4SWilliam S. Moses #include "mlir/Target/LLVMIR/TypeToLLVM.h"
215c0c51a9SNicolas Vasilache #include "mlir/Transforms/DialectConversion.h"
225c0c51a9SNicolas Vasilache 
235c0c51a9SNicolas Vasilache using namespace mlir;
2465678d93SNicolas Vasilache using namespace mlir::vector;
255c0c51a9SNicolas Vasilache 
269826fe5cSAart Bik // Helper to reduce vector type by one rank at front.
279826fe5cSAart Bik static VectorType reducedVectorTypeFront(VectorType tp) {
289826fe5cSAart Bik   assert((tp.getRank() > 1) && "unlowerable vector type");
29a4830d14SJavier Setoain   unsigned numScalableDims = tp.getNumScalableDims();
30a4830d14SJavier Setoain   if (tp.getShape().size() == numScalableDims)
31a4830d14SJavier Setoain     --numScalableDims;
32a4830d14SJavier Setoain   return VectorType::get(tp.getShape().drop_front(), tp.getElementType(),
33a4830d14SJavier Setoain                          numScalableDims);
349826fe5cSAart Bik }
359826fe5cSAart Bik 
369826fe5cSAart Bik // Helper to reduce vector type by *all* but one rank at back.
379826fe5cSAart Bik static VectorType reducedVectorTypeBack(VectorType tp) {
389826fe5cSAart Bik   assert((tp.getRank() > 1) && "unlowerable vector type");
39a4830d14SJavier Setoain   unsigned numScalableDims = tp.getNumScalableDims();
40a4830d14SJavier Setoain   if (numScalableDims > 0)
41a4830d14SJavier Setoain     --numScalableDims;
42a4830d14SJavier Setoain   return VectorType::get(tp.getShape().take_back(), tp.getElementType(),
43a4830d14SJavier Setoain                          numScalableDims);
449826fe5cSAart Bik }
459826fe5cSAart Bik 
461c81adf3SAart Bik // Helper that picks the proper sequence for inserting.
47e62a6956SRiver Riddle static Value insertOne(ConversionPatternRewriter &rewriter,
480f04384dSAlex Zinenko                        LLVMTypeConverter &typeConverter, Location loc,
490f04384dSAlex Zinenko                        Value val1, Value val2, Type llvmType, int64_t rank,
500f04384dSAlex Zinenko                        int64_t pos) {
51e7026abaSNicolas Vasilache   assert(rank > 0 && "0-D vector corner case should have been handled already");
521c81adf3SAart Bik   if (rank == 1) {
531c81adf3SAart Bik     auto idxType = rewriter.getIndexType();
541c81adf3SAart Bik     auto constant = rewriter.create<LLVM::ConstantOp>(
550f04384dSAlex Zinenko         loc, typeConverter.convertType(idxType),
561c81adf3SAart Bik         rewriter.getIntegerAttr(idxType, pos));
571c81adf3SAart Bik     return rewriter.create<LLVM::InsertElementOp>(loc, llvmType, val1, val2,
581c81adf3SAart Bik                                                   constant);
591c81adf3SAart Bik   }
601c81adf3SAart Bik   return rewriter.create<LLVM::InsertValueOp>(loc, llvmType, val1, val2,
611c81adf3SAart Bik                                               rewriter.getI64ArrayAttr(pos));
621c81adf3SAart Bik }
631c81adf3SAart Bik 
641c81adf3SAart Bik // Helper that picks the proper sequence for extracting.
65e62a6956SRiver Riddle static Value extractOne(ConversionPatternRewriter &rewriter,
660f04384dSAlex Zinenko                         LLVMTypeConverter &typeConverter, Location loc,
670f04384dSAlex Zinenko                         Value val, Type llvmType, int64_t rank, int64_t pos) {
68cc311a15SMichal Terepeta   if (rank <= 1) {
691c81adf3SAart Bik     auto idxType = rewriter.getIndexType();
701c81adf3SAart Bik     auto constant = rewriter.create<LLVM::ConstantOp>(
710f04384dSAlex Zinenko         loc, typeConverter.convertType(idxType),
721c81adf3SAart Bik         rewriter.getIntegerAttr(idxType, pos));
731c81adf3SAart Bik     return rewriter.create<LLVM::ExtractElementOp>(loc, llvmType, val,
741c81adf3SAart Bik                                                    constant);
751c81adf3SAart Bik   }
761c81adf3SAart Bik   return rewriter.create<LLVM::ExtractValueOp>(loc, llvmType, val,
771c81adf3SAart Bik                                                rewriter.getI64ArrayAttr(pos));
781c81adf3SAart Bik }
791c81adf3SAart Bik 
8026c8f908SThomas Raoux // Helper that returns data layout alignment of a memref.
8126c8f908SThomas Raoux LogicalResult getMemRefAlignment(LLVMTypeConverter &typeConverter,
8226c8f908SThomas Raoux                                  MemRefType memrefType, unsigned &align) {
8326c8f908SThomas Raoux   Type elementTy = typeConverter.convertType(memrefType.getElementType());
845f9e0466SNicolas Vasilache   if (!elementTy)
855f9e0466SNicolas Vasilache     return failure();
865f9e0466SNicolas Vasilache 
87b2ab375dSAlex Zinenko   // TODO: this should use the MLIR data layout when it becomes available and
88b2ab375dSAlex Zinenko   // stop depending on translation.
8987a89e0fSAlex Zinenko   llvm::LLVMContext llvmContext;
9087a89e0fSAlex Zinenko   align = LLVM::TypeToLLVMIRTranslator(llvmContext)
91c69c9e0fSAlex Zinenko               .getPreferredAlignment(elementTy, typeConverter.getDataLayout());
925f9e0466SNicolas Vasilache   return success();
935f9e0466SNicolas Vasilache }
945f9e0466SNicolas Vasilache 
95df5ccf5aSAart Bik // Add an index vector component to a base pointer. This almost always succeeds
96df5ccf5aSAart Bik // unless the last stride is non-unit or the memory space is not zero.
97df5ccf5aSAart Bik static LogicalResult getIndexedPtrs(ConversionPatternRewriter &rewriter,
98df5ccf5aSAart Bik                                     Location loc, Value memref, Value base,
99df5ccf5aSAart Bik                                     Value index, MemRefType memRefType,
100df5ccf5aSAart Bik                                     VectorType vType, Value &ptrs) {
10119dbb230Saartbik   int64_t offset;
10219dbb230Saartbik   SmallVector<int64_t, 4> strides;
10319dbb230Saartbik   auto successStrides = getStridesAndOffset(memRefType, strides, offset);
104df5ccf5aSAart Bik   if (failed(successStrides) || strides.back() != 1 ||
10537eca08eSVladislav Vinogradov       memRefType.getMemorySpaceAsInt() != 0)
106e8dcf5f8Saartbik     return failure();
1073a577f54SChristian Sigg   auto pType = MemRefDescriptor(memref).getElementPtrType();
108bd30a796SAlex Zinenko   auto ptrsType = LLVM::getFixedVectorType(pType, vType.getDimSize(0));
109df5ccf5aSAart Bik   ptrs = rewriter.create<LLVM::GEPOp>(loc, ptrsType, base, index);
11019dbb230Saartbik   return success();
11119dbb230Saartbik }
11219dbb230Saartbik 
113a57def30SAart Bik // Casts a strided element pointer to a vector pointer.  The vector pointer
11408c681f6SAndrew Pritchard // will be in the same address space as the incoming memref type.
115a57def30SAart Bik static Value castDataPtr(ConversionPatternRewriter &rewriter, Location loc,
116a57def30SAart Bik                          Value ptr, MemRefType memRefType, Type vt) {
11737eca08eSVladislav Vinogradov   auto pType = LLVM::LLVMPointerType::get(vt, memRefType.getMemorySpaceAsInt());
118a57def30SAart Bik   return rewriter.create<LLVM::BitcastOp>(loc, pType, ptr);
119a57def30SAart Bik }
120a57def30SAart Bik 
12190c01357SBenjamin Kramer namespace {
122e83b7b99Saartbik 
123a4830d14SJavier Setoain /// Trivial Vector to LLVM conversions
124a4830d14SJavier Setoain using VectorScaleOpConversion =
125a4830d14SJavier Setoain     OneToOneConvertToLLVMPattern<vector::VectorScaleOp, LLVM::vscale>;
126a4830d14SJavier Setoain 
127cf5c517cSDiego Caballero /// Conversion pattern for a vector.bitcast.
128cf5c517cSDiego Caballero class VectorBitCastOpConversion
129cf5c517cSDiego Caballero     : public ConvertOpToLLVMPattern<vector::BitCastOp> {
130cf5c517cSDiego Caballero public:
131cf5c517cSDiego Caballero   using ConvertOpToLLVMPattern<vector::BitCastOp>::ConvertOpToLLVMPattern;
132cf5c517cSDiego Caballero 
133cf5c517cSDiego Caballero   LogicalResult
134ef976337SRiver Riddle   matchAndRewrite(vector::BitCastOp bitCastOp, OpAdaptor adaptor,
135cf5c517cSDiego Caballero                   ConversionPatternRewriter &rewriter) const override {
1361423e8bfSMichal Terepeta     // Only 0-D and 1-D vectors can be lowered to LLVM.
1371423e8bfSMichal Terepeta     VectorType resultTy = bitCastOp.getResultVectorType();
1381423e8bfSMichal Terepeta     if (resultTy.getRank() > 1)
139cf5c517cSDiego Caballero       return failure();
140cf5c517cSDiego Caballero     Type newResultTy = typeConverter->convertType(resultTy);
141cf5c517cSDiego Caballero     rewriter.replaceOpWithNewOp<LLVM::BitcastOp>(bitCastOp, newResultTy,
142ef976337SRiver Riddle                                                  adaptor.getOperands()[0]);
143cf5c517cSDiego Caballero     return success();
144cf5c517cSDiego Caballero   }
145cf5c517cSDiego Caballero };
146cf5c517cSDiego Caballero 
14763b683a8SNicolas Vasilache /// Conversion pattern for a vector.matrix_multiply.
14863b683a8SNicolas Vasilache /// This is lowered directly to the proper llvm.intr.matrix.multiply.
149563879b6SRahul Joshi class VectorMatmulOpConversion
150563879b6SRahul Joshi     : public ConvertOpToLLVMPattern<vector::MatmulOp> {
15163b683a8SNicolas Vasilache public:
152563879b6SRahul Joshi   using ConvertOpToLLVMPattern<vector::MatmulOp>::ConvertOpToLLVMPattern;
15363b683a8SNicolas Vasilache 
1543145427dSRiver Riddle   LogicalResult
155ef976337SRiver Riddle   matchAndRewrite(vector::MatmulOp matmulOp, OpAdaptor adaptor,
15663b683a8SNicolas Vasilache                   ConversionPatternRewriter &rewriter) const override {
15763b683a8SNicolas Vasilache     rewriter.replaceOpWithNewOp<LLVM::MatrixMultiplyOp>(
158563879b6SRahul Joshi         matmulOp, typeConverter->convertType(matmulOp.res().getType()),
159563879b6SRahul Joshi         adaptor.lhs(), adaptor.rhs(), matmulOp.lhs_rows(),
160563879b6SRahul Joshi         matmulOp.lhs_columns(), matmulOp.rhs_columns());
1613145427dSRiver Riddle     return success();
16263b683a8SNicolas Vasilache   }
16363b683a8SNicolas Vasilache };
16463b683a8SNicolas Vasilache 
165c295a65dSaartbik /// Conversion pattern for a vector.flat_transpose.
166c295a65dSaartbik /// This is lowered directly to the proper llvm.intr.matrix.transpose.
167563879b6SRahul Joshi class VectorFlatTransposeOpConversion
168563879b6SRahul Joshi     : public ConvertOpToLLVMPattern<vector::FlatTransposeOp> {
169c295a65dSaartbik public:
170563879b6SRahul Joshi   using ConvertOpToLLVMPattern<vector::FlatTransposeOp>::ConvertOpToLLVMPattern;
171c295a65dSaartbik 
172c295a65dSaartbik   LogicalResult
173ef976337SRiver Riddle   matchAndRewrite(vector::FlatTransposeOp transOp, OpAdaptor adaptor,
174c295a65dSaartbik                   ConversionPatternRewriter &rewriter) const override {
175c295a65dSaartbik     rewriter.replaceOpWithNewOp<LLVM::MatrixTransposeOp>(
176dcec2ca5SChristian Sigg         transOp, typeConverter->convertType(transOp.res().getType()),
177c295a65dSaartbik         adaptor.matrix(), transOp.rows(), transOp.columns());
178c295a65dSaartbik     return success();
179c295a65dSaartbik   }
180c295a65dSaartbik };
181c295a65dSaartbik 
182ee66e43aSDiego Caballero /// Overloaded utility that replaces a vector.load, vector.store,
183ee66e43aSDiego Caballero /// vector.maskedload and vector.maskedstore with their respective LLVM
184ee66e43aSDiego Caballero /// couterparts.
185ee66e43aSDiego Caballero static void replaceLoadOrStoreOp(vector::LoadOp loadOp,
186ee66e43aSDiego Caballero                                  vector::LoadOpAdaptor adaptor,
187ee66e43aSDiego Caballero                                  VectorType vectorTy, Value ptr, unsigned align,
188ee66e43aSDiego Caballero                                  ConversionPatternRewriter &rewriter) {
189ee66e43aSDiego Caballero   rewriter.replaceOpWithNewOp<LLVM::LoadOp>(loadOp, ptr, align);
19039379916Saartbik }
19139379916Saartbik 
192ee66e43aSDiego Caballero static void replaceLoadOrStoreOp(vector::MaskedLoadOp loadOp,
193ee66e43aSDiego Caballero                                  vector::MaskedLoadOpAdaptor adaptor,
194ee66e43aSDiego Caballero                                  VectorType vectorTy, Value ptr, unsigned align,
195ee66e43aSDiego Caballero                                  ConversionPatternRewriter &rewriter) {
196ee66e43aSDiego Caballero   rewriter.replaceOpWithNewOp<LLVM::MaskedLoadOp>(
197ee66e43aSDiego Caballero       loadOp, vectorTy, ptr, adaptor.mask(), adaptor.pass_thru(), align);
198ee66e43aSDiego Caballero }
199ee66e43aSDiego Caballero 
200ee66e43aSDiego Caballero static void replaceLoadOrStoreOp(vector::StoreOp storeOp,
201ee66e43aSDiego Caballero                                  vector::StoreOpAdaptor adaptor,
202ee66e43aSDiego Caballero                                  VectorType vectorTy, Value ptr, unsigned align,
203ee66e43aSDiego Caballero                                  ConversionPatternRewriter &rewriter) {
204ee66e43aSDiego Caballero   rewriter.replaceOpWithNewOp<LLVM::StoreOp>(storeOp, adaptor.valueToStore(),
205ee66e43aSDiego Caballero                                              ptr, align);
206ee66e43aSDiego Caballero }
207ee66e43aSDiego Caballero 
208ee66e43aSDiego Caballero static void replaceLoadOrStoreOp(vector::MaskedStoreOp storeOp,
209ee66e43aSDiego Caballero                                  vector::MaskedStoreOpAdaptor adaptor,
210ee66e43aSDiego Caballero                                  VectorType vectorTy, Value ptr, unsigned align,
211ee66e43aSDiego Caballero                                  ConversionPatternRewriter &rewriter) {
212ee66e43aSDiego Caballero   rewriter.replaceOpWithNewOp<LLVM::MaskedStoreOp>(
213ee66e43aSDiego Caballero       storeOp, adaptor.valueToStore(), ptr, adaptor.mask(), align);
214ee66e43aSDiego Caballero }
215ee66e43aSDiego Caballero 
216ee66e43aSDiego Caballero /// Conversion pattern for a vector.load, vector.store, vector.maskedload, and
217ee66e43aSDiego Caballero /// vector.maskedstore.
218ee66e43aSDiego Caballero template <class LoadOrStoreOp, class LoadOrStoreOpAdaptor>
219ee66e43aSDiego Caballero class VectorLoadStoreConversion : public ConvertOpToLLVMPattern<LoadOrStoreOp> {
22039379916Saartbik public:
221ee66e43aSDiego Caballero   using ConvertOpToLLVMPattern<LoadOrStoreOp>::ConvertOpToLLVMPattern;
22239379916Saartbik 
22339379916Saartbik   LogicalResult
224ef976337SRiver Riddle   matchAndRewrite(LoadOrStoreOp loadOrStoreOp,
225ef976337SRiver Riddle                   typename LoadOrStoreOp::Adaptor adaptor,
22639379916Saartbik                   ConversionPatternRewriter &rewriter) const override {
227ee66e43aSDiego Caballero     // Only 1-D vectors can be lowered to LLVM.
228ee66e43aSDiego Caballero     VectorType vectorTy = loadOrStoreOp.getVectorType();
229ee66e43aSDiego Caballero     if (vectorTy.getRank() > 1)
230ee66e43aSDiego Caballero       return failure();
231ee66e43aSDiego Caballero 
232ee66e43aSDiego Caballero     auto loc = loadOrStoreOp->getLoc();
233ee66e43aSDiego Caballero     MemRefType memRefTy = loadOrStoreOp.getMemRefType();
23439379916Saartbik 
23539379916Saartbik     // Resolve alignment.
23639379916Saartbik     unsigned align;
23773863648SStephen Neuendorffer     if (failed(getMemRefAlignment(*this->getTypeConverter(), memRefTy, align)))
23839379916Saartbik       return failure();
23939379916Saartbik 
240a57def30SAart Bik     // Resolve address.
241ee66e43aSDiego Caballero     auto vtype = this->typeConverter->convertType(loadOrStoreOp.getVectorType())
242ee66e43aSDiego Caballero                      .template cast<VectorType>();
243ee66e43aSDiego Caballero     Value dataPtr = this->getStridedElementPtr(loc, memRefTy, adaptor.base(),
244a57def30SAart Bik                                                adaptor.indices(), rewriter);
245ee66e43aSDiego Caballero     Value ptr = castDataPtr(rewriter, loc, dataPtr, memRefTy, vtype);
24639379916Saartbik 
247ee66e43aSDiego Caballero     replaceLoadOrStoreOp(loadOrStoreOp, adaptor, vtype, ptr, align, rewriter);
24839379916Saartbik     return success();
24939379916Saartbik   }
25039379916Saartbik };
25139379916Saartbik 
25219dbb230Saartbik /// Conversion pattern for a vector.gather.
253563879b6SRahul Joshi class VectorGatherOpConversion
254563879b6SRahul Joshi     : public ConvertOpToLLVMPattern<vector::GatherOp> {
25519dbb230Saartbik public:
256563879b6SRahul Joshi   using ConvertOpToLLVMPattern<vector::GatherOp>::ConvertOpToLLVMPattern;
25719dbb230Saartbik 
25819dbb230Saartbik   LogicalResult
259ef976337SRiver Riddle   matchAndRewrite(vector::GatherOp gather, OpAdaptor adaptor,
26019dbb230Saartbik                   ConversionPatternRewriter &rewriter) const override {
261563879b6SRahul Joshi     auto loc = gather->getLoc();
262df5ccf5aSAart Bik     MemRefType memRefType = gather.getMemRefType();
26319dbb230Saartbik 
26419dbb230Saartbik     // Resolve alignment.
26519dbb230Saartbik     unsigned align;
26673863648SStephen Neuendorffer     if (failed(getMemRefAlignment(*getTypeConverter(), memRefType, align)))
26719dbb230Saartbik       return failure();
26819dbb230Saartbik 
269df5ccf5aSAart Bik     // Resolve address.
27019dbb230Saartbik     Value ptrs;
271df5ccf5aSAart Bik     VectorType vType = gather.getVectorType();
272df5ccf5aSAart Bik     Value ptr = getStridedElementPtr(loc, memRefType, adaptor.base(),
273df5ccf5aSAart Bik                                      adaptor.indices(), rewriter);
274df5ccf5aSAart Bik     if (failed(getIndexedPtrs(rewriter, loc, adaptor.base(), ptr,
275df5ccf5aSAart Bik                               adaptor.index_vec(), memRefType, vType, ptrs)))
27619dbb230Saartbik       return failure();
27719dbb230Saartbik 
27819dbb230Saartbik     // Replace with the gather intrinsic.
27919dbb230Saartbik     rewriter.replaceOpWithNewOp<LLVM::masked_gather>(
280dcec2ca5SChristian Sigg         gather, typeConverter->convertType(vType), ptrs, adaptor.mask(),
2810c2a4d3cSBenjamin Kramer         adaptor.pass_thru(), rewriter.getI32IntegerAttr(align));
28219dbb230Saartbik     return success();
28319dbb230Saartbik   }
28419dbb230Saartbik };
28519dbb230Saartbik 
28619dbb230Saartbik /// Conversion pattern for a vector.scatter.
287563879b6SRahul Joshi class VectorScatterOpConversion
288563879b6SRahul Joshi     : public ConvertOpToLLVMPattern<vector::ScatterOp> {
28919dbb230Saartbik public:
290563879b6SRahul Joshi   using ConvertOpToLLVMPattern<vector::ScatterOp>::ConvertOpToLLVMPattern;
29119dbb230Saartbik 
29219dbb230Saartbik   LogicalResult
293ef976337SRiver Riddle   matchAndRewrite(vector::ScatterOp scatter, OpAdaptor adaptor,
29419dbb230Saartbik                   ConversionPatternRewriter &rewriter) const override {
295563879b6SRahul Joshi     auto loc = scatter->getLoc();
296df5ccf5aSAart Bik     MemRefType memRefType = scatter.getMemRefType();
29719dbb230Saartbik 
29819dbb230Saartbik     // Resolve alignment.
29919dbb230Saartbik     unsigned align;
30073863648SStephen Neuendorffer     if (failed(getMemRefAlignment(*getTypeConverter(), memRefType, align)))
30119dbb230Saartbik       return failure();
30219dbb230Saartbik 
303df5ccf5aSAart Bik     // Resolve address.
30419dbb230Saartbik     Value ptrs;
305df5ccf5aSAart Bik     VectorType vType = scatter.getVectorType();
306df5ccf5aSAart Bik     Value ptr = getStridedElementPtr(loc, memRefType, adaptor.base(),
307df5ccf5aSAart Bik                                      adaptor.indices(), rewriter);
308df5ccf5aSAart Bik     if (failed(getIndexedPtrs(rewriter, loc, adaptor.base(), ptr,
309df5ccf5aSAart Bik                               adaptor.index_vec(), memRefType, vType, ptrs)))
31019dbb230Saartbik       return failure();
31119dbb230Saartbik 
31219dbb230Saartbik     // Replace with the scatter intrinsic.
31319dbb230Saartbik     rewriter.replaceOpWithNewOp<LLVM::masked_scatter>(
314656674a7SDiego Caballero         scatter, adaptor.valueToStore(), ptrs, adaptor.mask(),
31519dbb230Saartbik         rewriter.getI32IntegerAttr(align));
31619dbb230Saartbik     return success();
31719dbb230Saartbik   }
31819dbb230Saartbik };
31919dbb230Saartbik 
320e8dcf5f8Saartbik /// Conversion pattern for a vector.expandload.
321563879b6SRahul Joshi class VectorExpandLoadOpConversion
322563879b6SRahul Joshi     : public ConvertOpToLLVMPattern<vector::ExpandLoadOp> {
323e8dcf5f8Saartbik public:
324563879b6SRahul Joshi   using ConvertOpToLLVMPattern<vector::ExpandLoadOp>::ConvertOpToLLVMPattern;
325e8dcf5f8Saartbik 
326e8dcf5f8Saartbik   LogicalResult
327ef976337SRiver Riddle   matchAndRewrite(vector::ExpandLoadOp expand, OpAdaptor adaptor,
328e8dcf5f8Saartbik                   ConversionPatternRewriter &rewriter) const override {
329563879b6SRahul Joshi     auto loc = expand->getLoc();
330a57def30SAart Bik     MemRefType memRefType = expand.getMemRefType();
331e8dcf5f8Saartbik 
332a57def30SAart Bik     // Resolve address.
333656674a7SDiego Caballero     auto vtype = typeConverter->convertType(expand.getVectorType());
334df5ccf5aSAart Bik     Value ptr = getStridedElementPtr(loc, memRefType, adaptor.base(),
335a57def30SAart Bik                                      adaptor.indices(), rewriter);
336e8dcf5f8Saartbik 
337e8dcf5f8Saartbik     rewriter.replaceOpWithNewOp<LLVM::masked_expandload>(
338a57def30SAart Bik         expand, vtype, ptr, adaptor.mask(), adaptor.pass_thru());
339e8dcf5f8Saartbik     return success();
340e8dcf5f8Saartbik   }
341e8dcf5f8Saartbik };
342e8dcf5f8Saartbik 
343e8dcf5f8Saartbik /// Conversion pattern for a vector.compressstore.
344563879b6SRahul Joshi class VectorCompressStoreOpConversion
345563879b6SRahul Joshi     : public ConvertOpToLLVMPattern<vector::CompressStoreOp> {
346e8dcf5f8Saartbik public:
347563879b6SRahul Joshi   using ConvertOpToLLVMPattern<vector::CompressStoreOp>::ConvertOpToLLVMPattern;
348e8dcf5f8Saartbik 
349e8dcf5f8Saartbik   LogicalResult
350ef976337SRiver Riddle   matchAndRewrite(vector::CompressStoreOp compress, OpAdaptor adaptor,
351e8dcf5f8Saartbik                   ConversionPatternRewriter &rewriter) const override {
352563879b6SRahul Joshi     auto loc = compress->getLoc();
353a57def30SAart Bik     MemRefType memRefType = compress.getMemRefType();
354e8dcf5f8Saartbik 
355a57def30SAart Bik     // Resolve address.
356df5ccf5aSAart Bik     Value ptr = getStridedElementPtr(loc, memRefType, adaptor.base(),
357a57def30SAart Bik                                      adaptor.indices(), rewriter);
358e8dcf5f8Saartbik 
359e8dcf5f8Saartbik     rewriter.replaceOpWithNewOp<LLVM::masked_compressstore>(
360656674a7SDiego Caballero         compress, adaptor.valueToStore(), ptr, adaptor.mask());
361e8dcf5f8Saartbik     return success();
362e8dcf5f8Saartbik   }
363e8dcf5f8Saartbik };
364e8dcf5f8Saartbik 
36519dbb230Saartbik /// Conversion pattern for all vector reductions.
366563879b6SRahul Joshi class VectorReductionOpConversion
367563879b6SRahul Joshi     : public ConvertOpToLLVMPattern<vector::ReductionOp> {
368e83b7b99Saartbik public:
369563879b6SRahul Joshi   explicit VectorReductionOpConversion(LLVMTypeConverter &typeConv,
370060c9dd1Saartbik                                        bool reassociateFPRed)
371563879b6SRahul Joshi       : ConvertOpToLLVMPattern<vector::ReductionOp>(typeConv),
372060c9dd1Saartbik         reassociateFPReductions(reassociateFPRed) {}
373e83b7b99Saartbik 
3743145427dSRiver Riddle   LogicalResult
375ef976337SRiver Riddle   matchAndRewrite(vector::ReductionOp reductionOp, OpAdaptor adaptor,
376e83b7b99Saartbik                   ConversionPatternRewriter &rewriter) const override {
377e83b7b99Saartbik     auto kind = reductionOp.kind();
378e83b7b99Saartbik     Type eltType = reductionOp.dest().getType();
379dcec2ca5SChristian Sigg     Type llvmType = typeConverter->convertType(eltType);
380ef976337SRiver Riddle     Value operand = adaptor.getOperands()[0];
381e9628955SAart Bik     if (eltType.isIntOrIndex()) {
382e83b7b99Saartbik       // Integer reductions: add/mul/min/max/and/or/xor.
383fe0bf7d4SMatthias Springer       if (kind == vector::CombiningKind::ADD)
384ef976337SRiver Riddle         rewriter.replaceOpWithNewOp<LLVM::vector_reduce_add>(reductionOp,
385ef976337SRiver Riddle                                                              llvmType, operand);
386fe0bf7d4SMatthias Springer       else if (kind == vector::CombiningKind::MUL)
387ef976337SRiver Riddle         rewriter.replaceOpWithNewOp<LLVM::vector_reduce_mul>(reductionOp,
388ef976337SRiver Riddle                                                              llvmType, operand);
389fe0bf7d4SMatthias Springer       else if (kind == vector::CombiningKind::MINUI)
390322d0afdSAmara Emerson         rewriter.replaceOpWithNewOp<LLVM::vector_reduce_umin>(
391ef976337SRiver Riddle             reductionOp, llvmType, operand);
392fe0bf7d4SMatthias Springer       else if (kind == vector::CombiningKind::MINSI)
393322d0afdSAmara Emerson         rewriter.replaceOpWithNewOp<LLVM::vector_reduce_smin>(
394ef976337SRiver Riddle             reductionOp, llvmType, operand);
395fe0bf7d4SMatthias Springer       else if (kind == vector::CombiningKind::MAXUI)
396322d0afdSAmara Emerson         rewriter.replaceOpWithNewOp<LLVM::vector_reduce_umax>(
397ef976337SRiver Riddle             reductionOp, llvmType, operand);
398fe0bf7d4SMatthias Springer       else if (kind == vector::CombiningKind::MAXSI)
399322d0afdSAmara Emerson         rewriter.replaceOpWithNewOp<LLVM::vector_reduce_smax>(
400ef976337SRiver Riddle             reductionOp, llvmType, operand);
401fe0bf7d4SMatthias Springer       else if (kind == vector::CombiningKind::AND)
402ef976337SRiver Riddle         rewriter.replaceOpWithNewOp<LLVM::vector_reduce_and>(reductionOp,
403ef976337SRiver Riddle                                                              llvmType, operand);
404fe0bf7d4SMatthias Springer       else if (kind == vector::CombiningKind::OR)
405ef976337SRiver Riddle         rewriter.replaceOpWithNewOp<LLVM::vector_reduce_or>(reductionOp,
406ef976337SRiver Riddle                                                             llvmType, operand);
407fe0bf7d4SMatthias Springer       else if (kind == vector::CombiningKind::XOR)
408ef976337SRiver Riddle         rewriter.replaceOpWithNewOp<LLVM::vector_reduce_xor>(reductionOp,
409ef976337SRiver Riddle                                                              llvmType, operand);
410e83b7b99Saartbik       else
4113145427dSRiver Riddle         return failure();
4123145427dSRiver Riddle       return success();
413dcec2ca5SChristian Sigg     }
414e83b7b99Saartbik 
415dcec2ca5SChristian Sigg     if (!eltType.isa<FloatType>())
416dcec2ca5SChristian Sigg       return failure();
417dcec2ca5SChristian Sigg 
418e83b7b99Saartbik     // Floating-point reductions: add/mul/min/max
419fe0bf7d4SMatthias Springer     if (kind == vector::CombiningKind::ADD) {
4200d924700Saartbik       // Optional accumulator (or zero).
421ef976337SRiver Riddle       Value acc = adaptor.getOperands().size() > 1
422ef976337SRiver Riddle                       ? adaptor.getOperands()[1]
4230d924700Saartbik                       : rewriter.create<LLVM::ConstantOp>(
424563879b6SRahul Joshi                             reductionOp->getLoc(), llvmType,
4250d924700Saartbik                             rewriter.getZeroAttr(eltType));
426322d0afdSAmara Emerson       rewriter.replaceOpWithNewOp<LLVM::vector_reduce_fadd>(
427ef976337SRiver Riddle           reductionOp, llvmType, acc, operand,
428ceb1b327Saartbik           rewriter.getBoolAttr(reassociateFPReductions));
429fe0bf7d4SMatthias Springer     } else if (kind == vector::CombiningKind::MUL) {
4300d924700Saartbik       // Optional accumulator (or one).
431ef976337SRiver Riddle       Value acc = adaptor.getOperands().size() > 1
432ef976337SRiver Riddle                       ? adaptor.getOperands()[1]
4330d924700Saartbik                       : rewriter.create<LLVM::ConstantOp>(
434563879b6SRahul Joshi                             reductionOp->getLoc(), llvmType,
4350d924700Saartbik                             rewriter.getFloatAttr(eltType, 1.0));
436322d0afdSAmara Emerson       rewriter.replaceOpWithNewOp<LLVM::vector_reduce_fmul>(
437ef976337SRiver Riddle           reductionOp, llvmType, acc, operand,
438ceb1b327Saartbik           rewriter.getBoolAttr(reassociateFPReductions));
439fe0bf7d4SMatthias Springer     } else if (kind == vector::CombiningKind::MINF)
440eaf2588aSDiego Caballero       // FIXME: MLIR's 'minf' and LLVM's 'vector_reduce_fmin' do not handle
441eaf2588aSDiego Caballero       // NaNs/-0.0/+0.0 in the same way.
442ef976337SRiver Riddle       rewriter.replaceOpWithNewOp<LLVM::vector_reduce_fmin>(reductionOp,
443ef976337SRiver Riddle                                                             llvmType, operand);
444fe0bf7d4SMatthias Springer     else if (kind == vector::CombiningKind::MAXF)
445eaf2588aSDiego Caballero       // FIXME: MLIR's 'maxf' and LLVM's 'vector_reduce_fmax' do not handle
446eaf2588aSDiego Caballero       // NaNs/-0.0/+0.0 in the same way.
447ef976337SRiver Riddle       rewriter.replaceOpWithNewOp<LLVM::vector_reduce_fmax>(reductionOp,
448ef976337SRiver Riddle                                                             llvmType, operand);
449e83b7b99Saartbik     else
4503145427dSRiver Riddle       return failure();
4513145427dSRiver Riddle     return success();
452e83b7b99Saartbik   }
453ceb1b327Saartbik 
454ceb1b327Saartbik private:
455ceb1b327Saartbik   const bool reassociateFPReductions;
456e83b7b99Saartbik };
457e83b7b99Saartbik 
458563879b6SRahul Joshi class VectorShuffleOpConversion
459563879b6SRahul Joshi     : public ConvertOpToLLVMPattern<vector::ShuffleOp> {
4601c81adf3SAart Bik public:
461563879b6SRahul Joshi   using ConvertOpToLLVMPattern<vector::ShuffleOp>::ConvertOpToLLVMPattern;
4621c81adf3SAart Bik 
4633145427dSRiver Riddle   LogicalResult
464ef976337SRiver Riddle   matchAndRewrite(vector::ShuffleOp shuffleOp, OpAdaptor adaptor,
4651c81adf3SAart Bik                   ConversionPatternRewriter &rewriter) const override {
466563879b6SRahul Joshi     auto loc = shuffleOp->getLoc();
4671c81adf3SAart Bik     auto v1Type = shuffleOp.getV1VectorType();
4681c81adf3SAart Bik     auto v2Type = shuffleOp.getV2VectorType();
4691c81adf3SAart Bik     auto vectorType = shuffleOp.getVectorType();
470dcec2ca5SChristian Sigg     Type llvmType = typeConverter->convertType(vectorType);
4711c81adf3SAart Bik     auto maskArrayAttr = shuffleOp.mask();
4721c81adf3SAart Bik 
4731c81adf3SAart Bik     // Bail if result type cannot be lowered.
4741c81adf3SAart Bik     if (!llvmType)
4753145427dSRiver Riddle       return failure();
4761c81adf3SAart Bik 
4771c81adf3SAart Bik     // Get rank and dimension sizes.
4781c81adf3SAart Bik     int64_t rank = vectorType.getRank();
4791c81adf3SAart Bik     assert(v1Type.getRank() == rank);
4801c81adf3SAart Bik     assert(v2Type.getRank() == rank);
4811c81adf3SAart Bik     int64_t v1Dim = v1Type.getDimSize(0);
4821c81adf3SAart Bik 
4831c81adf3SAart Bik     // For rank 1, where both operands have *exactly* the same vector type,
4841c81adf3SAart Bik     // there is direct shuffle support in LLVM. Use it!
4851c81adf3SAart Bik     if (rank == 1 && v1Type == v2Type) {
486563879b6SRahul Joshi       Value llvmShuffleOp = rewriter.create<LLVM::ShuffleVectorOp>(
4871c81adf3SAart Bik           loc, adaptor.v1(), adaptor.v2(), maskArrayAttr);
488563879b6SRahul Joshi       rewriter.replaceOp(shuffleOp, llvmShuffleOp);
4893145427dSRiver Riddle       return success();
490b36aaeafSAart Bik     }
491b36aaeafSAart Bik 
4921c81adf3SAart Bik     // For all other cases, insert the individual values individually.
4935a8a159bSMehdi Amini     Type eltType;
4945a8a159bSMehdi Amini     if (auto arrayType = llvmType.dyn_cast<LLVM::LLVMArrayType>())
4955a8a159bSMehdi Amini       eltType = arrayType.getElementType();
4965a8a159bSMehdi Amini     else
4975a8a159bSMehdi Amini       eltType = llvmType.cast<VectorType>().getElementType();
498e62a6956SRiver Riddle     Value insert = rewriter.create<LLVM::UndefOp>(loc, llvmType);
4991c81adf3SAart Bik     int64_t insPos = 0;
500e4853be2SMehdi Amini     for (const auto &en : llvm::enumerate(maskArrayAttr)) {
5011c81adf3SAart Bik       int64_t extPos = en.value().cast<IntegerAttr>().getInt();
502e62a6956SRiver Riddle       Value value = adaptor.v1();
5031c81adf3SAart Bik       if (extPos >= v1Dim) {
5041c81adf3SAart Bik         extPos -= v1Dim;
5051c81adf3SAart Bik         value = adaptor.v2();
506b36aaeafSAart Bik       }
507dcec2ca5SChristian Sigg       Value extract = extractOne(rewriter, *getTypeConverter(), loc, value,
5085a8a159bSMehdi Amini                                  eltType, rank, extPos);
509dcec2ca5SChristian Sigg       insert = insertOne(rewriter, *getTypeConverter(), loc, insert, extract,
5100f04384dSAlex Zinenko                          llvmType, rank, insPos++);
5111c81adf3SAart Bik     }
512563879b6SRahul Joshi     rewriter.replaceOp(shuffleOp, insert);
5133145427dSRiver Riddle     return success();
514b36aaeafSAart Bik   }
515b36aaeafSAart Bik };
516b36aaeafSAart Bik 
517563879b6SRahul Joshi class VectorExtractElementOpConversion
518563879b6SRahul Joshi     : public ConvertOpToLLVMPattern<vector::ExtractElementOp> {
519cd5dab8aSAart Bik public:
520563879b6SRahul Joshi   using ConvertOpToLLVMPattern<
521563879b6SRahul Joshi       vector::ExtractElementOp>::ConvertOpToLLVMPattern;
522cd5dab8aSAart Bik 
5233145427dSRiver Riddle   LogicalResult
524ef976337SRiver Riddle   matchAndRewrite(vector::ExtractElementOp extractEltOp, OpAdaptor adaptor,
525cd5dab8aSAart Bik                   ConversionPatternRewriter &rewriter) const override {
526cd5dab8aSAart Bik     auto vectorType = extractEltOp.getVectorType();
527dcec2ca5SChristian Sigg     auto llvmType = typeConverter->convertType(vectorType.getElementType());
528cd5dab8aSAart Bik 
529cd5dab8aSAart Bik     // Bail if result type cannot be lowered.
530cd5dab8aSAart Bik     if (!llvmType)
5313145427dSRiver Riddle       return failure();
532cd5dab8aSAart Bik 
533e7026abaSNicolas Vasilache     if (vectorType.getRank() == 0) {
534e7026abaSNicolas Vasilache       Location loc = extractEltOp.getLoc();
535e7026abaSNicolas Vasilache       auto idxType = rewriter.getIndexType();
536e7026abaSNicolas Vasilache       auto zero = rewriter.create<LLVM::ConstantOp>(
537e7026abaSNicolas Vasilache           loc, typeConverter->convertType(idxType),
538e7026abaSNicolas Vasilache           rewriter.getIntegerAttr(idxType, 0));
539e7026abaSNicolas Vasilache       rewriter.replaceOpWithNewOp<LLVM::ExtractElementOp>(
540e7026abaSNicolas Vasilache           extractEltOp, llvmType, adaptor.vector(), zero);
541e7026abaSNicolas Vasilache       return success();
542e7026abaSNicolas Vasilache     }
543e7026abaSNicolas Vasilache 
544cd5dab8aSAart Bik     rewriter.replaceOpWithNewOp<LLVM::ExtractElementOp>(
545563879b6SRahul Joshi         extractEltOp, llvmType, adaptor.vector(), adaptor.position());
5463145427dSRiver Riddle     return success();
547cd5dab8aSAart Bik   }
548cd5dab8aSAart Bik };
549cd5dab8aSAart Bik 
550563879b6SRahul Joshi class VectorExtractOpConversion
551563879b6SRahul Joshi     : public ConvertOpToLLVMPattern<vector::ExtractOp> {
5525c0c51a9SNicolas Vasilache public:
553563879b6SRahul Joshi   using ConvertOpToLLVMPattern<vector::ExtractOp>::ConvertOpToLLVMPattern;
5545c0c51a9SNicolas Vasilache 
5553145427dSRiver Riddle   LogicalResult
556ef976337SRiver Riddle   matchAndRewrite(vector::ExtractOp extractOp, OpAdaptor adaptor,
5575c0c51a9SNicolas Vasilache                   ConversionPatternRewriter &rewriter) const override {
558563879b6SRahul Joshi     auto loc = extractOp->getLoc();
5599826fe5cSAart Bik     auto vectorType = extractOp.getVectorType();
5602bdf33ccSRiver Riddle     auto resultType = extractOp.getResult().getType();
561dcec2ca5SChristian Sigg     auto llvmResultType = typeConverter->convertType(resultType);
5625c0c51a9SNicolas Vasilache     auto positionArrayAttr = extractOp.position();
5639826fe5cSAart Bik 
5649826fe5cSAart Bik     // Bail if result type cannot be lowered.
5659826fe5cSAart Bik     if (!llvmResultType)
5663145427dSRiver Riddle       return failure();
5679826fe5cSAart Bik 
568864adf39SMatthias Springer     // Extract entire vector. Should be handled by folder, but just to be safe.
569864adf39SMatthias Springer     if (positionArrayAttr.empty()) {
570864adf39SMatthias Springer       rewriter.replaceOp(extractOp, adaptor.vector());
571864adf39SMatthias Springer       return success();
572864adf39SMatthias Springer     }
573864adf39SMatthias Springer 
5745c0c51a9SNicolas Vasilache     // One-shot extraction of vector from array (only requires extractvalue).
5755c0c51a9SNicolas Vasilache     if (resultType.isa<VectorType>()) {
576e62a6956SRiver Riddle       Value extracted = rewriter.create<LLVM::ExtractValueOp>(
5775c0c51a9SNicolas Vasilache           loc, llvmResultType, adaptor.vector(), positionArrayAttr);
578563879b6SRahul Joshi       rewriter.replaceOp(extractOp, extracted);
5793145427dSRiver Riddle       return success();
5805c0c51a9SNicolas Vasilache     }
5815c0c51a9SNicolas Vasilache 
5829826fe5cSAart Bik     // Potential extraction of 1-D vector from array.
583563879b6SRahul Joshi     auto *context = extractOp->getContext();
584e62a6956SRiver Riddle     Value extracted = adaptor.vector();
5855c0c51a9SNicolas Vasilache     auto positionAttrs = positionArrayAttr.getValue();
5865c0c51a9SNicolas Vasilache     if (positionAttrs.size() > 1) {
5879826fe5cSAart Bik       auto oneDVectorType = reducedVectorTypeBack(vectorType);
5885c0c51a9SNicolas Vasilache       auto nMinusOnePositionAttrs =
589c2c83e97STres Popp           ArrayAttr::get(context, positionAttrs.drop_back());
5905c0c51a9SNicolas Vasilache       extracted = rewriter.create<LLVM::ExtractValueOp>(
591dcec2ca5SChristian Sigg           loc, typeConverter->convertType(oneDVectorType), extracted,
5925c0c51a9SNicolas Vasilache           nMinusOnePositionAttrs);
5935c0c51a9SNicolas Vasilache     }
5945c0c51a9SNicolas Vasilache 
5955c0c51a9SNicolas Vasilache     // Remaining extraction of element from 1-D LLVM vector
5965c0c51a9SNicolas Vasilache     auto position = positionAttrs.back().cast<IntegerAttr>();
5972230bf99SAlex Zinenko     auto i64Type = IntegerType::get(rewriter.getContext(), 64);
5981d47564aSAart Bik     auto constant = rewriter.create<LLVM::ConstantOp>(loc, i64Type, position);
5995c0c51a9SNicolas Vasilache     extracted =
6005c0c51a9SNicolas Vasilache         rewriter.create<LLVM::ExtractElementOp>(loc, extracted, constant);
601563879b6SRahul Joshi     rewriter.replaceOp(extractOp, extracted);
6025c0c51a9SNicolas Vasilache 
6033145427dSRiver Riddle     return success();
6045c0c51a9SNicolas Vasilache   }
6055c0c51a9SNicolas Vasilache };
6065c0c51a9SNicolas Vasilache 
607681f929fSNicolas Vasilache /// Conversion pattern that turns a vector.fma on a 1-D vector
608681f929fSNicolas Vasilache /// into an llvm.intr.fmuladd. This is a trivial 1-1 conversion.
609681f929fSNicolas Vasilache /// This does not match vectors of n >= 2 rank.
610681f929fSNicolas Vasilache ///
611681f929fSNicolas Vasilache /// Example:
612681f929fSNicolas Vasilache /// ```
613681f929fSNicolas Vasilache ///  vector.fma %a, %a, %a : vector<8xf32>
614681f929fSNicolas Vasilache /// ```
615681f929fSNicolas Vasilache /// is converted to:
616681f929fSNicolas Vasilache /// ```
6173bffe602SBenjamin Kramer ///  llvm.intr.fmuladd %va, %va, %va:
618dd5165a9SAlex Zinenko ///    (!llvm."<8 x f32>">, !llvm<"<8 x f32>">, !llvm<"<8 x f32>">)
619dd5165a9SAlex Zinenko ///    -> !llvm."<8 x f32>">
620681f929fSNicolas Vasilache /// ```
621563879b6SRahul Joshi class VectorFMAOp1DConversion : public ConvertOpToLLVMPattern<vector::FMAOp> {
622681f929fSNicolas Vasilache public:
623563879b6SRahul Joshi   using ConvertOpToLLVMPattern<vector::FMAOp>::ConvertOpToLLVMPattern;
624681f929fSNicolas Vasilache 
6253145427dSRiver Riddle   LogicalResult
626ef976337SRiver Riddle   matchAndRewrite(vector::FMAOp fmaOp, OpAdaptor adaptor,
627681f929fSNicolas Vasilache                   ConversionPatternRewriter &rewriter) const override {
628681f929fSNicolas Vasilache     VectorType vType = fmaOp.getVectorType();
629681f929fSNicolas Vasilache     if (vType.getRank() != 1)
6303145427dSRiver Riddle       return failure();
631563879b6SRahul Joshi     rewriter.replaceOpWithNewOp<LLVM::FMulAddOp>(fmaOp, adaptor.lhs(),
6323bffe602SBenjamin Kramer                                                  adaptor.rhs(), adaptor.acc());
6333145427dSRiver Riddle     return success();
634681f929fSNicolas Vasilache   }
635681f929fSNicolas Vasilache };
636681f929fSNicolas Vasilache 
637563879b6SRahul Joshi class VectorInsertElementOpConversion
638563879b6SRahul Joshi     : public ConvertOpToLLVMPattern<vector::InsertElementOp> {
639cd5dab8aSAart Bik public:
640563879b6SRahul Joshi   using ConvertOpToLLVMPattern<vector::InsertElementOp>::ConvertOpToLLVMPattern;
641cd5dab8aSAart Bik 
6423145427dSRiver Riddle   LogicalResult
643ef976337SRiver Riddle   matchAndRewrite(vector::InsertElementOp insertEltOp, OpAdaptor adaptor,
644cd5dab8aSAart Bik                   ConversionPatternRewriter &rewriter) const override {
645cd5dab8aSAart Bik     auto vectorType = insertEltOp.getDestVectorType();
646dcec2ca5SChristian Sigg     auto llvmType = typeConverter->convertType(vectorType);
647cd5dab8aSAart Bik 
648cd5dab8aSAart Bik     // Bail if result type cannot be lowered.
649cd5dab8aSAart Bik     if (!llvmType)
6503145427dSRiver Riddle       return failure();
651cd5dab8aSAart Bik 
6523ff4e5f2SNicolas Vasilache     if (vectorType.getRank() == 0) {
6533ff4e5f2SNicolas Vasilache       Location loc = insertEltOp.getLoc();
6543ff4e5f2SNicolas Vasilache       auto idxType = rewriter.getIndexType();
6553ff4e5f2SNicolas Vasilache       auto zero = rewriter.create<LLVM::ConstantOp>(
6563ff4e5f2SNicolas Vasilache           loc, typeConverter->convertType(idxType),
6573ff4e5f2SNicolas Vasilache           rewriter.getIntegerAttr(idxType, 0));
6583ff4e5f2SNicolas Vasilache       rewriter.replaceOpWithNewOp<LLVM::InsertElementOp>(
6593ff4e5f2SNicolas Vasilache           insertEltOp, llvmType, adaptor.dest(), adaptor.source(), zero);
6603ff4e5f2SNicolas Vasilache       return success();
6613ff4e5f2SNicolas Vasilache     }
6623ff4e5f2SNicolas Vasilache 
663cd5dab8aSAart Bik     rewriter.replaceOpWithNewOp<LLVM::InsertElementOp>(
664563879b6SRahul Joshi         insertEltOp, llvmType, adaptor.dest(), adaptor.source(),
665563879b6SRahul Joshi         adaptor.position());
6663145427dSRiver Riddle     return success();
667cd5dab8aSAart Bik   }
668cd5dab8aSAart Bik };
669cd5dab8aSAart Bik 
670563879b6SRahul Joshi class VectorInsertOpConversion
671563879b6SRahul Joshi     : public ConvertOpToLLVMPattern<vector::InsertOp> {
6729826fe5cSAart Bik public:
673563879b6SRahul Joshi   using ConvertOpToLLVMPattern<vector::InsertOp>::ConvertOpToLLVMPattern;
6749826fe5cSAart Bik 
6753145427dSRiver Riddle   LogicalResult
676ef976337SRiver Riddle   matchAndRewrite(vector::InsertOp insertOp, OpAdaptor adaptor,
6779826fe5cSAart Bik                   ConversionPatternRewriter &rewriter) const override {
678563879b6SRahul Joshi     auto loc = insertOp->getLoc();
6799826fe5cSAart Bik     auto sourceType = insertOp.getSourceType();
6809826fe5cSAart Bik     auto destVectorType = insertOp.getDestVectorType();
681dcec2ca5SChristian Sigg     auto llvmResultType = typeConverter->convertType(destVectorType);
6829826fe5cSAart Bik     auto positionArrayAttr = insertOp.position();
6839826fe5cSAart Bik 
6849826fe5cSAart Bik     // Bail if result type cannot be lowered.
6859826fe5cSAart Bik     if (!llvmResultType)
6863145427dSRiver Riddle       return failure();
6879826fe5cSAart Bik 
688864adf39SMatthias Springer     // Overwrite entire vector with value. Should be handled by folder, but
689864adf39SMatthias Springer     // just to be safe.
690864adf39SMatthias Springer     if (positionArrayAttr.empty()) {
691864adf39SMatthias Springer       rewriter.replaceOp(insertOp, adaptor.source());
692864adf39SMatthias Springer       return success();
693864adf39SMatthias Springer     }
694864adf39SMatthias Springer 
6959826fe5cSAart Bik     // One-shot insertion of a vector into an array (only requires insertvalue).
6969826fe5cSAart Bik     if (sourceType.isa<VectorType>()) {
697e62a6956SRiver Riddle       Value inserted = rewriter.create<LLVM::InsertValueOp>(
6989826fe5cSAart Bik           loc, llvmResultType, adaptor.dest(), adaptor.source(),
6999826fe5cSAart Bik           positionArrayAttr);
700563879b6SRahul Joshi       rewriter.replaceOp(insertOp, inserted);
7013145427dSRiver Riddle       return success();
7029826fe5cSAart Bik     }
7039826fe5cSAart Bik 
7049826fe5cSAart Bik     // Potential extraction of 1-D vector from array.
705563879b6SRahul Joshi     auto *context = insertOp->getContext();
706e62a6956SRiver Riddle     Value extracted = adaptor.dest();
7079826fe5cSAart Bik     auto positionAttrs = positionArrayAttr.getValue();
7089826fe5cSAart Bik     auto position = positionAttrs.back().cast<IntegerAttr>();
7099826fe5cSAart Bik     auto oneDVectorType = destVectorType;
7109826fe5cSAart Bik     if (positionAttrs.size() > 1) {
7119826fe5cSAart Bik       oneDVectorType = reducedVectorTypeBack(destVectorType);
7129826fe5cSAart Bik       auto nMinusOnePositionAttrs =
713c2c83e97STres Popp           ArrayAttr::get(context, positionAttrs.drop_back());
7149826fe5cSAart Bik       extracted = rewriter.create<LLVM::ExtractValueOp>(
715dcec2ca5SChristian Sigg           loc, typeConverter->convertType(oneDVectorType), extracted,
7169826fe5cSAart Bik           nMinusOnePositionAttrs);
7179826fe5cSAart Bik     }
7189826fe5cSAart Bik 
7199826fe5cSAart Bik     // Insertion of an element into a 1-D LLVM vector.
7202230bf99SAlex Zinenko     auto i64Type = IntegerType::get(rewriter.getContext(), 64);
7211d47564aSAart Bik     auto constant = rewriter.create<LLVM::ConstantOp>(loc, i64Type, position);
722e62a6956SRiver Riddle     Value inserted = rewriter.create<LLVM::InsertElementOp>(
723dcec2ca5SChristian Sigg         loc, typeConverter->convertType(oneDVectorType), extracted,
7240f04384dSAlex Zinenko         adaptor.source(), constant);
7259826fe5cSAart Bik 
7269826fe5cSAart Bik     // Potential insertion of resulting 1-D vector into array.
7279826fe5cSAart Bik     if (positionAttrs.size() > 1) {
7289826fe5cSAart Bik       auto nMinusOnePositionAttrs =
729c2c83e97STres Popp           ArrayAttr::get(context, positionAttrs.drop_back());
7309826fe5cSAart Bik       inserted = rewriter.create<LLVM::InsertValueOp>(loc, llvmResultType,
7319826fe5cSAart Bik                                                       adaptor.dest(), inserted,
7329826fe5cSAart Bik                                                       nMinusOnePositionAttrs);
7339826fe5cSAart Bik     }
7349826fe5cSAart Bik 
735563879b6SRahul Joshi     rewriter.replaceOp(insertOp, inserted);
7363145427dSRiver Riddle     return success();
7379826fe5cSAart Bik   }
7389826fe5cSAart Bik };
7399826fe5cSAart Bik 
740681f929fSNicolas Vasilache /// Rank reducing rewrite for n-D FMA into (n-1)-D FMA where n > 1.
741681f929fSNicolas Vasilache ///
742681f929fSNicolas Vasilache /// Example:
743681f929fSNicolas Vasilache /// ```
744681f929fSNicolas Vasilache ///   %d = vector.fma %a, %b, %c : vector<2x4xf32>
745681f929fSNicolas Vasilache /// ```
746681f929fSNicolas Vasilache /// is rewritten into:
747681f929fSNicolas Vasilache /// ```
748681f929fSNicolas Vasilache ///  %r = splat %f0: vector<2x4xf32>
749681f929fSNicolas Vasilache ///  %va = vector.extractvalue %a[0] : vector<2x4xf32>
750681f929fSNicolas Vasilache ///  %vb = vector.extractvalue %b[0] : vector<2x4xf32>
751681f929fSNicolas Vasilache ///  %vc = vector.extractvalue %c[0] : vector<2x4xf32>
752681f929fSNicolas Vasilache ///  %vd = vector.fma %va, %vb, %vc : vector<4xf32>
753681f929fSNicolas Vasilache ///  %r2 = vector.insertvalue %vd, %r[0] : vector<4xf32> into vector<2x4xf32>
754681f929fSNicolas Vasilache ///  %va2 = vector.extractvalue %a2[1] : vector<2x4xf32>
755681f929fSNicolas Vasilache ///  %vb2 = vector.extractvalue %b2[1] : vector<2x4xf32>
756681f929fSNicolas Vasilache ///  %vc2 = vector.extractvalue %c2[1] : vector<2x4xf32>
757681f929fSNicolas Vasilache ///  %vd2 = vector.fma %va2, %vb2, %vc2 : vector<4xf32>
758681f929fSNicolas Vasilache ///  %r3 = vector.insertvalue %vd2, %r2[1] : vector<4xf32> into vector<2x4xf32>
759681f929fSNicolas Vasilache ///  // %r3 holds the final value.
760681f929fSNicolas Vasilache /// ```
761681f929fSNicolas Vasilache class VectorFMAOpNDRewritePattern : public OpRewritePattern<FMAOp> {
762681f929fSNicolas Vasilache public:
763681f929fSNicolas Vasilache   using OpRewritePattern<FMAOp>::OpRewritePattern;
764681f929fSNicolas Vasilache 
765ee80ffbfSNicolas Vasilache   void initialize() {
766ee80ffbfSNicolas Vasilache     // This pattern recursively unpacks one dimension at a time. The recursion
767ee80ffbfSNicolas Vasilache     // bounded as the rank is strictly decreasing.
768ee80ffbfSNicolas Vasilache     setHasBoundedRewriteRecursion();
769ee80ffbfSNicolas Vasilache   }
770ee80ffbfSNicolas Vasilache 
7713145427dSRiver Riddle   LogicalResult matchAndRewrite(FMAOp op,
772681f929fSNicolas Vasilache                                 PatternRewriter &rewriter) const override {
773681f929fSNicolas Vasilache     auto vType = op.getVectorType();
774681f929fSNicolas Vasilache     if (vType.getRank() < 2)
7753145427dSRiver Riddle       return failure();
776681f929fSNicolas Vasilache 
777681f929fSNicolas Vasilache     auto loc = op.getLoc();
778681f929fSNicolas Vasilache     auto elemType = vType.getElementType();
779a54f4eaeSMogball     Value zero = rewriter.create<arith::ConstantOp>(
780a54f4eaeSMogball         loc, elemType, rewriter.getZeroAttr(elemType));
7816a8ba318SRiver Riddle     Value desc = rewriter.create<vector::SplatOp>(loc, vType, zero);
782681f929fSNicolas Vasilache     for (int64_t i = 0, e = vType.getShape().front(); i != e; ++i) {
783681f929fSNicolas Vasilache       Value extrLHS = rewriter.create<ExtractOp>(loc, op.lhs(), i);
784681f929fSNicolas Vasilache       Value extrRHS = rewriter.create<ExtractOp>(loc, op.rhs(), i);
785681f929fSNicolas Vasilache       Value extrACC = rewriter.create<ExtractOp>(loc, op.acc(), i);
786681f929fSNicolas Vasilache       Value fma = rewriter.create<FMAOp>(loc, extrLHS, extrRHS, extrACC);
787681f929fSNicolas Vasilache       desc = rewriter.create<InsertOp>(loc, fma, desc, i);
788681f929fSNicolas Vasilache     }
789681f929fSNicolas Vasilache     rewriter.replaceOp(op, desc);
7903145427dSRiver Riddle     return success();
791681f929fSNicolas Vasilache   }
792681f929fSNicolas Vasilache };
793681f929fSNicolas Vasilache 
79430e6033bSNicolas Vasilache /// Returns the strides if the memory underlying `memRefType` has a contiguous
79530e6033bSNicolas Vasilache /// static layout.
79630e6033bSNicolas Vasilache static llvm::Optional<SmallVector<int64_t, 4>>
79730e6033bSNicolas Vasilache computeContiguousStrides(MemRefType memRefType) {
7982bf491c7SBenjamin Kramer   int64_t offset;
79930e6033bSNicolas Vasilache   SmallVector<int64_t, 4> strides;
80030e6033bSNicolas Vasilache   if (failed(getStridesAndOffset(memRefType, strides, offset)))
80130e6033bSNicolas Vasilache     return None;
80230e6033bSNicolas Vasilache   if (!strides.empty() && strides.back() != 1)
80330e6033bSNicolas Vasilache     return None;
80430e6033bSNicolas Vasilache   // If no layout or identity layout, this is contiguous by definition.
805e41ebbecSVladislav Vinogradov   if (memRefType.getLayout().isIdentity())
80630e6033bSNicolas Vasilache     return strides;
80730e6033bSNicolas Vasilache 
80830e6033bSNicolas Vasilache   // Otherwise, we must determine contiguity form shapes. This can only ever
80930e6033bSNicolas Vasilache   // work in static cases because MemRefType is underspecified to represent
81030e6033bSNicolas Vasilache   // contiguous dynamic shapes in other ways than with just empty/identity
81130e6033bSNicolas Vasilache   // layout.
8122bf491c7SBenjamin Kramer   auto sizes = memRefType.getShape();
8135017b0f8SMatthias Springer   for (int index = 0, e = strides.size() - 1; index < e; ++index) {
81430e6033bSNicolas Vasilache     if (ShapedType::isDynamic(sizes[index + 1]) ||
81530e6033bSNicolas Vasilache         ShapedType::isDynamicStrideOrOffset(strides[index]) ||
81630e6033bSNicolas Vasilache         ShapedType::isDynamicStrideOrOffset(strides[index + 1]))
81730e6033bSNicolas Vasilache       return None;
81830e6033bSNicolas Vasilache     if (strides[index] != strides[index + 1] * sizes[index + 1])
81930e6033bSNicolas Vasilache       return None;
8202bf491c7SBenjamin Kramer   }
82130e6033bSNicolas Vasilache   return strides;
8222bf491c7SBenjamin Kramer }
8232bf491c7SBenjamin Kramer 
824563879b6SRahul Joshi class VectorTypeCastOpConversion
825563879b6SRahul Joshi     : public ConvertOpToLLVMPattern<vector::TypeCastOp> {
8265c0c51a9SNicolas Vasilache public:
827563879b6SRahul Joshi   using ConvertOpToLLVMPattern<vector::TypeCastOp>::ConvertOpToLLVMPattern;
8285c0c51a9SNicolas Vasilache 
8293145427dSRiver Riddle   LogicalResult
830ef976337SRiver Riddle   matchAndRewrite(vector::TypeCastOp castOp, OpAdaptor adaptor,
8315c0c51a9SNicolas Vasilache                   ConversionPatternRewriter &rewriter) const override {
832563879b6SRahul Joshi     auto loc = castOp->getLoc();
8335c0c51a9SNicolas Vasilache     MemRefType sourceMemRefType =
8342bdf33ccSRiver Riddle         castOp.getOperand().getType().cast<MemRefType>();
8359eb3e564SChris Lattner     MemRefType targetMemRefType = castOp.getType();
8365c0c51a9SNicolas Vasilache 
8375c0c51a9SNicolas Vasilache     // Only static shape casts supported atm.
8385c0c51a9SNicolas Vasilache     if (!sourceMemRefType.hasStaticShape() ||
8395c0c51a9SNicolas Vasilache         !targetMemRefType.hasStaticShape())
8403145427dSRiver Riddle       return failure();
8415c0c51a9SNicolas Vasilache 
8425c0c51a9SNicolas Vasilache     auto llvmSourceDescriptorTy =
843ef976337SRiver Riddle         adaptor.getOperands()[0].getType().dyn_cast<LLVM::LLVMStructType>();
8448de43b92SAlex Zinenko     if (!llvmSourceDescriptorTy)
8453145427dSRiver Riddle       return failure();
846ef976337SRiver Riddle     MemRefDescriptor sourceMemRef(adaptor.getOperands()[0]);
8475c0c51a9SNicolas Vasilache 
848dcec2ca5SChristian Sigg     auto llvmTargetDescriptorTy = typeConverter->convertType(targetMemRefType)
8498de43b92SAlex Zinenko                                       .dyn_cast_or_null<LLVM::LLVMStructType>();
8508de43b92SAlex Zinenko     if (!llvmTargetDescriptorTy)
8513145427dSRiver Riddle       return failure();
8525c0c51a9SNicolas Vasilache 
85330e6033bSNicolas Vasilache     // Only contiguous source buffers supported atm.
85430e6033bSNicolas Vasilache     auto sourceStrides = computeContiguousStrides(sourceMemRefType);
85530e6033bSNicolas Vasilache     if (!sourceStrides)
85630e6033bSNicolas Vasilache       return failure();
85730e6033bSNicolas Vasilache     auto targetStrides = computeContiguousStrides(targetMemRefType);
85830e6033bSNicolas Vasilache     if (!targetStrides)
85930e6033bSNicolas Vasilache       return failure();
86030e6033bSNicolas Vasilache     // Only support static strides for now, regardless of contiguity.
86130e6033bSNicolas Vasilache     if (llvm::any_of(*targetStrides, [](int64_t stride) {
86230e6033bSNicolas Vasilache           return ShapedType::isDynamicStrideOrOffset(stride);
86330e6033bSNicolas Vasilache         }))
8643145427dSRiver Riddle       return failure();
8655c0c51a9SNicolas Vasilache 
8662230bf99SAlex Zinenko     auto int64Ty = IntegerType::get(rewriter.getContext(), 64);
8675c0c51a9SNicolas Vasilache 
8685c0c51a9SNicolas Vasilache     // Create descriptor.
8695c0c51a9SNicolas Vasilache     auto desc = MemRefDescriptor::undef(rewriter, loc, llvmTargetDescriptorTy);
8703a577f54SChristian Sigg     Type llvmTargetElementTy = desc.getElementPtrType();
8715c0c51a9SNicolas Vasilache     // Set allocated ptr.
872e62a6956SRiver Riddle     Value allocated = sourceMemRef.allocatedPtr(rewriter, loc);
8735c0c51a9SNicolas Vasilache     allocated =
8745c0c51a9SNicolas Vasilache         rewriter.create<LLVM::BitcastOp>(loc, llvmTargetElementTy, allocated);
8755c0c51a9SNicolas Vasilache     desc.setAllocatedPtr(rewriter, loc, allocated);
8765c0c51a9SNicolas Vasilache     // Set aligned ptr.
877e62a6956SRiver Riddle     Value ptr = sourceMemRef.alignedPtr(rewriter, loc);
8785c0c51a9SNicolas Vasilache     ptr = rewriter.create<LLVM::BitcastOp>(loc, llvmTargetElementTy, ptr);
8795c0c51a9SNicolas Vasilache     desc.setAlignedPtr(rewriter, loc, ptr);
8805c0c51a9SNicolas Vasilache     // Fill offset 0.
8815c0c51a9SNicolas Vasilache     auto attr = rewriter.getIntegerAttr(rewriter.getIndexType(), 0);
8825c0c51a9SNicolas Vasilache     auto zero = rewriter.create<LLVM::ConstantOp>(loc, int64Ty, attr);
8835c0c51a9SNicolas Vasilache     desc.setOffset(rewriter, loc, zero);
8845c0c51a9SNicolas Vasilache 
8855c0c51a9SNicolas Vasilache     // Fill size and stride descriptors in memref.
886e4853be2SMehdi Amini     for (const auto &indexedSize :
887e4853be2SMehdi Amini          llvm::enumerate(targetMemRefType.getShape())) {
8885c0c51a9SNicolas Vasilache       int64_t index = indexedSize.index();
8895c0c51a9SNicolas Vasilache       auto sizeAttr =
8905c0c51a9SNicolas Vasilache           rewriter.getIntegerAttr(rewriter.getIndexType(), indexedSize.value());
8915c0c51a9SNicolas Vasilache       auto size = rewriter.create<LLVM::ConstantOp>(loc, int64Ty, sizeAttr);
8925c0c51a9SNicolas Vasilache       desc.setSize(rewriter, loc, index, size);
89330e6033bSNicolas Vasilache       auto strideAttr = rewriter.getIntegerAttr(rewriter.getIndexType(),
89430e6033bSNicolas Vasilache                                                 (*targetStrides)[index]);
8955c0c51a9SNicolas Vasilache       auto stride = rewriter.create<LLVM::ConstantOp>(loc, int64Ty, strideAttr);
8965c0c51a9SNicolas Vasilache       desc.setStride(rewriter, loc, index, stride);
8975c0c51a9SNicolas Vasilache     }
8985c0c51a9SNicolas Vasilache 
899563879b6SRahul Joshi     rewriter.replaceOp(castOp, {desc});
9003145427dSRiver Riddle     return success();
9015c0c51a9SNicolas Vasilache   }
9025c0c51a9SNicolas Vasilache };
9035c0c51a9SNicolas Vasilache 
904*a75a46dbSJavier Setoain /// Conversion pattern for a `vector.create_mask` (1-D scalable vectors only).
905*a75a46dbSJavier Setoain /// Non-scalable versions of this operation are handled in Vector Transforms.
906*a75a46dbSJavier Setoain class VectorCreateMaskOpRewritePattern
907*a75a46dbSJavier Setoain     : public OpRewritePattern<vector::CreateMaskOp> {
908*a75a46dbSJavier Setoain public:
909*a75a46dbSJavier Setoain   explicit VectorCreateMaskOpRewritePattern(MLIRContext *context,
910*a75a46dbSJavier Setoain                                             bool enableIndexOpt)
911*a75a46dbSJavier Setoain       : OpRewritePattern<vector::CreateMaskOp>(context),
912*a75a46dbSJavier Setoain         indexOptimizations(enableIndexOpt) {}
913*a75a46dbSJavier Setoain 
914*a75a46dbSJavier Setoain   LogicalResult matchAndRewrite(vector::CreateMaskOp op,
915*a75a46dbSJavier Setoain                                 PatternRewriter &rewriter) const override {
916*a75a46dbSJavier Setoain     auto dstType = op.getType();
917*a75a46dbSJavier Setoain     if (dstType.getRank() != 1 || !dstType.cast<VectorType>().isScalable())
918*a75a46dbSJavier Setoain       return failure();
919*a75a46dbSJavier Setoain     IntegerType idxType =
920*a75a46dbSJavier Setoain         indexOptimizations ? rewriter.getI32Type() : rewriter.getI64Type();
921*a75a46dbSJavier Setoain     auto loc = op->getLoc();
922*a75a46dbSJavier Setoain     Value indices = rewriter.create<LLVM::StepVectorOp>(
923*a75a46dbSJavier Setoain         loc, LLVM::getVectorType(idxType, dstType.getShape()[0],
924*a75a46dbSJavier Setoain                                  /*isScalable=*/true));
925*a75a46dbSJavier Setoain     auto bound = getValueOrCreateCastToIndexLike(rewriter, loc, idxType,
926*a75a46dbSJavier Setoain                                                  op.getOperand(0));
927*a75a46dbSJavier Setoain     Value bounds = rewriter.create<SplatOp>(loc, indices.getType(), bound);
928*a75a46dbSJavier Setoain     Value comp = rewriter.create<arith::CmpIOp>(loc, arith::CmpIPredicate::slt,
929*a75a46dbSJavier Setoain                                                 indices, bounds);
930*a75a46dbSJavier Setoain     rewriter.replaceOp(op, comp);
931*a75a46dbSJavier Setoain     return success();
932*a75a46dbSJavier Setoain   }
933*a75a46dbSJavier Setoain 
934*a75a46dbSJavier Setoain private:
935*a75a46dbSJavier Setoain   const bool indexOptimizations;
936*a75a46dbSJavier Setoain };
937*a75a46dbSJavier Setoain 
938563879b6SRahul Joshi class VectorPrintOpConversion : public ConvertOpToLLVMPattern<vector::PrintOp> {
939d9b500d3SAart Bik public:
940563879b6SRahul Joshi   using ConvertOpToLLVMPattern<vector::PrintOp>::ConvertOpToLLVMPattern;
941d9b500d3SAart Bik 
942d9b500d3SAart Bik   // Proof-of-concept lowering implementation that relies on a small
943d9b500d3SAart Bik   // runtime support library, which only needs to provide a few
944d9b500d3SAart Bik   // printing methods (single value for all data types, opening/closing
945d9b500d3SAart Bik   // bracket, comma, newline). The lowering fully unrolls a vector
946d9b500d3SAart Bik   // in terms of these elementary printing operations. The advantage
947d9b500d3SAart Bik   // of this approach is that the library can remain unaware of all
948d9b500d3SAart Bik   // low-level implementation details of vectors while still supporting
949d9b500d3SAart Bik   // output of any shaped and dimensioned vector. Due to full unrolling,
950d9b500d3SAart Bik   // this approach is less suited for very large vectors though.
951d9b500d3SAart Bik   //
9529db53a18SRiver Riddle   // TODO: rely solely on libc in future? something else?
953d9b500d3SAart Bik   //
9543145427dSRiver Riddle   LogicalResult
955ef976337SRiver Riddle   matchAndRewrite(vector::PrintOp printOp, OpAdaptor adaptor,
956d9b500d3SAart Bik                   ConversionPatternRewriter &rewriter) const override {
957d9b500d3SAart Bik     Type printType = printOp.getPrintType();
958d9b500d3SAart Bik 
959dcec2ca5SChristian Sigg     if (typeConverter->convertType(printType) == nullptr)
9603145427dSRiver Riddle       return failure();
961d9b500d3SAart Bik 
962b8880f5fSAart Bik     // Make sure element type has runtime support.
963b8880f5fSAart Bik     PrintConversion conversion = PrintConversion::None;
964d9b500d3SAart Bik     VectorType vectorType = printType.dyn_cast<VectorType>();
965d9b500d3SAart Bik     Type eltType = vectorType ? vectorType.getElementType() : printType;
966d9b500d3SAart Bik     Operation *printer;
967b8880f5fSAart Bik     if (eltType.isF32()) {
968e332c22cSNicolas Vasilache       printer =
969e332c22cSNicolas Vasilache           LLVM::lookupOrCreatePrintF32Fn(printOp->getParentOfType<ModuleOp>());
970b8880f5fSAart Bik     } else if (eltType.isF64()) {
971e332c22cSNicolas Vasilache       printer =
972e332c22cSNicolas Vasilache           LLVM::lookupOrCreatePrintF64Fn(printOp->getParentOfType<ModuleOp>());
97354759cefSAart Bik     } else if (eltType.isIndex()) {
974e332c22cSNicolas Vasilache       printer =
975e332c22cSNicolas Vasilache           LLVM::lookupOrCreatePrintU64Fn(printOp->getParentOfType<ModuleOp>());
976b8880f5fSAart Bik     } else if (auto intTy = eltType.dyn_cast<IntegerType>()) {
977b8880f5fSAart Bik       // Integers need a zero or sign extension on the operand
978b8880f5fSAart Bik       // (depending on the source type) as well as a signed or
979b8880f5fSAart Bik       // unsigned print method. Up to 64-bit is supported.
980b8880f5fSAart Bik       unsigned width = intTy.getWidth();
981b8880f5fSAart Bik       if (intTy.isUnsigned()) {
98254759cefSAart Bik         if (width <= 64) {
983b8880f5fSAart Bik           if (width < 64)
984b8880f5fSAart Bik             conversion = PrintConversion::ZeroExt64;
985e332c22cSNicolas Vasilache           printer = LLVM::lookupOrCreatePrintU64Fn(
986e332c22cSNicolas Vasilache               printOp->getParentOfType<ModuleOp>());
987b8880f5fSAart Bik         } else {
9883145427dSRiver Riddle           return failure();
989b8880f5fSAart Bik         }
990b8880f5fSAart Bik       } else {
991b8880f5fSAart Bik         assert(intTy.isSignless() || intTy.isSigned());
99254759cefSAart Bik         if (width <= 64) {
993b8880f5fSAart Bik           // Note that we *always* zero extend booleans (1-bit integers),
994b8880f5fSAart Bik           // so that true/false is printed as 1/0 rather than -1/0.
995b8880f5fSAart Bik           if (width == 1)
99654759cefSAart Bik             conversion = PrintConversion::ZeroExt64;
99754759cefSAart Bik           else if (width < 64)
998b8880f5fSAart Bik             conversion = PrintConversion::SignExt64;
999e332c22cSNicolas Vasilache           printer = LLVM::lookupOrCreatePrintI64Fn(
1000e332c22cSNicolas Vasilache               printOp->getParentOfType<ModuleOp>());
1001b8880f5fSAart Bik         } else {
1002b8880f5fSAart Bik           return failure();
1003b8880f5fSAart Bik         }
1004b8880f5fSAart Bik       }
1005b8880f5fSAart Bik     } else {
1006b8880f5fSAart Bik       return failure();
1007b8880f5fSAart Bik     }
1008d9b500d3SAart Bik 
1009d9b500d3SAart Bik     // Unroll vector into elementary print calls.
1010b8880f5fSAart Bik     int64_t rank = vectorType ? vectorType.getRank() : 0;
1011cc311a15SMichal Terepeta     Type type = vectorType ? vectorType : eltType;
1012cc311a15SMichal Terepeta     emitRanks(rewriter, printOp, adaptor.source(), type, printer, rank,
1013b8880f5fSAart Bik               conversion);
1014e332c22cSNicolas Vasilache     emitCall(rewriter, printOp->getLoc(),
1015e332c22cSNicolas Vasilache              LLVM::lookupOrCreatePrintNewlineFn(
1016e332c22cSNicolas Vasilache                  printOp->getParentOfType<ModuleOp>()));
1017563879b6SRahul Joshi     rewriter.eraseOp(printOp);
10183145427dSRiver Riddle     return success();
1019d9b500d3SAart Bik   }
1020d9b500d3SAart Bik 
1021d9b500d3SAart Bik private:
1022b8880f5fSAart Bik   enum class PrintConversion {
102330e6033bSNicolas Vasilache     // clang-format off
1024b8880f5fSAart Bik     None,
1025b8880f5fSAart Bik     ZeroExt64,
1026b8880f5fSAart Bik     SignExt64
102730e6033bSNicolas Vasilache     // clang-format on
1028b8880f5fSAart Bik   };
1029b8880f5fSAart Bik 
1030d9b500d3SAart Bik   void emitRanks(ConversionPatternRewriter &rewriter, Operation *op,
1031cc311a15SMichal Terepeta                  Value value, Type type, Operation *printer, int64_t rank,
1032cc311a15SMichal Terepeta                  PrintConversion conversion) const {
1033cc311a15SMichal Terepeta     VectorType vectorType = type.dyn_cast<VectorType>();
1034d9b500d3SAart Bik     Location loc = op->getLoc();
1035cc311a15SMichal Terepeta     if (!vectorType) {
1036cc311a15SMichal Terepeta       assert(rank == 0 && "The scalar case expects rank == 0");
1037b8880f5fSAart Bik       switch (conversion) {
1038b8880f5fSAart Bik       case PrintConversion::ZeroExt64:
1039a54f4eaeSMogball         value = rewriter.create<arith::ExtUIOp>(
10403c69bc4dSRiver Riddle             loc, IntegerType::get(rewriter.getContext(), 64), value);
1041b8880f5fSAart Bik         break;
1042b8880f5fSAart Bik       case PrintConversion::SignExt64:
1043a54f4eaeSMogball         value = rewriter.create<arith::ExtSIOp>(
10443c69bc4dSRiver Riddle             loc, IntegerType::get(rewriter.getContext(), 64), value);
1045b8880f5fSAart Bik         break;
1046b8880f5fSAart Bik       case PrintConversion::None:
1047b8880f5fSAart Bik         break;
1048c9eeeb38Saartbik       }
1049d9b500d3SAart Bik       emitCall(rewriter, loc, printer, value);
1050d9b500d3SAart Bik       return;
1051d9b500d3SAart Bik     }
1052d9b500d3SAart Bik 
1053e332c22cSNicolas Vasilache     emitCall(rewriter, loc,
1054e332c22cSNicolas Vasilache              LLVM::lookupOrCreatePrintOpenFn(op->getParentOfType<ModuleOp>()));
1055e332c22cSNicolas Vasilache     Operation *printComma =
1056e332c22cSNicolas Vasilache         LLVM::lookupOrCreatePrintCommaFn(op->getParentOfType<ModuleOp>());
1057cc311a15SMichal Terepeta 
1058cc311a15SMichal Terepeta     if (rank <= 1) {
1059cc311a15SMichal Terepeta       auto reducedType = vectorType.getElementType();
1060cc311a15SMichal Terepeta       auto llvmType = typeConverter->convertType(reducedType);
1061cc311a15SMichal Terepeta       int64_t dim = rank == 0 ? 1 : vectorType.getDimSize(0);
1062cc311a15SMichal Terepeta       for (int64_t d = 0; d < dim; ++d) {
1063cc311a15SMichal Terepeta         Value nestedVal = extractOne(rewriter, *getTypeConverter(), loc, value,
1064cc311a15SMichal Terepeta                                      llvmType, /*rank=*/0, /*pos=*/d);
1065cc311a15SMichal Terepeta         emitRanks(rewriter, op, nestedVal, reducedType, printer, /*rank=*/0,
1066cc311a15SMichal Terepeta                   conversion);
1067cc311a15SMichal Terepeta         if (d != dim - 1)
1068cc311a15SMichal Terepeta           emitCall(rewriter, loc, printComma);
1069cc311a15SMichal Terepeta       }
1070cc311a15SMichal Terepeta       emitCall(
1071cc311a15SMichal Terepeta           rewriter, loc,
1072cc311a15SMichal Terepeta           LLVM::lookupOrCreatePrintCloseFn(op->getParentOfType<ModuleOp>()));
1073cc311a15SMichal Terepeta       return;
1074cc311a15SMichal Terepeta     }
1075cc311a15SMichal Terepeta 
1076d9b500d3SAart Bik     int64_t dim = vectorType.getDimSize(0);
1077d9b500d3SAart Bik     for (int64_t d = 0; d < dim; ++d) {
1078cc311a15SMichal Terepeta       auto reducedType = reducedVectorTypeFront(vectorType);
1079cc311a15SMichal Terepeta       auto llvmType = typeConverter->convertType(reducedType);
1080dcec2ca5SChristian Sigg       Value nestedVal = extractOne(rewriter, *getTypeConverter(), loc, value,
1081dcec2ca5SChristian Sigg                                    llvmType, rank, d);
1082b8880f5fSAart Bik       emitRanks(rewriter, op, nestedVal, reducedType, printer, rank - 1,
1083b8880f5fSAart Bik                 conversion);
1084d9b500d3SAart Bik       if (d != dim - 1)
1085d9b500d3SAart Bik         emitCall(rewriter, loc, printComma);
1086d9b500d3SAart Bik     }
1087e332c22cSNicolas Vasilache     emitCall(rewriter, loc,
1088e332c22cSNicolas Vasilache              LLVM::lookupOrCreatePrintCloseFn(op->getParentOfType<ModuleOp>()));
1089d9b500d3SAart Bik   }
1090d9b500d3SAart Bik 
1091d9b500d3SAart Bik   // Helper to emit a call.
1092d9b500d3SAart Bik   static void emitCall(ConversionPatternRewriter &rewriter, Location loc,
1093d9b500d3SAart Bik                        Operation *ref, ValueRange params = ValueRange()) {
1094faf1c224SChris Lattner     rewriter.create<LLVM::CallOp>(loc, TypeRange(), SymbolRefAttr::get(ref),
1095faf1c224SChris Lattner                                   params);
1096d9b500d3SAart Bik   }
1097d9b500d3SAart Bik };
1098d9b500d3SAart Bik 
10996a8ba318SRiver Riddle /// The Splat operation is lowered to an insertelement + a shufflevector
11006a8ba318SRiver Riddle /// operation. Splat to only 0-d and 1-d vector result types are lowered.
11016a8ba318SRiver Riddle struct VectorSplatOpLowering : public ConvertOpToLLVMPattern<vector::SplatOp> {
11026a8ba318SRiver Riddle   using ConvertOpToLLVMPattern<vector::SplatOp>::ConvertOpToLLVMPattern;
11036a8ba318SRiver Riddle 
11046a8ba318SRiver Riddle   LogicalResult
11056a8ba318SRiver Riddle   matchAndRewrite(vector::SplatOp splatOp, OpAdaptor adaptor,
11066a8ba318SRiver Riddle                   ConversionPatternRewriter &rewriter) const override {
11076a8ba318SRiver Riddle     VectorType resultType = splatOp.getType().cast<VectorType>();
11086a8ba318SRiver Riddle     if (resultType.getRank() > 1)
11096a8ba318SRiver Riddle       return failure();
11106a8ba318SRiver Riddle 
11116a8ba318SRiver Riddle     // First insert it into an undef vector so we can shuffle it.
11126a8ba318SRiver Riddle     auto vectorType = typeConverter->convertType(splatOp.getType());
11136a8ba318SRiver Riddle     Value undef = rewriter.create<LLVM::UndefOp>(splatOp.getLoc(), vectorType);
11146a8ba318SRiver Riddle     auto zero = rewriter.create<LLVM::ConstantOp>(
11156a8ba318SRiver Riddle         splatOp.getLoc(),
11166a8ba318SRiver Riddle         typeConverter->convertType(rewriter.getIntegerType(32)),
11176a8ba318SRiver Riddle         rewriter.getZeroAttr(rewriter.getIntegerType(32)));
11186a8ba318SRiver Riddle 
11196a8ba318SRiver Riddle     // For 0-d vector, we simply do `insertelement`.
11206a8ba318SRiver Riddle     if (resultType.getRank() == 0) {
11216a8ba318SRiver Riddle       rewriter.replaceOpWithNewOp<LLVM::InsertElementOp>(
11226a8ba318SRiver Riddle           splatOp, vectorType, undef, adaptor.input(), zero);
11236a8ba318SRiver Riddle       return success();
11246a8ba318SRiver Riddle     }
11256a8ba318SRiver Riddle 
11266a8ba318SRiver Riddle     // For 1-d vector, we additionally do a `vectorshuffle`.
11276a8ba318SRiver Riddle     auto v = rewriter.create<LLVM::InsertElementOp>(
11286a8ba318SRiver Riddle         splatOp.getLoc(), vectorType, undef, adaptor.input(), zero);
11296a8ba318SRiver Riddle 
11306a8ba318SRiver Riddle     int64_t width = splatOp.getType().cast<VectorType>().getDimSize(0);
11316a8ba318SRiver Riddle     SmallVector<int32_t, 4> zeroValues(width, 0);
11326a8ba318SRiver Riddle 
11336a8ba318SRiver Riddle     // Shuffle the value across the desired number of elements.
11346a8ba318SRiver Riddle     ArrayAttr zeroAttrs = rewriter.getI32ArrayAttr(zeroValues);
11356a8ba318SRiver Riddle     rewriter.replaceOpWithNewOp<LLVM::ShuffleVectorOp>(splatOp, v, undef,
11366a8ba318SRiver Riddle                                                        zeroAttrs);
11376a8ba318SRiver Riddle     return success();
11386a8ba318SRiver Riddle   }
11396a8ba318SRiver Riddle };
11406a8ba318SRiver Riddle 
11416a8ba318SRiver Riddle /// The Splat operation is lowered to an insertelement + a shufflevector
11426a8ba318SRiver Riddle /// operation. Splat to only 2+-d vector result types are lowered by the
11436a8ba318SRiver Riddle /// SplatNdOpLowering, the 1-d case is handled by SplatOpLowering.
11446a8ba318SRiver Riddle struct VectorSplatNdOpLowering : public ConvertOpToLLVMPattern<SplatOp> {
11456a8ba318SRiver Riddle   using ConvertOpToLLVMPattern<SplatOp>::ConvertOpToLLVMPattern;
11466a8ba318SRiver Riddle 
11476a8ba318SRiver Riddle   LogicalResult
11486a8ba318SRiver Riddle   matchAndRewrite(SplatOp splatOp, OpAdaptor adaptor,
11496a8ba318SRiver Riddle                   ConversionPatternRewriter &rewriter) const override {
11506a8ba318SRiver Riddle     VectorType resultType = splatOp.getType();
11516a8ba318SRiver Riddle     if (resultType.getRank() <= 1)
11526a8ba318SRiver Riddle       return failure();
11536a8ba318SRiver Riddle 
11546a8ba318SRiver Riddle     // First insert it into an undef vector so we can shuffle it.
11556a8ba318SRiver Riddle     auto loc = splatOp.getLoc();
11566a8ba318SRiver Riddle     auto vectorTypeInfo =
11576a8ba318SRiver Riddle         LLVM::detail::extractNDVectorTypeInfo(resultType, *getTypeConverter());
11586a8ba318SRiver Riddle     auto llvmNDVectorTy = vectorTypeInfo.llvmNDVectorTy;
11596a8ba318SRiver Riddle     auto llvm1DVectorTy = vectorTypeInfo.llvm1DVectorTy;
11606a8ba318SRiver Riddle     if (!llvmNDVectorTy || !llvm1DVectorTy)
11616a8ba318SRiver Riddle       return failure();
11626a8ba318SRiver Riddle 
11636a8ba318SRiver Riddle     // Construct returned value.
11646a8ba318SRiver Riddle     Value desc = rewriter.create<LLVM::UndefOp>(loc, llvmNDVectorTy);
11656a8ba318SRiver Riddle 
11666a8ba318SRiver Riddle     // Construct a 1-D vector with the splatted value that we insert in all the
11676a8ba318SRiver Riddle     // places within the returned descriptor.
11686a8ba318SRiver Riddle     Value vdesc = rewriter.create<LLVM::UndefOp>(loc, llvm1DVectorTy);
11696a8ba318SRiver Riddle     auto zero = rewriter.create<LLVM::ConstantOp>(
11706a8ba318SRiver Riddle         loc, typeConverter->convertType(rewriter.getIntegerType(32)),
11716a8ba318SRiver Riddle         rewriter.getZeroAttr(rewriter.getIntegerType(32)));
11726a8ba318SRiver Riddle     Value v = rewriter.create<LLVM::InsertElementOp>(loc, llvm1DVectorTy, vdesc,
11736a8ba318SRiver Riddle                                                      adaptor.input(), zero);
11746a8ba318SRiver Riddle 
11756a8ba318SRiver Riddle     // Shuffle the value across the desired number of elements.
11766a8ba318SRiver Riddle     int64_t width = resultType.getDimSize(resultType.getRank() - 1);
11776a8ba318SRiver Riddle     SmallVector<int32_t, 4> zeroValues(width, 0);
11786a8ba318SRiver Riddle     ArrayAttr zeroAttrs = rewriter.getI32ArrayAttr(zeroValues);
11796a8ba318SRiver Riddle     v = rewriter.create<LLVM::ShuffleVectorOp>(loc, v, v, zeroAttrs);
11806a8ba318SRiver Riddle 
11816a8ba318SRiver Riddle     // Iterate of linear index, convert to coords space and insert splatted 1-D
11826a8ba318SRiver Riddle     // vector in each position.
11836a8ba318SRiver Riddle     nDVectorIterate(vectorTypeInfo, rewriter, [&](ArrayAttr position) {
11846a8ba318SRiver Riddle       desc = rewriter.create<LLVM::InsertValueOp>(loc, llvmNDVectorTy, desc, v,
11856a8ba318SRiver Riddle                                                   position);
11866a8ba318SRiver Riddle     });
11876a8ba318SRiver Riddle     rewriter.replaceOp(splatOp, desc);
11886a8ba318SRiver Riddle     return success();
11896a8ba318SRiver Riddle   }
11906a8ba318SRiver Riddle };
11916a8ba318SRiver Riddle 
1192df186507SBenjamin Kramer } // namespace
1193df186507SBenjamin Kramer 
11945c0c51a9SNicolas Vasilache /// Populate the given list with patterns that convert from Vector to LLVM.
1195*a75a46dbSJavier Setoain void mlir::populateVectorToLLVMConversionPatterns(LLVMTypeConverter &converter,
1196*a75a46dbSJavier Setoain                                                   RewritePatternSet &patterns,
1197*a75a46dbSJavier Setoain                                                   bool reassociateFPReductions,
1198*a75a46dbSJavier Setoain                                                   bool indexOptimizations) {
119965678d93SNicolas Vasilache   MLIRContext *ctx = converter.getDialect()->getContext();
1200eda2ebd7SNicolas Vasilache   patterns.add<VectorFMAOpNDRewritePattern>(ctx);
1201eda2ebd7SNicolas Vasilache   populateVectorInsertExtractStridedSliceTransforms(patterns);
1202dc4e913bSChris Lattner   patterns.add<VectorReductionOpConversion>(converter, reassociateFPReductions);
1203*a75a46dbSJavier Setoain   patterns.add<VectorCreateMaskOpRewritePattern>(ctx, indexOptimizations);
12048345b86dSNicolas Vasilache   patterns
1205dc4e913bSChris Lattner       .add<VectorBitCastOpConversion, VectorShuffleOpConversion,
1206dc4e913bSChris Lattner            VectorExtractElementOpConversion, VectorExtractOpConversion,
1207dc4e913bSChris Lattner            VectorFMAOp1DConversion, VectorInsertElementOpConversion,
1208dc4e913bSChris Lattner            VectorInsertOpConversion, VectorPrintOpConversion,
1209a4830d14SJavier Setoain            VectorTypeCastOpConversion, VectorScaleOpConversion,
1210dc4e913bSChris Lattner            VectorLoadStoreConversion<vector::LoadOp, vector::LoadOpAdaptor>,
1211ee66e43aSDiego Caballero            VectorLoadStoreConversion<vector::MaskedLoadOp,
1212ee66e43aSDiego Caballero                                      vector::MaskedLoadOpAdaptor>,
1213dc4e913bSChris Lattner            VectorLoadStoreConversion<vector::StoreOp, vector::StoreOpAdaptor>,
1214ee66e43aSDiego Caballero            VectorLoadStoreConversion<vector::MaskedStoreOp,
1215ee66e43aSDiego Caballero                                      vector::MaskedStoreOpAdaptor>,
1216dc4e913bSChris Lattner            VectorGatherOpConversion, VectorScatterOpConversion,
12176a8ba318SRiver Riddle            VectorExpandLoadOpConversion, VectorCompressStoreOpConversion,
12186a8ba318SRiver Riddle            VectorSplatOpLowering, VectorSplatNdOpLowering>(converter);
1219d1a9e9a7SMatthias Springer   // Transfer ops with rank > 1 are handled by VectorToSCF.
1220d1a9e9a7SMatthias Springer   populateVectorTransferLoweringPatterns(patterns, /*maxTransferRank=*/1);
12215c0c51a9SNicolas Vasilache }
12225c0c51a9SNicolas Vasilache 
122363b683a8SNicolas Vasilache void mlir::populateVectorToLLVMMatrixConversionPatterns(
1224dc4e913bSChris Lattner     LLVMTypeConverter &converter, RewritePatternSet &patterns) {
1225dc4e913bSChris Lattner   patterns.add<VectorMatmulOpConversion>(converter);
1226dc4e913bSChris Lattner   patterns.add<VectorFlatTransposeOpConversion>(converter);
122763b683a8SNicolas Vasilache }
1228