X86Dialect.cpp

Go to the documentation of this file.

//===- X86Dialect.cpp - MLIR X86 ops implementation -----------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file implements the X86 dialect and its operations.
//
//===----------------------------------------------------------------------===//
 
#include "mlir/Dialect/X86/X86Dialect.h"
#include "mlir/Conversion/LLVMCommon/Pattern.h"
#include "mlir/Dialect/LLVMIR/LLVMDialect.h"
#include "mlir/Dialect/LLVMIR/LLVMTypes.h"
#include "mlir/IR/Builders.h"
#include "mlir/IR/OpImplementation.h"
#include "mlir/IR/TypeUtilities.h"
 
using namespace mlir;
 
#include "mlir/Dialect/X86/X86Interfaces.cpp.inc"
 
#include "mlir/Dialect/X86/X86Dialect.cpp.inc"
 
void x86::X86Dialect::initialize() {
  addTypes<
#define GET_TYPEDEF_LIST
#include "mlir/Dialect/X86/X86Types.cpp.inc"
      >();
 
  addOperations<
#define GET_OP_LIST
#include "mlir/Dialect/X86/X86.cpp.inc"
      >();
}
 
static Value getMemrefBuffPtr(Location loc, MemRefType type, Value buffer,
                              const LLVMTypeConverter &typeConverter,
                              RewriterBase &rewriter) {
  MemRefDescriptor memRefDescriptor(buffer);
  return memRefDescriptor.bufferPtr(rewriter, loc, typeConverter, type);
}
 
LogicalResult x86::avx512::MaskCompressOp::verify() {
  if (getSrc() && getConstantSrc())
    return emitError("cannot use both src and constant_src");
 
  if (getSrc() && (getSrc().getType() != getDst().getType()))
    return emitError("failed to verify that src and dst have same type");
 
  if (getConstantSrc() && (getConstantSrc()->getType() != getDst().getType()))
    return emitError(
        "failed to verify that constant_src and dst have same type");
 
  return success();
}
 
SmallVector<Value> x86::avx512::MaskCompressOp::getIntrinsicOperands(
    ArrayRef<Value> operands, const LLVMTypeConverter &typeConverter,
    RewriterBase &rewriter) {
  auto loc = getLoc();
  Adaptor adaptor(operands, *this);
 
  auto opType = adaptor.getA().getType();
  Value src;
  if (adaptor.getSrc()) {
    src = adaptor.getSrc();
  } else if (adaptor.getConstantSrc()) {
    src = LLVM::ConstantOp::create(rewriter, loc, opType,
                                   adaptor.getConstantSrcAttr());
  } else {
    auto zeroAttr = rewriter.getZeroAttr(opType);
    src = LLVM::ConstantOp::create(rewriter, loc, opType, zeroAttr);
  }
 
  return SmallVector<Value>{adaptor.getA(), src, adaptor.getK()};
}
 
SmallVector<Value>
x86::avx::DotOp::getIntrinsicOperands(ArrayRef<Value> operands,
                                      const LLVMTypeConverter &typeConverter,
                                      RewriterBase &rewriter) {
  SmallVector<Value> intrinsicOperands(operands);
  // Dot product of all elements, broadcasted to all elements.
  Value scale =
      LLVM::ConstantOp::create(rewriter, getLoc(), rewriter.getI8Type(), 0xff);
  intrinsicOperands.push_back(scale);
 
  return intrinsicOperands;
}
 
SmallVector<Value> x86::avx::BcstToPackedF32Op::getIntrinsicOperands(
    ArrayRef<Value> operands, const LLVMTypeConverter &typeConverter,
    RewriterBase &rewriter) {
  Adaptor adaptor(operands, *this);
  return {getMemrefBuffPtr(getLoc(), getA().getType(), adaptor.getA(),
                           typeConverter, rewriter)};
}
 
SmallVector<Value> x86::avx::CvtPackedEvenIndexedToF32Op::getIntrinsicOperands(
    ArrayRef<Value> operands, const LLVMTypeConverter &typeConverter,
    RewriterBase &rewriter) {
  Adaptor adaptor(operands, *this);
  return {getMemrefBuffPtr(getLoc(), getA().getType(), adaptor.getA(),
                           typeConverter, rewriter)};
}
 
SmallVector<Value> x86::avx::CvtPackedOddIndexedToF32Op::getIntrinsicOperands(
    ArrayRef<Value> operands, const LLVMTypeConverter &typeConverter,
    RewriterBase &rewriter) {
  Adaptor adaptor(operands, *this);
  return {getMemrefBuffPtr(getLoc(), getA().getType(), adaptor.getA(),
                           typeConverter, rewriter)};
}
 
/// Verify that AMX supports the implied tile shape.
static LogicalResult verifyTileSize(Operation *op, x86::amx::TileType tp) {
  const unsigned kMaxRows = 16;
  const unsigned kBitsPerRow = 64 * 8;
  unsigned col = tp.getDimSize(1) * tp.getElementType().getIntOrFloatBitWidth();
  if (tp.getDimSize(0) > kMaxRows)
    return op->emitOpError("bad row height: ") << tp.getDimSize(0);
  if (col > kBitsPerRow || col & 0x1f)
    return op->emitOpError("bad column width: ") << (col >> 3);
  return success();
}
 
/// Verify that AMX supports the multiplication.
static LogicalResult verifyMultShape(Operation *op, x86::amx::TileType atp,
                                     x86::amx::TileType btp,
                                     x86::amx::TileType ctp, unsigned scale) {
  unsigned am = atp.getDimSize(0), ak = atp.getDimSize(1) >> scale;
  unsigned bk = btp.getDimSize(0), bn = btp.getDimSize(1) >> scale;
  unsigned cm = ctp.getDimSize(0), cn = ctp.getDimSize(1);
  if (cm != am || cn != bn || ak != bk)
    return op->emitOpError("bad mult shape: ")
           << cm << " x " << cn << " x " << ak;
  return success();
}
 
/// Maps the 2-dim vector shape to the two 16-bit tile sizes. The first
/// dimension directly translates into the number of rows of the tiles.
/// The second dimensions needs to be scaled by the number of bytes.
static SmallVector<Value> getTileSizes(Location loc, x86::amx::TileType tType,
                                       RewriterBase &rewriter) {
  Type llvmInt16Type = rewriter.getIntegerType(16);
  unsigned width = tType.getElementType().getIntOrFloatBitWidth();
  assert(llvm::isPowerOf2_64(width) && width >= 8);
  unsigned bytes = width >> 3;
  auto mattr = rewriter.getI16IntegerAttr(tType.getDimSize(0));
  auto nattr = rewriter.getI16IntegerAttr(tType.getDimSize(1) * bytes);
  return SmallVector<Value>{
      LLVM::ConstantOp::create(rewriter, loc, llvmInt16Type, mattr),
      LLVM::ConstantOp::create(rewriter, loc, llvmInt16Type, nattr)};
}
 
/// Returns stride expressed in number of bytes for the given `elementStride`
/// stride encoded in number of elements of the type `mType`.
static Value computeStrideInBytes(Location loc, MemRefType mType,
                                  Value elementStride, RewriterBase &rewriter) {
  Type llvmInt64Type = rewriter.getIntegerType(64);
  unsigned bytes = mType.getElementType().getIntOrFloatBitWidth() / 8;
  auto attr = rewriter.getI64IntegerAttr(bytes);
  Value scale = LLVM::ConstantOp::create(rewriter, loc, llvmInt64Type, attr);
  return LLVM::MulOp::create(rewriter, loc, llvmInt64Type, scale, elementStride)
      .getResult();
}
 
/// Maps the 2-dim memref shape to the 64-bit stride. Note that the buffer
/// shape may "envelop" the actual tile shape, and may be dynamically sized.
static Value inferStride(Location loc, MemRefType mType, Value base,
                         RewriterBase &rewriter) {
  assert(mType.getRank() >= 2 && "Invalid shape for AMX strides");
  int64_t preLast = mType.getRank() - 2;
  Type llvmInt64Type = rewriter.getIntegerType(64);
  unsigned width = mType.getElementType().getIntOrFloatBitWidth();
  assert(llvm::isPowerOf2_64(width) && width >= 8);
  unsigned bytes = width >> 3;
  auto [strides, offset] = mType.getStridesAndOffset();
  if (strides[preLast] == ShapedType::kDynamic) {
    // Dynamic stride needs code to compute the stride at runtime.
    MemRefDescriptor memrefDescriptor(base);
    return computeStrideInBytes(
        loc, mType, memrefDescriptor.stride(rewriter, loc, preLast), rewriter);
  }
  // Use direct constant for static stride.
  auto attr = rewriter.getI64IntegerAttr(strides[preLast] * bytes);
  return LLVM::ConstantOp::create(rewriter, loc, llvmInt64Type, attr)
      .getResult();
}
 
LogicalResult x86::amx::TileZeroOp::verify() {
  return verifyTileSize(*this, getTileType());
}
 
SmallVector<Value> x86::amx::TileZeroOp::getIntrinsicOperands(
    ArrayRef<Value> operands, const LLVMTypeConverter &typeConverter,
    RewriterBase &rewriter) {
  return getTileSizes(getLoc(), getTileType(), rewriter);
}
 
template <typename OpTy, typename = std::enable_if_t<
                             std::is_same_v<OpTy, x86::amx::TileLoadOp> ||
                             std::is_same_v<OpTy, x86::amx::TileStoreOp>>>
static LogicalResult tileTransferVerifier(OpTy op) {
  MemRefType memrefTy = op.getMemRefType();
  unsigned rank = memrefTy.getRank();
  if (op.getIndices().size() != rank)
    return op.emitOpError("requires ") << rank << " indices";
 
  if (failed(verifyTileSize(op, op.getTileType())))
    return failure();
 
  // Validate basic buffer properties when the stride is implicit.
  if (!op.getStride()) {
    if (rank < 2)
      return op.emitOpError("requires at least 2D memref");
    SmallVector<int64_t> strides;
    int64_t offset;
    if (failed(memrefTy.getStridesAndOffset(strides, offset)) ||
        strides.back() != 1)
      return op.emitOpError("requires memref with unit innermost stride");
  }
 
  return success();
}
 
void x86::amx::TileLoadOp::build(OpBuilder &builder, OperationState &state,
                                 Type res, Value base, ValueRange indices) {
  build(builder, state, res, base, indices, /*stride=*/nullptr);
}
 
LogicalResult x86::amx::TileLoadOp::verify() {
  return tileTransferVerifier(*this);
}
 
SmallVector<Value> x86::amx::TileLoadOp::getIntrinsicOperands(
    ArrayRef<Value> operands, const LLVMTypeConverter &typeConverter,
    RewriterBase &rewriter) {
  auto loc = getLoc();
  Adaptor adaptor(operands, *this);
 
  SmallVector<Value> intrinsicOperands;
  intrinsicOperands.append(getTileSizes(loc, getTileType(), rewriter));
  intrinsicOperands.push_back(
      LLVM::getStridedElementPtr(rewriter, loc, typeConverter, getMemRefType(),
                                 adaptor.getBase(), adaptor.getIndices()));
  if (Value stride = adaptor.getStride())
    intrinsicOperands.push_back(
        computeStrideInBytes(loc, getMemRefType(), stride, rewriter));
  else
    intrinsicOperands.push_back(
        inferStride(loc, getMemRefType(), adaptor.getBase(), rewriter));
 
  return intrinsicOperands;
}
 
void x86::amx::TileStoreOp::build(OpBuilder &builder, OperationState &state,
                                  Value base, ValueRange indices, Value val) {
  build(builder, state, base, indices, val, /*stride=*/nullptr);
}
 
LogicalResult x86::amx::TileStoreOp::verify() {
  return tileTransferVerifier(*this);
}
 
SmallVector<Value> x86::amx::TileStoreOp::getIntrinsicOperands(
    ArrayRef<Value> operands, const LLVMTypeConverter &typeConverter,
    RewriterBase &rewriter) {
  auto loc = getLoc();
  Adaptor adaptor(operands, *this);
 
  SmallVector<Value> intrinsicOperands;
  intrinsicOperands.append(getTileSizes(loc, getTileType(), rewriter));
  intrinsicOperands.push_back(
      LLVM::getStridedElementPtr(rewriter, loc, typeConverter, getMemRefType(),
                                 adaptor.getBase(), adaptor.getIndices()));
  if (Value stride = adaptor.getStride())
    intrinsicOperands.push_back(
        computeStrideInBytes(loc, getMemRefType(), stride, rewriter));
  else
    intrinsicOperands.push_back(
        inferStride(loc, getMemRefType(), adaptor.getBase(), rewriter));
  intrinsicOperands.push_back(adaptor.getVal());
 
  return intrinsicOperands;
}
 
LogicalResult x86::amx::TileMulFOp::verify() {
  x86::amx::TileType aType = getLhsTileType();
  x86::amx::TileType bType = getRhsTileType();
  x86::amx::TileType cType = getTileType();
  unsigned scale = 1;
  if (aType.getElementType().isF8E4M3FN() || aType.getElementType().isF8E5M2())
    scale = 2;
  if (failed(verifyTileSize(*this, aType)) ||
      failed(verifyTileSize(*this, bType)) ||
      failed(verifyTileSize(*this, cType)) ||
      failed(verifyMultShape(*this, aType, bType, cType, scale)))
    return failure();
  Type ta = aType.getElementType();
  Type tb = bType.getElementType();
  Type tc = cType.getElementType();
  bool flag1 = !ta.isBF16() && !ta.isF16() &&
               !((ta.isF8E4M3FN() || ta.isF8E5M2()) &&
                 (tb.isF8E4M3FN() || tb.isF8E5M2()));
  bool flag2 = (ta.isBF16() || ta.isF16()) ? (ta != tb) : false;
  if (flag1 || flag2 || !tc.isF32())
    return emitOpError("unsupported type combination");
  return success();
}
 
SmallVector<Value> x86::amx::TileMulFOp::getIntrinsicOperands(
    ArrayRef<Value> operands, const LLVMTypeConverter &typeConverter,
    RewriterBase &rewriter) {
  auto loc = getLoc();
  Adaptor adaptor(operands, *this);
 
  x86::amx::TileType aType = getLhsTileType();
  x86::amx::TileType bType = getRhsTileType();
  SmallVector<Value> tsza = getTileSizes(loc, aType, rewriter);
  SmallVector<Value> tszb = getTileSizes(loc, bType, rewriter);
 
  SmallVector<Value> intrinsicOperands = {tsza[0],          tszb[1],
                                          tsza[1],          adaptor.getAcc(),
                                          adaptor.getLhs(), adaptor.getRhs()};
 
  return intrinsicOperands;
}
 
LogicalResult x86::amx::TileMulIOp::verify() {
  x86::amx::TileType aType = getLhsTileType();
  x86::amx::TileType bType = getRhsTileType();
  x86::amx::TileType cType = getTileType();
  if (failed(verifyTileSize(*this, aType)) ||
      failed(verifyTileSize(*this, bType)) ||
      failed(verifyTileSize(*this, cType)) ||
      failed(verifyMultShape(*this, aType, bType, cType, 2)))
    return failure();
  Type ta = aType.getElementType();
  Type tb = bType.getElementType();
  Type tc = cType.getElementType();
  if (!ta.isInteger(8) || !tb.isInteger(8) || !tc.isInteger(32))
    return emitOpError("unsupported type combination");
  return success();
}
 
SmallVector<Value> x86::amx::TileMulIOp::getIntrinsicOperands(
    ArrayRef<Value> operands, const LLVMTypeConverter &typeConverter,
    RewriterBase &rewriter) {
  auto loc = getLoc();
  Adaptor adaptor(operands, *this);
 
  x86::amx::TileType aType = getLhsTileType();
  x86::amx::TileType bType = getRhsTileType();
  SmallVector<Value> tsza = getTileSizes(loc, aType, rewriter);
  SmallVector<Value> tszb = getTileSizes(loc, bType, rewriter);
 
  SmallVector<Value> intrinsicOperands = {tsza[0],          tszb[1],
                                          tsza[1],          adaptor.getAcc(),
                                          adaptor.getLhs(), adaptor.getRhs()};
 
  return intrinsicOperands;
}
 
Type x86::amx::TileType::parse(AsmParser &parser) {
  if (parser.parseLess())
    return nullptr;
 
  SmallVector<int64_t, 2> shape;
  if (parser.parseDimensionList(shape, false, true))
    return nullptr;
 
  Type elementType;
  if (parser.parseType(elementType))
    return nullptr;
 
  if (parser.parseGreater())
    return nullptr;
 
  return AMXTileType::getChecked(
      [&] { return parser.emitError(parser.getNameLoc()); }, shape,
      elementType);
}
 
void x86::amx::TileType::print(AsmPrinter &os) const {
  os << "<";
  os.printDimensionList(getShape());
  os << 'x';
  os.printType(getElementType());
  os << '>';
}
 
#define GET_OP_CLASSES
#include "mlir/Dialect/X86/X86.cpp.inc"
 
#define GET_TYPEDEF_CLASSES
#include "mlir/Dialect/X86/X86Types.cpp.inc"