[mlir][tensor][linalg] Move Pack/Unpack Ops to Linalg (4/4)

This is merely moving code around, no new functionality is added.

PATCH 4: Remove `tensor.{pack|unpack}` and all the associated code (e.g.
transfromations, verifiers, etc).

CONTEXT:
This change was discussed in the following RFC:
* https://discourse.llvm.org/t/rfc-move-tensor-pack-and-tensor-unpack-into-linalg

Author: banach-space

mlir/include/mlir/Dialect/Tensor/IR/TensorOps.td

@@ -1816,314 +1816,6 @@ def Tensor_SplatOp : Tensor_Op<"splat", [
   let hasVerifier = 1;
 }
 
-//===----------------------------------------------------------------------===//
-// RelayoutOp
-//===----------------------------------------------------------------------===//
-
-class Tensor_RelayoutOp<string mnemonic, list<Trait> traits = []> :
-      Tensor_Op<mnemonic, !listconcat(traits, [
-        DeclareOpInterfaceMethods<OpAsmOpInterface, ["getAsmResultNames"]>,
-        DestinationStyleOpInterface,
-        ConditionallySpeculatable, NoMemoryEffect,
-        DeclareOpInterfaceMethods<ReifyRankedShapedTypeOpInterface>,
-        TypesMatchWith<"result type matches type of dest",
-                   "dest", "result",
-                   "$_self">])> {
-
-  code commonExtraClassDeclaration = [{
-    size_t getSourceRank() { return getSourceType().getRank(); };
-    size_t getDestRank() { return getDestType().getRank(); };
-    RankedTensorType getSourceType() {
-      return ::llvm::cast<RankedTensorType>(getSource().getType()); };
-    RankedTensorType getDestType() {
-      return ::llvm::cast<RankedTensorType>(getDest().getType()); };
-
-    MutableOperandRange getDpsInitsMutable() { return getDestMutable(); }
-
-    /// Interface method for ConditionallySpeculatable.
-    Speculation::Speculatability getSpeculatability();
-
-    /// Return a mapping from positions `inner_dims_pos` to their
-    /// tile factors.
-    DenseMap<int64_t, OpFoldResult> getDimAndTileMapping();
-
-    /// Return the tile sizes as OpFoldResult.
-    SmallVector<OpFoldResult> getMixedTiles();
-
-    /// Return the tile sizes as `int64_t`. If a tile size is dynamic
-    /// a sentinel `kDynamic` is introduced at that position in
-    /// the returned vector.
-    SmallVector<int64_t> getStaticTiles();
-
-    /// Retrieve all outer dims for this Pack/UnPack Op, i.e. all the leading
-    /// dims excluding the trailing dims corresponding to `innerTiles`. Note
-    /// that this will include both tiled and non-tiled dimensions. The order
-    /// of the output dimensions is consistent with the shape of the packed
-    /// tensor.
-    ArrayRef<int64_t> getAllOuterDims();
-
-    /// Similar to `getAllOuterDims`, but only retrieve the outer dims that
-    /// have been tiled. Also, the order of the output dimensions is consistent
-    /// with `inner_dims_pos` rather than the packed tensor.
-    SmallVector<int64_t> getTiledOuterDims();
-  }];
-
-  let hasVerifier = 1;
-}
-
-//===----------------------------------------------------------------------===//
-// PackOp
-//===----------------------------------------------------------------------===//
-
-def Tensor_PackOp : Tensor_RelayoutOp<"pack", [
-    AttrSizedOperandSegments]> {
-  let summary = "tensor pack operation";
-  let description = [{
-    The "pack" operation converts a source tensor of rank `n` into a result
-    tensor of rank `n + k` with a tiled and packed layout (maybe with padding)
-    and optionally transposes the tiled source tensor dimensions.
-
-    `inner_dims_pos` (mandatory) specifies `k` source tensor dimensions that are
-    being tiled, where `0 < k <= n`. The order of the dimensions matters:
-     - The tiled dimensions (of size `inner_tiles`) are added to the end of the result
-    tensor in the order in which they appear in `inner_dims_pos`.
-     - `inner_dims_pos[i]` specifies the source tensor dimension tiled by
-    `inner_tiles[i]`.
-
-    `inner_tiles` (mandatory) specifies `k` tile sizes. These tile sizes
-    correspond to the least significant ("inner") result tensor dimension sizes,
-    in the same order. Tile sizes can be static or dynamic.
-
-    Example: If `inner_tiles = [16, 32]`, the result tensor has a shape of
-    `...x16x32`. If `inner_dims_pos = [0, 1]`, the 0th source dimension is tiled
-    by 16 and the 1st source dimension is tiled by 32. Other source dimensions
-    (if any) are not tiled. If `inner_dims_pos = [1, 0]`, the 1st dimension is
-    tiled by 16 and the 0th dimension is tiled by 32.
-
-    Example:
-    ```mlir
-    // NC to NCnc
-    %0 = tensor.pack %source inner_dims_pos = [0, 1] inner_tiles = [8, 32]
-        into %dest : tensor<128x256xf32> -> tensor<16x8 x 8x32 xf32>
-    //                                             \  /   \  /
-    //                                       outer dims  inner dims
-    ```
-
-    `outer_dims_perm` (optional) specifies a permutation for the outer
-    dimensions. If specified, it must have `n` elements.
-
-    Example:
-    ```mlir
-    // CK to KCck
-    %0 = tensor.pack %source outer_dims_perm = [1, 0] inner_dims_pos = [0, 1]
-        inner_tiles = [8, 32] into %dest
-        : tensor<128x256xf32> -> tensor<8x16 x 8x32 xf32>
-    //                                  \  /
-    //            compare with "NC to NCnc": outer dims are transposed
-    ```
-
-    `padding_value` specifies a padding value at the boundary on non-perfectly
-    divisible dimensions. Padding is optional:
-    - If absent, it is UB if the tile does not perfectly divide the dimension.
-    - If present, it will pad along high dimensions (high-padding) to make the
-      tile complete.
-
-    Example:
-    ```mlir
-    %0 = tensor.pack %arg0 padding_value(%pad : f32) outer_dims_perm = [2, 1, 0]
-        inner_dims_pos = [1] inner_tiles = [2] into %arg1
-        : tensor<200x127x256xf32> -> tensor<256x64x200x2xf32>
-    //                 \
-    //                padded and tiled dim
-    //
-    // Source dimension 1 is tiled. 64 does not divide 127 evenly, so 1 padded
-    // element is added at the end.
-    //
-    // Note: Only tiled dimensions can be padded.
-    ```
-  }];
-  let arguments = (ins AnyRankedTensor:$source,
-                       AnyRankedTensor:$dest,
-                       Optional<AnyType>:$padding_value,
-                       DefaultValuedOptionalAttr<DenseI64ArrayAttr, "{}">:$outer_dims_perm,
-                       DenseI64ArrayAttr:$inner_dims_pos,
-                       Variadic<Index>:$inner_tiles,
-                       DenseI64ArrayAttr:$static_inner_tiles);
-  let results = (outs AnyRankedTensor:$result);
-  let assemblyFormat = [{
-    $source
-    (`padding_value` `(` $padding_value^ `:` type($padding_value) `)`)?
-    (`outer_dims_perm` `=` $outer_dims_perm^)?
-    `inner_dims_pos` `=` $inner_dims_pos
-    `inner_tiles` `=`
-    custom<DynamicIndexList>($inner_tiles, $static_inner_tiles)
-    `into` $dest attr-dict `:` type($source) `->` type($dest)
-  }];
-
-  let builders = [
-    OpBuilder<(ins "Value":$source, "Value":$dest,
-      "ArrayRef<int64_t>":$innerDimsPos,
-      "ArrayRef<OpFoldResult>":$innerTiles,
-      CArg<"std::optional<Value>", "std::nullopt">:$paddingValue,
-      CArg<"ArrayRef<int64_t>", "{}">:$outerDimsPerm)>
-  ];
-
-  let extraClassDeclaration = commonExtraClassDeclaration # [{
-    // Method to get the shape of the result as `SmallVector<OpFoldResult>`.
-    // This is a static method to allow getting the shape of the destination
-    // expected while creating a `pack` op.
-    static SmallVector<OpFoldResult> getResultShape(OpBuilder &builder,
-        Location loc, ArrayRef<OpFoldResult> sourceDims,
-        ArrayRef<OpFoldResult> innerTileDims, ArrayRef<int64_t> innerDimsPos,
-        ArrayRef<int64_t> outerDimsPerm = {});
-
-    // Method to get the `RankedTensorType` of the result based on the inner
-    // tiles, position of the inner tiles (innerDimsPos)  and interchange vector
-    // of outer loops (outerDimsPerm).
-    static RankedTensorType inferPackedType(RankedTensorType sourceType,
-        ArrayRef<int64_t> innerTileSizes, ArrayRef<int64_t> innerDimsPos,
-        ArrayRef<int64_t> outerDimsPerm = {});
-
-    // Returns true if we have enough static information to catch undefined
-    // behavior when the tile size does not divide perfectly the dimension of
-    // the input tensor. Detecting UB requires that the input size and either
-    // corresponding tile or output size are static.
-    static bool requirePaddingValue(ArrayRef<int64_t> inputShape,
-                                    ArrayRef<int64_t> innerDimsPos,
-                                    ArrayRef<int64_t> outputShape,
-                                    ArrayRef<int64_t> outerDimsPerm,
-                                    ArrayRef<OpFoldResult> innerTiles);
-
-    static Value createDestinationTensor(OpBuilder &b, Location loc,
-        Value source, ArrayRef<OpFoldResult> innerTileSizes,
-        ArrayRef<int64_t> innerDimsPos, ArrayRef<int64_t> outerDimsPerm);
-
-    /// Build and return a new PackOp that is a clone of the current PackOp with
-    /// (innerDimsPos, innerTiles) (resp. outerDimsPerm) are permuted by
-    /// innerPermutation (resp. outerPermutation).
-    /// A new `tensor.empty` of the proper shape is built in the process.
-    /// Asserts that:
-    ///   - At least one of innerPermutation or outerPermutation is non-empty.
-    ///   - If not empty, innerPermutation is a valid permutation of size
-    ///     matching innerDimPos.
-    ///   - If not empty, outerPermutation is a valid permutation of size
-    ///     matching outerDimsPerm.
-    PackOp createTransposedClone(OpBuilder &b,
-                                 Location loc,
-                                 ArrayRef<int64_t> innerPermutation,
-                                 ArrayRef<int64_t> outerPermutation);
-
-    /// Check if this PackOp is like a simple pad operation.
-    /// In other words, this operation:
-    /// 1. adds useless dimensions (dimension of size 1),
-    /// 2. pads the other ones, and
-    /// 3. doesn't shuffle the dimensions
-    bool isLikePad();
-  }];
-
-  let hasCanonicalizeMethod = 1;
-
-  let hasFolder = 1;
-}
-
-//===----------------------------------------------------------------------===//
-// UnPackOp
-//===----------------------------------------------------------------------===//
-
-def Tensor_UnPackOp : Tensor_RelayoutOp<"unpack"> {
-  let summary = "tensor unpack operation";
-  let description = [{
-    The "unpack" operation converts a source tensor of rank `n` with a tiled and
-    packed layout to a result tensor of rank `n - k`.
-
-    `inner_dims_pos` (mandatory) specifies `k` source tensor dimensions with
-    which the last `k` source tensor dimensions are combined, where
-    `0 < k <= n/2`. Each `inner_dims_pos` element must be `>= 0` and `< n - k`.
-    The order of the dimensions in `inner_dims_pos` matters: dimension
-    `inner_dims_pos[i]` is combined with dimension `n - k + i` (assuming that
-    `outer_dims_perm` is not specified).
-
-    `inner_tiles` (mandatory) specifies `k` tile sizes. These tile sizes
-    correspond to the least significant ("inner") source tensor dimension sizes.
-    The behavior of this op is undefined if:
-    - `inner_tiles` do not exactly match with the corresponding source tensor
-      dimension sizes.
-    - Or, `inner_tiles[i]` does not divide the size of dimension
-      `inner_dims_pos[i]` (assuming that `outer_dims_perm` is not specified)
-      evenly.
-
-    `outer_dims_perm` (optional) specifies a permutation for the outer
-    dimensions. If specified, it must have `n - k` elements. If specified, this
-    permutation is applied before combining any dimensions.
-
-    Example:
-
-    ```mlir
-    // NCnc to NC:
-    %0 = tensor.unpack %source inner_dims_pos = [0, 1] inner_tiles = [8, 32]
-        into %dest : tensor<16x8x8x32xf32> -> tensor<128x256xf32>
-
-    // CK to KCck:
-    %0 = tensor.unpack %source outer_dims_perm = [1, 0] inner_dims_pos = [0, 1]
-        inner_tiles = [8, 32] into %dest
-        : tensor<8x16x8x32xf32> -> tensor<128x256xf32>
-    ```
-  }];
-  let arguments = (ins AnyRankedTensor:$source,
-                       AnyRankedTensor:$dest,
-                       DefaultValuedOptionalAttr<DenseI64ArrayAttr, "{}">:$outer_dims_perm,
-                       DenseI64ArrayAttr:$inner_dims_pos,
-                       Variadic<Index>:$inner_tiles,
-                       DenseI64ArrayAttr:$static_inner_tiles);
-  let results = (outs AnyRankedTensor:$result);
-  let assemblyFormat = [{
-    $source
-    (`outer_dims_perm` `=` $outer_dims_perm^)?
-    `inner_dims_pos` `=` $inner_dims_pos
-    `inner_tiles` `=`
-    custom<DynamicIndexList>($inner_tiles, $static_inner_tiles)
-    `into` $dest attr-dict `:` type($source) `->` type($dest)
-  }];
-
-  let builders = [
-    OpBuilder<(ins "Value":$source, "Value":$dest,
-    "ArrayRef<int64_t>":$innerDimsPos,
-    "ArrayRef<OpFoldResult>":$innerTiles,
-    CArg<"ArrayRef<int64_t>", "{}">:$outerDimsPerm)>
-  ];
-
-  let extraClassDeclaration = commonExtraClassDeclaration # [{
-    static Value createDestinationTensor(OpBuilder &b, Location loc,
-        Value source, ArrayRef<OpFoldResult> innerTileSizes,
-        ArrayRef<int64_t> innerDimsPos, ArrayRef<int64_t> outerDimsPerm);
-
-    /// Build and return a new UnPackOp that is a clone of the current UnPackOp
-    /// with (innerDimsPos, innerTiles) (resp. outerDimsPerm) are permuted by
-    /// innerPermutation (resp. outerPermutation).
-    /// Asserts that:
-    ///   - At least one of innerPermutation or outerPermutation is non-empty.
-    ///   - If not empty, innerPermutation is a valid permutation of size
-    ///     matching innerDimPos.
-    ///   - If not empty, outerPermutation is a valid permutation of size
-    ///     matching outerDimsPerm.
-    UnPackOp createTransposedClone(OpBuilder &b,
-                                   Location loc,
-                                   Value transposedSource,
-                                   ArrayRef<int64_t> innerPermutation,
-                                   ArrayRef<int64_t> outerPermutation);
-
-    /// Check if this UnPackOp is like a simple unpad operation.
-    /// In other words, this operation:
-    /// 1. drops useless dimensions (dimension of size 1), and
-    /// 2. reduces dimensions in place (i.e., no transpose.)
-    bool isLikeUnPad();
-  }];
-
-  let hasCanonicalizeMethod = 1;
-
-  let hasFolder = 1;
-}
-
 //===----------------------------------------------------------------------===//
 // YieldOp
 //===----------------------------------------------------------------------===//

mlir/include/mlir/Dialect/Tensor/Utils/Utils.h

@@ -42,25 +42,6 @@ FailureOr<RankedTensorType>
 computeTransposedType(RankedTensorType rankedTensorType,
                       ArrayRef<int64_t> transposeVector);
 
-/// Shell function to compute the Destination Permutation of PackOp
-/// This function uses the helper function `computePackUnPackPerm` to get
-/// the permutation vector. Only major difference between UnPack and Pack is
-/// that packOp uses destination rank whereas unpack Uses source rank.
-SmallVector<int64_t> getPackInverseDestPerm(tensor::PackOp packOp);
-
-/// Shell function to compute the Source Permutation of unPackOp.
-/// This function, like the getPackInverseDestPerm uses the helper function
-/// computePackUnPackPerm` to get the permutation vector.
-/// Only major difference between UnPack and Pack is that packOp uses
-/// destination rank whereas unpack Uses source rank.
-SmallVector<int64_t> getUnPackInverseSrcPerm(tensor::UnPackOp unpackOp);
-
-/// Shell function to compute the Source rank permutation for unpackOp
-/// Unpack requires some packing metadata data information, so created
-/// another function where this value is passed by reference.
-SmallVector<int64_t> getUnPackInverseSrcPerm(tensor::UnPackOp,
-                                             PackingMetadata &metadata);
-
 /// A tensor.insert_slice is a cast-like operation if it merely rank-extends the
 /// source tensor or inserts the source tensor into a destination tensor with
 /// the same shape.

mlir/lib/Dialect/Tensor/IR/TensorDialect.cpp

@@ -63,7 +63,7 @@ void TensorDialect::initialize() {
   declarePromisedInterfaces<SubsetInsertionOpInterface, InsertSliceOp,
                             ParallelInsertSliceOp>();
   declarePromisedInterface<SubsetExtractionOpInterface, ExtractSliceOp>();
-  declarePromisedInterfaces<TilingInterface, PadOp, PackOp, UnPackOp>();
+  declarePromisedInterfaces<TilingInterface, PadOp>();
   declarePromisedInterfaces<ValueBoundsOpInterface, CastOp, DimOp, EmptyOp,
                             ExtractSliceOp, PadOp, RankOp>();
 }