AIEVecOptimizations.cpp

Go to the documentation of this file.

//===- AIEVecOptimizations.cpp - Patterns to optimize AIEVec ----*- 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
//
// (c) Copyright 2023, Advanced Micro Devices, Inc.
//
//===----------------------------------------------------------------------===//
// This file contains conversions and rewrite that replace common AIEVec ops
// with more complex, and performant AIEVec ops.
//===----------------------------------------------------------------------===//
 
#include "FoldMulAddChainToConvOp.h"
 
#include "aie/Dialect/AIEVec/AIE1/IR/AIEVecAIE1Ops.h"
#include "aie/Dialect/AIEVec/AIEVecUtils.h"
#include "aie/Dialect/AIEVec/Analysis/Passes.h"
#include "aie/Dialect/AIEVec/IR/AIEVecOps.h"
#include "aie/Dialect/AIEVec/Pipelines/Passes.h"
 
#include "mlir/Dialect/Affine/IR/AffineOps.h"
#include "mlir/Dialect/Func/IR/FuncOps.h"
#include "mlir/Dialect/MemRef/IR/MemRef.h"
#include "mlir/Dialect/SCF/IR/SCF.h"
#include "mlir/IR/PatternMatch.h"
#include "mlir/Pass/PassManager.h"
#include "mlir/Transforms/DialectConversion.h"
#include "mlir/Transforms/GreedyPatternRewriteDriver.h"
#include "mlir/Transforms/Passes.h"
 
#define DEBUG_TYPE "aievec-optimize"
 
using namespace llvm;
using namespace mlir;
using namespace arith;
using namespace vector;
using namespace xilinx;
using namespace xilinx::aievec;
 
//===----------------------------------------------------------------------===//
// Utility functions
//===----------------------------------------------------------------------===//
namespace xilinx {
namespace aievec {
 
SmallVector<NamedAttribute>
buildFMAOpSplatAttrForElemTy(aievec::aie1::FMAOp fmaOp, int64_t bcastPos,
                             int64_t step = 1);
 
} // namespace aievec
} // namespace xilinx
 
static bool canFoldAIEShiftAndBroadcast(aievec::BroadcastOp op,
                                        aievec::ShiftOp &shiftOp,
                                        int32_t &idx) {
  if (!op.getSource().getDefiningOp())
    return false;
 
  shiftOp = dyn_cast<aievec::ShiftOp>(op.getSource().getDefiningOp());
 
  if (!shiftOp)
    return false;
 
  VectorType vType = cast<VectorType>(shiftOp->getResult(0).getType());
  int32_t elemSize = getElementSizeInBits(vType);
  auto constOp = cast<arith::ConstantOp>(shiftOp.getShift().getDefiningOp());
  int32_t shiftBytes = cast<IntegerAttr>(constOp.getValue()).getInt();
  idx = shiftBytes * 8 / elemSize + op.getIdx();
 
  if (idx <= 0 || idx >= (int32_t)getVectorLaneSize(vType)) {
    return false;
  }
 
  return true;
}
 
template <typename AIEv1MACLikeOp,
          typename = std::enable_if_t<
              std::is_same_v<AIEv1MACLikeOp, aievec::aie1::FMAOp> ||
              std::is_same_v<AIEv1MACLikeOp, aievec::aie1::FMAOp::Adaptor>>>
static bool isSingleColumnInt16VectorTimesScalarMac(AIEv1MACLikeOp fmaOp) {
  // lhs is a 32xi16 vector
  VectorType lhsVTy = cast<VectorType>(fmaOp.getLhs().getType());
  auto intTy = dyn_cast<IntegerType>(lhsVTy.getElementType());
  if (!intTy || intTy.getWidth() != 16)
    return false;
  if (lhsVTy.getShape()[0] != 32)
    return false;
  // Attributes match a Vector x Scalar mac
  if (fmaOp.getXoffsets() != "0x73727170" ||
      fmaOp.getXoffsetsHi() != "0x77767574" || fmaOp.getXstart() != "0" ||
      fmaOp.getXsquare() != "0x3120" || fmaOp.getZoffsets() != "0" ||
      fmaOp.getZoffsetsHi() != "0" || fmaOp.getZstep() != "1")
    return false;
  // lhs op is a concat of a vector and a dense<0> constant vector
  if (!fmaOp.getLhs().getDefiningOp())
    return false;
  aievec::ConcatOp concatOp =
      dyn_cast<aievec::ConcatOp>(fmaOp.getLhs().getDefiningOp());
  if (!concatOp)
    return false;
  auto tailVec = concatOp.getSources()[1];
  if (!tailVec.getDefiningOp())
    return false;
  auto constOp = dyn_cast<arith::ConstantOp>(tailVec.getDefiningOp());
  if (!constOp)
    return false;
  auto cstDense = dyn_cast<DenseIntElementsAttr>(constOp.getValue());
  if (!cstDense)
    return false;
  return llvm::all_of(cstDense, [](const APInt &val) { return val == 0; });
}
 
static bool singleColumnFMAOpCanFold(aievec::aie1::FMAOp fmaOp) {
  auto accProdOp = fmaOp.getAcc().getDefiningOp();
  if (!accProdOp)
    return false;
  auto accFmaOp = dyn_cast<aievec::aie1::FMAOp>(accProdOp);
  if (!accFmaOp)
    return false;
  if (!isSingleColumnInt16VectorTimesScalarMac(accFmaOp))
    return false;
  return fmaOp.getRhs() == accFmaOp.getRhs() &&
         !singleColumnFMAOpCanFold(accFmaOp);
}
 
//===----------------------------------------------------------------------===//
// Lowering patterns
//===----------------------------------------------------------------------===//
struct MergeSingleColumnI16FMAOpPattern
    : public OpConversionPattern<aievec::aie1::FMAOp> {
  using OpConversionPattern<aievec::aie1::FMAOp>::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(aievec::aie1::FMAOp fmaOp, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    if (!isSingleColumnInt16VectorTimesScalarMac(adaptor))
      return failure();
    auto accProdOp = adaptor.getAcc().getDefiningOp();
    if (!accProdOp)
      return failure();
    auto accFmaOp = dyn_cast<aievec::aie1::FMAOp>(accProdOp);
    if (!accFmaOp)
      return failure();
    if (!isSingleColumnInt16VectorTimesScalarMac(accFmaOp))
      return failure();
    if (adaptor.getRhs() != accFmaOp.getRhs())
      return failure();
    auto accConcatOp =
        cast<aievec::ConcatOp>(accFmaOp.getLhs().getDefiningOp());
    auto fmaConcatOp = cast<aievec::ConcatOp>(adaptor.getLhs().getDefiningOp());
    unsigned fmaZstart, accFmaZstart;
    if (adaptor.getZstart().getAsInteger(10, fmaZstart) ||
        accFmaOp.getZstart().getAsInteger(10, accFmaZstart))
      return failure();
    auto start = std::min(fmaZstart, accFmaZstart);
    auto step = std::max(fmaZstart, accFmaZstart) - start;
    auto lowV = accConcatOp.getSources()[0];
    auto hiV = fmaConcatOp.getSources()[0];
    if (accFmaZstart > fmaZstart)
      std::swap(lowV, hiV);
    auto newConcatOp = rewriter.create<aievec::ConcatOp>(
        fmaOp.getLoc(), adaptor.getLhs().getType(),
        SmallVector<Value, 2>({lowV, hiV}));
    auto newFmaOpAttr = buildFMAOpSplatAttrForElemTy(fmaOp, start, step);
    rewriter.replaceOpWithNewOp<aievec::aie1::FMAOp>(
        fmaOp, TypeRange({fmaOp.getResult().getType()}),
        ValueRange({newConcatOp, adaptor.getRhs(), accFmaOp.getAcc()}),
        newFmaOpAttr);
    return success();
  }
  matchAndRewrite(aievec::aie1::FMAOp fmaOp, OpAdaptor adaptor, {…}
};
struct MergeSingleColumnI16FMAOpPattern {…};
 
struct FoldAIEShiftAndBroadcast
    : public OpConversionPattern<aievec::BroadcastOp> {
  using OpConversionPattern<aievec::BroadcastOp>::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(aievec::BroadcastOp bcastOp, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    aievec::ShiftOp shiftOp = nullptr;
    int32_t idx = 0;
 
    if (!canFoldAIEShiftAndBroadcast(bcastOp, shiftOp, idx)) {
      return failure();
    }
 
    VectorType resultType = cast<VectorType>(bcastOp.getResult().getType());
 
    rewriter.replaceOpWithNewOp<aievec::BroadcastOp>(bcastOp, resultType,
                                                     shiftOp.getLhs(), idx);
 
    return success();
  }
  matchAndRewrite(aievec::BroadcastOp bcastOp, OpAdaptor adaptor, {…}
};
struct FoldAIEShiftAndBroadcast {…};
 
//===----------------------------------------------------------------------===//
// Pattern collection
//===----------------------------------------------------------------------===//
static void populateAIEVecV1TransformationPatterns(RewritePatternSet &patterns,
                                                   TargetBackend backend) {
  patterns.add<MergeSingleColumnI16FMAOpPattern>(patterns.getContext());
}
 
static void populateAIEVecV2TransformationPatterns(RewritePatternSet &patterns,
                                                   TargetBackend backend) {
  patterns.add<FoldAIEShiftAndBroadcast>(patterns.getContext());
}
 
//===----------------------------------------------------------------------===//
// Legalizations
//===----------------------------------------------------------------------===//
 
static void
configureAIEVecV1TransformationLegalizations(ConversionTarget &target,
                                             TargetBackend backend) {
  target.addLegalDialect<aievec::AIEVecDialect,
                         aievec::aie1::AIEVecAIE1Dialect>();
  target.addDynamicallyLegalOp<aievec::aie1::FMAOp>(
      [](aievec::aie1::FMAOp fmaOp) {
        if (isSingleColumnInt16VectorTimesScalarMac(fmaOp))
          return !singleColumnFMAOpCanFold(fmaOp);
        return true;
      });
}
 
static void
configureAIEVecV2TransformationLegalizations(ConversionTarget &target,
                                             TargetBackend backend) {
  target.addDynamicallyLegalOp<xilinx::aievec::BroadcastOp>(
      [](xilinx::aievec::BroadcastOp op) {
        aievec::ShiftOp shiftOp = nullptr;
        int32_t idx = 0;
        return !canFoldAIEShiftAndBroadcast(op, shiftOp, idx);
      });
}
 
//===----------------------------------------------------------------------===//
// Lowering passes
//===----------------------------------------------------------------------===//
struct AIEVecTransformationPass
    : public PassWrapper<AIEVecTransformationPass, OperationPass<>> {
  MLIR_DEFINE_EXPLICIT_INTERNAL_INLINE_TYPE_ID(AIEVecTransformationPass)
 
  AIEVecTransformationPass() = default;
  AIEVecTransformationPass(const AIEVecTransformationPass &pass)
      : PassWrapper(pass) {}
  AIEVecTransformationPass(const AIEVecTransformationPass &pass) {…}
 
  AIEVecTransformationPass(const OptimizeAIEVecOptions &options)
      : AIEVecTransformationPass() {
    aieTarget = options.aieTarget;
    targetBackend = options.targetBackend;
  }
  AIEVecTransformationPass(const OptimizeAIEVecOptions &options) {…}
 
  // In case we want to register this pass as a standalone pass for test
  // purposes.
  StringRef getArgument() const final { return "test-aievec-optimize"; }
  StringRef getDescription() const final {
    return "Optimize groups of simple aievec ops into complex aievec ops.";
  }
  StringRef getDescription() const final {…}
  void getDependentDialects(DialectRegistry &registry) const override {
    // TODO: Review list of dependent dialects.
    registry.insert<affine::AffineDialect, xilinx::aievec::AIEVecDialect,
                    aievec::aie1::AIEVecAIE1Dialect, arith::ArithDialect,
                    memref::MemRefDialect, scf::SCFDialect,
                    vector::VectorDialect>();
  }
  void getDependentDialects(DialectRegistry &registry) const override  {…}
 
  Option<std::string> aieTarget{
      *this, "aie-target",
      llvm::cl::desc("Select AIE version: \"aie\" or \"aie2\". This will "
                     "determine the vector size and available operations."),
      llvm::cl::init("aie")};
  Option<std::string> aieTarget {…};
 
  Option<std::string> targetBackend{
      *this, "target-backend",
      llvm::cl::desc("Select translation backend: \"cpp\" or \"llvmir\". This "
                     "will determine the aievec operations used to convert "
                     "from vector dialect."),
      llvm::cl::init("cpp")};
  Option<std::string> targetBackend {…};
 
  void runOnOperation() override {
    auto op = getOperation();
    MLIRContext *context = &getContext();
    RewritePatternSet patterns(context);
    ConversionTarget target(*context);
    AIEArch aieVersion = AIEArch::AIE;
    if (!aieTarget.empty()) {
      std::string target = aieTarget;
      if (target == "aieml" || target == "aie2") {
        aieVersion = AIEArch::AIE2;
      } else if (target != "aie") {
        op->emitError() << "unknown AIE target '" << aieTarget << "'";
        signalPassFailure();
        return;
      }
    }
 
    TargetBackend backend = TargetBackend::CPP;
    if (!targetBackend.empty()) {
      std::string backendStr = targetBackend;
      if (backendStr == "llvmir") {
        backend = TargetBackend::LLVMIR;
        if (aieVersion == AIEArch::AIE) {
          op->emitError() << "targetting LLVM IR is not supported for AIEv1";
          signalPassFailure();
          return;
        }
      } else if (backendStr != "cpp") {
        op->emitError() << "unknown target backend'" << targetBackend << "'";
        signalPassFailure();
        return;
      }
    }
 
    if (aieVersion == AIEArch::AIE) {
      populateAIEVecV1TransformationPatterns(patterns, backend);
      configureAIEVecV1TransformationLegalizations(target, backend);
    } else {
      populateAIEVecV2TransformationPatterns(patterns, backend);
      configureAIEVecV2TransformationLegalizations(target, backend);
    }
 
    if (failed(applyPartialConversion(op, target, std::move(patterns)))) {
      signalPassFailure();
    }
  }
  void runOnOperation() override  {…}
};
struct AIEVecTransformationPass {…};
 
static std::unique_ptr<::mlir::Pass>
createAIEVecTransformationPass(const OptimizeAIEVecOptions &options) {
  return std::make_unique<AIEVecTransformationPass>(options);
}
 
struct AIEVecConvOpTransformationPass
    : public PassWrapper<AIEVecConvOpTransformationPass, OperationPass<>> {
  MLIR_DEFINE_EXPLICIT_INTERNAL_INLINE_TYPE_ID(AIEVecConvOpTransformationPass)
 
  AIEVecConvOpTransformationPass() = default;
  AIEVecConvOpTransformationPass(const AIEVecConvOpTransformationPass &pass)
      : PassWrapper(pass) {}
  AIEVecConvOpTransformationPass(const AIEVecConvOpTransformationPass &pass) {…}
 
  AIEVecConvOpTransformationPass(const OptimizeAIEVecOptions &options)
      : AIEVecConvOpTransformationPass() {
    aieTarget = options.aieTarget;
    targetBackend = options.targetBackend;
    shiftParam = options.shiftParam;
  }
  AIEVecConvOpTransformationPass(const OptimizeAIEVecOptions &options) {…}
 
  // In case we want to register this pass as a standalone pass for test
  // purposes.
  StringRef getArgument() const final {
    return "test-aievec-convolution-optimize";
  }
  StringRef getArgument() const final {…}
  StringRef getDescription() const final {
    return "Optimize chains of macs into AIE2 conv ops.";
  }
  StringRef getDescription() const final {…}
  void getDependentDialects(DialectRegistry &registry) const override {
    // TODO: Review list of dependent dialects.
    registry.insert<affine::AffineDialect, xilinx::aievec::AIEVecDialect,
                    aievec::aie1::AIEVecAIE1Dialect, arith::ArithDialect,
                    memref::MemRefDialect, scf::SCFDialect,
                    vector::VectorDialect>();
  }
  void getDependentDialects(DialectRegistry &registry) const override  {…}
 
  Option<std::string> aieTarget{
      *this, "aie-target",
      llvm::cl::desc("Select AIE version: \"aie\" or \"aie2\". This will "
                     "determine the vector size and available operations."),
      llvm::cl::init("aie")};
  Option<std::string> aieTarget {…};
 
  Option<std::string> targetBackend{
      *this, "target-backend",
      llvm::cl::desc("Select translation backend: \"cpp\" or \"llvmir\". This "
                     "will determine the aievec operations used to convert "
                     "from vector dialect."),
      llvm::cl::init("cpp")};
  Option<std::string> targetBackend {…};
 
  Option<unsigned> shiftParam{
      *this, "shift",
      llvm::cl::desc("Shift parameter for rounding and saturation."),
      llvm::cl::init(0)};
  Option<unsigned> shiftParam {…};
 
  void runOnOperation() override {
    auto op = getOperation();
    MLIRContext *context = &getContext();
    RewritePatternSet patterns(context);
    ConversionTarget target(*context);
    AIEArch aieVersion = AIEArch::AIE;
    if (!aieTarget.empty()) {
      std::string target = aieTarget;
      if (target == "aieml" || target == "aie2") {
        aieVersion = AIEArch::AIE2;
      } else if (target != "aie") {
        op->emitError() << "unknown AIE target '" << aieTarget << "'";
        signalPassFailure();
        return;
      }
    }
 
    TargetBackend backend = TargetBackend::CPP;
    if (!targetBackend.empty()) {
      std::string backendStr = targetBackend;
      if (backendStr == "llvmir") {
        backend = TargetBackend::LLVMIR;
        if (aieVersion == AIEArch::AIE) {
          op->emitError() << "targetting LLVM IR is not supported for AIEv1";
          signalPassFailure();
          return;
        }
      } else if (backendStr != "cpp") {
        op->emitError() << "unknown target backend'" << targetBackend << "'";
        signalPassFailure();
        return;
      }
    }
 
    AnalysisManager am = getAnalysisManager();
    if (aieVersion == AIEArch::AIE2) {
      populateAIEVecConvOpTransformationPatterns(patterns, am, shiftParam,
                                                 backend);
      configureAIEVecConvOpTransformationLegalizations(target, am, backend);
    }
 
    if (failed(applyPartialConversion(op, target, std::move(patterns)))) {
      signalPassFailure();
    }
  }
  void runOnOperation() override  {…}
};
struct AIEVecConvOpTransformationPass {…};
 
static std::unique_ptr<::mlir::Pass>
createAIEVecConvOpTransformationPass(const OptimizeAIEVecOptions &options) {
  return std::make_unique<AIEVecConvOpTransformationPass>(options);
}
 
//============================================================================//
//=============== Main AIEVec2AIEVec Pipeline Configuration ==================//
//============================================================================//
 
void xilinx::aievec::buildOptimizeAIEVec(OpPassManager &pm,
                                         const OptimizeAIEVecOptions &options) {
  // Add AIEVec transformation pass.
  pm.addPass(createAIEVecTransformationPass(options));
 
  pm.addPass(createCSEPass());
  pm.addPass(createCanonicalizerPass());
 
  // Add generating aievec convolution ops pass
  if (options.aieTarget == "aieml" || options.aieTarget == "aie2") {
    pm.addPass(createAIEVecConvolutionAnalysisPass());
    pm.addPass(createAIEVecConvOpTransformationPass(options));
  }
 
  // Add post-lowering canonicalization passes.
  pm.addPass(createCSEPass());
  pm.addPass(createCanonicalizerPass());
}