//===- XeGPUOps.cpp - MLIR XeGPU ops implementation -------------*- C++ -*-===// // // 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 // //===----------------------------------------------------------------------===// #include "mlir/Dialect/Arith/Utils/Utils.h" #include "mlir/Dialect/Utils/IndexingUtils.h" #include "mlir/Dialect/Utils/StaticValueUtils.h" #include "mlir/Dialect/XeGPU/IR/XeGPU.h" #include "mlir/IR/Builders.h" #include "mlir/IR/TypeUtilities.h" #include "llvm/Support/Debug.h" #define DEBUG_TYPE "xegpu" namespace mlir { namespace xegpu { static void transpose(llvm::ArrayRef trans, SmallVector &shape) { SmallVector old = shape; for (size_t i = 0; i < trans.size(); i++) shape[i] = old[trans[i]]; } template static std::string makeString(T array, bool breakline = false) { std::string buf; buf.clear(); llvm::raw_string_ostream os(buf); os << "["; for (size_t i = 1; i < array.size(); i++) { os << array[i - 1] << ", "; if (breakline) os << "\n\t\t"; } os << array.back() << "]"; return buf; } static SmallVector getShapeOf(Type type) { SmallVector shape; if (auto ty = llvm::dyn_cast(type)) shape = SmallVector(ty.getShape()); else shape.push_back(1); return shape; } static int64_t getRankOf(Value val) { auto type = val.getType(); if (auto ty = llvm::dyn_cast(type)) return ty.getRank(); return 0; } static bool isReadHintOrNone(const CachePolicyAttr &attr) { if (!attr) return true; auto kind = attr.getValue(); return kind == CachePolicy::CACHED || kind == CachePolicy::UNCACHED || kind == CachePolicy::STREAMING || kind == CachePolicy::READ_INVALIDATE; } static bool isWriteHintOrNone(const CachePolicyAttr &attr) { if (!attr) return true; auto kind = attr.getValue(); return kind == CachePolicy::CACHED || kind == CachePolicy::UNCACHED || kind == CachePolicy::WRITE_BACK || kind == CachePolicy::WRITE_THROUGH; } static LogicalResult isValidGatherScatterParams(Type maskTy, VectorType valueTy, TensorDescType tdescTy, UnitAttr transposeAttr, function_ref emitError) { if (!tdescTy.isScattered()) return emitError() << "Expects a scattered TensorDesc."; if (!valueTy) return emitError() << "Expecting a vector type result."; auto maskShape = getShapeOf(maskTy); auto valueShape = getShapeOf(valueTy); auto tdescShape = getShapeOf(tdescTy); auto chunkSize = tdescTy.getChunkSize(); if (valueTy.getElementType() != tdescTy.getElementType()) return emitError() << "Value should have the same element type as TensorDesc."; if (tdescShape[0] != maskShape[0]) return emitError() << "dim-0 of the Mask and TensorDesc should be the same."; // a valid shape for SIMT case if (valueTy.getRank() == 1 && valueTy.getNumElements() == chunkSize) { if (tdescTy.getLayoutAttr()) return emitError() << "TensorDesc doesn't need LayoutAttr for SIMT code"; if (transposeAttr) return emitError() << "doesn't need TransposeAttr for SIMT code"; return success(); } if (tdescTy.getRank() == 2 && valueTy.getRank() == 2) { if (!transposeAttr) return emitError() << "rank-2 tensor has to be transposed."; transpose({1, 0}, tdescShape); } if (tdescShape != valueShape) return emitError() << "Value shape " << makeString(valueShape) << " is neither a valid distribution for SIMT nor " "consistent with the tensor descriptor for SIMD " << tdescTy; return success(); } //===----------------------------------------------------------------------===// // XeGPU_CreateNdDescOp //===----------------------------------------------------------------------===// void CreateNdDescOp::build(OpBuilder &builder, OperationState &state, Type tdesc, TypedValue source, llvm::ArrayRef offsets) { [[maybe_unused]] auto ty = source.getType(); assert(ty.hasStaticShape() && offsets.size() == (size_t)ty.getRank()); llvm::SmallVector staticOffsets; llvm::SmallVector dynamicOffsets; dispatchIndexOpFoldResults(offsets, dynamicOffsets, staticOffsets); build(builder, state, tdesc, source, dynamicOffsets /* dynamic offsets */, ValueRange({}) /* empty dynamic shape */, ValueRange({}) /* empty dynamic strides */, staticOffsets /* const offsets */, {} /* empty const shape*/, {} /* empty const strides*/); } void CreateNdDescOp::build(OpBuilder &builder, OperationState &state, Type tdesc, Value source, llvm::ArrayRef offsets, llvm::ArrayRef shape, llvm::ArrayRef strides) { assert(shape.size() && offsets.size() && strides.size() && shape.size() == strides.size() && shape.size() == offsets.size()); Type srcTy = source.getType(); assert(isa(srcTy) || isa(srcTy) && "Source has to be either int or memref."); llvm::SmallVector dynamicOffsets; llvm::SmallVector dynamicShape; llvm::SmallVector dynamicStrides; llvm::SmallVector staticOffsets; llvm::SmallVector staticShape; llvm::SmallVector staticStrides; dispatchIndexOpFoldResults(offsets, dynamicOffsets, staticOffsets); dispatchIndexOpFoldResults(shape, dynamicShape, staticShape); dispatchIndexOpFoldResults(strides, dynamicStrides, staticStrides); auto staticOffsetsAttr = builder.getDenseI64ArrayAttr(staticOffsets); auto staticShapeAttr = builder.getDenseI64ArrayAttr(staticShape); auto staticStridesAttr = builder.getDenseI64ArrayAttr(staticStrides); if (auto memrefTy = dyn_cast(srcTy)) { auto memrefShape = memrefTy.getShape(); auto [memrefStrides, _] = memrefTy.getStridesAndOffset(); // if shape and strides are from Memref, we don't need attributes for them // to keep the IR print clean. if (staticShape == memrefShape && staticStrides == memrefStrides) { staticShapeAttr = DenseI64ArrayAttr(); staticStridesAttr = DenseI64ArrayAttr(); } } build(builder, state, tdesc, source, dynamicOffsets, dynamicShape, dynamicStrides, staticOffsetsAttr, staticShapeAttr, staticStridesAttr); } LogicalResult CreateNdDescOp::verify() { auto rank = (int64_t)getMixedOffsets().size(); bool invalidRank = false; bool invalidElemTy = false; // Memory space of created TensorDesc should match with the source. // Both source and TensorDesc are considered for global memory by default, // if the memory scope attr is not specified. If source is an integer, // it is considered as ptr to global memory. auto srcMemorySpace = getSourceMemorySpace(); auto tdescMemorySpace = static_cast(getType().getMemorySpace()); if (srcMemorySpace != tdescMemorySpace) return emitOpError("Memory space mismatch.") << " Source: " << srcMemorySpace << ", TensorDesc: " << tdescMemorySpace; // check source type matches the rank if it is a memref. // It also should have the same ElementType as TensorDesc. auto memrefTy = dyn_cast(getSourceType()); if (memrefTy) { invalidRank |= (memrefTy.getRank() != rank); invalidElemTy |= memrefTy.getElementType() != getElementType(); } // mismatches among shape, strides, and offsets are // already handeled by OffsetSizeAndStrideOpInterface. // So they are not check here. if (invalidRank) return emitOpError( "Expecting the rank of shape, strides, offsets, and source (if source " "is a memref) should match with each other."); // check result TensorDesc rank invalidRank = (getType().getRank() > 2 || getType().getRank() > rank); if (invalidRank) return emitOpError( "Expecting the TensorDesc rank is up to 2 and not greater than the " "ranks of shape, strides, offsets or the memref source."); if (invalidElemTy) return emitOpError("TensorDesc should have the same element " "type with the source if it is a memref.\n"); if (getType().isScattered()) return emitOpError("Expects a non-scattered TensorDesc.\n"); return success(); } //===----------------------------------------------------------------------===// // XeGPU_PrefetchNdOp //===----------------------------------------------------------------------===// LogicalResult PrefetchNdOp::verify() { auto tdescTy = getTensorDescType(); if (tdescTy.isScattered()) return emitOpError("Expects a non-scattered TensorDesc.\n"); if (!isReadHintOrNone(getL1HintAttr())) return emitOpError("invalid l1_hint: ") << getL1HintAttr(); if (!isReadHintOrNone(getL2HintAttr())) return emitOpError("invalid l2_hint: ") << getL2HintAttr(); if (!isReadHintOrNone(getL3HintAttr())) return emitOpError("invalid l3_hint: ") << getL3HintAttr(); return success(); } //===----------------------------------------------------------------------===// // XeGPU_LoadNdOp //===----------------------------------------------------------------------===// LogicalResult LoadNdOp::verify() { auto tdescTy = getTensorDescType(); auto valueTy = getType(); if (tdescTy.getRank() > 2) return emitOpError("Expecting a 1D/2D TensorDesc.\n"); if (tdescTy.isScattered()) return emitOpError("Expects a non-scattered TensorDesc.\n"); if (!valueTy) return emitOpError("Invalid result, it should be a VectorType.\n"); if (!isReadHintOrNone(getL1HintAttr())) return emitOpError("invalid l1_hint: ") << getL1HintAttr(); if (!isReadHintOrNone(getL2HintAttr())) return emitOpError("invalid l2_hint: ") << getL2HintAttr(); if (!isReadHintOrNone(getL3HintAttr())) return emitOpError("invalid l3_hint: ") << getL3HintAttr(); int tdescElems = tdescTy.getNumElements() * tdescTy.getArrayLength(); int valueElems = valueTy.getNumElements(); // If the result vector is 1D and has less elements than the tensor // descriptor, it is supposed to be a SIMT op. The layout attribute in // tensor_desc is not needed. if (valueElems < tdescElems && valueTy.getRank() == 1) { // SIMT mode doesn't need LayoutAttr. if (tdescTy.getLayoutAttr()) return emitOpError() << "TensorDesc doesn't need LayoutAttr for SIMT code"; // For SIMT code, the load is evenly distributed across all lanes in a // subgroup. Since subgroup size is arch dependent, we only check even // distribution here. if (tdescElems % valueElems) return emitOpError() << "Result shape " << makeString(getShapeOf(valueTy)) << " is not a valid distribution for tensor descriptor " << tdescTy; return success(); } // Check SIMD mode. auto tdescShape = getShapeOf(tdescTy); auto valueShape = getShapeOf(valueTy); if (getTranspose()) { auto trans = getTranspose().value(); // Make sure the transpose value is valid. bool valid = llvm::all_of( trans, [&](int t) { return t >= 0 && t < tdescTy.getRank(); }); if (valid) transpose(trans, tdescShape); else mlir::emitWarning(getLoc()) << "Invalid transpose attr. It is ignored."; } if (getPacked()) { if (tdescTy.getRank() == 2) { const int axis = 0; auto vnni_factor = valueShape.back(); tdescShape[axis] /= vnni_factor; tdescShape.push_back(vnni_factor); } else { mlir::emitWarning(getLoc()) << "Invalid Packed Attr. It is ignored (available for 2D " "TensorDesc only)."; } } auto array_len = tdescTy.getArrayLength(); if (array_len > 1) { tdescShape.insert(tdescShape.begin(), array_len); } if (tdescShape != valueShape) { return emitOpError() << "Result shape " << makeString(valueShape) << " is not consistent with tensor descriptor " << tdescTy; } return success(); } //===----------------------------------------------------------------------===// // XeGPU_StoreNdOp //===----------------------------------------------------------------------===// LogicalResult StoreNdOp::verify() { auto dstTy = getTensorDescType(); // Tile auto valTy = getValueType(); // Vector if (dstTy.getRank() > 2) return emitOpError("Expecting a 1D/2D TensorDesc.\n"); if (dstTy.isScattered()) return emitOpError("Expects a non-scattered TensorDesc.\n"); if (!valTy) return emitOpError("Expecting a VectorType result.\n"); if (!isWriteHintOrNone(getL1HintAttr())) return emitOpError("invalid l1_hint: ") << getL1HintAttr(); if (!isWriteHintOrNone(getL2HintAttr())) return emitOpError("invalid l2_hint: ") << getL2HintAttr(); if (!isWriteHintOrNone(getL3HintAttr())) return emitOpError("invalid l3_hint: ") << getL3HintAttr(); auto array_len = dstTy.getArrayLength(); if (array_len > 1) return emitOpError("array length is not supported by store_nd.\n"); auto tdescElems = dstTy.getNumElements(); auto valueElems = valTy.getNumElements(); // Similar to LoadNdOp, if the value vector is 1D and has less elements than // the tensor descriptor, it is supposed to be a SIMT op. The layout attribute // in tensor_desc is not needed. if (valTy.getRank() == 1 && valueElems < tdescElems) { // SIMT mode doesn't need LayoutAttr. if (dstTy.getLayoutAttr()) return emitOpError() << "TensorDesc doesn't need LayoutAttr for SIMT code"; if (tdescElems % valueElems) { return emitOpError() << "Value shape " << makeString(getShapeOf(valTy)) << " is not a valid distribution for tensor descriptor " << dstTy; } return success(); } // SIMD code should have the same shape as the tensor descriptor. auto tdescShape = getShapeOf(dstTy); auto valueShape = getShapeOf(valTy); if (tdescShape != valueShape) { return emitOpError() << "Value shape " << makeString(valueShape) << " is not consistent with tensor descriptor " << dstTy; } return success(); } //===----------------------------------------------------------------------===// // XeGPU_UpdateNDOffsetOp //===----------------------------------------------------------------------===// LogicalResult UpdateNdOffsetOp::verify() { auto ty = getTensorDescType(); if (ty.isScattered()) return emitOpError("Expects a non-scattered TensorDesc.\n"); // number of offsets specified must match the rank of the tensor descriptor if (ty.getRank() != (int64_t)getNumOffsets()) { return emitOpError("Invalid number of offsets."); } return success(); } //===----------------------------------------------------------------------===// // XeGPU_CreateDescOp //===----------------------------------------------------------------------===// void CreateDescOp::build(OpBuilder &builder, OperationState &state, TensorDescType TensorDesc, Value source, llvm::ArrayRef offsets) { auto loc = source.getLoc(); int64_t size = static_cast(offsets.size()); auto type = VectorType::get(size, builder.getIndexType()); auto values = getValueOrCreateConstantIndexOp(builder, loc, offsets); auto offset = builder.create(loc, type, values); build(builder, state, TensorDesc, source, offset); } void CreateDescOp::build(OpBuilder &builder, OperationState &state, TensorDescType TensorDesc, Value source, llvm::ArrayRef offsets) { auto ofrs = getAsIndexOpFoldResult(builder.getContext(), offsets); build(builder, state, TensorDesc, source, ofrs); } LogicalResult CreateDescOp::verify() { auto tdescTy = getTensorDescType(); if (getRankOf(getSource()) > 1) return emitOpError( "Expecting the source is a 1D memref or pointer (uint64_t)."); if (!tdescTy.isScattered()) return emitOpError("Expects a scattered TensorDesc.\n"); // Memory space of created TensorDesc should match with the source. // Both source and TensorDesc are considered for global memory by default, // if the memory scope attr is not specified. If source is an integer, // it is considered as ptr to global memory. auto srcMemorySpace = getSourceMemorySpace(); auto tdescMemorySpace = static_cast(tdescTy.getMemorySpace()); if (srcMemorySpace != tdescMemorySpace) return emitOpError("Memory space mismatch.") << " Source: " << srcMemorySpace << ", TensorDesc: " << tdescMemorySpace; // check total size auto chunkSize = tdescTy.getChunkSize(); auto elemBits = tdescTy.getElementType().getIntOrFloatBitWidth(); auto bitsPerLane = elemBits * chunkSize; if (chunkSize > 1 && bitsPerLane % 32) { // For 8-bit and 16-bit data, the hardware only supports chunk size of 1. // For 32-bit data, the hardware can support larger larger chunk size. So // we can bitcast 8-bit/16-bit data to 32-bit data for better performance. // But this requires the total size is 32 bit aligned to make the // optimization work. return emitOpError( "access size (chunk_size * sizeof(elemTy)) should be 32-bit aligned."); } auto lscConstraints = 512 * 8; // each access is upto 512 bytes. if (elemBits * tdescTy.getNumElements() > lscConstraints) return emitOpError("total access size (simd_lanes * chunk_size * " "sizeof(elemTy)) is upto 512 bytes."); SmallVector shape({(int64_t)getNumOffsets()}); if (chunkSize != 1) shape.push_back(chunkSize); auto tdescShape = getShapeOf(tdescTy); if (shape != tdescShape) return emitOpError("Incorrect TensorDesc shape. ") << "Expected is " << makeString(shape) << "\n"; return success(); } //===----------------------------------------------------------------------===// // XeGPU_PrefetchOp //===----------------------------------------------------------------------===// LogicalResult PrefetchOp::verify() { auto tdescTy = getTensorDescType(); if (!tdescTy.isScattered()) return emitOpError("Expects a scattered TensorDesc.\n"); if (!isReadHintOrNone(getL1HintAttr())) return emitOpError("invalid l1_hint: ") << getL1HintAttr(); if (!isReadHintOrNone(getL2HintAttr())) return emitOpError("invalid l2_hint: ") << getL2HintAttr(); if (!isReadHintOrNone(getL3HintAttr())) return emitOpError("invalid l3_hint: ") << getL3HintAttr(); return success(); } //===----------------------------------------------------------------------===// // XeGPU_LoadGatherOp //===----------------------------------------------------------------------===// LogicalResult LoadGatherOp::verify() { auto tdescTy = getTensorDescType(); auto maskTy = getMaskType(); auto valueTy = getValueType(); if (!isReadHintOrNone(getL1HintAttr())) return emitOpError("invalid l1_hint: ") << getL1HintAttr(); if (!isReadHintOrNone(getL2HintAttr())) return emitOpError("invalid l2_hint: ") << getL2HintAttr(); if (!isReadHintOrNone(getL3HintAttr())) return emitOpError("invalid l3_hint: ") << getL3HintAttr(); return isValidGatherScatterParams(maskTy, valueTy, tdescTy, getTransposeAttr(), [&]() { return emitOpError(); }); } //===----------------------------------------------------------------------===// // XeGPU_StoreScatterOp //===----------------------------------------------------------------------===// LogicalResult StoreScatterOp::verify() { auto tdescTy = getTensorDescType(); auto maskTy = getMaskType(); auto valueTy = getValueType(); if (!isWriteHintOrNone(getL1HintAttr())) return emitOpError("invalid l1_hint: ") << getL1HintAttr(); if (!isWriteHintOrNone(getL2HintAttr())) return emitOpError("invalid l2_hint: ") << getL2HintAttr(); if (!isWriteHintOrNone(getL3HintAttr())) return emitOpError("invalid l3_hint: ") << getL3HintAttr(); return isValidGatherScatterParams(maskTy, valueTy, tdescTy, getTransposeAttr(), [&]() { return emitOpError(); }); } //===----------------------------------------------------------------------===// // XeGPU_UpdateOffsetOp //===----------------------------------------------------------------------===// void UpdateOffsetOp::build(OpBuilder &builder, OperationState &state, mlir::Value tensorDesc, llvm::ArrayRef offsets) { auto tdescTy = mlir::dyn_cast(tensorDesc.getType()); assert(tdescTy && "Expecting the source is a TensorDescType value."); auto loc = tensorDesc.getLoc(); int64_t size = static_cast(offsets.size()); auto type = VectorType::get({size}, builder.getIndexType()); auto values = getValueOrCreateConstantIndexOp(builder, loc, offsets); auto offset = builder.create(loc, type, values); build(builder, state, tdescTy, tensorDesc, offset); } void UpdateOffsetOp::build(OpBuilder &builder, OperationState &state, Value tensorDesc, llvm::ArrayRef offsets) { auto ofrs = getAsIndexOpFoldResult(builder.getContext(), offsets); build(builder, state, tensorDesc, ofrs); } //===----------------------------------------------------------------------===// // XeGPU_DpasOp //===----------------------------------------------------------------------===// LogicalResult DpasOp::verify() { int64_t lhsRank = getLhsType().getRank(); int64_t rhsRank = getRhsType().getRank(); int64_t resRank = getResultType().getRank(); auto lhsShape = getLhsType().getShape(); auto rhsShape = getRhsType().getShape(); auto resShape = getResultType().getShape(); if (getAcc() && getAcc().getType() != getResultType()) return emitOpError("Expecting the acc type to be the same as result."); // SIMT code: the size of the B operand has to be a multiple of 32 bits. // It skips the semantic check since lack of architecture information. // Users need to ensure the correctness. if (lhsRank == 1 && rhsRank == 1 && resRank == 1) { auto numElems = getRhsType().getNumElements(); auto elemTy = getRhsType().getElementType(); auto factor = 32 / elemTy.getIntOrFloatBitWidth(); if (numElems % factor != 0) return emitOpError("Expecting B operand to be a multiple of 32 bits."); return success(); } // SIMD code if (lhsRank != 2 || (rhsRank != 2 && rhsRank != 3) || resRank != 2) return emitOpError( "expecting lhs and result to be a 2D vector, and rhs to be either " "2D or 3D (packed) vector."); auto bK = rhsRank == 3 ? rhsShape[0] * rhsShape[2] : rhsShape[0]; if (bK != lhsShape[1]) return emitOpError("K-dimension mismatch."); if (lhsShape[0] != resShape[0]) return emitOpError("M-dimension mismatch."); if (rhsShape[1] != resShape[1]) return emitOpError("N-dimension mismatch."); return success(); } //===----------------------------------------------------------------------===// // XeGPU_ConvertLayoutOp //===----------------------------------------------------------------------===// LogicalResult ConvertLayoutOp::verify() { auto srcMap = getSrcMapAttr(); auto resMap = getResMapAttr(); if (!srcMap) return emitOpError("expected srcMap."); if (!resMap) return emitOpError("expected resMap."); if (srcMap == resMap) return emitOpError("expected different srcMap and resMap."); // both srcMap and resMap should be WgLayout or SgLayout at the same time. if ((!srcMap.isWgLayout() || !resMap.isWgLayout()) && (!srcMap.isSgLayout() || !resMap.isSgLayout())) return emitOpError( "expected srcMap and resMap be WgLayout or SgLayout at the same time."); auto shape = getSource().getType().getShape(); if (!XeGPUDialect::isEvenlyDistributable(shape, srcMap)) return emitOpError("invalid srcMap, data cannot be evenly distributed."); if (!XeGPUDialect::isEvenlyDistributable(shape, resMap)) return emitOpError("invalid resMap, data cannot be evenly distributed."); return mlir::success(); } } // namespace xegpu } // namespace mlir #include #define GET_OP_CLASSES #include