1 //===- VectorOps.cpp - MLIR Vector Dialect Operations ---------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file implements convenience types for working with super-vectorization
10 // operations, in particular super-vector loads and stores.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "mlir/Dialect/Vector/IR/VectorOps.h"
15 
16 #include "mlir/Dialect/Arithmetic/IR/Arithmetic.h"
17 #include "mlir/Dialect/Arithmetic/Utils/Utils.h"
18 #include "mlir/Dialect/MemRef/IR/MemRef.h"
19 #include "mlir/Dialect/Tensor/IR/Tensor.h"
20 #include "mlir/Dialect/Utils/IndexingUtils.h"
21 #include "mlir/Dialect/Utils/StructuredOpsUtils.h"
22 #include "mlir/IR/AffineExpr.h"
23 #include "mlir/IR/AffineMap.h"
24 #include "mlir/IR/BlockAndValueMapping.h"
25 #include "mlir/IR/Builders.h"
26 #include "mlir/IR/BuiltinOps.h"
27 #include "mlir/IR/BuiltinTypes.h"
28 #include "mlir/IR/DialectImplementation.h"
29 #include "mlir/IR/OpImplementation.h"
30 #include "mlir/IR/PatternMatch.h"
31 #include "mlir/IR/TypeUtilities.h"
32 #include "mlir/Support/LLVM.h"
33 #include "mlir/Support/MathExtras.h"
34 #include "llvm/ADT/StringSet.h"
35 #include "llvm/ADT/bit.h"
36 #include <numeric>
37 
38 #include "mlir/Dialect/Vector/IR/VectorOpsDialect.cpp.inc"
39 // Pull in all enum type and utility function definitions.
40 #include "mlir/Dialect/Vector/IR/VectorOpsEnums.cpp.inc"
41 
42 using namespace mlir;
43 using namespace mlir::vector;
44 
45 /// Helper enum to classify mask value.
46 enum class MaskFormat {
47   AllTrue = 0,
48   AllFalse = 1,
49   Unknown = 2,
50 };
51 
52 /// Helper method to classify a 1-D mask value. Currently, the method
53 /// looks "under the hood" of a constant value with dense attributes
54 /// and a constant mask operation (since the client may be called at
55 /// various stages during progressive lowering).
56 static MaskFormat get1DMaskFormat(Value mask) {
57   if (auto c = mask.getDefiningOp<arith::ConstantOp>()) {
58     // Inspect constant dense values. We count up for bits that
59     // are set, count down for bits that are cleared, and bail
60     // when a mix is detected.
61     if (auto denseElts = c.getValue().dyn_cast<DenseIntElementsAttr>()) {
62       int64_t val = 0;
63       for (bool b : denseElts.getValues<bool>())
64         if (b && val >= 0)
65           val++;
66         else if (!b && val <= 0)
67           val--;
68         else
69           return MaskFormat::Unknown;
70       if (val > 0)
71         return MaskFormat::AllTrue;
72       if (val < 0)
73         return MaskFormat::AllFalse;
74     }
75   } else if (auto m = mask.getDefiningOp<ConstantMaskOp>()) {
76     // Inspect constant mask index. If the index exceeds the
77     // dimension size, all bits are set. If the index is zero
78     // or less, no bits are set.
79     ArrayAttr masks = m.getMaskDimSizes();
80     assert(masks.size() == 1);
81     int64_t i = masks[0].cast<IntegerAttr>().getInt();
82     int64_t u = m.getType().getDimSize(0);
83     if (i >= u)
84       return MaskFormat::AllTrue;
85     if (i <= 0)
86       return MaskFormat::AllFalse;
87   }
88   return MaskFormat::Unknown;
89 }
90 
91 // Helper for verifying combining kinds in contractions and reductions.
92 static bool isSupportedCombiningKind(CombiningKind combiningKind,
93                                      Type elementType) {
94   switch (combiningKind) {
95   case CombiningKind::ADD:
96   case CombiningKind::MUL:
97     return elementType.isIntOrIndexOrFloat();
98   case CombiningKind::MINUI:
99   case CombiningKind::MINSI:
100   case CombiningKind::MAXUI:
101   case CombiningKind::MAXSI:
102   case CombiningKind::AND:
103   case CombiningKind::OR:
104   case CombiningKind::XOR:
105     return elementType.isIntOrIndex();
106   case CombiningKind::MINF:
107   case CombiningKind::MAXF:
108     return elementType.isa<FloatType>();
109   }
110   return false;
111 }
112 
113 /// Return true if the last dimension of the MemRefType has unit stride. Also
114 /// return true for memrefs with no strides.
115 bool mlir::vector::isLastMemrefDimUnitStride(MemRefType type) {
116   int64_t offset;
117   SmallVector<int64_t> strides;
118   auto successStrides = getStridesAndOffset(type, strides, offset);
119   return succeeded(successStrides) && (strides.empty() || strides.back() == 1);
120 }
121 
122 AffineMap mlir::vector::getTransferMinorIdentityMap(ShapedType shapedType,
123                                                     VectorType vectorType) {
124   int64_t elementVectorRank = 0;
125   VectorType elementVectorType =
126       shapedType.getElementType().dyn_cast<VectorType>();
127   if (elementVectorType)
128     elementVectorRank += elementVectorType.getRank();
129   // 0-d transfers are to/from tensor<t>/memref<t> and vector<1xt>.
130   // TODO: replace once we have 0-d vectors.
131   if (shapedType.getRank() == 0 &&
132       vectorType.getShape() == ArrayRef<int64_t>{1})
133     return AffineMap::get(
134         /*numDims=*/0, /*numSymbols=*/0,
135         getAffineConstantExpr(0, shapedType.getContext()));
136   return AffineMap::getMinorIdentityMap(
137       shapedType.getRank(), vectorType.getRank() - elementVectorRank,
138       shapedType.getContext());
139 }
140 
141 bool mlir::vector::checkSameValueRAW(vector::TransferWriteOp defWrite,
142                                      vector::TransferReadOp read) {
143   return !defWrite.hasOutOfBoundsDim() && !defWrite.getMask() &&
144          !read.getMask() && defWrite.getIndices() == read.getIndices() &&
145          defWrite.getVectorType() == read.getVectorType() &&
146          defWrite.getPermutationMap() == read.getPermutationMap();
147 }
148 
149 bool mlir::vector::checkSameValueWAW(vector::TransferWriteOp write,
150                                      vector::TransferWriteOp priorWrite) {
151   return priorWrite.getIndices() == write.getIndices() &&
152          priorWrite.getMask() == write.getMask() &&
153          priorWrite.getVectorType() == write.getVectorType() &&
154          priorWrite.getPermutationMap() == write.getPermutationMap();
155 }
156 
157 bool mlir::vector::isDisjointTransferIndices(
158     VectorTransferOpInterface transferA, VectorTransferOpInterface transferB) {
159   // For simplicity only look at transfer of same type.
160   if (transferA.getVectorType() != transferB.getVectorType())
161     return false;
162   unsigned rankOffset = transferA.getLeadingShapedRank();
163   for (unsigned i = 0, e = transferA.indices().size(); i < e; i++) {
164     auto indexA = transferA.indices()[i].getDefiningOp<arith::ConstantOp>();
165     auto indexB = transferB.indices()[i].getDefiningOp<arith::ConstantOp>();
166     // If any of the indices are dynamic we cannot prove anything.
167     if (!indexA || !indexB)
168       continue;
169 
170     if (i < rankOffset) {
171       // For leading dimensions, if we can prove that index are different we
172       // know we are accessing disjoint slices.
173       if (indexA.getValue().cast<IntegerAttr>().getInt() !=
174           indexB.getValue().cast<IntegerAttr>().getInt())
175         return true;
176     } else {
177       // For this dimension, we slice a part of the memref we need to make sure
178       // the intervals accessed don't overlap.
179       int64_t distance =
180           std::abs(indexA.getValue().cast<IntegerAttr>().getInt() -
181                    indexB.getValue().cast<IntegerAttr>().getInt());
182       if (distance >= transferA.getVectorType().getDimSize(i - rankOffset))
183         return true;
184     }
185   }
186   return false;
187 }
188 
189 bool mlir::vector::isDisjointTransferSet(VectorTransferOpInterface transferA,
190                                          VectorTransferOpInterface transferB) {
191   if (transferA.source() != transferB.source())
192     return false;
193   return isDisjointTransferIndices(transferA, transferB);
194 }
195 
196 //===----------------------------------------------------------------------===//
197 // CombiningKindAttr
198 //===----------------------------------------------------------------------===//
199 
200 namespace mlir {
201 namespace vector {
202 namespace detail {
203 struct BitmaskEnumStorage : public AttributeStorage {
204   using KeyTy = uint64_t;
205 
206   BitmaskEnumStorage(KeyTy val) : value(val) {}
207 
208   bool operator==(const KeyTy &key) const { return value == key; }
209 
210   static BitmaskEnumStorage *construct(AttributeStorageAllocator &allocator,
211                                        const KeyTy &key) {
212     return new (allocator.allocate<BitmaskEnumStorage>())
213         BitmaskEnumStorage(key);
214   }
215 
216   KeyTy value = 0;
217 };
218 } // namespace detail
219 } // namespace vector
220 } // namespace mlir
221 
222 CombiningKindAttr CombiningKindAttr::get(CombiningKind kind,
223                                          MLIRContext *context) {
224   return Base::get(context, static_cast<uint64_t>(kind));
225 }
226 
227 CombiningKind CombiningKindAttr::getKind() const {
228   return static_cast<CombiningKind>(getImpl()->value);
229 }
230 
231 static constexpr const CombiningKind combiningKindsList[] = {
232     // clang-format off
233     CombiningKind::ADD,
234     CombiningKind::MUL,
235     CombiningKind::MINUI,
236     CombiningKind::MINSI,
237     CombiningKind::MINF,
238     CombiningKind::MAXUI,
239     CombiningKind::MAXSI,
240     CombiningKind::MAXF,
241     CombiningKind::AND,
242     CombiningKind::OR,
243     CombiningKind::XOR,
244     // clang-format on
245 };
246 
247 void CombiningKindAttr::print(AsmPrinter &printer) const {
248   printer << "<";
249   auto kinds = llvm::make_filter_range(combiningKindsList, [&](auto kind) {
250     return bitEnumContains(this->getKind(), kind);
251   });
252   llvm::interleaveComma(kinds, printer,
253                         [&](auto kind) { printer << stringifyEnum(kind); });
254   printer << ">";
255 }
256 
257 Attribute CombiningKindAttr::parse(AsmParser &parser, Type type) {
258   if (failed(parser.parseLess()))
259     return {};
260 
261   StringRef elemName;
262   if (failed(parser.parseKeyword(&elemName)))
263     return {};
264 
265   auto kind = symbolizeCombiningKind(elemName);
266   if (!kind) {
267     parser.emitError(parser.getNameLoc(), "Unknown combining kind: ")
268         << elemName;
269     return {};
270   }
271 
272   if (failed(parser.parseGreater()))
273     return {};
274 
275   return CombiningKindAttr::get(*kind, parser.getContext());
276 }
277 
278 Attribute VectorDialect::parseAttribute(DialectAsmParser &parser,
279                                         Type type) const {
280   StringRef attrKind;
281   if (parser.parseKeyword(&attrKind))
282     return {};
283 
284   if (attrKind == "kind")
285     return CombiningKindAttr::parse(parser, {});
286 
287   parser.emitError(parser.getNameLoc(), "Unknown attribute type: ") << attrKind;
288   return {};
289 }
290 
291 void VectorDialect::printAttribute(Attribute attr,
292                                    DialectAsmPrinter &os) const {
293   if (auto ck = attr.dyn_cast<CombiningKindAttr>()) {
294     os << "kind";
295     ck.print(os);
296     return;
297   }
298   llvm_unreachable("Unknown attribute type");
299 }
300 
301 //===----------------------------------------------------------------------===//
302 // VectorDialect
303 //===----------------------------------------------------------------------===//
304 
305 void VectorDialect::initialize() {
306   addAttributes<CombiningKindAttr>();
307 
308   addOperations<
309 #define GET_OP_LIST
310 #include "mlir/Dialect/Vector/IR/VectorOps.cpp.inc"
311       >();
312 }
313 
314 /// Materialize a single constant operation from a given attribute value with
315 /// the desired resultant type.
316 Operation *VectorDialect::materializeConstant(OpBuilder &builder,
317                                               Attribute value, Type type,
318                                               Location loc) {
319   return builder.create<arith::ConstantOp>(loc, type, value);
320 }
321 
322 IntegerType vector::getVectorSubscriptType(Builder &builder) {
323   return builder.getIntegerType(64);
324 }
325 
326 ArrayAttr vector::getVectorSubscriptAttr(Builder &builder,
327                                          ArrayRef<int64_t> values) {
328   return builder.getI64ArrayAttr(values);
329 }
330 
331 //===----------------------------------------------------------------------===//
332 // MultiDimReductionOp
333 //===----------------------------------------------------------------------===//
334 
335 void vector::MultiDimReductionOp::build(OpBuilder &builder,
336                                         OperationState &result, Value source,
337                                         Value acc, ArrayRef<bool> reductionMask,
338                                         CombiningKind kind) {
339   SmallVector<int64_t> reductionDims;
340   for (const auto &en : llvm::enumerate(reductionMask))
341     if (en.value())
342       reductionDims.push_back(en.index());
343   build(builder, result, kind, source, acc,
344         builder.getI64ArrayAttr(reductionDims));
345 }
346 
347 OpFoldResult MultiDimReductionOp::fold(ArrayRef<Attribute> operands) {
348   // Single parallel dim, this is a noop.
349   if (getSourceVectorType().getRank() == 1 && !isReducedDim(0))
350     return getSource();
351   return {};
352 }
353 
354 Optional<SmallVector<int64_t, 4>> MultiDimReductionOp::getShapeForUnroll() {
355   return llvm::to_vector<4>(getSourceVectorType().getShape());
356 }
357 
358 LogicalResult MultiDimReductionOp::verify() {
359   SmallVector<int64_t> targetShape;
360   Type inferredReturnType;
361   for (auto it : llvm::enumerate(getSourceVectorType().getShape()))
362     if (!llvm::any_of(getReductionDims().getValue(), [&](Attribute attr) {
363           return attr.cast<IntegerAttr>().getValue() == it.index();
364         }))
365       targetShape.push_back(it.value());
366   // TODO: update to also allow 0-d vectors when available.
367   if (targetShape.empty())
368     inferredReturnType = getSourceVectorType().getElementType();
369   else
370     inferredReturnType =
371         VectorType::get(targetShape, getSourceVectorType().getElementType());
372   if (getType() != inferredReturnType)
373     return emitOpError() << "destination type " << getType()
374                          << " is incompatible with source type "
375                          << getSourceVectorType();
376 
377   return success();
378 }
379 
380 //===----------------------------------------------------------------------===//
381 // ReductionOp
382 //===----------------------------------------------------------------------===//
383 
384 void vector::ReductionOp::build(OpBuilder &builder, OperationState &result,
385                                 CombiningKind kind, Value vector) {
386   build(builder, result, kind, vector, /*acc=*/Value());
387 }
388 
389 void vector::ReductionOp::build(OpBuilder &builder, OperationState &result,
390                                 CombiningKind kind, Value vector, Value acc) {
391   build(builder, result, vector.getType().cast<VectorType>().getElementType(),
392         kind, vector, acc);
393 }
394 
395 LogicalResult ReductionOp::verify() {
396   // Verify for 1-D vector.
397   int64_t rank = getVectorType().getRank();
398   if (rank != 1)
399     return emitOpError("unsupported reduction rank: ") << rank;
400 
401   // Verify supported reduction kind.
402   Type eltType = getDest().getType();
403   if (!isSupportedCombiningKind(getKind(), eltType))
404     return emitOpError("unsupported reduction type '")
405            << eltType << "' for kind '" << stringifyCombiningKind(getKind())
406            << "'";
407 
408   return success();
409 }
410 
411 ParseResult ReductionOp::parse(OpAsmParser &parser, OperationState &result) {
412   SmallVector<OpAsmParser::UnresolvedOperand, 2> operandsInfo;
413   Type redType;
414   Type resType;
415   CombiningKindAttr kindAttr;
416   if (parser.parseCustomAttributeWithFallback(kindAttr, Type{}, "kind",
417                                               result.attributes) ||
418       parser.parseComma() || parser.parseOperandList(operandsInfo) ||
419       parser.parseColonType(redType) ||
420       parser.parseKeywordType("into", resType) ||
421       (!operandsInfo.empty() &&
422        parser.resolveOperand(operandsInfo[0], redType, result.operands)) ||
423       (operandsInfo.size() > 1 &&
424        parser.resolveOperand(operandsInfo[1], resType, result.operands)) ||
425       parser.addTypeToList(resType, result.types))
426     return failure();
427   if (operandsInfo.empty() || operandsInfo.size() > 2)
428     return parser.emitError(parser.getNameLoc(),
429                             "unsupported number of operands");
430   return success();
431 }
432 
433 void ReductionOp::print(OpAsmPrinter &p) {
434   p << " ";
435   getKindAttr().print(p);
436   p << ", " << getVector();
437   if (getAcc())
438     p << ", " << getAcc();
439   p << " : " << getVector().getType() << " into " << getDest().getType();
440 }
441 
442 Value mlir::vector::getVectorReductionOp(arith::AtomicRMWKind op,
443                                          OpBuilder &builder, Location loc,
444                                          Value vector) {
445   switch (op) {
446   case arith::AtomicRMWKind::addf:
447   case arith::AtomicRMWKind::addi:
448     return builder.create<vector::ReductionOp>(vector.getLoc(),
449                                                CombiningKind::ADD, vector);
450   case arith::AtomicRMWKind::mulf:
451   case arith::AtomicRMWKind::muli:
452     return builder.create<vector::ReductionOp>(vector.getLoc(),
453                                                CombiningKind::MUL, vector);
454   case arith::AtomicRMWKind::minf:
455     return builder.create<vector::ReductionOp>(vector.getLoc(),
456                                                CombiningKind::MINF, vector);
457   case arith::AtomicRMWKind::mins:
458     return builder.create<vector::ReductionOp>(vector.getLoc(),
459                                                CombiningKind::MINSI, vector);
460   case arith::AtomicRMWKind::minu:
461     return builder.create<vector::ReductionOp>(vector.getLoc(),
462                                                CombiningKind::MINUI, vector);
463   case arith::AtomicRMWKind::maxf:
464     return builder.create<vector::ReductionOp>(vector.getLoc(),
465                                                CombiningKind::MAXF, vector);
466   case arith::AtomicRMWKind::maxs:
467     return builder.create<vector::ReductionOp>(vector.getLoc(),
468                                                CombiningKind::MAXSI, vector);
469   case arith::AtomicRMWKind::maxu:
470     return builder.create<vector::ReductionOp>(vector.getLoc(),
471                                                CombiningKind::MAXUI, vector);
472   case arith::AtomicRMWKind::andi:
473     return builder.create<vector::ReductionOp>(vector.getLoc(),
474                                                CombiningKind::AND, vector);
475   case arith::AtomicRMWKind::ori:
476     return builder.create<vector::ReductionOp>(vector.getLoc(),
477                                                CombiningKind::OR, vector);
478   // TODO: Add remaining reduction operations.
479   default:
480     (void)emitOptionalError(loc, "Reduction operation type not supported");
481     break;
482   }
483   return nullptr;
484 }
485 
486 Optional<SmallVector<int64_t, 4>> ReductionOp::getShapeForUnroll() {
487   return llvm::to_vector<4>(getVectorType().getShape());
488 }
489 
490 namespace {
491 struct ElideSingleElementReduction : public OpRewritePattern<ReductionOp> {
492   using OpRewritePattern::OpRewritePattern;
493 
494   LogicalResult matchAndRewrite(ReductionOp reductionOp,
495                                 PatternRewriter &rewriter) const override {
496     if (reductionOp.getVectorType().getDimSize(0) != 1)
497       return failure();
498 
499     Location loc = reductionOp.getLoc();
500     Value result = rewriter.create<ExtractOp>(loc, reductionOp.getType(),
501                                               reductionOp.getVector(),
502                                               rewriter.getI64ArrayAttr(0));
503 
504     if (Value acc = reductionOp.getAcc()) {
505       assert(reductionOp.getType().isa<FloatType>());
506       switch (reductionOp.getKind()) {
507       case CombiningKind::ADD:
508         result = rewriter.create<arith::AddFOp>(loc, result, acc);
509         break;
510       case CombiningKind::MUL:
511         result = rewriter.create<arith::MulFOp>(loc, result, acc);
512         break;
513       default:
514         assert(false && "invalid op!");
515       }
516     }
517 
518     rewriter.replaceOp(reductionOp, result);
519     return success();
520   }
521 };
522 } // namespace
523 
524 void ReductionOp::getCanonicalizationPatterns(RewritePatternSet &results,
525                                               MLIRContext *context) {
526   results.add<ElideSingleElementReduction>(context);
527 }
528 
529 //===----------------------------------------------------------------------===//
530 // ContractionOp
531 //===----------------------------------------------------------------------===//
532 
533 void vector::ContractionOp::build(OpBuilder &builder, OperationState &result,
534                                   Value lhs, Value rhs, Value acc,
535                                   ArrayRef<ArrayRef<AffineExpr>> indexingExprs,
536                                   ArrayRef<StringRef> iteratorTypes) {
537   result.addOperands({lhs, rhs, acc});
538   result.addTypes(acc.getType());
539   result.addAttribute(::mlir::getIndexingMapsAttrName(),
540                       builder.getAffineMapArrayAttr(
541                           AffineMap::inferFromExprList(indexingExprs)));
542   result.addAttribute(::mlir::getIteratorTypesAttrName(),
543                       builder.getStrArrayAttr(iteratorTypes));
544 }
545 
546 void vector::ContractionOp::build(OpBuilder &builder, OperationState &result,
547                                   Value lhs, Value rhs, Value acc,
548                                   ArrayAttr indexingMaps,
549                                   ArrayAttr iteratorTypes) {
550   build(builder, result, lhs, rhs, acc, indexingMaps, iteratorTypes,
551         ContractionOp::getDefaultKind());
552 }
553 
554 void vector::ContractionOp::build(OpBuilder &builder, OperationState &result,
555                                   Value lhs, Value rhs, Value acc,
556                                   ArrayAttr indexingMaps,
557                                   ArrayAttr iteratorTypes, CombiningKind kind) {
558   result.addOperands({lhs, rhs, acc});
559   result.addTypes(acc.getType());
560   result.addAttribute(::mlir::getIndexingMapsAttrName(), indexingMaps);
561   result.addAttribute(::mlir::getIteratorTypesAttrName(), iteratorTypes);
562   result.addAttribute(ContractionOp::getKindAttrStrName(),
563                       CombiningKindAttr::get(kind, builder.getContext()));
564 }
565 
566 ParseResult ContractionOp::parse(OpAsmParser &parser, OperationState &result) {
567   OpAsmParser::UnresolvedOperand lhsInfo;
568   OpAsmParser::UnresolvedOperand rhsInfo;
569   OpAsmParser::UnresolvedOperand accInfo;
570   SmallVector<OpAsmParser::UnresolvedOperand, 2> masksInfo;
571   SmallVector<Type, 2> types;
572   Type resultType;
573   auto loc = parser.getCurrentLocation();
574   DictionaryAttr dictAttr;
575   // TODO: Unify linalg op attribute parsing.
576   if (parser.parseAttribute(dictAttr, "_", result.attributes) ||
577       parser.parseOperand(lhsInfo) || parser.parseComma() ||
578       parser.parseOperand(rhsInfo) || parser.parseComma() ||
579       parser.parseOperand(accInfo) ||
580       parser.parseTrailingOperandList(masksInfo) ||
581       parser.parseOptionalAttrDict(result.attributes) ||
582       parser.parseColonTypeList(types) ||
583       parser.parseKeywordType("into", resultType) ||
584       parser.resolveOperand(lhsInfo, types[0], result.operands) ||
585       parser.resolveOperand(rhsInfo, types[1], result.operands) ||
586       parser.resolveOperand(accInfo, resultType, result.operands) ||
587       parser.addTypeToList(resultType, result.types))
588     return failure();
589   result.attributes.assign(dictAttr.getValue().begin(),
590                            dictAttr.getValue().end());
591   if (!result.attributes.get(ContractionOp::getKindAttrStrName())) {
592     result.addAttribute(ContractionOp::getKindAttrStrName(),
593                         CombiningKindAttr::get(ContractionOp::getDefaultKind(),
594                                                result.getContext()));
595   }
596   if (masksInfo.empty())
597     return success();
598   if (masksInfo.size() != 2)
599     return parser.emitError(parser.getNameLoc(),
600                             "expected zero or exactly 2 vector mask operands");
601   auto lhsType = types[0].cast<VectorType>();
602   auto rhsType = types[1].cast<VectorType>();
603   auto maskElementType = parser.getBuilder().getI1Type();
604   std::array<Type, 2> maskTypes = {
605       VectorType::Builder(lhsType).setElementType(maskElementType),
606       VectorType::Builder(rhsType).setElementType(maskElementType)};
607   if (parser.resolveOperands(masksInfo, maskTypes, loc, result.operands))
608     return failure();
609   return success();
610 }
611 
612 void ContractionOp::print(OpAsmPrinter &p) {
613   // TODO: Unify printing code with linalg ops.
614   auto attrNames = getTraitAttrNames();
615   llvm::StringSet<> traitAttrsSet;
616   traitAttrsSet.insert(attrNames.begin(), attrNames.end());
617   SmallVector<NamedAttribute, 8> attrs;
618   for (auto attr : (*this)->getAttrs())
619     if (traitAttrsSet.count(attr.getName().strref()) > 0)
620       attrs.push_back(attr);
621 
622   auto dictAttr = DictionaryAttr::get(getContext(), attrs);
623   p << " " << dictAttr << " " << getLhs() << ", ";
624   p << getRhs() << ", " << getAcc();
625   if (getMasks().size() == 2)
626     p << ", " << getMasks();
627 
628   p.printOptionalAttrDict((*this)->getAttrs(), attrNames);
629   p << " : " << getLhs().getType() << ", " << getRhs().getType() << " into "
630     << getResultType();
631 }
632 
633 static bool verifyDimMap(VectorType lhsType, VectorType rhsType,
634                          const std::vector<std::pair<int64_t, int64_t>> &map) {
635   for (auto &dimPair : map) {
636     if (dimPair.first < 0 || dimPair.first >= lhsType.getRank() ||
637         dimPair.second < 0 || dimPair.second >= rhsType.getRank() ||
638         lhsType.getDimSize(dimPair.first) != rhsType.getDimSize(dimPair.second))
639       return false;
640   }
641   return true;
642 }
643 
644 static LogicalResult verifyOutputShape(
645     ContractionOp op, VectorType lhsType, VectorType rhsType, Type accType,
646     Type resType,
647     const std::vector<std::pair<int64_t, int64_t>> &contractingDimMap,
648     const std::vector<std::pair<int64_t, int64_t>> &batchDimMap) {
649   DenseSet<int64_t> lhsContractingDimSet;
650   DenseSet<int64_t> rhsContractingDimSet;
651   for (auto &dimPair : contractingDimMap) {
652     lhsContractingDimSet.insert(dimPair.first);
653     rhsContractingDimSet.insert(dimPair.second);
654   }
655   DenseSet<int64_t> rhsBatchDimSet;
656   for (auto &dimPair : batchDimMap)
657     rhsBatchDimSet.insert(dimPair.second);
658 
659   // Add free and batch dimensions from 'lhsType' to 'expectedResultDims'.
660   SmallVector<int64_t, 4> expectedResultDims;
661   for (int64_t i = 0, e = lhsType.getRank(); i < e; ++i) {
662     if (lhsContractingDimSet.count(i) > 0)
663       continue;
664     expectedResultDims.push_back(lhsType.getDimSize(i));
665   }
666 
667   // Add free dimensions from 'rhsType' to 'expectedResultDims'.
668   for (int64_t i = 0, e = rhsType.getRank(); i < e; ++i) {
669     if (rhsContractingDimSet.count(i) > 0 || rhsBatchDimSet.count(i) > 0)
670       continue;
671     expectedResultDims.push_back(rhsType.getDimSize(i));
672   }
673 
674   // Verify 'expectedResultDims'.
675   if (expectedResultDims.empty()) {
676     // No batch or free dimension implies a scalar result.
677     if (resType.isa<VectorType>() || accType.isa<VectorType>())
678       return op.emitOpError("invalid accumulator/result vector shape");
679   } else {
680     // At least one batch or free dimension implies a vector result.
681     auto resVectorType = resType.dyn_cast<VectorType>();
682     auto accVectorType = accType.dyn_cast<VectorType>();
683     if (!resVectorType || !accVectorType)
684       return op.emitOpError("invalid accumulator/result vector shape");
685 
686     // Infer expected result vector type. Lhs + rhs map and lhs + rhs vector
687     // types fully define the result vector type. This assumes the affine maps
688     // are well-formed, which must have been verified already.
689     MLIRContext *ctx = op.getContext();
690     AffineMap lhsMap = op.getIndexingMaps()[0];
691     AffineMap rhsMap = op.getIndexingMaps()[1];
692     if (getUnusedDimsBitVector({lhsMap, rhsMap}).any())
693       return op.emitOpError(
694           "expected all dimensions to be either a LHS or a RHS dimension");
695     SmallVector<AffineExpr, 4> extents(lhsMap.getNumInputs());
696     for (auto pair :
697          {std::make_pair(lhsType, lhsMap), std::make_pair(rhsType, rhsMap)}) {
698       VectorType v = pair.first;
699       auto map = pair.second;
700       for (unsigned idx = 0, e = v.getRank(); idx < e; ++idx) {
701         unsigned pos = map.getDimPosition(idx);
702         if (!extents[pos])
703           extents[pos] = getAffineConstantExpr(v.getShape()[idx], ctx);
704       }
705     }
706     if (!llvm::all_of(extents, [](AffineExpr e) { return e; }))
707       return op.emitOpError("expected all dimensions to get an extent as "
708                             "either a LHS or a RHS dimension");
709 
710     AffineMap resMap = op.getIndexingMaps()[2];
711     auto extentsMap = AffineMap::get(/*dimCount=*/extents.size(),
712                                      /*symCount=*/0, extents, ctx);
713     // Compose the resMap with the extentsMap, which is a constant map.
714     AffineMap expectedMap = simplifyAffineMap(resMap.compose(extentsMap));
715     assert(llvm::all_of(
716                expectedMap.getResults(),
717                [](AffineExpr e) { return e.isa<AffineConstantExpr>(); }) &&
718            "expected constant extent along all dimensions.");
719     // Extract the expected shape and build the type.
720     auto expectedShape = llvm::to_vector<4>(
721         llvm::map_range(expectedMap.getResults(), [](AffineExpr e) {
722           return e.cast<AffineConstantExpr>().getValue();
723         }));
724     auto expected =
725         VectorType::get(expectedShape, resVectorType.getElementType());
726     if (resVectorType != expected || accVectorType != expected)
727       return op.emitOpError(
728                  "invalid accumulator/result vector shape, expected: ")
729              << expected;
730   }
731   return success();
732 }
733 
734 LogicalResult ContractionOp::verify() {
735   auto lhsType = getLhsType();
736   auto rhsType = getRhsType();
737   auto accType = getAccType();
738   auto resType = getResultType();
739 
740   // Verify that an indexing map was specified for each vector operand.
741   if (getIndexingMaps().size() != 3)
742     return emitOpError("expected an indexing map for each vector operand");
743 
744   // Verify that each index map has 'numIterators' inputs, no symbols, and
745   // that the number of map outputs equals the rank of its associated
746   // vector operand.
747   unsigned numIterators = getIteratorTypes().getValue().size();
748   for (const auto &it : llvm::enumerate(getIndexingMaps())) {
749     auto index = it.index();
750     auto map = it.value();
751     if (map.getNumSymbols() != 0)
752       return emitOpError("expected indexing map ")
753              << index << " to have no symbols";
754     auto vectorType = getOperand(index).getType().dyn_cast<VectorType>();
755     unsigned rank = vectorType ? vectorType.getShape().size() : 0;
756     // Verify that the map has the right number of inputs, outputs, and indices.
757     // This also correctly accounts for (..) -> () for rank-0 results.
758     if (map.getNumDims() != numIterators)
759       return emitOpError("expected indexing map ")
760              << index << " to have " << numIterators << " number of inputs";
761     if (map.getNumResults() != rank)
762       return emitOpError("expected indexing map ")
763              << index << " to have " << rank << " number of outputs";
764     if (!map.isProjectedPermutation())
765       return emitOpError("expected indexing map ")
766              << index << " to be a projected permutation of its inputs";
767   }
768 
769   auto contractingDimMap = getContractingDimMap();
770   auto batchDimMap = getBatchDimMap();
771 
772   // Verify at least one contracting dimension pair was specified.
773   if (contractingDimMap.empty())
774     return emitOpError("expected at least one contracting dimension pair");
775 
776   // Verify contracting dimension map was properly constructed.
777   if (!verifyDimMap(lhsType, rhsType, contractingDimMap))
778     return emitOpError("invalid contracting dimension map");
779 
780   // Verify batch dimension map was properly constructed.
781   if (!verifyDimMap(lhsType, rhsType, batchDimMap))
782     return emitOpError("invalid batch dimension map");
783 
784   // Verify 'accType' and 'resType' shape.
785   if (failed(verifyOutputShape(*this, lhsType, rhsType, accType, resType,
786                                contractingDimMap, batchDimMap)))
787     return failure();
788 
789   // Verify that either two vector masks are set or none are set.
790   auto lhsMaskType = getLHSVectorMaskType();
791   auto rhsMaskType = getRHSVectorMaskType();
792   if ((lhsMaskType && !rhsMaskType) || (!lhsMaskType && rhsMaskType))
793     return emitOpError("invalid number of vector masks specified");
794   if (lhsMaskType && rhsMaskType) {
795     // Verify mask rank == argument rank.
796     if (lhsMaskType.getShape().size() != lhsType.getShape().size() ||
797         rhsMaskType.getShape().size() != rhsType.getShape().size())
798       return emitOpError("invalid vector mask rank");
799   }
800 
801   // Verify supported combining kind.
802   auto vectorType = resType.dyn_cast<VectorType>();
803   auto elementType = vectorType ? vectorType.getElementType() : resType;
804   if (!isSupportedCombiningKind(getKind(), elementType))
805     return emitOpError("unsupported contraction type");
806 
807   return success();
808 }
809 
810 ArrayRef<StringRef> ContractionOp::getTraitAttrNames() {
811   static constexpr StringRef names[3] = {::mlir::getIndexingMapsAttrName(),
812                                          ::mlir::getIteratorTypesAttrName(),
813                                          ContractionOp::getKindAttrStrName()};
814   return llvm::makeArrayRef(names);
815 }
816 
817 static int64_t getResultIndex(AffineMap map, AffineExpr targetExpr) {
818   for (int64_t i = 0, e = map.getNumResults(); i < e; ++i)
819     if (targetExpr == map.getResult(i))
820       return i;
821   return -1;
822 }
823 
824 static std::vector<std::pair<int64_t, int64_t>>
825 getDimMap(ArrayRef<AffineMap> indexingMaps, ArrayAttr iteratorTypes,
826           StringRef targetIteratorTypeName, MLIRContext *context) {
827   std::vector<std::pair<int64_t, int64_t>> dimMap;
828   for (const auto &it : llvm::enumerate(iteratorTypes)) {
829     auto iteratorTypeName = it.value().cast<StringAttr>().getValue();
830     if (iteratorTypeName != targetIteratorTypeName)
831       continue;
832     // Search lhs/rhs map results for 'targetExpr'.
833     auto targetExpr = getAffineDimExpr(it.index(), context);
834     int64_t lhsDim = getResultIndex(indexingMaps[0], targetExpr);
835     int64_t rhsDim = getResultIndex(indexingMaps[1], targetExpr);
836     if (lhsDim >= 0 && rhsDim >= 0)
837       dimMap.emplace_back(lhsDim, rhsDim);
838   }
839   return dimMap;
840 }
841 
842 void ContractionOp::getIterationBounds(
843     SmallVectorImpl<int64_t> &iterationBounds) {
844   auto lhsShape = getLhsType().getShape();
845   auto resVectorType = getResultType().dyn_cast<VectorType>();
846   SmallVector<AffineMap, 4> indexingMaps(getIndexingMaps());
847   SmallVector<int64_t, 2> iterationShape;
848   for (const auto &it : llvm::enumerate(getIteratorTypes())) {
849     // Search lhs/rhs map results for 'targetExpr'.
850     auto targetExpr = getAffineDimExpr(it.index(), getContext());
851     auto iteratorTypeName = it.value().cast<StringAttr>().getValue();
852     if (iteratorTypeName == getReductionIteratorTypeName()) {
853       // Get reduction dim size from lhs shape (same size in rhsShape).
854       int64_t lhsDimIndex = getResultIndex(indexingMaps[0], targetExpr);
855       assert(lhsDimIndex >= 0);
856       iterationBounds.push_back(lhsShape[lhsDimIndex]);
857       continue;
858     }
859     // Get parallel dimension size from result shape.
860     int64_t resDimIndex = getResultIndex(indexingMaps[2], targetExpr);
861     assert(resDimIndex >= 0);
862     assert(resVectorType != nullptr);
863     iterationBounds.push_back(resVectorType.getShape()[resDimIndex]);
864   }
865 }
866 
867 void ContractionOp::getIterationIndexMap(
868     std::vector<DenseMap<int64_t, int64_t>> &iterationIndexMap) {
869   unsigned numMaps = getIndexingMaps().size();
870   iterationIndexMap.resize(numMaps);
871   for (const auto &it : llvm::enumerate(getIndexingMaps())) {
872     auto index = it.index();
873     auto map = it.value();
874     for (unsigned i = 0, e = map.getNumResults(); i < e; ++i) {
875       auto dim = map.getResult(i).cast<AffineDimExpr>();
876       iterationIndexMap[index][dim.getPosition()] = i;
877     }
878   }
879 }
880 
881 std::vector<std::pair<int64_t, int64_t>> ContractionOp::getContractingDimMap() {
882   SmallVector<AffineMap, 4> indexingMaps(getIndexingMaps());
883   return getDimMap(indexingMaps, getIteratorTypes(),
884                    getReductionIteratorTypeName(), getContext());
885 }
886 
887 std::vector<std::pair<int64_t, int64_t>> ContractionOp::getBatchDimMap() {
888   SmallVector<AffineMap, 4> indexingMaps(getIndexingMaps());
889   return getDimMap(indexingMaps, getIteratorTypes(),
890                    getParallelIteratorTypeName(), getContext());
891 }
892 
893 Optional<SmallVector<int64_t, 4>> ContractionOp::getShapeForUnroll() {
894   SmallVector<int64_t, 4> shape;
895   getIterationBounds(shape);
896   return shape;
897 }
898 
899 /// Return a fused vector::ContractionOp which represents a patterns such as:
900 ///
901 /// ```mlir
902 ///    %c0 = vector.constant 0: ...
903 ///    %c = vector.contract %a, %b, %c0: ...
904 ///    %e = add %c, %d: ...
905 /// ```
906 ///
907 /// by:
908 ///
909 /// ```mlir
910 ///    %e = vector.contract %a, %b, %d: ...
911 /// ```
912 ///
913 /// Return null if the canonicalization does not apply.
914 // TODO: This should be a folding of Add into Contract in core but while they
915 // live in different dialects, it is not possible without unnatural
916 // dependencies.
917 template <typename AddOpType>
918 struct CanonicalizeContractAdd : public OpRewritePattern<AddOpType> {
919   using OpRewritePattern<AddOpType>::OpRewritePattern;
920 
921   LogicalResult matchAndRewrite(AddOpType addOp,
922                                 PatternRewriter &rewriter) const override {
923     auto canonicalize = [&](Value maybeContraction,
924                             Value otherOperand) -> vector::ContractionOp {
925       vector::ContractionOp contractionOp =
926           dyn_cast_or_null<vector::ContractionOp>(
927               maybeContraction.getDefiningOp());
928       if (!contractionOp)
929         return vector::ContractionOp();
930       if (auto maybeZero = dyn_cast_or_null<arith::ConstantOp>(
931               contractionOp.getAcc().getDefiningOp())) {
932         if (maybeZero.getValue() ==
933             rewriter.getZeroAttr(contractionOp.getAcc().getType())) {
934           BlockAndValueMapping bvm;
935           bvm.map(contractionOp.getAcc(), otherOperand);
936           auto newContraction =
937               cast<vector::ContractionOp>(rewriter.clone(*contractionOp, bvm));
938           rewriter.replaceOp(addOp, newContraction.getResult());
939           return newContraction;
940         }
941       }
942       return vector::ContractionOp();
943     };
944 
945     Value a = addOp->getOperand(0), b = addOp->getOperand(1);
946     vector::ContractionOp contract = canonicalize(a, b);
947     contract = contract ? contract : canonicalize(b, a);
948     return contract ? success() : failure();
949   }
950 };
951 
952 void ContractionOp::getCanonicalizationPatterns(RewritePatternSet &results,
953                                                 MLIRContext *context) {
954   results.add<CanonicalizeContractAdd<arith::AddIOp>,
955               CanonicalizeContractAdd<arith::AddFOp>>(context);
956 }
957 
958 //===----------------------------------------------------------------------===//
959 // ExtractElementOp
960 //===----------------------------------------------------------------------===//
961 
962 void vector::ExtractElementOp::build(OpBuilder &builder, OperationState &result,
963                                      Value source) {
964   result.addOperands({source});
965   result.addTypes(source.getType().cast<VectorType>().getElementType());
966 }
967 
968 void vector::ExtractElementOp::build(OpBuilder &builder, OperationState &result,
969                                      Value source, Value position) {
970   result.addOperands({source, position});
971   result.addTypes(source.getType().cast<VectorType>().getElementType());
972 }
973 
974 LogicalResult vector::ExtractElementOp::verify() {
975   VectorType vectorType = getVectorType();
976   if (vectorType.getRank() == 0) {
977     if (getPosition())
978       return emitOpError("expected position to be empty with 0-D vector");
979     return success();
980   }
981   if (vectorType.getRank() != 1)
982     return emitOpError("unexpected >1 vector rank");
983   if (!getPosition())
984     return emitOpError("expected position for 1-D vector");
985   return success();
986 }
987 
988 OpFoldResult vector::ExtractElementOp::fold(ArrayRef<Attribute> operands) {
989   // Skip the 0-D vector here now.
990   if (operands.size() < 2)
991     return {};
992 
993   Attribute src = operands[0];
994   Attribute pos = operands[1];
995 
996   // Fold extractelement (splat X) -> X.
997   if (auto splat = getVector().getDefiningOp<vector::SplatOp>())
998     return splat.getInput();
999 
1000   if (!pos || !src)
1001     return {};
1002 
1003   auto srcElements = src.cast<DenseElementsAttr>().getValues<Attribute>();
1004 
1005   auto attr = pos.dyn_cast<IntegerAttr>();
1006   uint64_t posIdx = attr.getInt();
1007 
1008   return srcElements[posIdx];
1009 }
1010 
1011 //===----------------------------------------------------------------------===//
1012 // ExtractOp
1013 //===----------------------------------------------------------------------===//
1014 
1015 void vector::ExtractOp::build(OpBuilder &builder, OperationState &result,
1016                               Value source, ArrayRef<int64_t> position) {
1017   build(builder, result, source, getVectorSubscriptAttr(builder, position));
1018 }
1019 
1020 // Convenience builder which assumes the values are constant indices.
1021 void vector::ExtractOp::build(OpBuilder &builder, OperationState &result,
1022                               Value source, ValueRange position) {
1023   SmallVector<int64_t, 4> positionConstants =
1024       llvm::to_vector<4>(llvm::map_range(position, [](Value pos) {
1025         return pos.getDefiningOp<arith::ConstantIndexOp>().value();
1026       }));
1027   build(builder, result, source, positionConstants);
1028 }
1029 
1030 LogicalResult
1031 ExtractOp::inferReturnTypes(MLIRContext *, Optional<Location>,
1032                             ValueRange operands, DictionaryAttr attributes,
1033                             RegionRange,
1034                             SmallVectorImpl<Type> &inferredReturnTypes) {
1035   ExtractOp::Adaptor op(operands, attributes);
1036   auto vectorType = op.getVector().getType().cast<VectorType>();
1037   if (static_cast<int64_t>(op.getPosition().size()) == vectorType.getRank()) {
1038     inferredReturnTypes.push_back(vectorType.getElementType());
1039   } else {
1040     auto n =
1041         std::min<size_t>(op.getPosition().size(), vectorType.getRank() - 1);
1042     inferredReturnTypes.push_back(VectorType::get(
1043         vectorType.getShape().drop_front(n), vectorType.getElementType()));
1044   }
1045   return success();
1046 }
1047 
1048 bool ExtractOp::isCompatibleReturnTypes(TypeRange l, TypeRange r) {
1049   // Allow extracting 1-element vectors instead of scalars.
1050   auto isCompatible = [](TypeRange l, TypeRange r) {
1051     auto vectorType = l.front().dyn_cast<VectorType>();
1052     return vectorType && vectorType.getShape().equals({1}) &&
1053            vectorType.getElementType() == r.front();
1054   };
1055   if (l.size() == 1 && r.size() == 1 &&
1056       (isCompatible(l, r) || isCompatible(r, l)))
1057     return true;
1058   return l == r;
1059 }
1060 
1061 LogicalResult vector::ExtractOp::verify() {
1062   auto positionAttr = getPosition().getValue();
1063   if (positionAttr.size() > static_cast<unsigned>(getVectorType().getRank()))
1064     return emitOpError(
1065         "expected position attribute of rank smaller than vector rank");
1066   for (const auto &en : llvm::enumerate(positionAttr)) {
1067     auto attr = en.value().dyn_cast<IntegerAttr>();
1068     if (!attr || attr.getInt() < 0 ||
1069         attr.getInt() >= getVectorType().getDimSize(en.index()))
1070       return emitOpError("expected position attribute #")
1071              << (en.index() + 1)
1072              << " to be a non-negative integer smaller than the corresponding "
1073                 "vector dimension";
1074   }
1075   return success();
1076 }
1077 
1078 template <typename IntType>
1079 static SmallVector<IntType> extractVector(ArrayAttr arrayAttr) {
1080   return llvm::to_vector<4>(llvm::map_range(
1081       arrayAttr.getAsRange<IntegerAttr>(),
1082       [](IntegerAttr attr) { return static_cast<IntType>(attr.getInt()); }));
1083 }
1084 
1085 /// Fold the result of chains of ExtractOp in place by simply concatenating the
1086 /// positions.
1087 static LogicalResult foldExtractOpFromExtractChain(ExtractOp extractOp) {
1088   if (!extractOp.getVector().getDefiningOp<ExtractOp>())
1089     return failure();
1090 
1091   SmallVector<int64_t, 4> globalPosition;
1092   ExtractOp currentOp = extractOp;
1093   auto extrPos = extractVector<int64_t>(currentOp.getPosition());
1094   globalPosition.append(extrPos.rbegin(), extrPos.rend());
1095   while (ExtractOp nextOp = currentOp.getVector().getDefiningOp<ExtractOp>()) {
1096     currentOp = nextOp;
1097     auto extrPos = extractVector<int64_t>(currentOp.getPosition());
1098     globalPosition.append(extrPos.rbegin(), extrPos.rend());
1099   }
1100   extractOp.setOperand(currentOp.getVector());
1101   // OpBuilder is only used as a helper to build an I64ArrayAttr.
1102   OpBuilder b(extractOp.getContext());
1103   std::reverse(globalPosition.begin(), globalPosition.end());
1104   extractOp->setAttr(ExtractOp::getPositionAttrStrName(),
1105                      b.getI64ArrayAttr(globalPosition));
1106   return success();
1107 }
1108 
1109 namespace {
1110 /// Fold an ExtractOp that is fed by a chain of InsertOps and TransposeOps.
1111 /// Walk back a chain of InsertOp/TransposeOp until we hit a match.
1112 /// Compose TransposeOp permutations as we walk back.
1113 /// This helper class keeps an updated extraction position `extractPosition`
1114 /// with extra trailing sentinels.
1115 /// The sentinels encode the internal transposition status of the result vector.
1116 /// As we iterate, extractPosition is permuted and updated.
1117 class ExtractFromInsertTransposeChainState {
1118 public:
1119   ExtractFromInsertTransposeChainState(ExtractOp e);
1120 
1121   /// Iterate over producing insert and transpose ops until we find a fold.
1122   Value fold();
1123 
1124 private:
1125   /// Return true if the vector at position `a` is contained within the vector
1126   /// at position `b`. Under insert/extract semantics, this is the same as `a`
1127   /// is a prefix of `b`.
1128   template <typename ContainerA, typename ContainerB>
1129   bool isContainedWithin(const ContainerA &a, const ContainerB &b) {
1130     return a.size() <= b.size() &&
1131            std::equal(a.begin(), a.begin() + a.size(), b.begin());
1132   }
1133 
1134   /// Return true if the vector at position `a` intersects the vector at
1135   /// position `b`. Under insert/extract semantics, this is the same as equality
1136   /// of all entries of `a` that are >=0 with the corresponding entries of b.
1137   /// Comparison is on the common prefix (i.e. zip).
1138   template <typename ContainerA, typename ContainerB>
1139   bool intersectsWhereNonNegative(const ContainerA &a, const ContainerB &b) {
1140     for (auto it : llvm::zip(a, b)) {
1141       if (std::get<0>(it) < 0 || std::get<0>(it) < 0)
1142         continue;
1143       if (std::get<0>(it) != std::get<1>(it))
1144         return false;
1145     }
1146     return true;
1147   }
1148 
1149   /// Folding is only possible in the absence of an internal permutation in the
1150   /// result vector.
1151   bool canFold() {
1152     return (sentinels ==
1153             makeArrayRef(extractPosition).drop_front(extractedRank));
1154   }
1155 
1156   // Helper to get the next defining op of interest.
1157   void updateStateForNextIteration(Value v) {
1158     nextInsertOp = v.getDefiningOp<vector::InsertOp>();
1159     nextTransposeOp = v.getDefiningOp<vector::TransposeOp>();
1160   };
1161 
1162   // Case 1. If we hit a transpose, just compose the map and iterate.
1163   // Invariant: insert + transpose do not change rank, we can always compose.
1164   LogicalResult handleTransposeOp();
1165 
1166   // Case 2: the insert position matches extractPosition exactly, early return.
1167   LogicalResult handleInsertOpWithMatchingPos(Value &res);
1168 
1169   /// Case 3: if the insert position is a prefix of extractPosition, extract a
1170   /// portion of the source of the insert.
1171   /// Example:
1172   /// ```
1173   /// %ins = vector.insert %source, %vest[1]: vector<3x4> into vector<2x3x4x5>
1174   /// // extractPosition == [1, 2, 3]
1175   /// %ext = vector.extract %ins[1, 0]: vector<3x4x5>
1176   /// // can fold to vector.extract %source[0, 3]
1177   /// %ext = vector.extract %source[3]: vector<5x6>
1178   /// ```
1179   /// To traverse through %source, we need to set the leading dims to 0 and
1180   /// drop the extra leading dims.
1181   /// This method updates the internal state.
1182   LogicalResult handleInsertOpWithPrefixPos(Value &res);
1183 
1184   /// Try to fold in place to extract(source, extractPosition) and return the
1185   /// folded result. Return null if folding is not possible (e.g. due to an
1186   /// internal tranposition in the result).
1187   Value tryToFoldExtractOpInPlace(Value source);
1188 
1189   ExtractOp extractOp;
1190   int64_t vectorRank;
1191   int64_t extractedRank;
1192 
1193   InsertOp nextInsertOp;
1194   TransposeOp nextTransposeOp;
1195 
1196   /// Sentinel values that encode the internal permutation status of the result.
1197   /// They are set to (-1, ... , -k) at the beginning and appended to
1198   /// `extractPosition`.
1199   /// In the end, the tail of `extractPosition` must be exactly `sentinels` to
1200   /// ensure that there is no internal transposition.
1201   /// Internal transposition cannot be accounted for with a folding pattern.
1202   // TODO: We could relax the internal transposition with an extra transposition
1203   // operation in a future canonicalizer.
1204   SmallVector<int64_t> sentinels;
1205   SmallVector<int64_t> extractPosition;
1206 };
1207 } // namespace
1208 
1209 ExtractFromInsertTransposeChainState::ExtractFromInsertTransposeChainState(
1210     ExtractOp e)
1211     : extractOp(e), vectorRank(extractOp.getVectorType().getRank()),
1212       extractedRank(extractOp.getPosition().size()) {
1213   assert(vectorRank >= extractedRank && "extracted pos overflow");
1214   sentinels.reserve(vectorRank - extractedRank);
1215   for (int64_t i = 0, e = vectorRank - extractedRank; i < e; ++i)
1216     sentinels.push_back(-(i + 1));
1217   extractPosition = extractVector<int64_t>(extractOp.getPosition());
1218   llvm::append_range(extractPosition, sentinels);
1219 }
1220 
1221 // Case 1. If we hit a transpose, just compose the map and iterate.
1222 // Invariant: insert + transpose do not change rank, we can always compose.
1223 LogicalResult ExtractFromInsertTransposeChainState::handleTransposeOp() {
1224   if (!nextTransposeOp)
1225     return failure();
1226   auto permutation = extractVector<unsigned>(nextTransposeOp.getTransp());
1227   AffineMap m = inversePermutation(
1228       AffineMap::getPermutationMap(permutation, extractOp.getContext()));
1229   extractPosition = applyPermutationMap(m, makeArrayRef(extractPosition));
1230   return success();
1231 }
1232 
1233 // Case 2: the insert position matches extractPosition exactly, early return.
1234 LogicalResult
1235 ExtractFromInsertTransposeChainState::handleInsertOpWithMatchingPos(
1236     Value &res) {
1237   auto insertedPos = extractVector<int64_t>(nextInsertOp.getPosition());
1238   if (makeArrayRef(insertedPos) !=
1239       llvm::makeArrayRef(extractPosition).take_front(extractedRank))
1240     return failure();
1241   // Case 2.a. early-exit fold.
1242   res = nextInsertOp.getSource();
1243   // Case 2.b. if internal transposition is present, canFold will be false.
1244   return success();
1245 }
1246 
1247 /// Case 3: if inserted position is a prefix of extractPosition,
1248 /// extract a portion of the source of the insertion.
1249 /// This method updates the internal state.
1250 LogicalResult
1251 ExtractFromInsertTransposeChainState::handleInsertOpWithPrefixPos(Value &res) {
1252   auto insertedPos = extractVector<int64_t>(nextInsertOp.getPosition());
1253   if (!isContainedWithin(insertedPos, extractPosition))
1254     return failure();
1255   // Set leading dims to zero.
1256   std::fill_n(extractPosition.begin(), insertedPos.size(), 0);
1257   // Drop extra leading dims.
1258   extractPosition.erase(extractPosition.begin(),
1259                         extractPosition.begin() + insertedPos.size());
1260   extractedRank = extractPosition.size() - sentinels.size();
1261   // Case 3.a. early-exit fold (break and delegate to post-while path).
1262   res = nextInsertOp.getSource();
1263   // Case 3.b. if internal transposition is present, canFold will be false.
1264   return success();
1265 }
1266 
1267 /// Try to fold in place to extract(source, extractPosition) and return the
1268 /// folded result. Return null if folding is not possible (e.g. due to an
1269 /// internal tranposition in the result).
1270 Value ExtractFromInsertTransposeChainState::tryToFoldExtractOpInPlace(
1271     Value source) {
1272   // If we can't fold (either internal transposition, or nothing to fold), bail.
1273   bool nothingToFold = (source == extractOp.getVector());
1274   if (nothingToFold || !canFold())
1275     return Value();
1276   // Otherwise, fold by updating the op inplace and return its result.
1277   OpBuilder b(extractOp.getContext());
1278   extractOp->setAttr(
1279       extractOp.getPositionAttrName(),
1280       b.getI64ArrayAttr(
1281           makeArrayRef(extractPosition).take_front(extractedRank)));
1282   extractOp.getVectorMutable().assign(source);
1283   return extractOp.getResult();
1284 }
1285 
1286 /// Iterate over producing insert and transpose ops until we find a fold.
1287 Value ExtractFromInsertTransposeChainState::fold() {
1288   Value valueToExtractFrom = extractOp.getVector();
1289   updateStateForNextIteration(valueToExtractFrom);
1290   while (nextInsertOp || nextTransposeOp) {
1291     // Case 1. If we hit a transpose, just compose the map and iterate.
1292     // Invariant: insert + transpose do not change rank, we can always compose.
1293     if (succeeded(handleTransposeOp())) {
1294       valueToExtractFrom = nextTransposeOp.getVector();
1295       updateStateForNextIteration(valueToExtractFrom);
1296       continue;
1297     }
1298 
1299     Value result;
1300     // Case 2: the position match exactly.
1301     if (succeeded(handleInsertOpWithMatchingPos(result)))
1302       return result;
1303 
1304     // Case 3: if the inserted position is a prefix of extractPosition, we can
1305     // just extract a portion of the source of the insert.
1306     if (succeeded(handleInsertOpWithPrefixPos(result)))
1307       return tryToFoldExtractOpInPlace(result);
1308 
1309     // Case 4: extractPositionRef intersects insertedPosRef on non-sentinel
1310     // values. This is a more difficult case and we bail.
1311     auto insertedPos = extractVector<int64_t>(nextInsertOp.getPosition());
1312     if (isContainedWithin(extractPosition, insertedPos) ||
1313         intersectsWhereNonNegative(extractPosition, insertedPos))
1314       return Value();
1315 
1316     // Case 5: No intersection, we forward the extract to insertOp.dest().
1317     valueToExtractFrom = nextInsertOp.getDest();
1318     updateStateForNextIteration(valueToExtractFrom);
1319   }
1320   // If after all this we can fold, go for it.
1321   return tryToFoldExtractOpInPlace(valueToExtractFrom);
1322 }
1323 
1324 /// Fold extractOp with scalar result coming from BroadcastOp or SplatOp.
1325 static Value foldExtractFromBroadcast(ExtractOp extractOp) {
1326   Operation *defOp = extractOp.getVector().getDefiningOp();
1327   if (!defOp || !isa<vector::BroadcastOp, SplatOp>(defOp))
1328     return Value();
1329   Value source = defOp->getOperand(0);
1330   if (extractOp.getType() == source.getType())
1331     return source;
1332   auto getRank = [](Type type) {
1333     return type.isa<VectorType>() ? type.cast<VectorType>().getRank() : 0;
1334   };
1335   unsigned broadcastSrcRank = getRank(source.getType());
1336   unsigned extractResultRank = getRank(extractOp.getType());
1337   if (extractResultRank >= broadcastSrcRank)
1338     return Value();
1339   // Check that the dimension of the result haven't been broadcasted.
1340   auto extractVecType = extractOp.getType().dyn_cast<VectorType>();
1341   auto broadcastVecType = source.getType().dyn_cast<VectorType>();
1342   if (extractVecType && broadcastVecType &&
1343       extractVecType.getShape() !=
1344           broadcastVecType.getShape().take_back(extractResultRank))
1345     return Value();
1346   auto extractPos = extractVector<int64_t>(extractOp.getPosition());
1347   unsigned rankDiff = broadcastSrcRank - extractResultRank;
1348   extractPos.erase(extractPos.begin(),
1349                    std::next(extractPos.begin(), extractPos.size() - rankDiff));
1350   extractOp.setOperand(source);
1351   // OpBuilder is only used as a helper to build an I64ArrayAttr.
1352   OpBuilder b(extractOp.getContext());
1353   extractOp->setAttr(ExtractOp::getPositionAttrStrName(),
1354                      b.getI64ArrayAttr(extractPos));
1355   return extractOp.getResult();
1356 }
1357 
1358 // Fold extractOp with source coming from ShapeCast op.
1359 static Value foldExtractFromShapeCast(ExtractOp extractOp) {
1360   auto shapeCastOp = extractOp.getVector().getDefiningOp<vector::ShapeCastOp>();
1361   if (!shapeCastOp)
1362     return Value();
1363   // Get the nth dimension size starting from lowest dimension.
1364   auto getDimReverse = [](VectorType type, int64_t n) {
1365     return type.getShape().take_back(n + 1).front();
1366   };
1367   int64_t destinationRank =
1368       extractOp.getType().isa<VectorType>()
1369           ? extractOp.getType().cast<VectorType>().getRank()
1370           : 0;
1371   if (destinationRank > shapeCastOp.getSourceVectorType().getRank())
1372     return Value();
1373   if (destinationRank > 0) {
1374     auto destinationType = extractOp.getResult().getType().cast<VectorType>();
1375     for (int64_t i = 0; i < destinationRank; i++) {
1376       // The lowest dimension of of the destination must match the lowest
1377       // dimension of the shapecast op source.
1378       // TODO: This case could be support in a canonicalization pattern.
1379       if (getDimReverse(shapeCastOp.getSourceVectorType(), i) !=
1380           getDimReverse(destinationType, i))
1381         return Value();
1382     }
1383   }
1384   // Extract the strides associated with the extract op vector source. Then use
1385   // this to calculate a linearized position for the extract.
1386   auto extractedPos = extractVector<int64_t>(extractOp.getPosition());
1387   std::reverse(extractedPos.begin(), extractedPos.end());
1388   SmallVector<int64_t, 4> strides;
1389   int64_t stride = 1;
1390   for (int64_t i = 0, e = extractedPos.size(); i < e; i++) {
1391     strides.push_back(stride);
1392     stride *= getDimReverse(extractOp.getVectorType(), i + destinationRank);
1393   }
1394 
1395   int64_t position = linearize(extractedPos, strides);
1396   // Then extract the strides associated to the shapeCast op vector source and
1397   // delinearize the position using those strides.
1398   SmallVector<int64_t, 4> newStrides;
1399   int64_t numDimension =
1400       shapeCastOp.getSourceVectorType().getRank() - destinationRank;
1401   stride = 1;
1402   for (int64_t i = 0; i < numDimension; i++) {
1403     newStrides.push_back(stride);
1404     stride *=
1405         getDimReverse(shapeCastOp.getSourceVectorType(), i + destinationRank);
1406   }
1407   std::reverse(newStrides.begin(), newStrides.end());
1408   SmallVector<int64_t, 4> newPosition = delinearize(newStrides, position);
1409   // OpBuilder is only used as a helper to build an I64ArrayAttr.
1410   OpBuilder b(extractOp.getContext());
1411   extractOp->setAttr(ExtractOp::getPositionAttrStrName(),
1412                      b.getI64ArrayAttr(newPosition));
1413   extractOp.setOperand(shapeCastOp.getSource());
1414   return extractOp.getResult();
1415 }
1416 
1417 /// Fold an ExtractOp from ExtractStridedSliceOp.
1418 static Value foldExtractFromExtractStrided(ExtractOp extractOp) {
1419   auto extractStridedSliceOp =
1420       extractOp.getVector().getDefiningOp<vector::ExtractStridedSliceOp>();
1421   if (!extractStridedSliceOp)
1422     return Value();
1423   // Return if 'extractStridedSliceOp' has non-unit strides.
1424   if (extractStridedSliceOp.hasNonUnitStrides())
1425     return Value();
1426 
1427   // Trim offsets for dimensions fully extracted.
1428   auto sliceOffsets =
1429       extractVector<int64_t>(extractStridedSliceOp.getOffsets());
1430   while (!sliceOffsets.empty()) {
1431     size_t lastOffset = sliceOffsets.size() - 1;
1432     if (sliceOffsets.back() != 0 ||
1433         extractStridedSliceOp.getType().getDimSize(lastOffset) !=
1434             extractStridedSliceOp.getVectorType().getDimSize(lastOffset))
1435       break;
1436     sliceOffsets.pop_back();
1437   }
1438   unsigned destinationRank = 0;
1439   if (auto vecType = extractOp.getType().dyn_cast<VectorType>())
1440     destinationRank = vecType.getRank();
1441   // The dimensions of the result need to be untouched by the
1442   // extractStridedSlice op.
1443   if (destinationRank >
1444       extractStridedSliceOp.getVectorType().getRank() - sliceOffsets.size())
1445     return Value();
1446   auto extractedPos = extractVector<int64_t>(extractOp.getPosition());
1447   assert(extractedPos.size() >= sliceOffsets.size());
1448   for (size_t i = 0, e = sliceOffsets.size(); i < e; i++)
1449     extractedPos[i] = extractedPos[i] + sliceOffsets[i];
1450   extractOp.getVectorMutable().assign(extractStridedSliceOp.getVector());
1451   // OpBuilder is only used as a helper to build an I64ArrayAttr.
1452   OpBuilder b(extractOp.getContext());
1453   extractOp->setAttr(ExtractOp::getPositionAttrStrName(),
1454                      b.getI64ArrayAttr(extractedPos));
1455   return extractOp.getResult();
1456 }
1457 
1458 /// Fold extract_op fed from a chain of insertStridedSlice ops.
1459 static Value foldExtractStridedOpFromInsertChain(ExtractOp op) {
1460   int64_t destinationRank = op.getType().isa<VectorType>()
1461                                 ? op.getType().cast<VectorType>().getRank()
1462                                 : 0;
1463   auto insertOp = op.getVector().getDefiningOp<InsertStridedSliceOp>();
1464   while (insertOp) {
1465     int64_t insertRankDiff = insertOp.getDestVectorType().getRank() -
1466                              insertOp.getSourceVectorType().getRank();
1467     if (destinationRank > insertOp.getSourceVectorType().getRank())
1468       return Value();
1469     auto insertOffsets = extractVector<int64_t>(insertOp.getOffsets());
1470     auto extractOffsets = extractVector<int64_t>(op.getPosition());
1471 
1472     if (llvm::any_of(insertOp.getStrides(), [](Attribute attr) {
1473           return attr.cast<IntegerAttr>().getInt() != 1;
1474         }))
1475       return Value();
1476     bool disjoint = false;
1477     SmallVector<int64_t, 4> offsetDiffs;
1478     for (unsigned dim = 0, e = extractOffsets.size(); dim < e; ++dim) {
1479       int64_t start = insertOffsets[dim];
1480       int64_t size =
1481           (dim < insertRankDiff)
1482               ? 1
1483               : insertOp.getSourceVectorType().getDimSize(dim - insertRankDiff);
1484       int64_t end = start + size;
1485       int64_t offset = extractOffsets[dim];
1486       // Check if the start of the extract offset is in the interval inserted.
1487       if (start <= offset && offset < end) {
1488         if (dim >= insertRankDiff)
1489           offsetDiffs.push_back(offset - start);
1490         continue;
1491       }
1492       disjoint = true;
1493       break;
1494     }
1495     // The extract element chunk overlap with the vector inserted.
1496     if (!disjoint) {
1497       // If any of the inner dimensions are only partially inserted we have a
1498       // partial overlap.
1499       int64_t srcRankDiff =
1500           insertOp.getSourceVectorType().getRank() - destinationRank;
1501       for (int64_t i = 0; i < destinationRank; i++) {
1502         if (insertOp.getSourceVectorType().getDimSize(i + srcRankDiff) !=
1503             insertOp.getDestVectorType().getDimSize(i + srcRankDiff +
1504                                                     insertRankDiff))
1505           return Value();
1506       }
1507       op.getVectorMutable().assign(insertOp.getSource());
1508       // OpBuilder is only used as a helper to build an I64ArrayAttr.
1509       OpBuilder b(op.getContext());
1510       op->setAttr(ExtractOp::getPositionAttrStrName(),
1511                   b.getI64ArrayAttr(offsetDiffs));
1512       return op.getResult();
1513     }
1514     // If the chunk extracted is disjoint from the chunk inserted, keep
1515     // looking in the insert chain.
1516     insertOp = insertOp.getDest().getDefiningOp<InsertStridedSliceOp>();
1517   }
1518   return Value();
1519 }
1520 
1521 OpFoldResult ExtractOp::fold(ArrayRef<Attribute>) {
1522   if (getPosition().empty())
1523     return getVector();
1524   if (succeeded(foldExtractOpFromExtractChain(*this)))
1525     return getResult();
1526   if (auto res = ExtractFromInsertTransposeChainState(*this).fold())
1527     return res;
1528   if (auto res = foldExtractFromBroadcast(*this))
1529     return res;
1530   if (auto res = foldExtractFromShapeCast(*this))
1531     return res;
1532   if (auto val = foldExtractFromExtractStrided(*this))
1533     return val;
1534   if (auto val = foldExtractStridedOpFromInsertChain(*this))
1535     return val;
1536   return OpFoldResult();
1537 }
1538 
1539 namespace {
1540 
1541 // Pattern to rewrite a ExtractOp(Broadcast) -> Broadcast.
1542 class ExtractOpFromBroadcast final : public OpRewritePattern<ExtractOp> {
1543 public:
1544   using OpRewritePattern<ExtractOp>::OpRewritePattern;
1545 
1546   LogicalResult matchAndRewrite(ExtractOp extractOp,
1547                                 PatternRewriter &rewriter) const override {
1548     Operation *defOp = extractOp.getVector().getDefiningOp();
1549     if (!defOp || !isa<vector::BroadcastOp, SplatOp>(defOp))
1550       return failure();
1551 
1552     Value source = defOp->getOperand(0);
1553     if (extractOp.getType() == source.getType())
1554       return failure();
1555     auto getRank = [](Type type) {
1556       return type.isa<VectorType>() ? type.cast<VectorType>().getRank() : 0;
1557     };
1558     unsigned broadcastSrcRank = getRank(source.getType());
1559     unsigned extractResultRank = getRank(extractOp.getType());
1560     // We only consider the case where the rank of the source is less than or
1561     // equal to the rank of the extract dst. The other cases are handled in the
1562     // folding patterns.
1563     if (extractResultRank < broadcastSrcRank)
1564       return failure();
1565     rewriter.replaceOpWithNewOp<vector::BroadcastOp>(
1566         extractOp, extractOp.getType(), source);
1567     return success();
1568   }
1569 };
1570 
1571 // Pattern to rewrite a ExtractOp(splat ConstantOp) -> ConstantOp.
1572 class ExtractOpConstantFolder final : public OpRewritePattern<ExtractOp> {
1573 public:
1574   using OpRewritePattern<ExtractOp>::OpRewritePattern;
1575 
1576   LogicalResult matchAndRewrite(ExtractOp extractOp,
1577                                 PatternRewriter &rewriter) const override {
1578     // Return if 'extractStridedSliceOp' operand is not defined by a
1579     // ConstantOp.
1580     auto constantOp = extractOp.getVector().getDefiningOp<arith::ConstantOp>();
1581     if (!constantOp)
1582       return failure();
1583     auto dense = constantOp.getValue().dyn_cast<SplatElementsAttr>();
1584     if (!dense)
1585       return failure();
1586     Attribute newAttr = dense.getSplatValue<Attribute>();
1587     if (auto vecDstType = extractOp.getType().dyn_cast<VectorType>())
1588       newAttr = DenseElementsAttr::get(vecDstType, newAttr);
1589     rewriter.replaceOpWithNewOp<arith::ConstantOp>(extractOp, newAttr);
1590     return success();
1591   }
1592 };
1593 
1594 } // namespace
1595 
1596 void ExtractOp::getCanonicalizationPatterns(RewritePatternSet &results,
1597                                             MLIRContext *context) {
1598   results.add<ExtractOpConstantFolder, ExtractOpFromBroadcast>(context);
1599 }
1600 
1601 static void populateFromInt64AttrArray(ArrayAttr arrayAttr,
1602                                        SmallVectorImpl<int64_t> &results) {
1603   for (auto attr : arrayAttr)
1604     results.push_back(attr.cast<IntegerAttr>().getInt());
1605 }
1606 
1607 //===----------------------------------------------------------------------===//
1608 // ExtractMapOp
1609 //===----------------------------------------------------------------------===//
1610 
1611 void ExtractMapOp::build(OpBuilder &builder, OperationState &result,
1612                          Value vector, ValueRange ids,
1613                          ArrayRef<int64_t> multiplicity,
1614                          AffineMap permutationMap) {
1615   assert(ids.size() == multiplicity.size() &&
1616          ids.size() == permutationMap.getNumResults());
1617   assert(permutationMap.isProjectedPermutation());
1618   VectorType type = vector.getType().cast<VectorType>();
1619   SmallVector<int64_t, 4> newShape(type.getShape().begin(),
1620                                    type.getShape().end());
1621   for (unsigned i = 0, e = permutationMap.getNumResults(); i < e; i++) {
1622     AffineExpr expr = permutationMap.getResult(i);
1623     auto dim = expr.cast<AffineDimExpr>();
1624     newShape[dim.getPosition()] = newShape[dim.getPosition()] / multiplicity[i];
1625   }
1626   VectorType resultType = VectorType::get(newShape, type.getElementType());
1627   ExtractMapOp::build(builder, result, resultType, vector, ids);
1628 }
1629 
1630 LogicalResult ExtractMapOp::verify() {
1631   if (getSourceVectorType().getRank() != getResultType().getRank())
1632     return emitOpError("expected source and destination vectors of same rank");
1633   unsigned numId = 0;
1634   for (unsigned i = 0, e = getSourceVectorType().getRank(); i < e; ++i) {
1635     if (getSourceVectorType().getDimSize(i) % getResultType().getDimSize(i) !=
1636         0)
1637       return emitOpError("source vector dimensions must be a multiple of "
1638                          "destination vector dimensions");
1639     if (getSourceVectorType().getDimSize(i) != getResultType().getDimSize(i))
1640       numId++;
1641   }
1642   if (numId != getIds().size())
1643     return emitOpError("expected number of ids must match the number of "
1644                        "dimensions distributed");
1645   return success();
1646 }
1647 
1648 OpFoldResult ExtractMapOp::fold(ArrayRef<Attribute> operands) {
1649   auto insert = getVector().getDefiningOp<vector::InsertMapOp>();
1650   if (insert == nullptr || getType() != insert.getVector().getType() ||
1651       getIds() != insert.getIds())
1652     return {};
1653   return insert.getVector();
1654 }
1655 
1656 void ExtractMapOp::getMultiplicity(SmallVectorImpl<int64_t> &multiplicity) {
1657   assert(multiplicity.empty());
1658   for (unsigned i = 0, e = getSourceVectorType().getRank(); i < e; i++) {
1659     if (getSourceVectorType().getDimSize(i) != getResultType().getDimSize(i))
1660       multiplicity.push_back(getSourceVectorType().getDimSize(i) /
1661                              getResultType().getDimSize(i));
1662   }
1663 }
1664 
1665 template <typename MapOp>
1666 AffineMap calculateImplicitMap(MapOp op) {
1667   SmallVector<AffineExpr, 4> perm;
1668   // Check which dimension have a multiplicity greater than 1 and associated
1669   // them to the IDs in order.
1670   for (unsigned i = 0, e = op.getSourceVectorType().getRank(); i < e; i++) {
1671     if (op.getSourceVectorType().getDimSize(i) !=
1672         op.getResultType().getDimSize(i))
1673       perm.push_back(getAffineDimExpr(i, op.getContext()));
1674   }
1675   auto map = AffineMap::get(op.getSourceVectorType().getRank(), 0, perm,
1676                             op.getContext());
1677   return map;
1678 }
1679 
1680 AffineMap ExtractMapOp::map() { return calculateImplicitMap(*this); }
1681 
1682 //===----------------------------------------------------------------------===//
1683 // FmaOp
1684 //===----------------------------------------------------------------------===//
1685 
1686 Optional<SmallVector<int64_t, 4>> FMAOp::getShapeForUnroll() {
1687   return llvm::to_vector<4>(getVectorType().getShape());
1688 }
1689 
1690 //===----------------------------------------------------------------------===//
1691 // BroadcastOp
1692 //===----------------------------------------------------------------------===//
1693 
1694 BroadcastableToResult
1695 mlir::vector::isBroadcastableTo(Type srcType, VectorType dstVectorType,
1696                                 std::pair<int, int> *mismatchingDims) {
1697   // Broadcast scalar to vector of the same element type.
1698   if (srcType.isIntOrIndexOrFloat() && dstVectorType &&
1699       getElementTypeOrSelf(srcType) == getElementTypeOrSelf(dstVectorType))
1700     return BroadcastableToResult::Success;
1701   // From now on, only vectors broadcast.
1702   VectorType srcVectorType = srcType.dyn_cast<VectorType>();
1703   if (!srcVectorType)
1704     return BroadcastableToResult::SourceTypeNotAVector;
1705 
1706   int64_t srcRank = srcVectorType.getRank();
1707   int64_t dstRank = dstVectorType.getRank();
1708   if (srcRank > dstRank)
1709     return BroadcastableToResult::SourceRankHigher;
1710   // Source has an exact match or singleton value for all trailing dimensions
1711   // (all leading dimensions are simply duplicated).
1712   int64_t lead = dstRank - srcRank;
1713   for (int64_t r = 0; r < srcRank; ++r) {
1714     int64_t srcDim = srcVectorType.getDimSize(r);
1715     int64_t dstDim = dstVectorType.getDimSize(lead + r);
1716     if (srcDim != 1 && srcDim != dstDim) {
1717       if (mismatchingDims) {
1718         mismatchingDims->first = srcDim;
1719         mismatchingDims->second = dstDim;
1720       }
1721       return BroadcastableToResult::DimensionMismatch;
1722     }
1723   }
1724 
1725   return BroadcastableToResult::Success;
1726 }
1727 
1728 LogicalResult BroadcastOp::verify() {
1729   std::pair<int, int> mismatchingDims;
1730   BroadcastableToResult res =
1731       isBroadcastableTo(getSourceType(), getVectorType(), &mismatchingDims);
1732   if (res == BroadcastableToResult::Success)
1733     return success();
1734   if (res == BroadcastableToResult::SourceRankHigher)
1735     return emitOpError("source rank higher than destination rank");
1736   if (res == BroadcastableToResult::DimensionMismatch)
1737     return emitOpError("dimension mismatch (")
1738            << mismatchingDims.first << " vs. " << mismatchingDims.second << ")";
1739   if (res == BroadcastableToResult::SourceTypeNotAVector)
1740     return emitOpError("source type is not a vector");
1741   llvm_unreachable("unexpected vector.broadcast op error");
1742 }
1743 
1744 OpFoldResult BroadcastOp::fold(ArrayRef<Attribute> operands) {
1745   if (getSourceType() == getVectorType())
1746     return getSource();
1747   if (!operands[0])
1748     return {};
1749   auto vectorType = getVectorType();
1750   if (operands[0].getType().isIntOrIndexOrFloat())
1751     return DenseElementsAttr::get(vectorType, operands[0]);
1752   if (auto attr = operands[0].dyn_cast<SplatElementsAttr>())
1753     return DenseElementsAttr::get(vectorType, attr.getSplatValue<Attribute>());
1754   return {};
1755 }
1756 
1757 namespace {
1758 
1759 // Fold broadcast1(broadcast2(x)) into broadcast1(x).
1760 struct BroadcastFolder : public OpRewritePattern<BroadcastOp> {
1761   using OpRewritePattern<BroadcastOp>::OpRewritePattern;
1762 
1763   LogicalResult matchAndRewrite(BroadcastOp broadcastOp,
1764                                 PatternRewriter &rewriter) const override {
1765     auto srcBroadcast = broadcastOp.getSource().getDefiningOp<BroadcastOp>();
1766     if (!srcBroadcast)
1767       return failure();
1768     rewriter.replaceOpWithNewOp<BroadcastOp>(
1769         broadcastOp, broadcastOp.getVectorType(), srcBroadcast.getSource());
1770     return success();
1771   }
1772 };
1773 } // namespace
1774 
1775 void BroadcastOp::getCanonicalizationPatterns(RewritePatternSet &results,
1776                                               MLIRContext *context) {
1777   // BroadcastToShapeCast is not a default canonicalization, it is opt-in by
1778   // calling `populateCastAwayVectorLeadingOneDimPatterns`
1779   results.add<BroadcastFolder>(context);
1780 }
1781 
1782 //===----------------------------------------------------------------------===//
1783 // ShuffleOp
1784 //===----------------------------------------------------------------------===//
1785 
1786 void ShuffleOp::build(OpBuilder &builder, OperationState &result, Value v1,
1787                       Value v2, ArrayRef<int64_t> mask) {
1788   build(builder, result, v1, v2, getVectorSubscriptAttr(builder, mask));
1789 }
1790 
1791 LogicalResult ShuffleOp::verify() {
1792   VectorType resultType = getVectorType();
1793   VectorType v1Type = getV1VectorType();
1794   VectorType v2Type = getV2VectorType();
1795   // Verify ranks.
1796   int64_t resRank = resultType.getRank();
1797   int64_t v1Rank = v1Type.getRank();
1798   int64_t v2Rank = v2Type.getRank();
1799   if (resRank != v1Rank || v1Rank != v2Rank)
1800     return emitOpError("rank mismatch");
1801   // Verify all but leading dimension sizes.
1802   for (int64_t r = 1; r < v1Rank; ++r) {
1803     int64_t resDim = resultType.getDimSize(r);
1804     int64_t v1Dim = v1Type.getDimSize(r);
1805     int64_t v2Dim = v2Type.getDimSize(r);
1806     if (resDim != v1Dim || v1Dim != v2Dim)
1807       return emitOpError("dimension mismatch");
1808   }
1809   // Verify mask length.
1810   auto maskAttr = getMask().getValue();
1811   int64_t maskLength = maskAttr.size();
1812   if (maskLength <= 0)
1813     return emitOpError("invalid mask length");
1814   if (maskLength != resultType.getDimSize(0))
1815     return emitOpError("mask length mismatch");
1816   // Verify all indices.
1817   int64_t indexSize = v1Type.getDimSize(0) + v2Type.getDimSize(0);
1818   for (const auto &en : llvm::enumerate(maskAttr)) {
1819     auto attr = en.value().dyn_cast<IntegerAttr>();
1820     if (!attr || attr.getInt() < 0 || attr.getInt() >= indexSize)
1821       return emitOpError("mask index #") << (en.index() + 1) << " out of range";
1822   }
1823   return success();
1824 }
1825 
1826 LogicalResult
1827 ShuffleOp::inferReturnTypes(MLIRContext *, Optional<Location>,
1828                             ValueRange operands, DictionaryAttr attributes,
1829                             RegionRange,
1830                             SmallVectorImpl<Type> &inferredReturnTypes) {
1831   ShuffleOp::Adaptor op(operands, attributes);
1832   auto v1Type = op.getV1().getType().cast<VectorType>();
1833   // Construct resulting type: leading dimension matches mask length,
1834   // all trailing dimensions match the operands.
1835   SmallVector<int64_t, 4> shape;
1836   shape.reserve(v1Type.getRank());
1837   shape.push_back(std::max<size_t>(1, op.getMask().size()));
1838   llvm::append_range(shape, v1Type.getShape().drop_front());
1839   inferredReturnTypes.push_back(
1840       VectorType::get(shape, v1Type.getElementType()));
1841   return success();
1842 }
1843 
1844 static bool isStepIndexArray(ArrayAttr idxArr, uint64_t begin, size_t width) {
1845   uint64_t expected = begin;
1846   return idxArr.size() == width &&
1847          llvm::all_of(idxArr.getAsValueRange<IntegerAttr>(),
1848                       [&expected](auto attr) {
1849                         return attr.getZExtValue() == expected++;
1850                       });
1851 }
1852 
1853 OpFoldResult vector::ShuffleOp::fold(ArrayRef<Attribute> operands) {
1854   // fold shuffle V1, V2, [0, 1, 2, 3] : <4xi32>, <2xi32> -> V1
1855   if (!getV1VectorType().isScalable() &&
1856       isStepIndexArray(getMask(), 0, getV1VectorType().getDimSize(0)))
1857     return getV1();
1858   // fold shuffle V1, V2, [4, 5] : <4xi32>, <2xi32> -> V2
1859   if (!getV1VectorType().isScalable() && !getV2VectorType().isScalable() &&
1860       isStepIndexArray(getMask(), getV1VectorType().getDimSize(0),
1861                        getV2VectorType().getDimSize(0)))
1862     return getV2();
1863 
1864   Attribute lhs = operands.front(), rhs = operands.back();
1865   if (!lhs || !rhs)
1866     return {};
1867 
1868   auto lhsType = lhs.getType().cast<VectorType>();
1869   // Only support 1-D for now to avoid complicated n-D DenseElementsAttr
1870   // manipulation.
1871   if (lhsType.getRank() != 1)
1872     return {};
1873   int64_t lhsSize = lhsType.getDimSize(0);
1874 
1875   SmallVector<Attribute> results;
1876   auto lhsElements = lhs.cast<DenseElementsAttr>().getValues<Attribute>();
1877   auto rhsElements = rhs.cast<DenseElementsAttr>().getValues<Attribute>();
1878   for (const auto &index : this->getMask().getAsValueRange<IntegerAttr>()) {
1879     int64_t i = index.getZExtValue();
1880     if (i >= lhsSize) {
1881       results.push_back(rhsElements[i - lhsSize]);
1882     } else {
1883       results.push_back(lhsElements[i]);
1884     }
1885   }
1886 
1887   return DenseElementsAttr::get(getVectorType(), results);
1888 }
1889 
1890 namespace {
1891 
1892 /// Pattern to rewrite a ShuffleOp(SplatOp, SplatOp) to SplatOp.
1893 class ShuffleSplat final : public OpRewritePattern<ShuffleOp> {
1894 public:
1895   using OpRewritePattern<ShuffleOp>::OpRewritePattern;
1896 
1897   LogicalResult matchAndRewrite(ShuffleOp op,
1898                                 PatternRewriter &rewriter) const override {
1899     auto v1Splat = op.getV1().getDefiningOp<SplatOp>();
1900     auto v2Splat = op.getV2().getDefiningOp<SplatOp>();
1901 
1902     if (!v1Splat || !v2Splat)
1903       return failure();
1904 
1905     if (v1Splat.getInput() != v2Splat.getInput())
1906       return failure();
1907 
1908     rewriter.replaceOpWithNewOp<SplatOp>(op, op.getType(), v1Splat.getInput());
1909     return success();
1910   }
1911 };
1912 
1913 } // namespace
1914 
1915 void ShuffleOp::getCanonicalizationPatterns(RewritePatternSet &results,
1916                                             MLIRContext *context) {
1917   results.add<ShuffleSplat>(context);
1918 }
1919 
1920 //===----------------------------------------------------------------------===//
1921 // InsertElementOp
1922 //===----------------------------------------------------------------------===//
1923 
1924 void InsertElementOp::build(OpBuilder &builder, OperationState &result,
1925                             Value source, Value dest) {
1926   build(builder, result, source, dest, {});
1927 }
1928 
1929 LogicalResult InsertElementOp::verify() {
1930   auto dstVectorType = getDestVectorType();
1931   if (dstVectorType.getRank() == 0) {
1932     if (getPosition())
1933       return emitOpError("expected position to be empty with 0-D vector");
1934     return success();
1935   }
1936   if (dstVectorType.getRank() != 1)
1937     return emitOpError("unexpected >1 vector rank");
1938   if (!getPosition())
1939     return emitOpError("expected position for 1-D vector");
1940   return success();
1941 }
1942 
1943 OpFoldResult vector::InsertElementOp::fold(ArrayRef<Attribute> operands) {
1944   // Skip the 0-D vector here.
1945   if (operands.size() < 3)
1946     return {};
1947 
1948   Attribute src = operands[0];
1949   Attribute dst = operands[1];
1950   Attribute pos = operands[2];
1951   if (!src || !dst || !pos)
1952     return {};
1953 
1954   auto dstElements = dst.cast<DenseElementsAttr>().getValues<Attribute>();
1955 
1956   SmallVector<Attribute> results(dstElements);
1957 
1958   auto attr = pos.dyn_cast<IntegerAttr>();
1959   uint64_t posIdx = attr.getInt();
1960 
1961   results[posIdx] = src;
1962 
1963   return DenseElementsAttr::get(getDestVectorType(), results);
1964 }
1965 
1966 //===----------------------------------------------------------------------===//
1967 // InsertOp
1968 //===----------------------------------------------------------------------===//
1969 
1970 void InsertOp::build(OpBuilder &builder, OperationState &result, Value source,
1971                      Value dest, ArrayRef<int64_t> position) {
1972   result.addOperands({source, dest});
1973   auto positionAttr = getVectorSubscriptAttr(builder, position);
1974   result.addTypes(dest.getType());
1975   result.addAttribute(getPositionAttrStrName(), positionAttr);
1976 }
1977 
1978 // Convenience builder which assumes the values are constant indices.
1979 void InsertOp::build(OpBuilder &builder, OperationState &result, Value source,
1980                      Value dest, ValueRange position) {
1981   SmallVector<int64_t, 4> positionConstants =
1982       llvm::to_vector<4>(llvm::map_range(position, [](Value pos) {
1983         return pos.getDefiningOp<arith::ConstantIndexOp>().value();
1984       }));
1985   build(builder, result, source, dest, positionConstants);
1986 }
1987 
1988 LogicalResult InsertOp::verify() {
1989   auto positionAttr = getPosition().getValue();
1990   auto destVectorType = getDestVectorType();
1991   if (positionAttr.size() > static_cast<unsigned>(destVectorType.getRank()))
1992     return emitOpError(
1993         "expected position attribute of rank smaller than dest vector rank");
1994   auto srcVectorType = getSourceType().dyn_cast<VectorType>();
1995   if (srcVectorType &&
1996       (static_cast<unsigned>(srcVectorType.getRank()) + positionAttr.size() !=
1997        static_cast<unsigned>(destVectorType.getRank())))
1998     return emitOpError("expected position attribute rank + source rank to "
1999                        "match dest vector rank");
2000   if (!srcVectorType &&
2001       (positionAttr.size() != static_cast<unsigned>(destVectorType.getRank())))
2002     return emitOpError(
2003         "expected position attribute rank to match the dest vector rank");
2004   for (const auto &en : llvm::enumerate(positionAttr)) {
2005     auto attr = en.value().dyn_cast<IntegerAttr>();
2006     if (!attr || attr.getInt() < 0 ||
2007         attr.getInt() >= destVectorType.getDimSize(en.index()))
2008       return emitOpError("expected position attribute #")
2009              << (en.index() + 1)
2010              << " to be a non-negative integer smaller than the corresponding "
2011                 "dest vector dimension";
2012   }
2013   return success();
2014 }
2015 
2016 namespace {
2017 
2018 // If insertOp is only inserting unit dimensions it can be transformed to a
2019 // broadcast.
2020 class InsertToBroadcast final : public OpRewritePattern<InsertOp> {
2021 public:
2022   using OpRewritePattern<InsertOp>::OpRewritePattern;
2023 
2024   LogicalResult matchAndRewrite(InsertOp insertOp,
2025                                 PatternRewriter &rewriter) const override {
2026     auto srcVecType = insertOp.getSourceType().dyn_cast<VectorType>();
2027     if (!srcVecType || insertOp.getDestVectorType().getNumElements() !=
2028                            srcVecType.getNumElements())
2029       return failure();
2030     rewriter.replaceOpWithNewOp<BroadcastOp>(
2031         insertOp, insertOp.getDestVectorType(), insertOp.getSource());
2032     return success();
2033   }
2034 };
2035 
2036 /// Pattern to rewrite a InsertOp(SplatOp, SplatOp) to SplatOp.
2037 class InsertSplatToSplat final : public OpRewritePattern<InsertOp> {
2038 public:
2039   using OpRewritePattern<InsertOp>::OpRewritePattern;
2040 
2041   LogicalResult matchAndRewrite(InsertOp op,
2042                                 PatternRewriter &rewriter) const override {
2043     auto srcSplat = op.getSource().getDefiningOp<SplatOp>();
2044     auto dstSplat = op.getDest().getDefiningOp<SplatOp>();
2045 
2046     if (!srcSplat || !dstSplat)
2047       return failure();
2048 
2049     if (srcSplat.getInput() != dstSplat.getInput())
2050       return failure();
2051 
2052     rewriter.replaceOpWithNewOp<SplatOp>(op, op.getType(), srcSplat.getInput());
2053     return success();
2054   }
2055 };
2056 
2057 } // namespace
2058 
2059 void InsertOp::getCanonicalizationPatterns(RewritePatternSet &results,
2060                                            MLIRContext *context) {
2061   results.add<InsertToBroadcast, BroadcastFolder, InsertSplatToSplat>(context);
2062 }
2063 
2064 // Eliminates insert operations that produce values identical to their source
2065 // value. This happens when the source and destination vectors have identical
2066 // sizes.
2067 OpFoldResult vector::InsertOp::fold(ArrayRef<Attribute> operands) {
2068   if (getPosition().empty())
2069     return getSource();
2070   return {};
2071 }
2072 
2073 //===----------------------------------------------------------------------===//
2074 // InsertMapOp
2075 //===----------------------------------------------------------------------===//
2076 
2077 LogicalResult InsertMapOp::verify() {
2078   if (getSourceVectorType().getRank() != getResultType().getRank())
2079     return emitOpError("expected source and destination vectors of same rank");
2080   unsigned numId = 0;
2081   for (unsigned i = 0, e = getResultType().getRank(); i < e; i++) {
2082     if (getResultType().getDimSize(i) % getSourceVectorType().getDimSize(i) !=
2083         0)
2084       return emitOpError(
2085           "destination vector size must be a multiple of source vector size");
2086     if (getResultType().getDimSize(i) != getSourceVectorType().getDimSize(i))
2087       numId++;
2088   }
2089   if (numId != getIds().size())
2090     return emitOpError("expected number of ids must match the number of "
2091                        "dimensions distributed");
2092   return success();
2093 }
2094 
2095 AffineMap InsertMapOp::map() { return calculateImplicitMap(*this); }
2096 
2097 //===----------------------------------------------------------------------===//
2098 // InsertStridedSliceOp
2099 //===----------------------------------------------------------------------===//
2100 
2101 void InsertStridedSliceOp::build(OpBuilder &builder, OperationState &result,
2102                                  Value source, Value dest,
2103                                  ArrayRef<int64_t> offsets,
2104                                  ArrayRef<int64_t> strides) {
2105   result.addOperands({source, dest});
2106   auto offsetsAttr = getVectorSubscriptAttr(builder, offsets);
2107   auto stridesAttr = getVectorSubscriptAttr(builder, strides);
2108   result.addTypes(dest.getType());
2109   result.addAttribute(getOffsetsAttrStrName(), offsetsAttr);
2110   result.addAttribute(getStridesAttrStrName(), stridesAttr);
2111 }
2112 
2113 // TODO: Should be moved to Tablegen Confined attributes.
2114 template <typename OpType>
2115 static LogicalResult isIntegerArrayAttrSmallerThanShape(OpType op,
2116                                                         ArrayAttr arrayAttr,
2117                                                         ArrayRef<int64_t> shape,
2118                                                         StringRef attrName) {
2119   if (arrayAttr.size() > shape.size())
2120     return op.emitOpError("expected ")
2121            << attrName << " attribute of rank smaller than vector rank";
2122   return success();
2123 }
2124 
2125 // Returns true if all integers in `arrayAttr` are in the half-open [min, max}
2126 // interval. If `halfOpen` is true then the admissible interval is [min, max).
2127 // Otherwise, the admissible interval is [min, max].
2128 template <typename OpType>
2129 static LogicalResult
2130 isIntegerArrayAttrConfinedToRange(OpType op, ArrayAttr arrayAttr, int64_t min,
2131                                   int64_t max, StringRef attrName,
2132                                   bool halfOpen = true) {
2133   for (auto attr : arrayAttr) {
2134     auto val = attr.cast<IntegerAttr>().getInt();
2135     auto upper = max;
2136     if (!halfOpen)
2137       upper += 1;
2138     if (val < min || val >= upper)
2139       return op.emitOpError("expected ") << attrName << " to be confined to ["
2140                                          << min << ", " << upper << ")";
2141   }
2142   return success();
2143 }
2144 
2145 // Returns true if all integers in `arrayAttr` are in the half-open [min, max}
2146 // interval. If `halfOpen` is true then the admissible interval is [min, max).
2147 // Otherwise, the admissible interval is [min, max].
2148 template <typename OpType>
2149 static LogicalResult
2150 isIntegerArrayAttrConfinedToShape(OpType op, ArrayAttr arrayAttr,
2151                                   ArrayRef<int64_t> shape, StringRef attrName,
2152                                   bool halfOpen = true, int64_t min = 0) {
2153   assert(arrayAttr.size() <= shape.size());
2154   unsigned index = 0;
2155   for (auto it : llvm::zip(arrayAttr, shape)) {
2156     auto val = std::get<0>(it).cast<IntegerAttr>().getInt();
2157     auto max = std::get<1>(it);
2158     if (!halfOpen)
2159       max += 1;
2160     if (val < min || val >= max)
2161       return op.emitOpError("expected ")
2162              << attrName << " dimension " << index << " to be confined to ["
2163              << min << ", " << max << ")";
2164     ++index;
2165   }
2166   return success();
2167 }
2168 
2169 // Returns true if all integers in `arrayAttr` are in the interval [min, max}.
2170 // interval. If `halfOpen` is true then the admissible interval is [min, max).
2171 // Otherwise, the admissible interval is [min, max].
2172 template <typename OpType>
2173 static LogicalResult isSumOfIntegerArrayAttrConfinedToShape(
2174     OpType op, ArrayAttr arrayAttr1, ArrayAttr arrayAttr2,
2175     ArrayRef<int64_t> shape, StringRef attrName1, StringRef attrName2,
2176     bool halfOpen = true, int64_t min = 1) {
2177   assert(arrayAttr1.size() <= shape.size());
2178   assert(arrayAttr2.size() <= shape.size());
2179   unsigned index = 0;
2180   for (auto it : llvm::zip(arrayAttr1, arrayAttr2, shape)) {
2181     auto val1 = std::get<0>(it).cast<IntegerAttr>().getInt();
2182     auto val2 = std::get<1>(it).cast<IntegerAttr>().getInt();
2183     auto max = std::get<2>(it);
2184     if (!halfOpen)
2185       max += 1;
2186     if (val1 + val2 < 0 || val1 + val2 >= max)
2187       return op.emitOpError("expected sum(")
2188              << attrName1 << ", " << attrName2 << ") dimension " << index
2189              << " to be confined to [" << min << ", " << max << ")";
2190     ++index;
2191   }
2192   return success();
2193 }
2194 
2195 static ArrayAttr makeI64ArrayAttr(ArrayRef<int64_t> values,
2196                                   MLIRContext *context) {
2197   auto attrs = llvm::map_range(values, [context](int64_t v) -> Attribute {
2198     return IntegerAttr::get(IntegerType::get(context, 64), APInt(64, v));
2199   });
2200   return ArrayAttr::get(context, llvm::to_vector<8>(attrs));
2201 }
2202 
2203 LogicalResult InsertStridedSliceOp::verify() {
2204   auto sourceVectorType = getSourceVectorType();
2205   auto destVectorType = getDestVectorType();
2206   auto offsets = getOffsetsAttr();
2207   auto strides = getStridesAttr();
2208   if (offsets.size() != static_cast<unsigned>(destVectorType.getRank()))
2209     return emitOpError(
2210         "expected offsets of same size as destination vector rank");
2211   if (strides.size() != static_cast<unsigned>(sourceVectorType.getRank()))
2212     return emitOpError("expected strides of same size as source vector rank");
2213   if (sourceVectorType.getRank() > destVectorType.getRank())
2214     return emitOpError(
2215         "expected source rank to be smaller than destination rank");
2216 
2217   auto sourceShape = sourceVectorType.getShape();
2218   auto destShape = destVectorType.getShape();
2219   SmallVector<int64_t, 4> sourceShapeAsDestShape(
2220       destShape.size() - sourceShape.size(), 0);
2221   sourceShapeAsDestShape.append(sourceShape.begin(), sourceShape.end());
2222   auto offName = InsertStridedSliceOp::getOffsetsAttrName();
2223   auto stridesName = InsertStridedSliceOp::getStridesAttrName();
2224   if (failed(isIntegerArrayAttrConfinedToShape(*this, offsets, destShape,
2225                                                offName)) ||
2226       failed(isIntegerArrayAttrConfinedToRange(*this, strides, 1, 1,
2227                                                stridesName,
2228                                                /*halfOpen=*/false)) ||
2229       failed(isSumOfIntegerArrayAttrConfinedToShape(
2230           *this, offsets,
2231           makeI64ArrayAttr(sourceShapeAsDestShape, getContext()), destShape,
2232           offName, "source vector shape",
2233           /*halfOpen=*/false, /*min=*/1)))
2234     return failure();
2235 
2236   return success();
2237 }
2238 
2239 namespace {
2240 /// Pattern to rewrite an InsertStridedSliceOp(SplatOp(X):src_type,
2241 /// SplatOp(X):dst_type) to SplatOp(X):dst_type.
2242 class FoldInsertStridedSliceSplat final
2243     : public OpRewritePattern<InsertStridedSliceOp> {
2244 public:
2245   using OpRewritePattern<InsertStridedSliceOp>::OpRewritePattern;
2246 
2247   LogicalResult matchAndRewrite(InsertStridedSliceOp insertStridedSliceOp,
2248                                 PatternRewriter &rewriter) const override {
2249     auto srcSplatOp =
2250         insertStridedSliceOp.getSource().getDefiningOp<vector::SplatOp>();
2251     auto destSplatOp =
2252         insertStridedSliceOp.getDest().getDefiningOp<vector::SplatOp>();
2253 
2254     if (!srcSplatOp || !destSplatOp)
2255       return failure();
2256 
2257     if (srcSplatOp.getInput() != destSplatOp.getInput())
2258       return failure();
2259 
2260     rewriter.replaceOp(insertStridedSliceOp, insertStridedSliceOp.getDest());
2261     return success();
2262   }
2263 };
2264 
2265 /// Pattern to rewrite an InsertStridedSliceOp(ExtractStridedSliceOp(dst), dst)
2266 /// to dst.
2267 class FoldInsertStridedSliceOfExtract final
2268     : public OpRewritePattern<InsertStridedSliceOp> {
2269 public:
2270   using OpRewritePattern<InsertStridedSliceOp>::OpRewritePattern;
2271 
2272   LogicalResult matchAndRewrite(InsertStridedSliceOp insertStridedSliceOp,
2273                                 PatternRewriter &rewriter) const override {
2274     auto extractStridedSliceOp =
2275         insertStridedSliceOp.getSource()
2276             .getDefiningOp<vector::ExtractStridedSliceOp>();
2277 
2278     if (!extractStridedSliceOp)
2279       return failure();
2280 
2281     if (extractStridedSliceOp.getOperand() != insertStridedSliceOp.getDest())
2282       return failure();
2283 
2284     // Check if have the same strides and offsets.
2285     if (extractStridedSliceOp.getStrides() !=
2286             insertStridedSliceOp.getStrides() ||
2287         extractStridedSliceOp.getOffsets() != insertStridedSliceOp.getOffsets())
2288       return failure();
2289 
2290     rewriter.replaceOp(insertStridedSliceOp, insertStridedSliceOp.getDest());
2291     return success();
2292   }
2293 };
2294 
2295 } // namespace
2296 
2297 void vector::InsertStridedSliceOp::getCanonicalizationPatterns(
2298     RewritePatternSet &results, MLIRContext *context) {
2299   results.add<FoldInsertStridedSliceSplat, FoldInsertStridedSliceOfExtract>(
2300       context);
2301 }
2302 
2303 OpFoldResult InsertStridedSliceOp::fold(ArrayRef<Attribute> operands) {
2304   if (getSourceVectorType() == getDestVectorType())
2305     return getSource();
2306   return {};
2307 }
2308 
2309 //===----------------------------------------------------------------------===//
2310 // OuterProductOp
2311 //===----------------------------------------------------------------------===//
2312 
2313 /// Build an op without mask, use the type of `acc` as the return type.
2314 void OuterProductOp::build(OpBuilder &builder, OperationState &result,
2315                            Value lhs, Value rhs, Value acc) {
2316   result.addOperands({lhs, rhs, acc});
2317   result.addTypes(acc.getType());
2318 }
2319 
2320 void OuterProductOp::print(OpAsmPrinter &p) {
2321   p << " " << getLhs() << ", " << getRhs();
2322   if (!getAcc().empty()) {
2323     p << ", " << getAcc();
2324     p.printOptionalAttrDict((*this)->getAttrs());
2325   }
2326   p << " : " << getLhs().getType() << ", " << getRhs().getType();
2327 }
2328 
2329 ParseResult OuterProductOp::parse(OpAsmParser &parser, OperationState &result) {
2330   SmallVector<OpAsmParser::UnresolvedOperand, 3> operandsInfo;
2331   Type tLHS, tRHS;
2332   if (parser.parseOperandList(operandsInfo) ||
2333       parser.parseOptionalAttrDict(result.attributes) ||
2334       parser.parseColonType(tLHS) || parser.parseComma() ||
2335       parser.parseType(tRHS))
2336     return failure();
2337   if (operandsInfo.size() < 2)
2338     return parser.emitError(parser.getNameLoc(),
2339                             "expected at least 2 operands");
2340   VectorType vLHS = tLHS.dyn_cast<VectorType>();
2341   VectorType vRHS = tRHS.dyn_cast<VectorType>();
2342   if (!vLHS)
2343     return parser.emitError(parser.getNameLoc(),
2344                             "expected vector type for operand #1");
2345   VectorType resType =
2346       vRHS ? VectorType::get({vLHS.getDimSize(0), vRHS.getDimSize(0)},
2347                              vLHS.getElementType())
2348            : VectorType::get({vLHS.getDimSize(0)}, vLHS.getElementType());
2349 
2350   if (!result.attributes.get(OuterProductOp::getKindAttrStrName())) {
2351     result.attributes.append(
2352         OuterProductOp::getKindAttrStrName(),
2353         CombiningKindAttr::get(OuterProductOp::getDefaultKind(),
2354                                result.getContext()));
2355   }
2356 
2357   return failure(
2358       parser.resolveOperand(operandsInfo[0], tLHS, result.operands) ||
2359       parser.resolveOperand(operandsInfo[1], tRHS, result.operands) ||
2360       (operandsInfo.size() > 2 &&
2361        parser.resolveOperand(operandsInfo[2], resType, result.operands)) ||
2362       parser.addTypeToList(resType, result.types));
2363 }
2364 
2365 LogicalResult OuterProductOp::verify() {
2366   Type tRHS = getOperandTypeRHS();
2367   VectorType vLHS = getOperandVectorTypeLHS(),
2368              vRHS = tRHS.dyn_cast<VectorType>(),
2369              vACC = getOperandVectorTypeACC(), vRES = getVectorType();
2370 
2371   if (vLHS.getRank() != 1)
2372     return emitOpError("expected 1-d vector for operand #1");
2373 
2374   if (vRHS) {
2375     // Proper OUTER operation.
2376     if (vRHS.getRank() != 1)
2377       return emitOpError("expected 1-d vector for operand #2");
2378     if (vRES.getRank() != 2)
2379       return emitOpError("expected 2-d vector result");
2380     if (vLHS.getDimSize(0) != vRES.getDimSize(0))
2381       return emitOpError("expected #1 operand dim to match result dim #1");
2382     if (vRHS.getDimSize(0) != vRES.getDimSize(1))
2383       return emitOpError("expected #2 operand dim to match result dim #2");
2384   } else {
2385     // An AXPY operation.
2386     if (vRES.getRank() != 1)
2387       return emitOpError("expected 1-d vector result");
2388     if (vLHS.getDimSize(0) != vRES.getDimSize(0))
2389       return emitOpError("expected #1 operand dim to match result dim #1");
2390   }
2391 
2392   if (vACC && vACC != vRES)
2393     return emitOpError("expected operand #3 of same type as result type");
2394 
2395   // Verify supported combining kind.
2396   if (!isSupportedCombiningKind(getKind(), vRES.getElementType()))
2397     return emitOpError("unsupported outerproduct type");
2398 
2399   return success();
2400 }
2401 
2402 //===----------------------------------------------------------------------===//
2403 // ReshapeOp
2404 //===----------------------------------------------------------------------===//
2405 
2406 LogicalResult ReshapeOp::verify() {
2407   // Verify that rank(numInputs/outputs) + numFixedVec dim matches vec rank.
2408   auto inputVectorType = getInputVectorType();
2409   auto outputVectorType = getOutputVectorType();
2410   int64_t inputShapeRank = getNumInputShapeSizes();
2411   int64_t outputShapeRank = getNumOutputShapeSizes();
2412   SmallVector<int64_t, 4> fixedVectorSizes;
2413   getFixedVectorSizes(fixedVectorSizes);
2414   int64_t numFixedVectorSizes = fixedVectorSizes.size();
2415 
2416   if (inputVectorType.getRank() != inputShapeRank + numFixedVectorSizes)
2417     return emitError("invalid input shape for vector type ") << inputVectorType;
2418 
2419   if (outputVectorType.getRank() != outputShapeRank + numFixedVectorSizes)
2420     return emitError("invalid output shape for vector type ")
2421            << outputVectorType;
2422 
2423   // Verify that the 'fixedVectorSizes' match an input/output vector shape
2424   // suffix.
2425   unsigned inputVectorRank = inputVectorType.getRank();
2426   for (unsigned i = 0; i < numFixedVectorSizes; ++i) {
2427     unsigned index = inputVectorRank - numFixedVectorSizes - i;
2428     if (fixedVectorSizes[i] != inputVectorType.getShape()[index])
2429       return emitError("fixed vector size must match input vector for dim ")
2430              << i;
2431   }
2432 
2433   unsigned outputVectorRank = outputVectorType.getRank();
2434   for (unsigned i = 0; i < numFixedVectorSizes; ++i) {
2435     unsigned index = outputVectorRank - numFixedVectorSizes - i;
2436     if (fixedVectorSizes[i] != outputVectorType.getShape()[index])
2437       return emitError("fixed vector size must match output vector for dim ")
2438              << i;
2439   }
2440 
2441   // If all shape operands are produced by constant ops, verify that product
2442   // of dimensions for input/output shape match.
2443   auto isDefByConstant = [](Value operand) {
2444     return isa_and_nonnull<arith::ConstantIndexOp>(operand.getDefiningOp());
2445   };
2446   if (llvm::all_of(getInputShape(), isDefByConstant) &&
2447       llvm::all_of(getOutputShape(), isDefByConstant)) {
2448     int64_t numInputElements = 1;
2449     for (auto operand : getInputShape())
2450       numInputElements *=
2451           cast<arith::ConstantIndexOp>(operand.getDefiningOp()).value();
2452     int64_t numOutputElements = 1;
2453     for (auto operand : getOutputShape())
2454       numOutputElements *=
2455           cast<arith::ConstantIndexOp>(operand.getDefiningOp()).value();
2456     if (numInputElements != numOutputElements)
2457       return emitError("product of input and output shape sizes must match");
2458   }
2459   return success();
2460 }
2461 
2462 void ReshapeOp::getFixedVectorSizes(SmallVectorImpl<int64_t> &results) {
2463   populateFromInt64AttrArray(getFixedVectorSizes(), results);
2464 }
2465 
2466 //===----------------------------------------------------------------------===//
2467 // ExtractStridedSliceOp
2468 //===----------------------------------------------------------------------===//
2469 
2470 // Inference works as follows:
2471 //   1. Add 'sizes' from prefix of dims in 'offsets'.
2472 //   2. Add sizes from 'vectorType' for remaining dims.
2473 static Type inferStridedSliceOpResultType(VectorType vectorType,
2474                                           ArrayAttr offsets, ArrayAttr sizes,
2475                                           ArrayAttr strides) {
2476   assert(offsets.size() == sizes.size() && offsets.size() == strides.size());
2477   SmallVector<int64_t, 4> shape;
2478   shape.reserve(vectorType.getRank());
2479   unsigned idx = 0;
2480   for (unsigned e = offsets.size(); idx < e; ++idx)
2481     shape.push_back(sizes[idx].cast<IntegerAttr>().getInt());
2482   for (unsigned e = vectorType.getShape().size(); idx < e; ++idx)
2483     shape.push_back(vectorType.getShape()[idx]);
2484 
2485   return VectorType::get(shape, vectorType.getElementType());
2486 }
2487 
2488 void ExtractStridedSliceOp::build(OpBuilder &builder, OperationState &result,
2489                                   Value source, ArrayRef<int64_t> offsets,
2490                                   ArrayRef<int64_t> sizes,
2491                                   ArrayRef<int64_t> strides) {
2492   result.addOperands(source);
2493   auto offsetsAttr = getVectorSubscriptAttr(builder, offsets);
2494   auto sizesAttr = getVectorSubscriptAttr(builder, sizes);
2495   auto stridesAttr = getVectorSubscriptAttr(builder, strides);
2496   result.addTypes(
2497       inferStridedSliceOpResultType(source.getType().cast<VectorType>(),
2498                                     offsetsAttr, sizesAttr, stridesAttr));
2499   result.addAttribute(getOffsetsAttrStrName(), offsetsAttr);
2500   result.addAttribute(getSizesAttrStrName(), sizesAttr);
2501   result.addAttribute(getStridesAttrStrName(), stridesAttr);
2502 }
2503 
2504 LogicalResult ExtractStridedSliceOp::verify() {
2505   auto type = getVectorType();
2506   auto offsets = getOffsetsAttr();
2507   auto sizes = getSizesAttr();
2508   auto strides = getStridesAttr();
2509   if (offsets.size() != sizes.size() || offsets.size() != strides.size())
2510     return emitOpError(
2511         "expected offsets, sizes and strides attributes of same size");
2512 
2513   auto shape = type.getShape();
2514   auto offName = getOffsetsAttrName();
2515   auto sizesName = getSizesAttrName();
2516   auto stridesName = getStridesAttrName();
2517   if (failed(
2518           isIntegerArrayAttrSmallerThanShape(*this, offsets, shape, offName)) ||
2519       failed(
2520           isIntegerArrayAttrSmallerThanShape(*this, sizes, shape, sizesName)) ||
2521       failed(isIntegerArrayAttrSmallerThanShape(*this, strides, shape,
2522                                                 stridesName)) ||
2523       failed(
2524           isIntegerArrayAttrConfinedToShape(*this, offsets, shape, offName)) ||
2525       failed(isIntegerArrayAttrConfinedToShape(*this, sizes, shape, sizesName,
2526                                                /*halfOpen=*/false,
2527                                                /*min=*/1)) ||
2528       failed(isIntegerArrayAttrConfinedToRange(*this, strides, 1, 1,
2529                                                stridesName,
2530                                                /*halfOpen=*/false)) ||
2531       failed(isSumOfIntegerArrayAttrConfinedToShape(*this, offsets, sizes,
2532                                                     shape, offName, sizesName,
2533                                                     /*halfOpen=*/false)))
2534     return failure();
2535 
2536   auto resultType =
2537       inferStridedSliceOpResultType(getVectorType(), offsets, sizes, strides);
2538   if (getResult().getType() != resultType)
2539     return emitOpError("expected result type to be ") << resultType;
2540 
2541   return success();
2542 }
2543 
2544 // When the source of ExtractStrided comes from a chain of InsertStrided ops try
2545 // to use the source of the InsertStrided ops if we can detect that the
2546 // extracted vector is a subset of one of the vector inserted.
2547 static LogicalResult
2548 foldExtractStridedOpFromInsertChain(ExtractStridedSliceOp op) {
2549   // Helper to extract integer out of ArrayAttr.
2550   auto getElement = [](ArrayAttr array, int idx) {
2551     return array[idx].cast<IntegerAttr>().getInt();
2552   };
2553   ArrayAttr extractOffsets = op.getOffsets();
2554   ArrayAttr extractStrides = op.getStrides();
2555   ArrayAttr extractSizes = op.getSizes();
2556   auto insertOp = op.getVector().getDefiningOp<InsertStridedSliceOp>();
2557   while (insertOp) {
2558     if (op.getVectorType().getRank() !=
2559         insertOp.getSourceVectorType().getRank())
2560       return failure();
2561     ArrayAttr insertOffsets = insertOp.getOffsets();
2562     ArrayAttr insertStrides = insertOp.getStrides();
2563     // If the rank of extract is greater than the rank of insert, we are likely
2564     // extracting a partial chunk of the vector inserted.
2565     if (extractOffsets.size() > insertOffsets.size())
2566       return failure();
2567     bool patialoverlap = false;
2568     bool disjoint = false;
2569     SmallVector<int64_t, 4> offsetDiffs;
2570     for (unsigned dim = 0, e = extractOffsets.size(); dim < e; ++dim) {
2571       if (getElement(extractStrides, dim) != getElement(insertStrides, dim))
2572         return failure();
2573       int64_t start = getElement(insertOffsets, dim);
2574       int64_t end = start + insertOp.getSourceVectorType().getDimSize(dim);
2575       int64_t offset = getElement(extractOffsets, dim);
2576       int64_t size = getElement(extractSizes, dim);
2577       // Check if the start of the extract offset is in the interval inserted.
2578       if (start <= offset && offset < end) {
2579         // If the extract interval overlaps but is not fully included we may
2580         // have a partial overlap that will prevent any folding.
2581         if (offset + size > end)
2582           patialoverlap = true;
2583         offsetDiffs.push_back(offset - start);
2584         continue;
2585       }
2586       disjoint = true;
2587       break;
2588     }
2589     // The extract element chunk is a subset of the insert element.
2590     if (!disjoint && !patialoverlap) {
2591       op.setOperand(insertOp.getSource());
2592       // OpBuilder is only used as a helper to build an I64ArrayAttr.
2593       OpBuilder b(op.getContext());
2594       op->setAttr(ExtractStridedSliceOp::getOffsetsAttrStrName(),
2595                   b.getI64ArrayAttr(offsetDiffs));
2596       return success();
2597     }
2598     // If the chunk extracted is disjoint from the chunk inserted, keep looking
2599     // in the insert chain.
2600     if (disjoint)
2601       insertOp = insertOp.getDest().getDefiningOp<InsertStridedSliceOp>();
2602     else {
2603       // The extracted vector partially overlap the inserted vector, we cannot
2604       // fold.
2605       return failure();
2606     }
2607   }
2608   return failure();
2609 }
2610 
2611 OpFoldResult ExtractStridedSliceOp::fold(ArrayRef<Attribute> operands) {
2612   if (getVectorType() == getResult().getType())
2613     return getVector();
2614   if (succeeded(foldExtractStridedOpFromInsertChain(*this)))
2615     return getResult();
2616   return {};
2617 }
2618 
2619 void ExtractStridedSliceOp::getOffsets(SmallVectorImpl<int64_t> &results) {
2620   populateFromInt64AttrArray(getOffsets(), results);
2621 }
2622 
2623 namespace {
2624 
2625 // Pattern to rewrite an ExtractStridedSliceOp(ConstantMaskOp) to
2626 // ConstantMaskOp.
2627 class StridedSliceConstantMaskFolder final
2628     : public OpRewritePattern<ExtractStridedSliceOp> {
2629 public:
2630   using OpRewritePattern<ExtractStridedSliceOp>::OpRewritePattern;
2631 
2632   LogicalResult matchAndRewrite(ExtractStridedSliceOp extractStridedSliceOp,
2633                                 PatternRewriter &rewriter) const override {
2634     // Return if 'extractStridedSliceOp' operand is not defined by a
2635     // ConstantMaskOp.
2636     auto *defOp = extractStridedSliceOp.getVector().getDefiningOp();
2637     auto constantMaskOp = dyn_cast_or_null<ConstantMaskOp>(defOp);
2638     if (!constantMaskOp)
2639       return failure();
2640     // Return if 'extractStridedSliceOp' has non-unit strides.
2641     if (extractStridedSliceOp.hasNonUnitStrides())
2642       return failure();
2643     // Gather constant mask dimension sizes.
2644     SmallVector<int64_t, 4> maskDimSizes;
2645     populateFromInt64AttrArray(constantMaskOp.getMaskDimSizes(), maskDimSizes);
2646     // Gather strided slice offsets and sizes.
2647     SmallVector<int64_t, 4> sliceOffsets;
2648     populateFromInt64AttrArray(extractStridedSliceOp.getOffsets(),
2649                                sliceOffsets);
2650     SmallVector<int64_t, 4> sliceSizes;
2651     populateFromInt64AttrArray(extractStridedSliceOp.getSizes(), sliceSizes);
2652 
2653     // Compute slice of vector mask region.
2654     SmallVector<int64_t, 4> sliceMaskDimSizes;
2655     assert(sliceOffsets.size() == maskDimSizes.size());
2656     for (auto it : llvm::zip(maskDimSizes, sliceOffsets, sliceSizes)) {
2657       int64_t maskDimSize = std::get<0>(it);
2658       int64_t sliceOffset = std::get<1>(it);
2659       int64_t sliceSize = std::get<2>(it);
2660       int64_t sliceMaskDimSize = std::max(
2661           static_cast<int64_t>(0),
2662           std::min(sliceOffset + sliceSize, maskDimSize) - sliceOffset);
2663       sliceMaskDimSizes.push_back(sliceMaskDimSize);
2664     }
2665     // If any of 'sliceMaskDimSizes' are zero, then set all to zero (masked
2666     // region is a conjunction of mask dim intervals).
2667     if (llvm::is_contained(sliceMaskDimSizes, 0))
2668       sliceMaskDimSizes.assign(maskDimSizes.size(), 0);
2669 
2670     // Replace 'extractStridedSliceOp' with ConstantMaskOp with sliced mask
2671     // region.
2672     rewriter.replaceOpWithNewOp<ConstantMaskOp>(
2673         extractStridedSliceOp, extractStridedSliceOp.getResult().getType(),
2674         vector::getVectorSubscriptAttr(rewriter, sliceMaskDimSizes));
2675     return success();
2676   }
2677 };
2678 
2679 // Pattern to rewrite a ExtractStridedSliceOp(splat ConstantOp) -> ConstantOp.
2680 class StridedSliceConstantFolder final
2681     : public OpRewritePattern<ExtractStridedSliceOp> {
2682 public:
2683   using OpRewritePattern<ExtractStridedSliceOp>::OpRewritePattern;
2684 
2685   LogicalResult matchAndRewrite(ExtractStridedSliceOp extractStridedSliceOp,
2686                                 PatternRewriter &rewriter) const override {
2687     // Return if 'extractStridedSliceOp' operand is not defined by a
2688     // ConstantOp.
2689     auto constantOp =
2690         extractStridedSliceOp.getVector().getDefiningOp<arith::ConstantOp>();
2691     if (!constantOp)
2692       return failure();
2693     auto dense = constantOp.getValue().dyn_cast<SplatElementsAttr>();
2694     if (!dense)
2695       return failure();
2696     auto newAttr = DenseElementsAttr::get(extractStridedSliceOp.getType(),
2697                                           dense.getSplatValue<Attribute>());
2698     rewriter.replaceOpWithNewOp<arith::ConstantOp>(extractStridedSliceOp,
2699                                                    newAttr);
2700     return success();
2701   }
2702 };
2703 
2704 // Pattern to rewrite an ExtractStridedSliceOp(BroadcastOp) to
2705 // BroadcastOp(ExtractStrideSliceOp).
2706 class StridedSliceBroadcast final
2707     : public OpRewritePattern<ExtractStridedSliceOp> {
2708 public:
2709   using OpRewritePattern<ExtractStridedSliceOp>::OpRewritePattern;
2710 
2711   LogicalResult matchAndRewrite(ExtractStridedSliceOp op,
2712                                 PatternRewriter &rewriter) const override {
2713     auto broadcast = op.getVector().getDefiningOp<BroadcastOp>();
2714     if (!broadcast)
2715       return failure();
2716     auto srcVecType = broadcast.getSource().getType().dyn_cast<VectorType>();
2717     unsigned srcRank = srcVecType ? srcVecType.getRank() : 0;
2718     auto dstVecType = op.getType().cast<VectorType>();
2719     unsigned dstRank = dstVecType.getRank();
2720     unsigned rankDiff = dstRank - srcRank;
2721     // Check if the most inner dimensions of the source of the broadcast are the
2722     // same as the destination of the extract. If this is the case we can just
2723     // use a broadcast as the original dimensions are untouched.
2724     bool lowerDimMatch = true;
2725     for (unsigned i = 0; i < srcRank; i++) {
2726       if (srcVecType.getDimSize(i) != dstVecType.getDimSize(i + rankDiff)) {
2727         lowerDimMatch = false;
2728         break;
2729       }
2730     }
2731     Value source = broadcast.getSource();
2732     // If the inner dimensions don't match, it means we need to extract from the
2733     // source of the orignal broadcast and then broadcast the extracted value.
2734     // We also need to handle degenerated cases where the source is effectively
2735     // just a single scalar.
2736     bool isScalarSrc = (srcRank == 0 || srcVecType.getNumElements() == 1);
2737     if (!lowerDimMatch && !isScalarSrc) {
2738       source = rewriter.create<ExtractStridedSliceOp>(
2739           op->getLoc(), source,
2740           getI64SubArray(op.getOffsets(), /* dropFront=*/rankDiff),
2741           getI64SubArray(op.getSizes(), /* dropFront=*/rankDiff),
2742           getI64SubArray(op.getStrides(), /* dropFront=*/rankDiff));
2743     }
2744     rewriter.replaceOpWithNewOp<BroadcastOp>(op, op.getType(), source);
2745     return success();
2746   }
2747 };
2748 
2749 /// Pattern to rewrite an ExtractStridedSliceOp(SplatOp) to SplatOp.
2750 class StridedSliceSplat final : public OpRewritePattern<ExtractStridedSliceOp> {
2751 public:
2752   using OpRewritePattern<ExtractStridedSliceOp>::OpRewritePattern;
2753 
2754   LogicalResult matchAndRewrite(ExtractStridedSliceOp op,
2755                                 PatternRewriter &rewriter) const override {
2756     auto splat = op.getVector().getDefiningOp<SplatOp>();
2757     if (!splat)
2758       return failure();
2759     rewriter.replaceOpWithNewOp<SplatOp>(op, op.getType(), splat.getInput());
2760     return success();
2761   }
2762 };
2763 
2764 } // namespace
2765 
2766 void ExtractStridedSliceOp::getCanonicalizationPatterns(
2767     RewritePatternSet &results, MLIRContext *context) {
2768   // Pattern to rewrite a ExtractStridedSliceOp(ConstantMaskOp) ->
2769   // ConstantMaskOp and ExtractStridedSliceOp(ConstantOp) -> ConstantOp.
2770   results.add<StridedSliceConstantMaskFolder, StridedSliceConstantFolder,
2771               StridedSliceBroadcast, StridedSliceSplat>(context);
2772 }
2773 
2774 //===----------------------------------------------------------------------===//
2775 // TransferReadOp
2776 //===----------------------------------------------------------------------===//
2777 
2778 /// 1. Builder that sets padding to zero and an empty mask (variant with attrs).
2779 void TransferReadOp::build(OpBuilder &builder, OperationState &result,
2780                            VectorType vectorType, Value source,
2781                            ValueRange indices, AffineMapAttr permutationMapAttr,
2782                            /*optional*/ ArrayAttr inBoundsAttr) {
2783   Type elemType = source.getType().cast<ShapedType>().getElementType();
2784   Value padding = builder.create<arith::ConstantOp>(
2785       result.location, elemType, builder.getZeroAttr(elemType));
2786   build(builder, result, vectorType, source, indices, permutationMapAttr,
2787         padding, /*mask=*/Value(), inBoundsAttr);
2788 }
2789 
2790 /// 2. Builder that sets padding to zero an empty mask (variant without attrs).
2791 void TransferReadOp::build(OpBuilder &builder, OperationState &result,
2792                            VectorType vectorType, Value source,
2793                            ValueRange indices, AffineMap permutationMap,
2794                            Optional<ArrayRef<bool>> inBounds) {
2795   auto permutationMapAttr = AffineMapAttr::get(permutationMap);
2796   auto inBoundsAttr = (inBounds && !inBounds.getValue().empty())
2797                           ? builder.getBoolArrayAttr(inBounds.getValue())
2798                           : ArrayAttr();
2799   build(builder, result, vectorType, source, indices, permutationMapAttr,
2800         inBoundsAttr);
2801 }
2802 
2803 /// 3. Builder that sets permutation map to 'getMinorIdentityMap'.
2804 void TransferReadOp::build(OpBuilder &builder, OperationState &result,
2805                            VectorType vectorType, Value source,
2806                            ValueRange indices, Value padding,
2807                            Optional<ArrayRef<bool>> inBounds) {
2808   AffineMap permutationMap = getTransferMinorIdentityMap(
2809       source.getType().cast<ShapedType>(), vectorType);
2810   auto permutationMapAttr = AffineMapAttr::get(permutationMap);
2811   auto inBoundsAttr = (inBounds && !inBounds.getValue().empty())
2812                           ? builder.getBoolArrayAttr(inBounds.getValue())
2813                           : ArrayAttr();
2814   build(builder, result, vectorType, source, indices, permutationMapAttr,
2815         padding,
2816         /*mask=*/Value(), inBoundsAttr);
2817 }
2818 
2819 /// 4. Builder that sets padding to zero and permutation map to
2820 /// 'getMinorIdentityMap'.
2821 void TransferReadOp::build(OpBuilder &builder, OperationState &result,
2822                            VectorType vectorType, Value source,
2823                            ValueRange indices,
2824                            Optional<ArrayRef<bool>> inBounds) {
2825   Type elemType = source.getType().cast<ShapedType>().getElementType();
2826   Value padding = builder.create<arith::ConstantOp>(
2827       result.location, elemType, builder.getZeroAttr(elemType));
2828   build(builder, result, vectorType, source, indices, padding, inBounds);
2829 }
2830 
2831 template <typename EmitFun>
2832 static LogicalResult verifyPermutationMap(AffineMap permutationMap,
2833                                           EmitFun emitOpError) {
2834   SmallVector<bool, 8> seen(permutationMap.getNumInputs(), false);
2835   for (auto expr : permutationMap.getResults()) {
2836     auto dim = expr.dyn_cast<AffineDimExpr>();
2837     auto zero = expr.dyn_cast<AffineConstantExpr>();
2838     if (zero) {
2839       if (zero.getValue() != 0) {
2840         return emitOpError(
2841             "requires a projected permutation_map (at most one dim or the zero "
2842             "constant can appear in each result)");
2843       }
2844       continue;
2845     }
2846     if (!dim) {
2847       return emitOpError("requires a projected permutation_map (at most one "
2848                          "dim or the zero constant can appear in each result)");
2849     }
2850     if (seen[dim.getPosition()]) {
2851       return emitOpError(
2852           "requires a permutation_map that is a permutation (found one dim "
2853           "used more than once)");
2854     }
2855     seen[dim.getPosition()] = true;
2856   }
2857   return success();
2858 }
2859 
2860 static LogicalResult
2861 verifyTransferOp(VectorTransferOpInterface op, ShapedType shapedType,
2862                  VectorType vectorType, VectorType maskType,
2863                  AffineMap permutationMap, ArrayAttr inBounds) {
2864   if (op->hasAttr("masked")) {
2865     return op->emitOpError("masked attribute has been removed. "
2866                            "Use in_bounds instead.");
2867   }
2868 
2869   if (!shapedType.isa<MemRefType, RankedTensorType>())
2870     return op->emitOpError(
2871         "requires source to be a memref or ranked tensor type");
2872 
2873   auto elementType = shapedType.getElementType();
2874   DataLayout dataLayout = DataLayout::closest(op);
2875   if (auto vectorElementType = elementType.dyn_cast<VectorType>()) {
2876     // Memref or tensor has vector element type.
2877     unsigned sourceVecSize =
2878         dataLayout.getTypeSizeInBits(vectorElementType.getElementType()) *
2879         vectorElementType.getShape().back();
2880     unsigned resultVecSize =
2881         dataLayout.getTypeSizeInBits(vectorType.getElementType()) *
2882         vectorType.getShape().back();
2883     if (resultVecSize % sourceVecSize != 0)
2884       return op->emitOpError(
2885           "requires the bitwidth of the minor 1-D vector to be an integral "
2886           "multiple of the bitwidth of the minor 1-D vector of the source");
2887 
2888     unsigned sourceVecEltRank = vectorElementType.getRank();
2889     unsigned resultVecRank = vectorType.getRank();
2890     if (sourceVecEltRank > resultVecRank)
2891       return op->emitOpError(
2892           "requires source vector element and vector result ranks to match.");
2893     unsigned rankOffset = resultVecRank - sourceVecEltRank;
2894     // Check that permutation map results match 'rankOffset' of vector type.
2895     if (permutationMap.getNumResults() != rankOffset)
2896       return op->emitOpError("requires a permutation_map with result dims of "
2897                              "the same rank as the vector type");
2898 
2899     if (maskType)
2900       return op->emitOpError("does not support masks with vector element type");
2901   } else {
2902     // Memref or tensor has scalar element type.
2903     unsigned minorSize =
2904         vectorType.getRank() == 0 ? 1 : vectorType.getShape().back();
2905     unsigned resultVecSize =
2906         dataLayout.getTypeSizeInBits(vectorType.getElementType()) * minorSize;
2907     if (resultVecSize % dataLayout.getTypeSizeInBits(elementType) != 0)
2908       return op->emitOpError(
2909           "requires the bitwidth of the minor 1-D vector to be an integral "
2910           "multiple of the bitwidth of the source element type");
2911 
2912     // Check that permutation map results match rank of vector type.
2913     if (permutationMap.getNumResults() != vectorType.getRank())
2914       return op->emitOpError("requires a permutation_map with result dims of "
2915                              "the same rank as the vector type");
2916 
2917     VectorType expectedMaskType =
2918         vector::detail::transferMaskType(vectorType, permutationMap);
2919     if (maskType && expectedMaskType != maskType)
2920       return op->emitOpError("expects mask type consistent with permutation "
2921                              "map: ")
2922              << maskType;
2923   }
2924 
2925   if (permutationMap.getNumSymbols() != 0)
2926     return op->emitOpError("requires permutation_map without symbols");
2927 
2928   if (permutationMap.getNumInputs() != shapedType.getRank())
2929     return op->emitOpError("requires a permutation_map with input dims of the "
2930                            "same rank as the source type");
2931 
2932   if (inBounds) {
2933     if (permutationMap.getNumResults() != static_cast<int64_t>(inBounds.size()))
2934       return op->emitOpError("expects the optional in_bounds attr of same rank "
2935                              "as permutation_map results: ")
2936              << AffineMapAttr::get(permutationMap)
2937              << " vs inBounds of size: " << inBounds.size();
2938     for (unsigned int i = 0; i < permutationMap.getNumResults(); ++i)
2939       if (permutationMap.getResult(i).isa<AffineConstantExpr>() &&
2940           !inBounds.getValue()[i].cast<BoolAttr>().getValue())
2941         return op->emitOpError("requires broadcast dimensions to be in-bounds");
2942   }
2943 
2944   return success();
2945 }
2946 
2947 static void printTransferAttrs(OpAsmPrinter &p, VectorTransferOpInterface op) {
2948   SmallVector<StringRef, 3> elidedAttrs;
2949   elidedAttrs.push_back(TransferReadOp::getOperandSegmentSizeAttr());
2950   if (op.permutation_map().isMinorIdentity())
2951     elidedAttrs.push_back(op.getPermutationMapAttrStrName());
2952   bool elideInBounds = true;
2953   if (auto inBounds = op.in_bounds()) {
2954     for (auto attr : *inBounds) {
2955       if (attr.template cast<BoolAttr>().getValue()) {
2956         elideInBounds = false;
2957         break;
2958       }
2959     }
2960   }
2961   if (elideInBounds)
2962     elidedAttrs.push_back(op.getInBoundsAttrStrName());
2963   p.printOptionalAttrDict(op->getAttrs(), elidedAttrs);
2964 }
2965 
2966 void TransferReadOp::print(OpAsmPrinter &p) {
2967   p << " " << getSource() << "[" << getIndices() << "], " << getPadding();
2968   if (getMask())
2969     p << ", " << getMask();
2970   printTransferAttrs(p, *this);
2971   p << " : " << getShapedType() << ", " << getVectorType();
2972 }
2973 
2974 ParseResult TransferReadOp::parse(OpAsmParser &parser, OperationState &result) {
2975   auto &builder = parser.getBuilder();
2976   SMLoc typesLoc;
2977   OpAsmParser::UnresolvedOperand sourceInfo;
2978   SmallVector<OpAsmParser::UnresolvedOperand, 8> indexInfo;
2979   OpAsmParser::UnresolvedOperand paddingInfo;
2980   SmallVector<Type, 2> types;
2981   OpAsmParser::UnresolvedOperand maskInfo;
2982   // Parsing with support for paddingValue.
2983   if (parser.parseOperand(sourceInfo) ||
2984       parser.parseOperandList(indexInfo, OpAsmParser::Delimiter::Square) ||
2985       parser.parseComma() || parser.parseOperand(paddingInfo))
2986     return failure();
2987   ParseResult hasMask = parser.parseOptionalComma();
2988   if (hasMask.succeeded()) {
2989     if (parser.parseOperand(maskInfo))
2990       return failure();
2991   }
2992   if (parser.parseOptionalAttrDict(result.attributes) ||
2993       parser.getCurrentLocation(&typesLoc) || parser.parseColonTypeList(types))
2994     return failure();
2995   if (types.size() != 2)
2996     return parser.emitError(typesLoc, "requires two types");
2997   auto indexType = builder.getIndexType();
2998   auto shapedType = types[0].dyn_cast<ShapedType>();
2999   if (!shapedType || !shapedType.isa<MemRefType, RankedTensorType>())
3000     return parser.emitError(typesLoc, "requires memref or ranked tensor type");
3001   VectorType vectorType = types[1].dyn_cast<VectorType>();
3002   if (!vectorType)
3003     return parser.emitError(typesLoc, "requires vector type");
3004   auto permutationAttrName = TransferReadOp::getPermutationMapAttrStrName();
3005   Attribute mapAttr = result.attributes.get(permutationAttrName);
3006   if (!mapAttr) {
3007     auto permMap = getTransferMinorIdentityMap(shapedType, vectorType);
3008     // Update `mapAttr` that is used later to determine mask type.
3009     mapAttr = AffineMapAttr::get(permMap);
3010     result.attributes.set(permutationAttrName, mapAttr);
3011   }
3012   if (parser.resolveOperand(sourceInfo, shapedType, result.operands) ||
3013       parser.resolveOperands(indexInfo, indexType, result.operands) ||
3014       parser.resolveOperand(paddingInfo, shapedType.getElementType(),
3015                             result.operands))
3016     return failure();
3017   if (hasMask.succeeded()) {
3018     if (shapedType.getElementType().dyn_cast<VectorType>())
3019       return parser.emitError(
3020           maskInfo.location, "does not support masks with vector element type");
3021     auto map = mapAttr.dyn_cast<AffineMapAttr>().getValue();
3022     // Instead of adding the mask type as an op type, compute it based on the
3023     // vector type and the permutation map (to keep the type signature small).
3024     auto maskType = mlir::vector::detail::transferMaskType(vectorType, map);
3025     if (parser.resolveOperand(maskInfo, maskType, result.operands))
3026       return failure();
3027   }
3028   result.addAttribute(
3029       TransferReadOp::getOperandSegmentSizeAttr(),
3030       builder.getI32VectorAttr({1, static_cast<int32_t>(indexInfo.size()), 1,
3031                                 static_cast<int32_t>(hasMask.succeeded())}));
3032   return parser.addTypeToList(vectorType, result.types);
3033 }
3034 
3035 LogicalResult TransferReadOp::verify() {
3036   // Consistency of elemental types in source and vector.
3037   ShapedType shapedType = getShapedType();
3038   VectorType vectorType = getVectorType();
3039   VectorType maskType = getMaskType();
3040   auto paddingType = getPadding().getType();
3041   auto permutationMap = getPermutationMap();
3042   auto sourceElementType = shapedType.getElementType();
3043 
3044   if (static_cast<int64_t>(getIndices().size()) != shapedType.getRank())
3045     return emitOpError("requires ") << shapedType.getRank() << " indices";
3046 
3047   if (failed(verifyTransferOp(cast<VectorTransferOpInterface>(getOperation()),
3048                               shapedType, vectorType, maskType, permutationMap,
3049                               getInBounds() ? *getInBounds() : ArrayAttr())))
3050     return failure();
3051 
3052   if (auto sourceVectorElementType = sourceElementType.dyn_cast<VectorType>()) {
3053     // Source has vector element type.
3054     // Check that 'sourceVectorElementType' and 'paddingType' types match.
3055     if (sourceVectorElementType != paddingType)
3056       return emitOpError(
3057           "requires source element type and padding type to match.");
3058 
3059   } else {
3060     // Check that 'paddingType' is valid to store in a vector type.
3061     if (!VectorType::isValidElementType(paddingType))
3062       return emitOpError("requires valid padding vector elemental type");
3063 
3064     // Check that padding type and vector element types match.
3065     if (paddingType != sourceElementType)
3066       return emitOpError(
3067           "requires formal padding and source of the same elemental type");
3068   }
3069 
3070   return verifyPermutationMap(permutationMap,
3071                               [&](Twine t) { return emitOpError(t); });
3072 }
3073 
3074 /// This is a common class used for patterns of the form
3075 /// ```
3076 ///    someop(memrefcast) -> someop
3077 /// ```
3078 /// It folds the source of the memref.cast into the root operation directly.
3079 static LogicalResult foldMemRefCast(Operation *op) {
3080   bool folded = false;
3081   for (OpOperand &operand : op->getOpOperands()) {
3082     auto castOp = operand.get().getDefiningOp<memref::CastOp>();
3083     if (castOp && memref::CastOp::canFoldIntoConsumerOp(castOp)) {
3084       operand.set(castOp.getOperand());
3085       folded = true;
3086     }
3087   }
3088   return success(folded);
3089 }
3090 
3091 static LogicalResult foldTensorCast(Operation *op) {
3092   bool folded = false;
3093   for (OpOperand &operand : op->getOpOperands()) {
3094     auto castOp = operand.get().getDefiningOp<tensor::CastOp>();
3095     if (castOp && tensor::canFoldIntoConsumerOp(castOp)) {
3096       operand.set(castOp.getOperand());
3097       folded = true;
3098     }
3099   }
3100   return success(folded);
3101 }
3102 
3103 template <typename TransferOp>
3104 static bool isInBounds(TransferOp op, int64_t resultIdx, int64_t indicesIdx) {
3105   // TODO: support more aggressive createOrFold on:
3106   // `op.indices()[indicesIdx] + vectorType < dim(op.source(), indicesIdx)`
3107   if (op.getShapedType().isDynamicDim(indicesIdx))
3108     return false;
3109   Value index = op.getIndices()[indicesIdx];
3110   auto cstOp = index.getDefiningOp<arith::ConstantIndexOp>();
3111   if (!cstOp)
3112     return false;
3113 
3114   int64_t sourceSize = op.getShapedType().getDimSize(indicesIdx);
3115   int64_t vectorSize = op.getVectorType().getDimSize(resultIdx);
3116 
3117   return cstOp.value() + vectorSize <= sourceSize;
3118 }
3119 
3120 template <typename TransferOp>
3121 static LogicalResult foldTransferInBoundsAttribute(TransferOp op) {
3122   // TODO: support 0-d corner case.
3123   // TODO: Be less conservative.
3124   if (op.getTransferRank() == 0)
3125     return failure();
3126   AffineMap permutationMap = op.getPermutationMap();
3127   bool changed = false;
3128   SmallVector<bool, 4> newInBounds;
3129   newInBounds.reserve(op.getTransferRank());
3130   for (unsigned i = 0; i < op.getTransferRank(); ++i) {
3131     // Already marked as in-bounds, nothing to see here.
3132     if (op.isDimInBounds(i)) {
3133       newInBounds.push_back(true);
3134       continue;
3135     }
3136     // Currently out-of-bounds, check whether we can statically determine it is
3137     // inBounds.
3138     auto dimExpr = permutationMap.getResult(i).dyn_cast<AffineDimExpr>();
3139     assert(dimExpr && "Broadcast dims must be in-bounds");
3140     auto inBounds =
3141         isInBounds(op, /*resultIdx=*/i, /*indicesIdx=*/dimExpr.getPosition());
3142     newInBounds.push_back(inBounds);
3143     // We commit the pattern if it is "more inbounds".
3144     changed |= inBounds;
3145   }
3146   if (!changed)
3147     return failure();
3148   // OpBuilder is only used as a helper to build an I64ArrayAttr.
3149   OpBuilder b(op.getContext());
3150   op->setAttr(TransferOp::getInBoundsAttrStrName(),
3151               b.getBoolArrayAttr(newInBounds));
3152   return success();
3153 }
3154 
3155 ///  ```
3156 ///  %w0 = vector.transfer_write %v0, %arg0[%c1, %c0] {in_bounds = [true, true]}
3157 ///    : vector<1x4xf32>, tensor<4x4xf32>
3158 ///  %0 = vector.transfer_read %w0[%c1, %c0], %cf0 {in_bounds = [true, true]}
3159 ///    : tensor<4x4xf32>, vector<1x4xf32>
3160 ///  ```
3161 ///  -> Folds into
3162 ///  ```
3163 ///  %v0
3164 ///  ```
3165 static Value foldRAW(TransferReadOp readOp) {
3166   if (!readOp.getShapedType().isa<RankedTensorType>())
3167     return {};
3168   auto defWrite = readOp.getSource().getDefiningOp<vector::TransferWriteOp>();
3169   while (defWrite) {
3170     if (checkSameValueRAW(defWrite, readOp))
3171       return defWrite.getVector();
3172     if (!isDisjointTransferIndices(
3173             cast<VectorTransferOpInterface>(defWrite.getOperation()),
3174             cast<VectorTransferOpInterface>(readOp.getOperation())))
3175       break;
3176     defWrite = defWrite.getSource().getDefiningOp<vector::TransferWriteOp>();
3177   }
3178   return {};
3179 }
3180 
3181 OpFoldResult TransferReadOp::fold(ArrayRef<Attribute>) {
3182   if (Value vec = foldRAW(*this))
3183     return vec;
3184   /// transfer_read(memrefcast) -> transfer_read
3185   if (succeeded(foldTransferInBoundsAttribute(*this)))
3186     return getResult();
3187   if (succeeded(foldMemRefCast(*this)))
3188     return getResult();
3189   if (succeeded(foldTensorCast(*this)))
3190     return getResult();
3191   return OpFoldResult();
3192 }
3193 
3194 Optional<SmallVector<int64_t, 4>> TransferReadOp::getShapeForUnroll() {
3195   return llvm::to_vector<4>(getVectorType().getShape());
3196 }
3197 
3198 void TransferReadOp::getEffects(
3199     SmallVectorImpl<SideEffects::EffectInstance<MemoryEffects::Effect>>
3200         &effects) {
3201   if (getShapedType().isa<MemRefType>())
3202     effects.emplace_back(MemoryEffects::Read::get(), getSource(),
3203                          SideEffects::DefaultResource::get());
3204 }
3205 
3206 namespace {
3207 /// Fold transfer_reads of a tensor.extract_slice op. E.g.:
3208 ///
3209 /// ```
3210 /// %0 = tensor.extract_slice %t[%a, %b] [%c, %d] [1, 1]
3211 ///     : tensor<?x?xf32> to tensor<?x?xf32>
3212 /// %1 = vector.transfer_read %0[%e, %f], %cst {in_bounds = [true, true]}
3213 ///     : tensor<?x?xf32>, vector<4x5xf32>
3214 /// ```
3215 /// is rewritten to:
3216 /// ```
3217 /// %p0 = arith.addi %a, %e : index
3218 /// %p1 = arith.addi %b, %f : index
3219 /// %1 = vector.transfer_read %t[%p0, %p1], %cst {in_bounds = [true, true]}
3220 ///     : tensor<?x?xf32>, vector<4x5xf32>
3221 /// ```
3222 struct FoldExtractSliceIntoTransferRead
3223     : public OpRewritePattern<TransferReadOp> {
3224 public:
3225   using OpRewritePattern<TransferReadOp>::OpRewritePattern;
3226 
3227   LogicalResult matchAndRewrite(TransferReadOp xferOp,
3228                                 PatternRewriter &rewriter) const override {
3229     // TODO: support 0-d corner case.
3230     if (xferOp.getTransferRank() == 0)
3231       return failure();
3232     if (xferOp.hasOutOfBoundsDim())
3233       return failure();
3234     if (!xferOp.getPermutationMap().isIdentity())
3235       return failure();
3236     if (xferOp.getMask())
3237       return failure();
3238     auto extractOp = xferOp.getSource().getDefiningOp<tensor::ExtractSliceOp>();
3239     if (!extractOp)
3240       return failure();
3241     if (!extractOp.hasUnitStride())
3242       return failure();
3243 
3244     // Bail on illegal rank-reduction: we need to check that the rank-reduced
3245     // dims are exactly the leading dims. I.e. the following is illegal:
3246     // ```
3247     //    %0 = tensor.extract_slice %t[0,0,0][2,1,4][1,1,1] :
3248     //      tensor<2x1x4xf32> to tensor<2x4xf32>
3249     //    %1 = vector.transfer_read %0[0,0], %cst :
3250     //      tensor<2x4xf32>, vector<2x4xf32>
3251     // ```
3252     //
3253     // Cannot fold into:
3254     // ```
3255     //    %0 = vector.transfer_read %t[0,0,0], %cst :
3256     //      tensor<2x1x4xf32>, vector<2x4xf32>
3257     // ```
3258     // For this, check the trailing `vectorRank` dims of the extract_slice
3259     // result tensor match the trailing dims of the inferred result tensor.
3260     int64_t rankReduced =
3261         extractOp.getSourceType().getRank() - extractOp.getType().getRank();
3262     int64_t vectorRank = xferOp.getVectorType().getRank();
3263     RankedTensorType inferredDestTensorType =
3264         tensor::ExtractSliceOp::inferResultType(
3265             extractOp.getSourceType(), extractOp.getMixedOffsets(),
3266             extractOp.getMixedSizes(), extractOp.getMixedStrides());
3267     auto actualDestTensorShape = extractOp.getType().getShape();
3268     if (rankReduced > 0 &&
3269         actualDestTensorShape.take_back(vectorRank) !=
3270             inferredDestTensorType.getShape().take_back(vectorRank))
3271       return failure();
3272 
3273     SmallVector<Value> newIndices;
3274     // In case this is a rank-reducing ExtractSliceOp, copy rank-reduced
3275     // indices first.
3276     for (int64_t i = 0; i < rankReduced; ++i) {
3277       OpFoldResult offset = extractOp.getMixedOffsets()[i];
3278       newIndices.push_back(getValueOrCreateConstantIndexOp(
3279           rewriter, extractOp.getLoc(), offset));
3280     }
3281     for (const auto &it : llvm::enumerate(xferOp.getIndices())) {
3282       OpFoldResult offset =
3283           extractOp.getMixedOffsets()[it.index() + rankReduced];
3284       newIndices.push_back(rewriter.create<arith::AddIOp>(
3285           xferOp->getLoc(), it.value(),
3286           getValueOrCreateConstantIndexOp(rewriter, extractOp.getLoc(),
3287                                           offset)));
3288     }
3289     SmallVector<bool> inBounds(xferOp.getTransferRank(), true);
3290     rewriter.replaceOpWithNewOp<TransferReadOp>(
3291         xferOp, xferOp.getVectorType(), extractOp.getSource(), newIndices,
3292         xferOp.getPadding(), ArrayRef<bool>{inBounds});
3293 
3294     return success();
3295   }
3296 };
3297 } // namespace
3298 
3299 void TransferReadOp::getCanonicalizationPatterns(RewritePatternSet &results,
3300                                                  MLIRContext *context) {
3301   results.add<FoldExtractSliceIntoTransferRead>(context);
3302 }
3303 
3304 //===----------------------------------------------------------------------===//
3305 // TransferWriteOp
3306 //===----------------------------------------------------------------------===//
3307 
3308 /// 1. Builder with type inference.
3309 void TransferWriteOp::build(OpBuilder &builder, OperationState &result,
3310                             Value vector, Value dest, ValueRange indices,
3311                             AffineMapAttr permutationMapAttr,
3312                             /*optional*/ Value mask,
3313                             /*optional*/ ArrayAttr inBoundsAttr) {
3314   Type resultType = dest.getType().dyn_cast<RankedTensorType>();
3315   build(builder, result, resultType, vector, dest, indices, permutationMapAttr,
3316         mask, inBoundsAttr);
3317 }
3318 
3319 /// 2. Builder with type inference that sets an empty mask (variant with attrs).
3320 void TransferWriteOp::build(OpBuilder &builder, OperationState &result,
3321                             Value vector, Value dest, ValueRange indices,
3322                             AffineMapAttr permutationMapAttr,
3323                             /*optional*/ ArrayAttr inBoundsAttr) {
3324   build(builder, result, vector, dest, indices, permutationMapAttr,
3325         /*mask=*/Value(), inBoundsAttr);
3326 }
3327 
3328 /// 3. Builder with type inference that sets an empty mask (variant without
3329 /// attrs)
3330 void TransferWriteOp::build(OpBuilder &builder, OperationState &result,
3331                             Value vector, Value dest, ValueRange indices,
3332                             AffineMap permutationMap,
3333                             Optional<ArrayRef<bool>> inBounds) {
3334   auto permutationMapAttr = AffineMapAttr::get(permutationMap);
3335   auto inBoundsAttr = (inBounds && !inBounds.getValue().empty())
3336                           ? builder.getBoolArrayAttr(inBounds.getValue())
3337                           : ArrayAttr();
3338   build(builder, result, vector, dest, indices, permutationMapAttr,
3339         /*mask=*/Value(), inBoundsAttr);
3340 }
3341 
3342 /// 4. Builder with type inference that sets an empty mask and sets permutation
3343 ///    map to 'getMinorIdentityMap'.
3344 void TransferWriteOp::build(OpBuilder &builder, OperationState &result,
3345                             Value vector, Value dest, ValueRange indices,
3346                             Optional<ArrayRef<bool>> inBounds) {
3347   auto vectorType = vector.getType().cast<VectorType>();
3348   AffineMap permutationMap = getTransferMinorIdentityMap(
3349       dest.getType().cast<ShapedType>(), vectorType);
3350   build(builder, result, vector, dest, indices, permutationMap, inBounds);
3351 }
3352 
3353 ParseResult TransferWriteOp::parse(OpAsmParser &parser,
3354                                    OperationState &result) {
3355   auto &builder = parser.getBuilder();
3356   SMLoc typesLoc;
3357   OpAsmParser::UnresolvedOperand vectorInfo, sourceInfo;
3358   SmallVector<OpAsmParser::UnresolvedOperand, 8> indexInfo;
3359   SmallVector<Type, 2> types;
3360   OpAsmParser::UnresolvedOperand maskInfo;
3361   if (parser.parseOperand(vectorInfo) || parser.parseComma() ||
3362       parser.parseOperand(sourceInfo) ||
3363       parser.parseOperandList(indexInfo, OpAsmParser::Delimiter::Square))
3364     return failure();
3365   ParseResult hasMask = parser.parseOptionalComma();
3366   if (hasMask.succeeded() && parser.parseOperand(maskInfo))
3367     return failure();
3368   if (parser.parseOptionalAttrDict(result.attributes) ||
3369       parser.getCurrentLocation(&typesLoc) || parser.parseColonTypeList(types))
3370     return failure();
3371   if (types.size() != 2)
3372     return parser.emitError(typesLoc, "requires two types");
3373   auto indexType = builder.getIndexType();
3374   VectorType vectorType = types[0].dyn_cast<VectorType>();
3375   if (!vectorType)
3376     return parser.emitError(typesLoc, "requires vector type");
3377   ShapedType shapedType = types[1].dyn_cast<ShapedType>();
3378   if (!shapedType || !shapedType.isa<MemRefType, RankedTensorType>())
3379     return parser.emitError(typesLoc, "requires memref or ranked tensor type");
3380   auto permutationAttrName = TransferWriteOp::getPermutationMapAttrStrName();
3381   auto attr = result.attributes.get(permutationAttrName);
3382   if (!attr) {
3383     auto permMap = getTransferMinorIdentityMap(shapedType, vectorType);
3384     result.attributes.set(permutationAttrName, AffineMapAttr::get(permMap));
3385   }
3386   if (parser.resolveOperand(vectorInfo, vectorType, result.operands) ||
3387       parser.resolveOperand(sourceInfo, shapedType, result.operands) ||
3388       parser.resolveOperands(indexInfo, indexType, result.operands))
3389     return failure();
3390   if (hasMask.succeeded()) {
3391     if (shapedType.getElementType().dyn_cast<VectorType>())
3392       return parser.emitError(
3393           maskInfo.location, "does not support masks with vector element type");
3394     auto maskType = VectorType::get(vectorType.getShape(), builder.getI1Type());
3395     if (parser.resolveOperand(maskInfo, maskType, result.operands))
3396       return failure();
3397   }
3398   result.addAttribute(
3399       TransferWriteOp::getOperandSegmentSizeAttr(),
3400       builder.getI32VectorAttr({1, 1, static_cast<int32_t>(indexInfo.size()),
3401                                 static_cast<int32_t>(hasMask.succeeded())}));
3402   return failure(shapedType.isa<RankedTensorType>() &&
3403                  parser.addTypeToList(shapedType, result.types));
3404 }
3405 
3406 void TransferWriteOp::print(OpAsmPrinter &p) {
3407   p << " " << getVector() << ", " << getSource() << "[" << getIndices() << "]";
3408   if (getMask())
3409     p << ", " << getMask();
3410   printTransferAttrs(p, *this);
3411   p << " : " << getVectorType() << ", " << getShapedType();
3412 }
3413 
3414 LogicalResult TransferWriteOp::verify() {
3415   // Consistency of elemental types in shape and vector.
3416   ShapedType shapedType = getShapedType();
3417   VectorType vectorType = getVectorType();
3418   VectorType maskType = getMaskType();
3419   auto permutationMap = getPermutationMap();
3420 
3421   if (llvm::size(getIndices()) != shapedType.getRank())
3422     return emitOpError("requires ") << shapedType.getRank() << " indices";
3423 
3424   // We do not allow broadcast dimensions on TransferWriteOps for the moment,
3425   // as the semantics is unclear. This can be revisited later if necessary.
3426   if (hasBroadcastDim())
3427     return emitOpError("should not have broadcast dimensions");
3428 
3429   if (failed(verifyTransferOp(cast<VectorTransferOpInterface>(getOperation()),
3430                               shapedType, vectorType, maskType, permutationMap,
3431                               getInBounds() ? *getInBounds() : ArrayAttr())))
3432     return failure();
3433 
3434   return verifyPermutationMap(permutationMap,
3435                               [&](Twine t) { return emitOpError(t); });
3436 }
3437 
3438 /// Fold:
3439 /// ```
3440 ///    %t1 = ...
3441 ///    %v = vector.transfer_read %t0[%c0...], {in_bounds = [true...]} :
3442 ///      tensor<static_sizesxf32>, vector<static_sizesxf32>
3443 ///    %t2 = vector.transfer_write %v, %t1[%c0...] {in_bounds = [true...]} :
3444 ///      vector<static_sizesxf32>, tensor<static_sizesxf32>
3445 /// ```
3446 ///
3447 /// into:
3448 ///
3449 /// ```
3450 ///    %t0
3451 /// ```
3452 ///
3453 /// The producer of t1 may or may not be DCE'd depending on whether it is a
3454 /// block argument or has side effects.
3455 static LogicalResult foldReadInitWrite(TransferWriteOp write,
3456                                        ArrayRef<Attribute>,
3457                                        SmallVectorImpl<OpFoldResult> &results) {
3458   // TODO: support 0-d corner case.
3459   if (write.getTransferRank() == 0)
3460     return failure();
3461   auto rankedTensorType =
3462       write.getSource().getType().dyn_cast<RankedTensorType>();
3463   // If not operating on tensors, bail.
3464   if (!rankedTensorType)
3465     return failure();
3466   // If no read, bail.
3467   auto read = write.getVector().getDefiningOp<vector::TransferReadOp>();
3468   if (!read)
3469     return failure();
3470   // TODO: support 0-d corner case.
3471   if (read.getTransferRank() == 0)
3472     return failure();
3473   // For now, only accept minor identity. Future: composition is minor identity.
3474   if (!read.getPermutationMap().isMinorIdentity() ||
3475       !write.getPermutationMap().isMinorIdentity())
3476     return failure();
3477   // Bail on mismatching ranks.
3478   if (read.getTransferRank() != write.getTransferRank())
3479     return failure();
3480   // Bail on potential out-of-bounds accesses.
3481   if (read.hasOutOfBoundsDim() || write.hasOutOfBoundsDim())
3482     return failure();
3483   // Tensor types must be the same.
3484   if (read.getSource().getType() != rankedTensorType)
3485     return failure();
3486   // Vector types must be the same.
3487   if (read.getVectorType() != write.getVectorType())
3488     return failure();
3489   // Vector and Tensor shapes must match.
3490   if (read.getVectorType().getShape() != rankedTensorType.getShape())
3491     return failure();
3492   // If any index is nonzero.
3493   auto isNotConstantZero = [](Value v) {
3494     auto cstOp = v.getDefiningOp<arith::ConstantIndexOp>();
3495     return !cstOp || cstOp.value() != 0;
3496   };
3497   if (llvm::any_of(read.getIndices(), isNotConstantZero) ||
3498       llvm::any_of(write.getIndices(), isNotConstantZero))
3499     return failure();
3500   // Success.
3501   results.push_back(read.getSource());
3502   return success();
3503 }
3504 
3505 static bool checkSameValueWAR(vector::TransferReadOp read,
3506                               vector::TransferWriteOp write) {
3507   return read.getSource() == write.getSource() &&
3508          read.getIndices() == write.getIndices() &&
3509          read.getPermutationMap() == write.getPermutationMap() &&
3510          read.getVectorType() == write.getVectorType() && !read.getMask() &&
3511          !write.getMask();
3512 }
3513 /// Fold transfer_write write after read:
3514 /// ```
3515 ///    %t0 = ...
3516 ///    %v = vector.transfer_read %t0[%c0...] :
3517 ///      tensor<static_sizesxf32>, vector<static_sizesxf32>
3518 ///    %t1 = vector.transfer_write %v, %t0[%c0...] :
3519 ///      vector<static_sizesxf32>, tensor<static_sizesxf32>
3520 /// ```
3521 ///
3522 /// into:
3523 ///
3524 /// ```
3525 ///    %t0
3526 /// ```
3527 static LogicalResult foldWAR(TransferWriteOp write,
3528                              SmallVectorImpl<OpFoldResult> &results) {
3529   if (!write.getSource().getType().isa<RankedTensorType>())
3530     return failure();
3531   auto read = write.getVector().getDefiningOp<vector::TransferReadOp>();
3532   if (!read)
3533     return failure();
3534 
3535   if (!checkSameValueWAR(read, write))
3536     return failure();
3537   results.push_back(read.getSource());
3538   return success();
3539 }
3540 
3541 LogicalResult TransferWriteOp::fold(ArrayRef<Attribute> operands,
3542                                     SmallVectorImpl<OpFoldResult> &results) {
3543   if (succeeded(foldReadInitWrite(*this, operands, results)))
3544     return success();
3545   if (succeeded(foldWAR(*this, results)))
3546     return success();
3547   if (succeeded(foldTransferInBoundsAttribute(*this)))
3548     return success();
3549   return foldMemRefCast(*this);
3550 }
3551 
3552 Optional<SmallVector<int64_t, 4>> TransferWriteOp::getShapeForUnroll() {
3553   return llvm::to_vector<4>(getVectorType().getShape());
3554 }
3555 
3556 void TransferWriteOp::getEffects(
3557     SmallVectorImpl<SideEffects::EffectInstance<MemoryEffects::Effect>>
3558         &effects) {
3559   if (getShapedType().isa<MemRefType>())
3560     effects.emplace_back(MemoryEffects::Write::get(), getSource(),
3561                          SideEffects::DefaultResource::get());
3562 }
3563 
3564 namespace {
3565 /// Remove dead transfer write from the SSA chain so that it an be eliminated by
3566 /// DCE
3567 /// ```
3568 ///  %w0 = vector.transfer_write %v0, %arg0[%c1, %c0] {in_bounds = [true, true]}
3569 ///    : vector<1x4xf32>, tensor<4x4xf32>
3570 ///  %w1 = vector.transfer_write %v0, %w0[%c2, %c0] {in_bounds = [true, true]}
3571 ///    : vector<1x4xf32>, tensor<4x4xf32>
3572 ///  %w2 = vector.transfer_write %v1, %w1[%c1, %c0] {in_bounds = [true, true]}
3573 ///    : vector<1x4xf32>, tensor<4x4xf32>
3574 /// ```
3575 ///
3576 /// into:
3577 ///
3578 /// ```
3579 ///  %w0 = vector.transfer_write %v0, %arg0[%c1, %c0] {in_bounds = [true, true]}
3580 ///    : vector<1x4xf32>, tensor<4x4xf32>
3581 ///  %w1 = vector.transfer_write %v0, %arg0[%c2, %c0] {in_bounds = [true, true]}
3582 ///    : vector<1x4xf32>, tensor<4x4xf32>
3583 ///  %w2 = vector.transfer_write %v1, %w1[%c1, %c0] {in_bounds = [true, true]}
3584 ///    : vector<1x4xf32>, tensor<4x4xf32>
3585 /// ```
3586 ///
3587 /// `%w0 = vector.transfer_write` op will be removed by DCE if it doesn't have
3588 /// any other uses.
3589 class FoldWaw final : public OpRewritePattern<TransferWriteOp> {
3590 public:
3591   using OpRewritePattern<TransferWriteOp>::OpRewritePattern;
3592   LogicalResult matchAndRewrite(TransferWriteOp writeOp,
3593                                 PatternRewriter &rewriter) const override {
3594     if (!writeOp.getShapedType().isa<RankedTensorType>())
3595       return failure();
3596     vector::TransferWriteOp writeToModify = writeOp;
3597 
3598     auto defWrite =
3599         writeOp.getSource().getDefiningOp<vector::TransferWriteOp>();
3600     while (defWrite) {
3601       if (checkSameValueWAW(writeOp, defWrite)) {
3602         writeToModify.getSourceMutable().assign(defWrite.getSource());
3603         return success();
3604       }
3605       if (!isDisjointTransferIndices(
3606               cast<VectorTransferOpInterface>(defWrite.getOperation()),
3607               cast<VectorTransferOpInterface>(writeOp.getOperation())))
3608         break;
3609       // If the previous write op doesn't have any other use we an safely look
3610       // at the previous store to see if it can be removed.
3611       if (!defWrite->hasOneUse())
3612         break;
3613       writeToModify = defWrite;
3614       defWrite = defWrite.getSource().getDefiningOp<vector::TransferWriteOp>();
3615     }
3616     return failure();
3617   }
3618 };
3619 
3620 /// Fold tensor.insert_slice into vector.transfer_write if the transfer_write
3621 /// could directly write to the insert_slice's destination. E.g.:
3622 ///
3623 /// ```
3624 /// %0 = vector.transfer_write %v, %t1[%c0, %c0] {in_bounds = [true, true]}
3625 ///     : vector<4x5xf32>, tensor<4x5xf32>
3626 /// %1 = tensor.insert_slice %0 into %t2[%a, %b] [4, 5] [1, 1]
3627 ///     : tensor<4x5xf32> into tensor<?x?xf32>
3628 /// ```
3629 /// is rewritten to:
3630 /// ```
3631 /// %1 = vector.transfer_write %v, %t2[%a, %b] {in_bounds = [true, true]}
3632 ///     : vector<4x5xf32>, tensor<?x?xf32>
3633 /// ```
3634 struct FoldInsertSliceIntoTransferWrite
3635     : public OpRewritePattern<tensor::InsertSliceOp> {
3636 public:
3637   using OpRewritePattern<tensor::InsertSliceOp>::OpRewritePattern;
3638 
3639   LogicalResult matchAndRewrite(tensor::InsertSliceOp insertOp,
3640                                 PatternRewriter &rewriter) const override {
3641     if (!insertOp.hasUnitStride())
3642       return failure();
3643 
3644     auto xferOp = insertOp.getSource().getDefiningOp<TransferWriteOp>();
3645     if (!xferOp)
3646       return failure();
3647     // TODO: support 0-d corner case.
3648     if (xferOp.getTransferRank() == 0)
3649       return failure();
3650 
3651     if (xferOp.hasOutOfBoundsDim())
3652       return failure();
3653     if (xferOp.getVectorType().getRank() != xferOp.getShapedType().getRank())
3654       return failure();
3655     if (xferOp.getMask())
3656       return failure();
3657     // Fold only if the TransferWriteOp completely overwrites the `source` with
3658     // a vector. I.e., the result of the TransferWriteOp is a new tensor whose
3659     // content is the data of the vector.
3660     if (!llvm::equal(xferOp.getVectorType().getShape(),
3661                      xferOp.getShapedType().getShape()))
3662       return failure();
3663     if (!xferOp.getPermutationMap().isIdentity())
3664       return failure();
3665 
3666     // Bail on illegal rank-reduction: we need to check that the rank-reduced
3667     // dims are exactly the leading dims. I.e. the following is illegal:
3668     // ```
3669     //    %0 = vector.transfer_write %v, %t[0,0], %cst :
3670     //      vector<2x4xf32>, tensor<2x4xf32>
3671     //    %1 = tensor.insert_slice %0 into %tt[0,0,0][2,1,4][1,1,1] :
3672     //      tensor<2x4xf32> into tensor<2x1x4xf32>
3673     // ```
3674     //
3675     // Cannot fold into:
3676     // ```
3677     //    %0 = vector.transfer_write %v, %t[0,0,0], %cst :
3678     //      vector<2x4xf32>, tensor<2x1x4xf32>
3679     // ```
3680     // For this, check the trailing `vectorRank` dims of the insert_slice result
3681     // tensor match the trailing dims of the inferred result tensor.
3682     int64_t rankReduced =
3683         insertOp.getType().getRank() - insertOp.getSourceType().getRank();
3684     int64_t vectorRank = xferOp.getVectorType().getRank();
3685     RankedTensorType inferredSourceTensorType =
3686         tensor::ExtractSliceOp::inferResultType(
3687             insertOp.getType(), insertOp.getMixedOffsets(),
3688             insertOp.getMixedSizes(), insertOp.getMixedStrides());
3689     auto actualSourceTensorShape = insertOp.getSourceType().getShape();
3690     if (rankReduced > 0 &&
3691         actualSourceTensorShape.take_back(vectorRank) !=
3692             inferredSourceTensorType.getShape().take_back(vectorRank))
3693       return failure();
3694 
3695     SmallVector<Value> indices = getValueOrCreateConstantIndexOp(
3696         rewriter, insertOp.getLoc(), insertOp.getMixedOffsets());
3697     SmallVector<bool> inBounds(xferOp.getTransferRank(), true);
3698     rewriter.replaceOpWithNewOp<TransferWriteOp>(insertOp, xferOp.getVector(),
3699                                                  insertOp.getDest(), indices,
3700                                                  ArrayRef<bool>{inBounds});
3701     return success();
3702   }
3703 };
3704 
3705 /// Rewrite tensor::ExtractSliceOp(vector::TransferWriteOp) to
3706 /// vector::TransferWriteOp(tensor::ExtractSliceOp) if the full slice is
3707 /// overwritten and inserted into another tensor. After this rewrite, the
3708 /// operations bufferize in-place since all of them work on the same slice.
3709 ///
3710 /// For example:
3711 /// ```mlir
3712 ///   %0 = vector.transfer_write %vec, %init_tensor[%c0, %c0]
3713 ///        : vector<8x16xf32>, tensor<8x16xf32>
3714 ///   %1 = tensor.extract_slice %0[0, 0] [%sz0, %sz1] [1, 1]
3715 ///        : tensor<8x16xf32> to tensor<?x?xf32>
3716 ///   %r = tensor.insert_slice %1 into %iter_arg[%iv0, %iv1] [%sz0, %sz1] [1, 1]
3717 ///        : tensor<?x?xf32> into tensor<27x37xf32>
3718 /// ```
3719 /// folds to
3720 /// ```mlir
3721 ///   %0 = tensor.extract_slice %iter_arg[%iv0, %iv1] [%sz0, %sz1] [1, 1]
3722 ///        : tensor<27x37xf32> to tensor<?x?xf32>
3723 ///   %1 = vector.transfer_write %vec, %0[%c0, %c0]
3724 ///        : vector<8x16xf32>, tensor<?x?xf32>
3725 ///   %r = tensor.insert_slice %1 into %iter_arg[%iv0, %iv1] [%sz0, %sz1] [1, 1]
3726 ///        : tensor<?x?xf32> into tensor<27x37xf32>
3727 /// ```
3728 struct SwapExtractSliceOfTransferWrite
3729     : public OpRewritePattern<tensor::InsertSliceOp> {
3730 public:
3731   using OpRewritePattern<tensor::InsertSliceOp>::OpRewritePattern;
3732 
3733   LogicalResult matchAndRewrite(tensor::InsertSliceOp insertOp,
3734                                 PatternRewriter &rewriter) const override {
3735     if (!insertOp.hasUnitStride())
3736       return failure();
3737     auto extractOp =
3738         insertOp.getSource().getDefiningOp<tensor::ExtractSliceOp>();
3739     if (!extractOp || !extractOp.hasUnitStride() || !extractOp->hasOneUse())
3740       return failure();
3741     auto transferOp = extractOp.getSource().getDefiningOp<TransferWriteOp>();
3742     if (!transferOp || !transferOp->hasOneUse())
3743       return failure();
3744 
3745     // Fail if vector::TransferWriteOp or tensor::ExtractSliceOp is
3746     // rank-reducing.
3747     if (insertOp.getSourceType().getRank() != transferOp.getTransferRank()) {
3748       return rewriter.notifyMatchFailure(insertOp,
3749                                          "use-def chain is rank-reducing");
3750     }
3751 
3752     // Fail if tensor::ExtractSliceOp has non-zero offset.
3753     if (!extractOp.hasZeroOffset()) {
3754       return rewriter.notifyMatchFailure(insertOp,
3755                                          "ExtractSliceOp has non-zero offset");
3756     }
3757 
3758     // Fail if tensor::TransferWriteOp has non-zero offset.
3759     if (!llvm::all_of(transferOp.getIndices(), [](Value value) {
3760           return getConstantIntValue(value) == static_cast<int64_t>(0);
3761         })) {
3762       return rewriter.notifyMatchFailure(insertOp,
3763                                          "TranferWriteOp has non-zero offset");
3764     }
3765 
3766     // Fail if tensor::ExtractSliceOp and tensor::InsertSliceOp sizes differ.
3767     for (const auto &it :
3768          llvm::zip(insertOp.getMixedSizes(), extractOp.getMixedSizes())) {
3769       if (!isEqualConstantIntOrValue(std::get<0>(it), std::get<1>(it))) {
3770         return rewriter.notifyMatchFailure(
3771             insertOp, "InsertSliceOp and ExtractSliceOp sizes differ");
3772       }
3773     }
3774 
3775     // Fail if the vector::TransferWriteOp may not overwrite the full tensor.
3776     assert(transferOp.getVectorType().hasStaticShape() &&
3777            "expected vector to have a static shape");
3778     ArrayRef<int64_t> vectorShape = transferOp.getVectorType().getShape();
3779     SmallVector<int64_t> resultShape = applyPermutationMap(
3780         transferOp.getPermutationMap(), transferOp.getShapedType().getShape());
3781     if (transferOp.getMask() || !vectorShape.equals(resultShape)) {
3782       return rewriter.notifyMatchFailure(
3783           insertOp, "TransferWriteOp may not write the full tensor.");
3784     }
3785 
3786     // Swap the tensor::ExtractSliceOp in front of the vector::TransferWriteOp.
3787     SmallVector<int64_t> newResultShape = applyPermutationMap(
3788         transferOp.getPermutationMap(), insertOp.getSourceType().getShape());
3789     SmallVector<bool> newInBounds;
3790     for (const auto &en : enumerate(newResultShape))
3791       newInBounds.push_back(en.value() == vectorShape[en.index()]);
3792     auto newExtractOp = rewriter.create<tensor::ExtractSliceOp>(
3793         extractOp.getLoc(), insertOp.getSourceType(), insertOp.getDest(),
3794         insertOp.getMixedOffsets(), insertOp.getMixedSizes(),
3795         insertOp.getMixedStrides());
3796     auto newTransferWriteOp = rewriter.create<TransferWriteOp>(
3797         transferOp.getLoc(), transferOp.getVector(), newExtractOp.getResult(),
3798         transferOp.getIndices(), transferOp.getPermutationMapAttr(),
3799         rewriter.getBoolArrayAttr(newInBounds));
3800     rewriter.updateRootInPlace(insertOp, [&]() {
3801       insertOp.getSourceMutable().assign(newTransferWriteOp.getResult());
3802     });
3803     return success();
3804   }
3805 };
3806 
3807 } // namespace
3808 
3809 void TransferWriteOp::getCanonicalizationPatterns(RewritePatternSet &results,
3810                                                   MLIRContext *context) {
3811   results.add<FoldWaw, FoldInsertSliceIntoTransferWrite,
3812               SwapExtractSliceOfTransferWrite>(context);
3813 }
3814 
3815 //===----------------------------------------------------------------------===//
3816 // LoadOp
3817 //===----------------------------------------------------------------------===//
3818 
3819 static LogicalResult verifyLoadStoreMemRefLayout(Operation *op,
3820                                                  MemRefType memRefTy) {
3821   if (!isLastMemrefDimUnitStride(memRefTy))
3822     return op->emitOpError("most minor memref dim must have unit stride");
3823   return success();
3824 }
3825 
3826 LogicalResult vector::LoadOp::verify() {
3827   VectorType resVecTy = getVectorType();
3828   MemRefType memRefTy = getMemRefType();
3829 
3830   if (failed(verifyLoadStoreMemRefLayout(*this, memRefTy)))
3831     return failure();
3832 
3833   // Checks for vector memrefs.
3834   Type memElemTy = memRefTy.getElementType();
3835   if (auto memVecTy = memElemTy.dyn_cast<VectorType>()) {
3836     if (memVecTy != resVecTy)
3837       return emitOpError("base memref and result vector types should match");
3838     memElemTy = memVecTy.getElementType();
3839   }
3840 
3841   if (resVecTy.getElementType() != memElemTy)
3842     return emitOpError("base and result element types should match");
3843   if (llvm::size(getIndices()) != memRefTy.getRank())
3844     return emitOpError("requires ") << memRefTy.getRank() << " indices";
3845   return success();
3846 }
3847 
3848 OpFoldResult LoadOp::fold(ArrayRef<Attribute>) {
3849   if (succeeded(foldMemRefCast(*this)))
3850     return getResult();
3851   return OpFoldResult();
3852 }
3853 
3854 //===----------------------------------------------------------------------===//
3855 // StoreOp
3856 //===----------------------------------------------------------------------===//
3857 
3858 LogicalResult vector::StoreOp::verify() {
3859   VectorType valueVecTy = getVectorType();
3860   MemRefType memRefTy = getMemRefType();
3861 
3862   if (failed(verifyLoadStoreMemRefLayout(*this, memRefTy)))
3863     return failure();
3864 
3865   // Checks for vector memrefs.
3866   Type memElemTy = memRefTy.getElementType();
3867   if (auto memVecTy = memElemTy.dyn_cast<VectorType>()) {
3868     if (memVecTy != valueVecTy)
3869       return emitOpError(
3870           "base memref and valueToStore vector types should match");
3871     memElemTy = memVecTy.getElementType();
3872   }
3873 
3874   if (valueVecTy.getElementType() != memElemTy)
3875     return emitOpError("base and valueToStore element type should match");
3876   if (llvm::size(getIndices()) != memRefTy.getRank())
3877     return emitOpError("requires ") << memRefTy.getRank() << " indices";
3878   return success();
3879 }
3880 
3881 LogicalResult StoreOp::fold(ArrayRef<Attribute> operands,
3882                             SmallVectorImpl<OpFoldResult> &results) {
3883   return foldMemRefCast(*this);
3884 }
3885 
3886 //===----------------------------------------------------------------------===//
3887 // MaskedLoadOp
3888 //===----------------------------------------------------------------------===//
3889 
3890 LogicalResult MaskedLoadOp::verify() {
3891   VectorType maskVType = getMaskVectorType();
3892   VectorType passVType = getPassThruVectorType();
3893   VectorType resVType = getVectorType();
3894   MemRefType memType = getMemRefType();
3895 
3896   if (resVType.getElementType() != memType.getElementType())
3897     return emitOpError("base and result element type should match");
3898   if (llvm::size(getIndices()) != memType.getRank())
3899     return emitOpError("requires ") << memType.getRank() << " indices";
3900   if (resVType.getDimSize(0) != maskVType.getDimSize(0))
3901     return emitOpError("expected result dim to match mask dim");
3902   if (resVType != passVType)
3903     return emitOpError("expected pass_thru of same type as result type");
3904   return success();
3905 }
3906 
3907 namespace {
3908 class MaskedLoadFolder final : public OpRewritePattern<MaskedLoadOp> {
3909 public:
3910   using OpRewritePattern<MaskedLoadOp>::OpRewritePattern;
3911   LogicalResult matchAndRewrite(MaskedLoadOp load,
3912                                 PatternRewriter &rewriter) const override {
3913     switch (get1DMaskFormat(load.getMask())) {
3914     case MaskFormat::AllTrue:
3915       rewriter.replaceOpWithNewOp<vector::LoadOp>(
3916           load, load.getType(), load.getBase(), load.getIndices());
3917       return success();
3918     case MaskFormat::AllFalse:
3919       rewriter.replaceOp(load, load.getPassThru());
3920       return success();
3921     case MaskFormat::Unknown:
3922       return failure();
3923     }
3924     llvm_unreachable("Unexpected 1DMaskFormat on MaskedLoad");
3925   }
3926 };
3927 } // namespace
3928 
3929 void MaskedLoadOp::getCanonicalizationPatterns(RewritePatternSet &results,
3930                                                MLIRContext *context) {
3931   results.add<MaskedLoadFolder>(context);
3932 }
3933 
3934 OpFoldResult MaskedLoadOp::fold(ArrayRef<Attribute>) {
3935   if (succeeded(foldMemRefCast(*this)))
3936     return getResult();
3937   return OpFoldResult();
3938 }
3939 
3940 //===----------------------------------------------------------------------===//
3941 // MaskedStoreOp
3942 //===----------------------------------------------------------------------===//
3943 
3944 LogicalResult MaskedStoreOp::verify() {
3945   VectorType maskVType = getMaskVectorType();
3946   VectorType valueVType = getVectorType();
3947   MemRefType memType = getMemRefType();
3948 
3949   if (valueVType.getElementType() != memType.getElementType())
3950     return emitOpError("base and valueToStore element type should match");
3951   if (llvm::size(getIndices()) != memType.getRank())
3952     return emitOpError("requires ") << memType.getRank() << " indices";
3953   if (valueVType.getDimSize(0) != maskVType.getDimSize(0))
3954     return emitOpError("expected valueToStore dim to match mask dim");
3955   return success();
3956 }
3957 
3958 namespace {
3959 class MaskedStoreFolder final : public OpRewritePattern<MaskedStoreOp> {
3960 public:
3961   using OpRewritePattern<MaskedStoreOp>::OpRewritePattern;
3962   LogicalResult matchAndRewrite(MaskedStoreOp store,
3963                                 PatternRewriter &rewriter) const override {
3964     switch (get1DMaskFormat(store.getMask())) {
3965     case MaskFormat::AllTrue:
3966       rewriter.replaceOpWithNewOp<vector::StoreOp>(
3967           store, store.getValueToStore(), store.getBase(), store.getIndices());
3968       return success();
3969     case MaskFormat::AllFalse:
3970       rewriter.eraseOp(store);
3971       return success();
3972     case MaskFormat::Unknown:
3973       return failure();
3974     }
3975     llvm_unreachable("Unexpected 1DMaskFormat on MaskedStore");
3976   }
3977 };
3978 } // namespace
3979 
3980 void MaskedStoreOp::getCanonicalizationPatterns(RewritePatternSet &results,
3981                                                 MLIRContext *context) {
3982   results.add<MaskedStoreFolder>(context);
3983 }
3984 
3985 LogicalResult MaskedStoreOp::fold(ArrayRef<Attribute> operands,
3986                                   SmallVectorImpl<OpFoldResult> &results) {
3987   return foldMemRefCast(*this);
3988 }
3989 
3990 //===----------------------------------------------------------------------===//
3991 // GatherOp
3992 //===----------------------------------------------------------------------===//
3993 
3994 LogicalResult GatherOp::verify() {
3995   VectorType indVType = getIndexVectorType();
3996   VectorType maskVType = getMaskVectorType();
3997   VectorType resVType = getVectorType();
3998   MemRefType memType = getMemRefType();
3999 
4000   if (resVType.getElementType() != memType.getElementType())
4001     return emitOpError("base and result element type should match");
4002   if (llvm::size(getIndices()) != memType.getRank())
4003     return emitOpError("requires ") << memType.getRank() << " indices";
4004   if (resVType.getDimSize(0) != indVType.getDimSize(0))
4005     return emitOpError("expected result dim to match indices dim");
4006   if (resVType.getDimSize(0) != maskVType.getDimSize(0))
4007     return emitOpError("expected result dim to match mask dim");
4008   if (resVType != getPassThruVectorType())
4009     return emitOpError("expected pass_thru of same type as result type");
4010   return success();
4011 }
4012 
4013 namespace {
4014 class GatherFolder final : public OpRewritePattern<GatherOp> {
4015 public:
4016   using OpRewritePattern<GatherOp>::OpRewritePattern;
4017   LogicalResult matchAndRewrite(GatherOp gather,
4018                                 PatternRewriter &rewriter) const override {
4019     switch (get1DMaskFormat(gather.getMask())) {
4020     case MaskFormat::AllTrue:
4021       return failure(); // no unmasked equivalent
4022     case MaskFormat::AllFalse:
4023       rewriter.replaceOp(gather, gather.getPassThru());
4024       return success();
4025     case MaskFormat::Unknown:
4026       return failure();
4027     }
4028     llvm_unreachable("Unexpected 1DMaskFormat on GatherFolder");
4029   }
4030 };
4031 } // namespace
4032 
4033 void GatherOp::getCanonicalizationPatterns(RewritePatternSet &results,
4034                                            MLIRContext *context) {
4035   results.add<GatherFolder>(context);
4036 }
4037 
4038 //===----------------------------------------------------------------------===//
4039 // ScatterOp
4040 //===----------------------------------------------------------------------===//
4041 
4042 LogicalResult ScatterOp::verify() {
4043   VectorType indVType = getIndexVectorType();
4044   VectorType maskVType = getMaskVectorType();
4045   VectorType valueVType = getVectorType();
4046   MemRefType memType = getMemRefType();
4047 
4048   if (valueVType.getElementType() != memType.getElementType())
4049     return emitOpError("base and valueToStore element type should match");
4050   if (llvm::size(getIndices()) != memType.getRank())
4051     return emitOpError("requires ") << memType.getRank() << " indices";
4052   if (valueVType.getDimSize(0) != indVType.getDimSize(0))
4053     return emitOpError("expected valueToStore dim to match indices dim");
4054   if (valueVType.getDimSize(0) != maskVType.getDimSize(0))
4055     return emitOpError("expected valueToStore dim to match mask dim");
4056   return success();
4057 }
4058 
4059 namespace {
4060 class ScatterFolder final : public OpRewritePattern<ScatterOp> {
4061 public:
4062   using OpRewritePattern<ScatterOp>::OpRewritePattern;
4063   LogicalResult matchAndRewrite(ScatterOp scatter,
4064                                 PatternRewriter &rewriter) const override {
4065     switch (get1DMaskFormat(scatter.getMask())) {
4066     case MaskFormat::AllTrue:
4067       return failure(); // no unmasked equivalent
4068     case MaskFormat::AllFalse:
4069       rewriter.eraseOp(scatter);
4070       return success();
4071     case MaskFormat::Unknown:
4072       return failure();
4073     }
4074     llvm_unreachable("Unexpected 1DMaskFormat on ScatterFolder");
4075   }
4076 };
4077 } // namespace
4078 
4079 void ScatterOp::getCanonicalizationPatterns(RewritePatternSet &results,
4080                                             MLIRContext *context) {
4081   results.add<ScatterFolder>(context);
4082 }
4083 
4084 //===----------------------------------------------------------------------===//
4085 // ExpandLoadOp
4086 //===----------------------------------------------------------------------===//
4087 
4088 LogicalResult ExpandLoadOp::verify() {
4089   VectorType maskVType = getMaskVectorType();
4090   VectorType passVType = getPassThruVectorType();
4091   VectorType resVType = getVectorType();
4092   MemRefType memType = getMemRefType();
4093 
4094   if (resVType.getElementType() != memType.getElementType())
4095     return emitOpError("base and result element type should match");
4096   if (llvm::size(getIndices()) != memType.getRank())
4097     return emitOpError("requires ") << memType.getRank() << " indices";
4098   if (resVType.getDimSize(0) != maskVType.getDimSize(0))
4099     return emitOpError("expected result dim to match mask dim");
4100   if (resVType != passVType)
4101     return emitOpError("expected pass_thru of same type as result type");
4102   return success();
4103 }
4104 
4105 namespace {
4106 class ExpandLoadFolder final : public OpRewritePattern<ExpandLoadOp> {
4107 public:
4108   using OpRewritePattern<ExpandLoadOp>::OpRewritePattern;
4109   LogicalResult matchAndRewrite(ExpandLoadOp expand,
4110                                 PatternRewriter &rewriter) const override {
4111     switch (get1DMaskFormat(expand.getMask())) {
4112     case MaskFormat::AllTrue:
4113       rewriter.replaceOpWithNewOp<vector::LoadOp>(
4114           expand, expand.getType(), expand.getBase(), expand.getIndices());
4115       return success();
4116     case MaskFormat::AllFalse:
4117       rewriter.replaceOp(expand, expand.getPassThru());
4118       return success();
4119     case MaskFormat::Unknown:
4120       return failure();
4121     }
4122     llvm_unreachable("Unexpected 1DMaskFormat on ExpandLoadFolder");
4123   }
4124 };
4125 } // namespace
4126 
4127 void ExpandLoadOp::getCanonicalizationPatterns(RewritePatternSet &results,
4128                                                MLIRContext *context) {
4129   results.add<ExpandLoadFolder>(context);
4130 }
4131 
4132 //===----------------------------------------------------------------------===//
4133 // CompressStoreOp
4134 //===----------------------------------------------------------------------===//
4135 
4136 LogicalResult CompressStoreOp::verify() {
4137   VectorType maskVType = getMaskVectorType();
4138   VectorType valueVType = getVectorType();
4139   MemRefType memType = getMemRefType();
4140 
4141   if (valueVType.getElementType() != memType.getElementType())
4142     return emitOpError("base and valueToStore element type should match");
4143   if (llvm::size(getIndices()) != memType.getRank())
4144     return emitOpError("requires ") << memType.getRank() << " indices";
4145   if (valueVType.getDimSize(0) != maskVType.getDimSize(0))
4146     return emitOpError("expected valueToStore dim to match mask dim");
4147   return success();
4148 }
4149 
4150 namespace {
4151 class CompressStoreFolder final : public OpRewritePattern<CompressStoreOp> {
4152 public:
4153   using OpRewritePattern<CompressStoreOp>::OpRewritePattern;
4154   LogicalResult matchAndRewrite(CompressStoreOp compress,
4155                                 PatternRewriter &rewriter) const override {
4156     switch (get1DMaskFormat(compress.getMask())) {
4157     case MaskFormat::AllTrue:
4158       rewriter.replaceOpWithNewOp<vector::StoreOp>(
4159           compress, compress.getValueToStore(), compress.getBase(),
4160           compress.getIndices());
4161       return success();
4162     case MaskFormat::AllFalse:
4163       rewriter.eraseOp(compress);
4164       return success();
4165     case MaskFormat::Unknown:
4166       return failure();
4167     }
4168     llvm_unreachable("Unexpected 1DMaskFormat on CompressStoreFolder");
4169   }
4170 };
4171 } // namespace
4172 
4173 void CompressStoreOp::getCanonicalizationPatterns(RewritePatternSet &results,
4174                                                   MLIRContext *context) {
4175   results.add<CompressStoreFolder>(context);
4176 }
4177 
4178 //===----------------------------------------------------------------------===//
4179 // ShapeCastOp
4180 //===----------------------------------------------------------------------===//
4181 
4182 /// Returns true if each element of 'a' is equal to the product of a contiguous
4183 /// sequence of the elements of 'b'. Returns false otherwise.
4184 static bool isValidShapeCast(ArrayRef<int64_t> a, ArrayRef<int64_t> b) {
4185   unsigned rankA = a.size();
4186   unsigned rankB = b.size();
4187   assert(rankA < rankB);
4188 
4189   unsigned i = 0;
4190   unsigned j = 0;
4191   while (i < rankA && j < rankB) {
4192     int64_t dimA = a[i];
4193     int64_t dimB = 1;
4194     while (dimB < dimA && j < rankB)
4195       dimB *= b[j++];
4196     if (dimA != dimB)
4197       break;
4198     ++i;
4199 
4200     // Handle the case when trailing dimensions are of size 1.
4201     // Include them into the contiguous sequence.
4202     auto isOne = [](int64_t v) { return v == 1; };
4203     if (i < rankA && llvm::all_of(a.slice(i), isOne))
4204       i = rankA;
4205     if (j < rankB && llvm::all_of(b.slice(j), isOne))
4206       j = rankB;
4207   }
4208 
4209   return i == rankA && j == rankB;
4210 }
4211 
4212 static LogicalResult verifyVectorShapeCast(Operation *op,
4213                                            VectorType sourceVectorType,
4214                                            VectorType resultVectorType) {
4215   // Check that element type is the same.
4216   if (sourceVectorType.getElementType() != resultVectorType.getElementType())
4217     return op->emitOpError("source/result vectors must have same element type");
4218   auto sourceShape = sourceVectorType.getShape();
4219   auto resultShape = resultVectorType.getShape();
4220 
4221   // Check that product of source dim sizes matches product of result dim sizes.
4222   int64_t sourceDimProduct = std::accumulate(
4223       sourceShape.begin(), sourceShape.end(), 1LL, std::multiplies<int64_t>{});
4224   int64_t resultDimProduct = std::accumulate(
4225       resultShape.begin(), resultShape.end(), 1LL, std::multiplies<int64_t>{});
4226   if (sourceDimProduct != resultDimProduct)
4227     return op->emitOpError("source/result number of elements must match");
4228 
4229   // Check that expanding/contracting rank cases.
4230   unsigned sourceRank = sourceVectorType.getRank();
4231   unsigned resultRank = resultVectorType.getRank();
4232   if (sourceRank < resultRank) {
4233     if (!isValidShapeCast(sourceShape, resultShape))
4234       return op->emitOpError("invalid shape cast");
4235   } else if (sourceRank > resultRank) {
4236     if (!isValidShapeCast(resultShape, sourceShape))
4237       return op->emitOpError("invalid shape cast");
4238   }
4239   return success();
4240 }
4241 
4242 LogicalResult ShapeCastOp::verify() {
4243   auto sourceVectorType = getSource().getType().dyn_cast_or_null<VectorType>();
4244   auto resultVectorType = getResult().getType().dyn_cast_or_null<VectorType>();
4245 
4246   // Check if source/result are of vector type.
4247   if (sourceVectorType && resultVectorType)
4248     return verifyVectorShapeCast(*this, sourceVectorType, resultVectorType);
4249 
4250   return success();
4251 }
4252 
4253 OpFoldResult ShapeCastOp::fold(ArrayRef<Attribute> operands) {
4254   // No-op shape cast.
4255   if (getSource().getType() == getResult().getType())
4256     return getSource();
4257 
4258   // Canceling shape casts.
4259   if (auto otherOp = getSource().getDefiningOp<ShapeCastOp>()) {
4260     if (getResult().getType() == otherOp.getSource().getType())
4261       return otherOp.getSource();
4262 
4263     // Only allows valid transitive folding.
4264     VectorType srcType = otherOp.getSource().getType().cast<VectorType>();
4265     VectorType resultType = getResult().getType().cast<VectorType>();
4266     if (srcType.getRank() < resultType.getRank()) {
4267       if (!isValidShapeCast(srcType.getShape(), resultType.getShape()))
4268         return {};
4269     } else if (srcType.getRank() > resultType.getRank()) {
4270       if (!isValidShapeCast(resultType.getShape(), srcType.getShape()))
4271         return {};
4272     } else {
4273       return {};
4274     }
4275 
4276     setOperand(otherOp.getSource());
4277     return getResult();
4278   }
4279 
4280   // Cancelling broadcast and shape cast ops.
4281   if (auto bcastOp = getSource().getDefiningOp<BroadcastOp>()) {
4282     if (bcastOp.getSourceType() == getType())
4283       return bcastOp.getSource();
4284   }
4285 
4286   return {};
4287 }
4288 
4289 namespace {
4290 // Pattern to rewrite a ShapeCast(splat ConstantOp) -> ConstantOp.
4291 class ShapeCastConstantFolder final : public OpRewritePattern<ShapeCastOp> {
4292 public:
4293   using OpRewritePattern<ShapeCastOp>::OpRewritePattern;
4294 
4295   LogicalResult matchAndRewrite(ShapeCastOp shapeCastOp,
4296                                 PatternRewriter &rewriter) const override {
4297     auto constantOp =
4298         shapeCastOp.getSource().getDefiningOp<arith::ConstantOp>();
4299     if (!constantOp)
4300       return failure();
4301     // Only handle splat for now.
4302     auto dense = constantOp.getValue().dyn_cast<SplatElementsAttr>();
4303     if (!dense)
4304       return failure();
4305     auto newAttr =
4306         DenseElementsAttr::get(shapeCastOp.getType().cast<VectorType>(),
4307                                dense.getSplatValue<Attribute>());
4308     rewriter.replaceOpWithNewOp<arith::ConstantOp>(shapeCastOp, newAttr);
4309     return success();
4310   }
4311 };
4312 
4313 /// Pattern to rewrite a ShapeCast(Broadcast) -> Broadcast.
4314 /// This only applies when the shape of the broadcast source is a suffix of the
4315 /// shape of the result (i.e. when broadcast without reshape is expressive
4316 /// enough to capture the result in a single op).
4317 class ShapeCastBroadcastFolder final : public OpRewritePattern<ShapeCastOp> {
4318 public:
4319   using OpRewritePattern<ShapeCastOp>::OpRewritePattern;
4320 
4321   LogicalResult matchAndRewrite(ShapeCastOp shapeCastOp,
4322                                 PatternRewriter &rewriter) const override {
4323     auto broadcastOp =
4324         shapeCastOp.getSource().getDefiningOp<vector::BroadcastOp>();
4325     if (!broadcastOp)
4326       return failure();
4327 
4328     auto broadcastSourceVectorType =
4329         broadcastOp.getSourceType().dyn_cast<VectorType>();
4330     auto broadcastSourceShape = broadcastSourceVectorType
4331                                     ? broadcastSourceVectorType.getShape()
4332                                     : ArrayRef<int64_t>{};
4333     auto shapeCastTargetShape = shapeCastOp.getResultVectorType().getShape();
4334 
4335     // Bail if `broadcastSourceShape` is not a suffix of the result.
4336     bool isSuffix = (broadcastSourceShape == shapeCastTargetShape.take_back(
4337                                                  broadcastSourceShape.size()));
4338     if (!isSuffix)
4339       return failure();
4340 
4341     rewriter.replaceOpWithNewOp<vector::BroadcastOp>(
4342         shapeCastOp, shapeCastOp.getResultVectorType(),
4343         broadcastOp.getSource());
4344     return success();
4345   }
4346 };
4347 
4348 } // namespace
4349 
4350 void ShapeCastOp::getCanonicalizationPatterns(RewritePatternSet &results,
4351                                               MLIRContext *context) {
4352   results.add<ShapeCastConstantFolder, ShapeCastBroadcastFolder>(context);
4353 }
4354 
4355 //===----------------------------------------------------------------------===//
4356 // VectorBitCastOp
4357 //===----------------------------------------------------------------------===//
4358 
4359 LogicalResult BitCastOp::verify() {
4360   auto sourceVectorType = getSourceVectorType();
4361   auto resultVectorType = getResultVectorType();
4362 
4363   for (int64_t i = 0, e = sourceVectorType.getRank() - 1; i < e; i++) {
4364     if (sourceVectorType.getDimSize(i) != resultVectorType.getDimSize(i))
4365       return emitOpError("dimension size mismatch at: ") << i;
4366   }
4367 
4368   DataLayout dataLayout = DataLayout::closest(*this);
4369   auto sourceElementBits =
4370       dataLayout.getTypeSizeInBits(sourceVectorType.getElementType());
4371   auto resultElementBits =
4372       dataLayout.getTypeSizeInBits(resultVectorType.getElementType());
4373 
4374   if (sourceVectorType.getRank() == 0) {
4375     if (sourceElementBits != resultElementBits)
4376       return emitOpError("source/result bitwidth of the 0-D vector element "
4377                          "types must be equal");
4378   } else if (sourceElementBits * sourceVectorType.getShape().back() !=
4379              resultElementBits * resultVectorType.getShape().back()) {
4380     return emitOpError(
4381         "source/result bitwidth of the minor 1-D vectors must be equal");
4382   }
4383 
4384   return success();
4385 }
4386 
4387 OpFoldResult BitCastOp::fold(ArrayRef<Attribute> operands) {
4388   // Nop cast.
4389   if (getSource().getType() == getResult().getType())
4390     return getSource();
4391 
4392   // Canceling bitcasts.
4393   if (auto otherOp = getSource().getDefiningOp<BitCastOp>()) {
4394     if (getResult().getType() == otherOp.getSource().getType())
4395       return otherOp.getSource();
4396 
4397     setOperand(otherOp.getSource());
4398     return getResult();
4399   }
4400 
4401   Attribute sourceConstant = operands.front();
4402   if (!sourceConstant)
4403     return {};
4404 
4405   Type srcElemType = getSourceVectorType().getElementType();
4406   Type dstElemType = getResultVectorType().getElementType();
4407 
4408   if (auto floatPack = sourceConstant.dyn_cast<DenseFPElementsAttr>()) {
4409     if (floatPack.isSplat()) {
4410       auto splat = floatPack.getSplatValue<FloatAttr>();
4411 
4412       // Casting fp16 into fp32.
4413       if (srcElemType.isF16() && dstElemType.isF32()) {
4414         uint32_t bits = static_cast<uint32_t>(
4415             splat.getValue().bitcastToAPInt().getZExtValue());
4416         // Duplicate the 16-bit pattern.
4417         bits = (bits << 16) | (bits & 0xffff);
4418         APInt intBits(32, bits);
4419         APFloat floatBits(llvm::APFloat::IEEEsingle(), intBits);
4420         return DenseElementsAttr::get(getResultVectorType(), floatBits);
4421       }
4422     }
4423   }
4424 
4425   return {};
4426 }
4427 
4428 //===----------------------------------------------------------------------===//
4429 // TypeCastOp
4430 //===----------------------------------------------------------------------===//
4431 
4432 static SmallVector<int64_t, 8> extractShape(MemRefType memRefType) {
4433   auto vectorType = memRefType.getElementType().dyn_cast<VectorType>();
4434   SmallVector<int64_t, 8> res(memRefType.getShape().begin(),
4435                               memRefType.getShape().end());
4436   if (vectorType)
4437     res.append(vectorType.getShape().begin(), vectorType.getShape().end());
4438   return res;
4439 }
4440 
4441 /// Build the canonical memRefType with a single vector.
4442 /// E.g. memref<4 x 5 x vector<6 x f32>> -> memref<vector<4 x 5 x 6 x f32>>.
4443 void TypeCastOp::build(OpBuilder &builder, OperationState &result,
4444                        Value source) {
4445   result.addOperands(source);
4446   MemRefType memRefType = source.getType().cast<MemRefType>();
4447   VectorType vectorType =
4448       VectorType::get(extractShape(memRefType),
4449                       getElementTypeOrSelf(getElementTypeOrSelf(memRefType)));
4450   result.addTypes(MemRefType::get({}, vectorType, MemRefLayoutAttrInterface(),
4451                                   memRefType.getMemorySpace()));
4452 }
4453 
4454 LogicalResult TypeCastOp::verify() {
4455   MemRefType canonicalType = canonicalizeStridedLayout(getMemRefType());
4456   if (!canonicalType.getLayout().isIdentity())
4457     return emitOpError("expects operand to be a memref with identity layout");
4458   if (!getResultMemRefType().getLayout().isIdentity())
4459     return emitOpError("expects result to be a memref with identity layout");
4460   if (getResultMemRefType().getMemorySpace() !=
4461       getMemRefType().getMemorySpace())
4462     return emitOpError("expects result in same memory space");
4463 
4464   auto sourceType = getMemRefType();
4465   auto resultType = getResultMemRefType();
4466   if (getElementTypeOrSelf(getElementTypeOrSelf(sourceType)) !=
4467       getElementTypeOrSelf(getElementTypeOrSelf(resultType)))
4468     return emitOpError(
4469                "expects result and operand with same underlying scalar type: ")
4470            << resultType;
4471   if (extractShape(sourceType) != extractShape(resultType))
4472     return emitOpError(
4473                "expects concatenated result and operand shapes to be equal: ")
4474            << resultType;
4475   return success();
4476 }
4477 
4478 //===----------------------------------------------------------------------===//
4479 // TransposeOp
4480 //===----------------------------------------------------------------------===//
4481 
4482 void vector::TransposeOp::build(OpBuilder &builder, OperationState &result,
4483                                 Value vector, ArrayRef<int64_t> transp) {
4484   VectorType vt = vector.getType().cast<VectorType>();
4485   SmallVector<int64_t, 4> transposedShape(vt.getRank());
4486   for (unsigned i = 0; i < transp.size(); ++i)
4487     transposedShape[i] = vt.getShape()[transp[i]];
4488 
4489   result.addOperands(vector);
4490   result.addTypes(VectorType::get(transposedShape, vt.getElementType()));
4491   result.addAttribute(getTranspAttrStrName(), builder.getI64ArrayAttr(transp));
4492 }
4493 
4494 OpFoldResult vector::TransposeOp::fold(ArrayRef<Attribute> operands) {
4495   // Eliminate splat constant transpose ops.
4496   if (auto attr = operands.front().dyn_cast_or_null<DenseElementsAttr>())
4497     if (attr.isSplat())
4498       return attr.reshape(getResultType());
4499 
4500   // Eliminate identity transpose ops. This happens when the dimensions of the
4501   // input vector remain in their original order after the transpose operation.
4502   SmallVector<int64_t, 4> transp;
4503   getTransp(transp);
4504 
4505   // Check if the permutation of the dimensions contains sequential values:
4506   // {0, 1, 2, ...}.
4507   for (int64_t i = 0, e = transp.size(); i < e; i++) {
4508     if (transp[i] != i)
4509       return {};
4510   }
4511 
4512   return getVector();
4513 }
4514 
4515 LogicalResult vector::TransposeOp::verify() {
4516   VectorType vectorType = getVectorType();
4517   VectorType resultType = getResultType();
4518   int64_t rank = resultType.getRank();
4519   if (vectorType.getRank() != rank)
4520     return emitOpError("vector result rank mismatch: ") << rank;
4521   // Verify transposition array.
4522   auto transpAttr = getTransp().getValue();
4523   int64_t size = transpAttr.size();
4524   if (rank != size)
4525     return emitOpError("transposition length mismatch: ") << size;
4526   SmallVector<bool, 8> seen(rank, false);
4527   for (const auto &ta : llvm::enumerate(transpAttr)) {
4528     int64_t i = ta.value().cast<IntegerAttr>().getInt();
4529     if (i < 0 || i >= rank)
4530       return emitOpError("transposition index out of range: ") << i;
4531     if (seen[i])
4532       return emitOpError("duplicate position index: ") << i;
4533     seen[i] = true;
4534     if (resultType.getDimSize(ta.index()) != vectorType.getDimSize(i))
4535       return emitOpError("dimension size mismatch at: ") << i;
4536   }
4537   return success();
4538 }
4539 
4540 Optional<SmallVector<int64_t, 4>> TransposeOp::getShapeForUnroll() {
4541   return llvm::to_vector<4>(getResultType().getShape());
4542 }
4543 
4544 namespace {
4545 
4546 // Rewrites two back-to-back TransposeOp operations into a single TransposeOp.
4547 class TransposeFolder final : public OpRewritePattern<vector::TransposeOp> {
4548 public:
4549   using OpRewritePattern<vector::TransposeOp>::OpRewritePattern;
4550 
4551   LogicalResult matchAndRewrite(vector::TransposeOp transposeOp,
4552                                 PatternRewriter &rewriter) const override {
4553     // Wrapper around vector::TransposeOp::getTransp() for cleaner code.
4554     auto getPermutation = [](vector::TransposeOp transpose) {
4555       SmallVector<int64_t, 4> permutation;
4556       transpose.getTransp(permutation);
4557       return permutation;
4558     };
4559 
4560     // Composes two permutations: result[i] = permutation1[permutation2[i]].
4561     auto composePermutations = [](ArrayRef<int64_t> permutation1,
4562                                   ArrayRef<int64_t> permutation2) {
4563       SmallVector<int64_t, 4> result;
4564       for (auto index : permutation2)
4565         result.push_back(permutation1[index]);
4566       return result;
4567     };
4568 
4569     // Return if the input of 'transposeOp' is not defined by another transpose.
4570     vector::TransposeOp parentTransposeOp =
4571         transposeOp.getVector().getDefiningOp<vector::TransposeOp>();
4572     if (!parentTransposeOp)
4573       return failure();
4574 
4575     SmallVector<int64_t, 4> permutation = composePermutations(
4576         getPermutation(parentTransposeOp), getPermutation(transposeOp));
4577     // Replace 'transposeOp' with a new transpose operation.
4578     rewriter.replaceOpWithNewOp<vector::TransposeOp>(
4579         transposeOp, transposeOp.getResult().getType(),
4580         parentTransposeOp.getVector(),
4581         vector::getVectorSubscriptAttr(rewriter, permutation));
4582     return success();
4583   }
4584 };
4585 
4586 // Folds transpose(broadcast(<scalar>)) into brodcast(<scalar>).
4587 struct FoldTransposedScalarBroadcast final
4588     : public OpRewritePattern<vector::TransposeOp> {
4589   using OpRewritePattern::OpRewritePattern;
4590 
4591   LogicalResult matchAndRewrite(vector::TransposeOp transposeOp,
4592                                 PatternRewriter &rewriter) const override {
4593     auto bcastOp = transposeOp.getVector().getDefiningOp<vector::BroadcastOp>();
4594     if (!bcastOp)
4595       return failure();
4596 
4597     auto srcVectorType = bcastOp.getSourceType().dyn_cast<VectorType>();
4598     if (!srcVectorType || srcVectorType.getNumElements() == 1) {
4599       rewriter.replaceOpWithNewOp<vector::BroadcastOp>(
4600           transposeOp, transposeOp.getResultType(), bcastOp.getSource());
4601       return success();
4602     }
4603 
4604     return failure();
4605   }
4606 };
4607 
4608 // Folds transpose(splat x : src_type) : res_type into splat x : res_type.
4609 class FoldTransposeSplat final : public OpRewritePattern<TransposeOp> {
4610 public:
4611   using OpRewritePattern<TransposeOp>::OpRewritePattern;
4612 
4613   LogicalResult matchAndRewrite(TransposeOp transposeOp,
4614                                 PatternRewriter &rewriter) const override {
4615     auto splatOp = transposeOp.getVector().getDefiningOp<vector::SplatOp>();
4616     if (!splatOp)
4617       return failure();
4618 
4619     rewriter.replaceOpWithNewOp<vector::SplatOp>(
4620         transposeOp, transposeOp.getResultType(), splatOp.getInput());
4621     return success();
4622   }
4623 };
4624 
4625 } // namespace
4626 
4627 void vector::TransposeOp::getCanonicalizationPatterns(
4628     RewritePatternSet &results, MLIRContext *context) {
4629   results
4630       .add<FoldTransposedScalarBroadcast, TransposeFolder, FoldTransposeSplat>(
4631           context);
4632 }
4633 
4634 void vector::TransposeOp::getTransp(SmallVectorImpl<int64_t> &results) {
4635   populateFromInt64AttrArray(getTransp(), results);
4636 }
4637 
4638 //===----------------------------------------------------------------------===//
4639 // ConstantMaskOp
4640 //===----------------------------------------------------------------------===//
4641 
4642 LogicalResult ConstantMaskOp::verify() {
4643   auto resultType = getResult().getType().cast<VectorType>();
4644   // Check the corner case of 0-D vectors first.
4645   if (resultType.getRank() == 0) {
4646     if (getMaskDimSizes().size() != 1)
4647       return emitError("array attr must have length 1 for 0-D vectors");
4648     auto dim = getMaskDimSizes()[0].cast<IntegerAttr>().getInt();
4649     if (dim != 0 && dim != 1)
4650       return emitError("mask dim size must be either 0 or 1 for 0-D vectors");
4651     return success();
4652   }
4653 
4654   // Verify that array attr size matches the rank of the vector result.
4655   if (static_cast<int64_t>(getMaskDimSizes().size()) != resultType.getRank())
4656     return emitOpError(
4657         "must specify array attr of size equal vector result rank");
4658   // Verify that each array attr element is in bounds of corresponding vector
4659   // result dimension size.
4660   auto resultShape = resultType.getShape();
4661   SmallVector<int64_t, 4> maskDimSizes;
4662   for (const auto &it : llvm::enumerate(getMaskDimSizes())) {
4663     int64_t attrValue = it.value().cast<IntegerAttr>().getInt();
4664     if (attrValue < 0 || attrValue > resultShape[it.index()])
4665       return emitOpError(
4666           "array attr of size out of bounds of vector result dimension size");
4667     maskDimSizes.push_back(attrValue);
4668   }
4669   // Verify that if one mask dim size is zero, they all should be zero (because
4670   // the mask region is a conjunction of each mask dimension interval).
4671   bool anyZeros = llvm::is_contained(maskDimSizes, 0);
4672   bool allZeros = llvm::all_of(maskDimSizes, [](int64_t s) { return s == 0; });
4673   if (anyZeros && !allZeros)
4674     return emitOpError("expected all mask dim sizes to be zeros, "
4675                        "as a result of conjunction with zero mask dim");
4676   // Verify that if the mask type is scalable, dimensions should be zero because
4677   // constant scalable masks can only be defined for the "none set" or "all set"
4678   // cases, and there is no VLA way to define an "all set" case for
4679   // `vector.constant_mask`. In the future, a convention could be established
4680   // to decide if a specific dimension value could be considered as "all set".
4681   if (resultType.isScalable() &&
4682       getMaskDimSizes()[0].cast<IntegerAttr>().getInt() != 0)
4683     return emitOpError("expected mask dim sizes for scalable masks to be 0");
4684   return success();
4685 }
4686 
4687 //===----------------------------------------------------------------------===//
4688 // CreateMaskOp
4689 //===----------------------------------------------------------------------===//
4690 
4691 LogicalResult CreateMaskOp::verify() {
4692   auto vectorType = getResult().getType().cast<VectorType>();
4693   // Verify that an operand was specified for each result vector each dimension.
4694   if (vectorType.getRank() == 0) {
4695     if (getNumOperands() != 1)
4696       return emitOpError(
4697           "must specify exactly one operand for 0-D create_mask");
4698   } else if (getNumOperands() !=
4699              getResult().getType().cast<VectorType>().getRank()) {
4700     return emitOpError(
4701         "must specify an operand for each result vector dimension");
4702   }
4703   return success();
4704 }
4705 
4706 namespace {
4707 
4708 // Pattern to rewrite a CreateMaskOp with a ConstantMaskOp.
4709 class CreateMaskFolder final : public OpRewritePattern<CreateMaskOp> {
4710 public:
4711   using OpRewritePattern<CreateMaskOp>::OpRewritePattern;
4712 
4713   LogicalResult matchAndRewrite(CreateMaskOp createMaskOp,
4714                                 PatternRewriter &rewriter) const override {
4715     // Return if any of 'createMaskOp' operands are not defined by a constant.
4716     auto isNotDefByConstant = [](Value operand) {
4717       return !isa_and_nonnull<arith::ConstantIndexOp>(operand.getDefiningOp());
4718     };
4719     if (llvm::any_of(createMaskOp.operands(), isNotDefByConstant))
4720       return failure();
4721 
4722     // CreateMaskOp for scalable vectors can be folded only if all dimensions
4723     // are negative or zero.
4724     if (auto vType = createMaskOp.getType().dyn_cast<VectorType>()) {
4725       if (vType.isScalable())
4726         for (auto opDim : createMaskOp.getOperands()) {
4727           APInt intVal;
4728           if (matchPattern(opDim, m_ConstantInt(&intVal)) &&
4729               intVal.isStrictlyPositive())
4730             return failure();
4731         }
4732     }
4733 
4734     // Gather constant mask dimension sizes.
4735     SmallVector<int64_t, 4> maskDimSizes;
4736     for (auto it : llvm::zip(createMaskOp.operands(),
4737                              createMaskOp.getType().getShape())) {
4738       auto *defOp = std::get<0>(it).getDefiningOp();
4739       int64_t maxDimSize = std::get<1>(it);
4740       int64_t dimSize = cast<arith::ConstantIndexOp>(defOp).value();
4741       dimSize = std::min(dimSize, maxDimSize);
4742       // If one of dim sizes is zero, set all dims to zero.
4743       if (dimSize <= 0) {
4744         maskDimSizes.assign(createMaskOp.getType().getRank(), 0);
4745         break;
4746       }
4747       maskDimSizes.push_back(dimSize);
4748     }
4749     // Replace 'createMaskOp' with ConstantMaskOp.
4750     rewriter.replaceOpWithNewOp<ConstantMaskOp>(
4751         createMaskOp, createMaskOp.getResult().getType(),
4752         vector::getVectorSubscriptAttr(rewriter, maskDimSizes));
4753     return success();
4754   }
4755 };
4756 
4757 } // namespace
4758 
4759 void CreateMaskOp::getCanonicalizationPatterns(RewritePatternSet &results,
4760                                                MLIRContext *context) {
4761   results.add<CreateMaskFolder>(context);
4762 }
4763 
4764 //===----------------------------------------------------------------------===//
4765 // ScanOp
4766 //===----------------------------------------------------------------------===//
4767 
4768 LogicalResult ScanOp::verify() {
4769   VectorType srcType = getSourceType();
4770   VectorType initialType = getInitialValueType();
4771   // Check reduction dimension < rank.
4772   int64_t srcRank = srcType.getRank();
4773   int64_t reductionDim = getReductionDim();
4774   if (reductionDim >= srcRank)
4775     return emitOpError("reduction dimension ")
4776            << reductionDim << " has to be less than " << srcRank;
4777 
4778   // Check that rank(initial_value) = rank(src) - 1.
4779   int64_t initialValueRank = initialType.getRank();
4780   if (initialValueRank != srcRank - 1)
4781     return emitOpError("initial value rank ")
4782            << initialValueRank << " has to be equal to " << srcRank - 1;
4783 
4784   // Check shapes of initial value and src.
4785   ArrayRef<int64_t> srcShape = srcType.getShape();
4786   ArrayRef<int64_t> initialValueShapes = initialType.getShape();
4787   SmallVector<int64_t> expectedShape;
4788   for (int i = 0; i < srcRank; i++) {
4789     if (i != reductionDim)
4790       expectedShape.push_back(srcShape[i]);
4791   }
4792   if (llvm::any_of(llvm::zip(initialValueShapes, expectedShape),
4793                    [](std::tuple<int64_t, int64_t> s) {
4794                      return std::get<0>(s) != std::get<1>(s);
4795                    })) {
4796     return emitOpError("incompatible input/initial value shapes");
4797   }
4798 
4799   // Verify supported reduction kind.
4800   Type eltType = getDestType().getElementType();
4801   if (!isSupportedCombiningKind(getKind(), eltType))
4802     return emitOpError("unsupported reduction type ")
4803            << eltType << " for kind '" << stringifyCombiningKind(getKind())
4804            << "'";
4805 
4806   return success();
4807 }
4808 
4809 void mlir::vector::populateVectorToVectorCanonicalizationPatterns(
4810     RewritePatternSet &patterns) {
4811   patterns
4812       .add<CreateMaskFolder, MaskedLoadFolder, MaskedStoreFolder, GatherFolder,
4813            ScatterFolder, ExpandLoadFolder, CompressStoreFolder,
4814            StridedSliceConstantMaskFolder, TransposeFolder>(
4815           patterns.getContext());
4816 }
4817 
4818 //===----------------------------------------------------------------------===//
4819 // SplatOp
4820 //===----------------------------------------------------------------------===//
4821 
4822 OpFoldResult SplatOp::fold(ArrayRef<Attribute> operands) {
4823   auto constOperand = operands.front();
4824   if (!constOperand.isa_and_nonnull<IntegerAttr, FloatAttr>())
4825     return {};
4826 
4827   // SplatElementsAttr::get treats single value for second arg as being a splat.
4828   return SplatElementsAttr::get(getType(), {constOperand});
4829 }
4830 
4831 //===----------------------------------------------------------------------===//
4832 // WarpExecuteOnLane0Op
4833 //===----------------------------------------------------------------------===//
4834 
4835 void WarpExecuteOnLane0Op::print(OpAsmPrinter &p) {
4836   p << "(" << getLaneid() << ")";
4837 
4838   SmallVector<StringRef> coreAttr = {getWarpSizeAttrName()};
4839   auto warpSizeAttr = getOperation()->getAttr(getWarpSizeAttrName());
4840   p << "[" << warpSizeAttr.cast<IntegerAttr>().getInt() << "]";
4841 
4842   if (!getArgs().empty())
4843     p << " args(" << getArgs() << " : " << getArgs().getTypes() << ")";
4844   if (!getResults().empty())
4845     p << " -> (" << getResults().getTypes() << ')';
4846   p << " ";
4847   p.printRegion(getRegion(),
4848                 /*printEntryBlockArgs=*/true,
4849                 /*printBlockTerminators=*/!getResults().empty());
4850   p.printOptionalAttrDict(getOperation()->getAttrs(), coreAttr);
4851 }
4852 
4853 ParseResult WarpExecuteOnLane0Op::parse(OpAsmParser &parser,
4854                                         OperationState &result) {
4855   // Create the region.
4856   result.regions.reserve(1);
4857   Region *warpRegion = result.addRegion();
4858 
4859   auto &builder = parser.getBuilder();
4860   OpAsmParser::UnresolvedOperand laneId;
4861 
4862   // Parse predicate operand.
4863   if (parser.parseLParen() ||
4864       parser.parseOperand(laneId, /*allowResultNumber=*/false) ||
4865       parser.parseRParen())
4866     return failure();
4867 
4868   int64_t warpSize;
4869   if (parser.parseLSquare() || parser.parseInteger(warpSize) ||
4870       parser.parseRSquare())
4871     return failure();
4872   result.addAttribute(getWarpSizeAttrName(OperationName(getOperationName(),
4873                                                         builder.getContext())),
4874                       builder.getI64IntegerAttr(warpSize));
4875 
4876   if (parser.resolveOperand(laneId, builder.getIndexType(), result.operands))
4877     return failure();
4878 
4879   llvm::SMLoc inputsOperandsLoc;
4880   SmallVector<OpAsmParser::UnresolvedOperand> inputsOperands;
4881   SmallVector<Type> inputTypes;
4882   if (succeeded(parser.parseOptionalKeyword("args"))) {
4883     if (parser.parseLParen())
4884       return failure();
4885 
4886     inputsOperandsLoc = parser.getCurrentLocation();
4887     if (parser.parseOperandList(inputsOperands) ||
4888         parser.parseColonTypeList(inputTypes) || parser.parseRParen())
4889       return failure();
4890   }
4891   if (parser.resolveOperands(inputsOperands, inputTypes, inputsOperandsLoc,
4892                              result.operands))
4893     return failure();
4894 
4895   // Parse optional results type list.
4896   if (parser.parseOptionalArrowTypeList(result.types))
4897     return failure();
4898   // Parse the region.
4899   if (parser.parseRegion(*warpRegion, /*arguments=*/{},
4900                          /*argTypes=*/{}))
4901     return failure();
4902   WarpExecuteOnLane0Op::ensureTerminator(*warpRegion, builder, result.location);
4903 
4904   // Parse the optional attribute list.
4905   if (parser.parseOptionalAttrDict(result.attributes))
4906     return failure();
4907   return success();
4908 }
4909 
4910 void WarpExecuteOnLane0Op::getSuccessorRegions(
4911     Optional<unsigned> index, ArrayRef<Attribute> operands,
4912     SmallVectorImpl<RegionSuccessor> &regions) {
4913   if (index) {
4914     regions.push_back(RegionSuccessor(getResults()));
4915     return;
4916   }
4917 
4918   // The warp region is always executed
4919   regions.push_back(RegionSuccessor(&getWarpRegion()));
4920 }
4921 
4922 void WarpExecuteOnLane0Op::build(OpBuilder &builder, OperationState &result,
4923                                  TypeRange resultTypes, Value laneId,
4924                                  int64_t warpSize) {
4925   build(builder, result, resultTypes, laneId, warpSize,
4926         /*operands=*/llvm::None, /*argTypes=*/llvm::None);
4927 }
4928 
4929 void WarpExecuteOnLane0Op::build(OpBuilder &builder, OperationState &result,
4930                                  TypeRange resultTypes, Value laneId,
4931                                  int64_t warpSize, ValueRange args,
4932                                  TypeRange blockArgTypes) {
4933   result.addOperands(laneId);
4934   result.addAttribute(getAttributeNames()[0],
4935                       builder.getI64IntegerAttr(warpSize));
4936   result.addTypes(resultTypes);
4937   result.addOperands(args);
4938   assert(args.size() == blockArgTypes.size());
4939   OpBuilder::InsertionGuard guard(builder);
4940   Region *warpRegion = result.addRegion();
4941   Block *block = builder.createBlock(warpRegion);
4942   for (auto it : llvm::zip(blockArgTypes, args))
4943     block->addArgument(std::get<0>(it), std::get<1>(it).getLoc());
4944 }
4945 
4946 /// Helper check if the distributed vector type is consistent with the expanded
4947 /// type and distributed size.
4948 static LogicalResult verifyDistributedType(Type expanded, Type distributed,
4949                                            int64_t warpSize, Operation *op) {
4950   // If the types matches there is no distribution.
4951   if (expanded == distributed)
4952     return success();
4953   auto expandedVecType = expanded.dyn_cast<VectorType>();
4954   auto distributedVecType = distributed.dyn_cast<VectorType>();
4955   if (!expandedVecType || !distributedVecType)
4956     return op->emitOpError("expected vector type for distributed operands.");
4957   if (expandedVecType.getRank() != distributedVecType.getRank() ||
4958       expandedVecType.getElementType() != distributedVecType.getElementType())
4959     return op->emitOpError(
4960         "expected distributed vectors to have same rank and element type.");
4961   bool foundDistributedDim = false;
4962   for (int64_t i = 0, e = expandedVecType.getRank(); i < e; i++) {
4963     if (expandedVecType.getDimSize(i) == distributedVecType.getDimSize(i))
4964       continue;
4965     if (expandedVecType.getDimSize(i) ==
4966         distributedVecType.getDimSize(i) * warpSize) {
4967       if (foundDistributedDim)
4968         return op->emitOpError()
4969                << "expected only one dimension to be distributed from "
4970                << expandedVecType << " to " << distributedVecType;
4971       foundDistributedDim = true;
4972       continue;
4973     }
4974     return op->emitOpError() << "incompatible distribution dimensions from "
4975                              << expandedVecType << " to " << distributedVecType;
4976   }
4977   return success();
4978 }
4979 
4980 LogicalResult WarpExecuteOnLane0Op::verify() {
4981   if (getArgs().size() != getWarpRegion().getNumArguments())
4982     return emitOpError(
4983         "expected same number op arguments and block arguments.");
4984   auto yield =
4985       cast<YieldOp>(getWarpRegion().getBlocks().begin()->getTerminator());
4986   if (yield.getNumOperands() != getNumResults())
4987     return emitOpError(
4988         "expected same number of yield operands and return values.");
4989   int64_t warpSize = getWarpSize();
4990   for (auto it : llvm::zip(getWarpRegion().getArguments(), getArgs())) {
4991     if (failed(verifyDistributedType(std::get<0>(it).getType(),
4992                                      std::get<1>(it).getType(), warpSize,
4993                                      getOperation())))
4994       return failure();
4995   }
4996   for (auto it : llvm::zip(yield.getOperands(), getResults())) {
4997     if (failed(verifyDistributedType(std::get<0>(it).getType(),
4998                                      std::get<1>(it).getType(), warpSize,
4999                                      getOperation())))
5000       return failure();
5001   }
5002   return success();
5003 }
5004 
5005 bool WarpExecuteOnLane0Op::areTypesCompatible(Type lhs, Type rhs) {
5006   return succeeded(
5007       verifyDistributedType(lhs, rhs, getWarpSize(), getOperation()));
5008 }
5009 
5010 //===----------------------------------------------------------------------===//
5011 // TableGen'd op method definitions
5012 //===----------------------------------------------------------------------===//
5013 
5014 #define GET_OP_CLASSES
5015 #include "mlir/Dialect/Vector/IR/VectorOps.cpp.inc"
5016