ESILowerToHW.cpp

Go to the documentation of this file.

//===- ESILowerToHW.cpp - Lower ESI to HW -----------------------*- 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
//
//===----------------------------------------------------------------------===//
//
// Lower to HW/SV conversions and pass.
//
//===----------------------------------------------------------------------===//
 
#include "../PassDetails.h"
 
#include "circt/Dialect/Comb/CombOps.h"
#include "circt/Dialect/ESI/ESIOps.h"
#include "circt/Dialect/HW/HWOps.h"
#include "circt/Dialect/SV/SVOps.h"
#include "circt/Dialect/Seq/SeqOps.h"
#include "circt/Support/BackedgeBuilder.h"
#include "circt/Support/LLVM.h"
#include "circt/Support/SymCache.h"
 
#include "mlir/Transforms/DialectConversion.h"
#include "mlir/Transforms/GreedyPatternRewriteDriver.h"
 
#include "llvm/ADT/StringExtras.h"
#include "llvm/ADT/TypeSwitch.h"
#include "llvm/Support/JSON.h"
 
namespace circt {
namespace esi {
#define GEN_PASS_DEF_LOWERESITOHW
#include "circt/Dialect/ESI/ESIPasses.h.inc"
} // namespace esi
} // namespace circt
 
using namespace circt;
using namespace circt::esi;
using namespace circt::esi::detail;
using namespace circt::hw;
using namespace circt::sv;
 
namespace {
/// Lower PipelineStageOp ops to an HW implementation. Unwrap and re-wrap
/// appropriately. Another conversion will take care merging the resulting
/// adjacent wrap/unwrap ops.
struct PipelineStageLowering : public OpConversionPattern<PipelineStageOp> {
public:
  PipelineStageLowering(ESIHWBuilder &builder, MLIRContext *ctxt)
      : OpConversionPattern(ctxt), builder(builder) {}
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(PipelineStageOp stage, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const final;
 
private:
  ESIHWBuilder &builder;
};
} // anonymous namespace
 
LogicalResult PipelineStageLowering::matchAndRewrite(
    PipelineStageOp stage, OpAdaptor adaptor,
    ConversionPatternRewriter &rewriter) const {
  auto loc = stage.getLoc();
  auto chPort = dyn_cast<ChannelType>(stage.getInput().getType());
  if (!chPort)
    return rewriter.notifyMatchFailure(stage, "stage had wrong type");
  Operation *symTable = stage->getParentWithTrait<OpTrait::SymbolTable>();
  auto stageModule = builder.declareStage(symTable, stage);
 
  size_t width = circt::hw::getBitWidth(chPort.getInner());
 
  ArrayAttr stageParams = builder.getStageParameterList(
      rewriter.getUI32IntegerAttr(width),
      rewriter.getUI32IntegerAttr(chPort.getDataDelay()));
 
  // Unwrap the channel. The ready signal is a Value we haven't created yet,
  // so create a temp value and replace it later. Give this constant an
  // odd-looking type to make debugging easier.
  circt::BackedgeBuilder back(rewriter, loc);
  circt::Backedge wrapReady = back.get(rewriter.getI1Type());
  auto unwrap =
      UnwrapValidReadyOp::create(rewriter, loc, stage.getInput(), wrapReady);
 
  StringRef pipeStageName = "pipelineStage";
  if (auto name = stage->getAttrOfType<StringAttr>("name"))
    pipeStageName = name.getValue();
 
  // Instantiate the "ESI_PipelineStage" external module.
  circt::Backedge stageReady = back.get(rewriter.getI1Type());
  llvm::SmallVector<Value> operands = {stage.getClk(), stage.getRst()};
  operands.push_back(unwrap.getRawOutput());
  operands.push_back(unwrap.getValid());
  operands.push_back(stageReady);
  auto stageInst = hw::InstanceOp::create(rewriter, loc, stageModule,
                                          pipeStageName, operands, stageParams);
  auto stageInstResults = stageInst.getResults();
 
  // Set a_ready (from the unwrap) back edge correctly to its output from
  // stage.
  wrapReady.setValue(stageInstResults[0]);
  Value x, xValid;
  x = stageInstResults[1];
  xValid = stageInstResults[2];
 
  // Wrap up the output of the HW stage module.
  auto wrap = WrapValidReadyOp::create(rewriter, loc, chPort,
                                       rewriter.getI1Type(), x, xValid);
  // Set the stages x_ready backedge correctly.
  stageReady.setValue(wrap.getReady());
 
  rewriter.replaceOp(stage, wrap.getChanOutput());
  return success();
}
 
namespace {
struct NullSourceOpLowering : public OpConversionPattern<NullSourceOp> {
public:
  NullSourceOpLowering(MLIRContext *ctxt) : OpConversionPattern(ctxt) {}
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(NullSourceOp nullop, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const final;
};
} // anonymous namespace
 
LogicalResult NullSourceOpLowering::matchAndRewrite(
    NullSourceOp nullop, OpAdaptor adaptor,
    ConversionPatternRewriter &rewriter) const {
  auto chanType = cast<ChannelType>(nullop.getOut().getType());
  auto innerType = chanType.getInner();
  Location loc = nullop.getLoc();
  int64_t width = hw::getBitWidth(innerType);
  if (width == -1)
    return rewriter.notifyMatchFailure(
        nullop, "NullOp lowering only supports hw types");
  auto valid = hw::ConstantOp::create(rewriter, nullop.getLoc(),
                                      rewriter.getI1Type(), 0);
  auto zero =
      hw::ConstantOp::create(rewriter, loc, rewriter.getIntegerType(width), 0);
  auto typedZero = hw::BitcastOp::create(rewriter, loc, innerType, zero);
 
  if (chanType.getSignaling() == ChannelSignaling::ValidOnly) {
    auto wrap = WrapValidOnlyOp::create(rewriter, loc, typedZero, valid,
                                        chanType.getDataDelay());
    wrap->setAttr("name", rewriter.getStringAttr("nullsource"));
    rewriter.replaceOp(nullop, {wrap.getChanOutput()});
  } else {
    auto wrap = WrapValidReadyOp::create(rewriter, loc, typedZero, valid,
                                         chanType.getDataDelay());
    wrap->setAttr("name", rewriter.getStringAttr("nullsource"));
    rewriter.replaceOp(nullop, {wrap.getChanOutput()});
  }
  return success();
}
 
namespace {
/// Eliminate snoop operations by extracting signals from wrap operations.
/// After ESI ports lowering, channels always come from wraps and are consumed
/// by unwraps (or have no consumers). This pattern leverages that invariant.
struct RemoveSnoopOp : public OpConversionPattern<SnoopValidReadyOp> {
public:
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(SnoopValidReadyOp op, SnoopValidReadyOpAdaptor operands,
                  ConversionPatternRewriter &rewriter) const override {
    Operation *defOp = op.getInput().getDefiningOp();
    if (!defOp)
      return rewriter.notifyMatchFailure(op,
                                         "snoop input is not defined by an op");
    auto wrap = dyn_cast<WrapValidReadyOp>(defOp);
    if (!wrap)
      return rewriter.notifyMatchFailure(
          defOp, "Snoop input must be a wrap.vr operation");
 
    // Get valid and data directly from the wrap
    Value valid = wrap.getValid();
    Value data = wrap.getRawInput();
 
    // For ready: check if there's an unwrap consumer
    Value ready;
    auto *unwrapOpOperand =
        ChannelType::getSingleConsumer(wrap.getChanOutput());
 
    if (unwrapOpOperand &&
        isa<UnwrapValidReadyOp>(unwrapOpOperand->getOwner())) {
      // There's an unwrap - use its ready signal
      auto unwrap = cast<UnwrapValidReadyOp>(unwrapOpOperand->getOwner());
      ready = unwrap.getReady();
    } else {
      // No consumer: synthesize a constant false ready signal
      // (nothing is ready to consume this channel)
      assert(!unwrapOpOperand &&
             "Expected no consumer or consumer should be an unwrap");
      ready = hw::ConstantOp::create(rewriter, op.getLoc(),
                                     rewriter.getI1Type(), 0);
    }
 
    rewriter.replaceOp(op, {valid, ready, data});
    return success();
  }
};
} // anonymous namespace
 
namespace {
/// Eliminate snoop transaction operations by extracting signals from wrap
/// operations. After ESI ports lowering, channels always come from wraps
/// and are consumed by unwraps (or have no consumers).
struct RemoveSnoopTransactionOp
    : public OpConversionPattern<SnoopTransactionOp> {
public:
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(SnoopTransactionOp op, SnoopTransactionOpAdaptor operands,
                  ConversionPatternRewriter &rewriter) const override {
    Operation *defOp = op.getInput().getDefiningOp();
    if (!defOp)
      return rewriter.notifyMatchFailure(op,
                                         "snoop input is not defined by an op");
 
    // Handle ValidReady signaling
    if (auto wrapVR = dyn_cast<WrapValidReadyOp>(defOp)) {
      Value data = wrapVR.getRawInput();
      Value valid = wrapVR.getValid();
 
      // Find ready signal
      Value ready;
      auto *unwrapOpOperand =
          ChannelType::getSingleConsumer(wrapVR.getChanOutput());
 
      if (unwrapOpOperand &&
          isa<UnwrapValidReadyOp>(unwrapOpOperand->getOwner())) {
        // There's an unwrap - use its ready signal
        auto unwrapVR = cast<UnwrapValidReadyOp>(unwrapOpOperand->getOwner());
        ready = unwrapVR.getReady();
      } else {
        // No consumer: transaction never happens (valid && false)
        assert(!unwrapOpOperand &&
               "Expected no consumer or consumer should be an unwrap");
        ready = hw::ConstantOp::create(rewriter, op.getLoc(),
                                       rewriter.getI1Type(), 0);
      }
 
      // Create transaction signal as valid AND ready
      auto transaction =
          comb::AndOp::create(rewriter, op.getLoc(), valid, ready);
 
      rewriter.replaceOp(op, {transaction, data});
      return success();
    }
 
    // Handle FIFO signaling
    if (auto wrapFIFO = dyn_cast<WrapFIFOOp>(defOp)) {
      Value data = wrapFIFO.getData();
      Value empty = wrapFIFO.getEmpty();
 
      // Find rden signal
      Value rden;
      auto *unwrapOpOperand =
          ChannelType::getSingleConsumer(wrapFIFO.getChanOutput());
 
      if (unwrapOpOperand && isa<UnwrapFIFOOp>(unwrapOpOperand->getOwner())) {
        // There's an unwrap - use its rden signal
        auto unwrapFIFO = cast<UnwrapFIFOOp>(unwrapOpOperand->getOwner());
        rden = unwrapFIFO.getRden();
      } else {
        // No consumer: never reading
        assert(!unwrapOpOperand &&
               "Expected no consumer or consumer should be an unwrap");
        rden = hw::ConstantOp::create(rewriter, op.getLoc(),
                                      rewriter.getI1Type(), 0);
      }
 
      // Create transaction signal as !empty AND rden
      auto notEmpty = comb::XorOp::create(
          rewriter, op.getLoc(), empty,
          hw::ConstantOp::create(rewriter, op.getLoc(),
                                 rewriter.getBoolAttr(true)));
      auto transaction =
          comb::AndOp::create(rewriter, op.getLoc(), notEmpty, rden);
 
      rewriter.replaceOp(op, {transaction, data});
      return success();
    }
 
    // Handle ValidOnly signaling
    if (auto wrapVO = dyn_cast<WrapValidOnlyOp>(defOp)) {
      Value data = wrapVO.getRawInput();
      Value valid = wrapVO.getValid();
      // For ValidOnly, transaction == valid (always ready, no backpressure).
      rewriter.replaceOp(op, {valid, data});
      return success();
    }
 
    return rewriter.notifyMatchFailure(
        defOp,
        "Snoop input must be a wrap.vr, wrap.fifo, or wrap.vo operation");
  }
};
} // anonymous namespace
 
namespace {
/// Use the op canonicalizer to lower away the op. Assumes the canonicalizer
/// deletes the op.
template <typename Op>
struct CanonicalizerOpLowering : public OpConversionPattern<Op> {
public:
  CanonicalizerOpLowering(MLIRContext *ctxt) : OpConversionPattern<Op>(ctxt) {}
 
  LogicalResult
  matchAndRewrite(Op op, typename Op::Adaptor adaptor,
                  ConversionPatternRewriter &rewriter) const final {
    if (failed(Op::canonicalize(op, rewriter)))
      return rewriter.notifyMatchFailure(op->getLoc(), "canonicalizer failed");
    return success();
  }
};
} // anonymous namespace
 
namespace {
struct ESItoHWPass : public circt::esi::impl::LowerESItoHWBase<ESItoHWPass> {
  void runOnOperation() override;
};
} // anonymous namespace
 
namespace {
/// Lower `CosimEndpointOp` ops to a SystemVerilog extern module and a Capnp
/// gasket op.
struct CosimToHostLowering : public OpConversionPattern<CosimToHostEndpointOp> {
public:
  CosimToHostLowering(ESIHWBuilder &b)
      : OpConversionPattern(b.getContext(), 1), builder(b) {}
 
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(CosimToHostEndpointOp, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const final;
 
private:
  ESIHWBuilder &builder;
};
} // anonymous namespace
 
LogicalResult CosimToHostLowering::matchAndRewrite(
    CosimToHostEndpointOp ep, OpAdaptor adaptor,
    ConversionPatternRewriter &rewriter) const {
  auto loc = ep.getLoc();
  auto *ctxt = rewriter.getContext();
  circt::BackedgeBuilder bb(rewriter, loc);
 
  Value toHost = adaptor.getToHost();
  Type type = toHost.getType();
  auto chanTy = dyn_cast<ChannelType>(type);
  uint64_t width = getWidth(type);
 
  // Set all the parameters.
  SmallVector<Attribute, 8> params;
  params.push_back(ParamDeclAttr::get("ENDPOINT_ID", ep.getIdAttr()));
  params.push_back(ParamDeclAttr::get("TO_HOST_TYPE_ID", getTypeID(type)));
  params.push_back(ParamDeclAttr::get(
      "TO_HOST_SIZE_BITS", rewriter.getI32IntegerAttr(width > 0 ? width : 1)));
 
  // Set up the egest route to drive the EP's toHost ports.
  auto sendReady = bb.get(rewriter.getI1Type());
  UnwrapValidReadyOp unwrapSend =
      UnwrapValidReadyOp::create(rewriter, loc, toHost, sendReady);
 
  Value rawSendData = unwrapSend.getRawOutput();
  // For windows, we need to extract the lowered data from the window type.
  if (chanTy)
    if (WindowType windowType = dyn_cast_or_null<WindowType>(chanTy.getInner()))
      rawSendData = UnwrapWindow::create(rewriter, loc, rawSendData);
 
  Value castedSendData;
  if (width > 0)
    castedSendData = hw::BitcastOp::create(
        rewriter, loc, rewriter.getIntegerType(width), rawSendData);
  else
    castedSendData = hw::ConstantOp::create(
        rewriter, loc, rewriter.getIntegerType(1), rewriter.getBoolAttr(false));
 
  // Build or get the cached Cosim Endpoint module parameterization.
  Operation *symTable = ep->getParentWithTrait<OpTrait::SymbolTable>();
  HWModuleExternOp endpoint =
      builder.declareCosimEndpointToHostModule(symTable);
 
  // Create replacement Cosim_Endpoint instance.
  Value operands[] = {
      adaptor.getClk(),
      adaptor.getRst(),
      unwrapSend.getValid(),
      castedSendData,
  };
  auto cosimEpModule =
      hw::InstanceOp::create(rewriter, loc, endpoint, ep.getIdAttr(), operands,
                             ArrayAttr::get(ctxt, params));
  sendReady.setValue(cosimEpModule.getResult(0));
 
  // Replace the CosimEndpointOp op.
  rewriter.eraseOp(ep);
 
  return success();
}
 
namespace {
/// Lower `CosimEndpointOp` ops to a SystemVerilog extern module and a Capnp
/// gasket op.
struct CosimFromHostLowering
    : public OpConversionPattern<CosimFromHostEndpointOp> {
public:
  CosimFromHostLowering(ESIHWBuilder &b)
      : OpConversionPattern(b.getContext(), 1), builder(b) {}
 
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(CosimFromHostEndpointOp, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const final;
 
private:
  ESIHWBuilder &builder;
};
} // anonymous namespace
 
LogicalResult CosimFromHostLowering::matchAndRewrite(
    CosimFromHostEndpointOp ep, OpAdaptor adaptor,
    ConversionPatternRewriter &rewriter) const {
  auto loc = ep.getLoc();
  auto *ctxt = rewriter.getContext();
  circt::BackedgeBuilder bb(rewriter, loc);
 
  ChannelType type = ep.getFromHost().getType();
  WindowType windowType = dyn_cast<WindowType>(type.getInner());
  uint64_t width = getWidth(type);
 
  // Set all the parameters.
  SmallVector<Attribute, 8> params;
  params.push_back(ParamDeclAttr::get("ENDPOINT_ID", ep.getIdAttr()));
  params.push_back(ParamDeclAttr::get("FROM_HOST_TYPE_ID", getTypeID(type)));
  params.push_back(
      ParamDeclAttr::get("FROM_HOST_SIZE_BITS",
                         rewriter.getI32IntegerAttr(width > 0 ? width : 1)));
 
  // Get information necessary for injest path.
  auto recvReady = bb.get(rewriter.getI1Type());
 
  // Build or get the cached Cosim Endpoint module parameterization.
  Operation *symTable = ep->getParentWithTrait<OpTrait::SymbolTable>();
  HWModuleExternOp endpoint =
      builder.declareCosimEndpointFromHostModule(symTable);
 
  // Create replacement Cosim_Endpoint instance.
  Value operands[] = {adaptor.getClk(), adaptor.getRst(), recvReady};
  auto cosimEpModule =
      hw::InstanceOp::create(rewriter, loc, endpoint, ep.getIdAttr(), operands,
                             ArrayAttr::get(ctxt, params));
 
  // Set up the injest path.
  Value recvDataFromCosim = cosimEpModule.getResult(1);
  Value recvValidFromCosim = cosimEpModule.getResult(0);
  Value castedRecvData;
  Type castToType = windowType ? windowType.getLoweredType() : type.getInner();
  if (width > 0)
    castedRecvData =
        hw::BitcastOp::create(rewriter, loc, castToType, recvDataFromCosim);
  else
    castedRecvData = hw::ConstantOp::create(
        rewriter, loc, rewriter.getIntegerType(0),
        rewriter.getIntegerAttr(rewriter.getIntegerType(0), 0));
  if (windowType) {
    // For windows, we need to reconstruct the window type from the lowered
    // data.
    castedRecvData =
        WrapWindow::create(rewriter, loc, windowType, castedRecvData);
  }
  WrapValidReadyOp wrapRecv = WrapValidReadyOp::create(
      rewriter, loc, castedRecvData, recvValidFromCosim, type.getDataDelay());
  recvReady.setValue(wrapRecv.getReady());
 
  // Replace the CosimEndpointOp op.
  rewriter.replaceOp(ep, wrapRecv.getChanOutput());
 
  return success();
}
 
namespace {
/// Lower `CompressedManifestOps` ops to a module containing an on-chip ROM.
/// Said module has registered input and outputs, so it has two cycles latency
/// between changing the address and the data being reflected on the output.
struct ManifestRomLowering : public OpConversionPattern<CompressedManifestOp> {
public:
  using OpConversionPattern::OpConversionPattern;
  constexpr static StringRef manifestRomName = "__ESI_Manifest_ROM";
 
  LogicalResult
  matchAndRewrite(CompressedManifestOp, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override;
 
protected:
  LogicalResult createRomModule(CompressedManifestOp op,
                                ConversionPatternRewriter &rewriter) const;
};
} // anonymous namespace
 
LogicalResult ManifestRomLowering::createRomModule(
    CompressedManifestOp op, ConversionPatternRewriter &rewriter) const {
  Location loc = op.getLoc();
  auto mlirModBody = op->getParentOfType<mlir::ModuleOp>();
  rewriter.setInsertionPointToStart(mlirModBody.getBody());
 
  // Find possible existing module (which may have been created as a dummy
  // module) and erase it.
  if (Operation *existingExtern = mlirModBody.lookupSymbol(manifestRomName)) {
    if (!isa<hw::HWModuleExternOp>(existingExtern))
      return rewriter.notifyMatchFailure(
          op,
          "Found " + manifestRomName + " but it wasn't an HWModuleExternOp");
    rewriter.eraseOp(existingExtern);
  }
 
  // Create the real module.
  PortInfo ports[] = {
      {{rewriter.getStringAttr("clk"), rewriter.getType<seq::ClockType>(),
        ModulePort::Direction::Input}},
      {{rewriter.getStringAttr("address"), rewriter.getIntegerType(29),
        ModulePort::Direction::Input}},
      {{rewriter.getStringAttr("data"), rewriter.getI64Type(),
        ModulePort::Direction::Output}},
  };
  auto rom = HWModuleOp::create(rewriter, loc,
                                rewriter.getStringAttr(manifestRomName), ports);
  Block *romBody = rom.getBodyBlock();
  rewriter.setInsertionPointToStart(romBody);
  Value clk = romBody->getArgument(0);
  Value inputAddress = romBody->getArgument(1);
 
  // Manifest the compressed manifest into 64-bit words.
  ArrayRef<uint8_t> maniBytes = op.getCompressedManifest().getData();
  SmallVector<uint64_t> words;
  words.push_back(maniBytes.size());
 
  for (size_t i = 0; i < maniBytes.size() - 7; i += 8) {
    uint64_t word = 0;
    for (size_t b = 0; b < 8; ++b)
      word |= static_cast<uint64_t>(maniBytes[i + b]) << (8 * b);
    words.push_back(word);
  }
  size_t overHang = maniBytes.size() % 8;
  if (overHang != 0) {
    uint64_t word = 0;
    for (size_t i = 0; i < overHang; ++i)
      word |= static_cast<uint64_t>(maniBytes[maniBytes.size() - overHang + i])
              << (i * 8);
    words.push_back(word);
  }
 
  // From the words, create an the register which will hold the manifest (and
  // hopefully synthized to a ROM).
  SmallVector<Attribute> wordAttrs;
  for (uint64_t word : words)
    wordAttrs.push_back(rewriter.getI64IntegerAttr(word));
  auto manifestConstant = hw::AggregateConstantOp::create(
      rewriter, loc,
      hw::UnpackedArrayType::get(rewriter.getI64Type(), words.size()),
      rewriter.getArrayAttr(wordAttrs));
  auto manifestReg =
      sv::VarOp::create(rewriter, loc, manifestConstant.getType());
  sv::VarAssignOp::create(rewriter, loc, manifestReg, manifestConstant);
 
  // Slim down the address, register it, do the lookup, and register the output.
  size_t addrBits = llvm::Log2_64_Ceil(words.size());
  auto slimmedIdx =
      comb::ExtractOp::create(rewriter, loc, inputAddress, 0, addrBits);
  Value inputAddresReg = seq::CompRegOp::create(rewriter, loc, slimmedIdx, clk);
  auto readIdx =
      sv::ArrayIndexInOutOp::create(rewriter, loc, manifestReg, inputAddresReg);
  auto readData = sv::ReadInOutOp::create(rewriter, loc, readIdx);
  Value readDataReg = seq::CompRegOp::create(rewriter, loc, readData, clk);
  if (auto *term = romBody->getTerminator())
    rewriter.eraseOp(term);
  hw::OutputOp::create(rewriter, loc, ValueRange{readDataReg});
  return success();
}
 
LogicalResult ManifestRomLowering::matchAndRewrite(
    CompressedManifestOp op, OpAdaptor adaptor,
    ConversionPatternRewriter &rewriter) const {
  LogicalResult ret = createRomModule(op, rewriter);
  rewriter.eraseOp(op);
  return ret;
}
 
namespace {
/// Lower `CompressedManifestOps` ops to a SystemVerilog module which sets the
/// Cosim manifest using a DPI support module.
struct CosimManifestLowering : public ManifestRomLowering {
public:
  using ManifestRomLowering::ManifestRomLowering;
 
  LogicalResult
  matchAndRewrite(CompressedManifestOp, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const final;
};
} // anonymous namespace
 
LogicalResult CosimManifestLowering::matchAndRewrite(
    CompressedManifestOp op, OpAdaptor adaptor,
    ConversionPatternRewriter &rewriter) const {
  MLIRContext *ctxt = rewriter.getContext();
  Location loc = op.getLoc();
 
  // Cosim can optionally include a manifest simulation, so produce it in case
  // the Cosim BSP wants it.
  LogicalResult ret = createRomModule(op, rewriter);
  if (failed(ret))
    return ret;
 
  // Declare external module.
  Attribute params[] = {
      ParamDeclAttr::get("COMPRESSED_MANIFEST_SIZE", rewriter.getI32Type()),
      ParamDeclAttr::get("ESI_VERSION", rewriter.getI32Type())};
  PortInfo ports[] = {
      {{rewriter.getStringAttr("compressed_manifest"),
        rewriter.getType<hw::ArrayType>(
            rewriter.getI8Type(),
            ParamDeclRefAttr::get(
                rewriter.getStringAttr("COMPRESSED_MANIFEST_SIZE"),
                rewriter.getI32Type())),
        ModulePort::Direction::Input},
       0},
  };
  rewriter.setInsertionPointToEnd(
      op->getParentOfType<mlir::ModuleOp>().getBody());
  auto cosimManifestExternModule = HWModuleExternOp::create(
      rewriter, loc, rewriter.getStringAttr("Cosim_Manifest"), ports,
      "Cosim_Manifest", ArrayAttr::get(ctxt, params));
 
  hw::ModulePortInfo portInfo({});
  auto manifestMod = hw::HWModuleOp::create(
      rewriter, loc, rewriter.getStringAttr("__ESIManifest"), portInfo,
      [&](OpBuilder &rewriter, const hw::HWModulePortAccessor &) {
        // Assemble the manifest data into a constant.
        SmallVector<Attribute> bytes;
        for (uint8_t b : op.getCompressedManifest().getData())
          bytes.push_back(rewriter.getI8IntegerAttr(b));
        auto manifestConstant = hw::AggregateConstantOp::create(
            rewriter, loc,
            hw::ArrayType::get(rewriter.getI8Type(), bytes.size()),
            rewriter.getArrayAttr(bytes));
        auto manifestLogic =
            sv::VarOp::create(rewriter, loc, manifestConstant.getType());
        sv::VarAssignOp::create(rewriter, loc, manifestLogic, manifestConstant);
        auto manifest = sv::ReadInOutOp::create(rewriter, loc, manifestLogic);
 
        // Then instantiate the external module.
        hw::InstanceOp::create(
            rewriter, loc, cosimManifestExternModule, "__manifest",
            ArrayRef<Value>({manifest}),
            rewriter.getArrayAttr({
                ParamDeclAttr::get("COMPRESSED_MANIFEST_SIZE",
                                   rewriter.getI32IntegerAttr(bytes.size())),
                ParamDeclAttr::get("ESI_VERSION",
                                   rewriter.getI32IntegerAttr(esiApiVersion)),
            }));
      });
 
  rewriter.setInsertionPoint(op);
  hw::InstanceOp::create(rewriter, loc, manifestMod, "__manifest",
                         ArrayRef<Value>({}));
 
  rewriter.eraseOp(op);
  return success();
}
 
/// Returns true if `type` is an ESI channel or an aggregate (e.g. array,
/// struct) that contains a channel somewhere within it.
static bool typeContainsChannel(Type type) {
  return type.walk([](ChannelType) { return WalkResult::interrupt(); })
      .wasInterrupted();
}
 
/// Greedily canonicalize every op whose type involves an ESI channel. This
/// hopefully removes all channel ops: channel-typed aggregates (e.g.
/// hw.array_create/ array_get over channels) fold away, exposing adjacent
/// wrap/unwrap pairs that the wrap/unwrap canonicalizers then merge. A greedy
/// rewrite is used (rather than a dialect conversion) because this requires
/// folding, DCE, and iterating to a fixpoint, none of which the conversion
/// driver does.
static void canonicalizeChannelOps(Operation *top, MLIRContext *ctxt) {
  SmallVector<Operation *> channelOps;
  DenseSet<OperationName> seenOpNames;
  RewritePatternSet canonPatterns(ctxt);
  top->walk([&](Operation *op) {
    if (!llvm::any_of(op->getResultTypes(), typeContainsChannel) &&
        !llvm::any_of(op->getOperandTypes(), typeContainsChannel))
      return;
    channelOps.push_back(op);
    if (std::optional<mlir::RegisteredOperationName> info =
            op->getRegisteredInfo();
        info && seenOpNames.insert(op->getName()).second)
      info->getCanonicalizationPatterns(canonPatterns, ctxt);
  });
  mlir::GreedyRewriteConfig config;
  config.setStrictness(mlir::GreedyRewriteStrictness::ExistingAndNewOps);
  (void)mlir::applyOpPatternsGreedily(
      channelOps, mlir::FrozenRewritePatternSet(std::move(canonPatterns)),
      config);
}
 
/// Returns true if any of `types` is or contains an ESI channel.
static bool anyTypeContainsChannel(TypeRange types) {
  return llvm::any_of(types, typeContainsChannel);
}
 
/// Verify that no ESI channel ops or channel-typed values remain under `top`,
/// which the channel lowering is responsible for removing. Returns true if all
/// channels were removed; otherwise emits diagnostics on a handful of offenders
/// (rather than all of them) and returns false.
static bool verifyNoChannelsRemain(Operation *top, MLIRContext *ctxt) {
  constexpr unsigned maxReported = 10;
  unsigned numReported = 0;
  auto *esiDialect = ctxt->getLoadedDialect<ESIDialect>();
  top->walk([&](Operation *op) {
    // Ops marked OperatesOnESITypes (e.g. the window wrap/unwrap ops)
    // operate on ESI types and are lowered by a later pass.
    if (op->hasTrait<OperatesOnESITypes>())
      return WalkResult::advance();
 
    // Other ESI ops must have been lowered away by now.
    if (op->getDialect() == esiDialect) {
      op->emitError("lower-esi-to-hw left behind a channel operation");
      if (++numReported >= maxReported)
        return WalkResult::interrupt();
      return WalkResult::advance();
    }
 
    // Channel types should have been fully lowered away, even if they're buried
    // inside aggregates. Look for any type that contains a channel anywhere
    // within it: results, operands, and block arguments (e.g. module ports,
    // which may not appear as an operand if they are unused).
    bool hasChannelType = anyTypeContainsChannel(op->getResultTypes()) ||
                          anyTypeContainsChannel(op->getOperandTypes());
    for (Region &region : op->getRegions())
      for (Block &block : region)
        hasChannelType |= anyTypeContainsChannel(block.getArgumentTypes());
    if (hasChannelType) {
      op->emitError("lower-esi-to-hw left behind a channel-typed value");
      if (++numReported >= maxReported)
        return WalkResult::interrupt();
    }
    return WalkResult::advance();
  });
  return numReported == 0;
}
 
void ESItoHWPass::runOnOperation() {
  auto top = getOperation();
  auto *ctxt = &getContext();
 
  // Lower all the bundles.
  ConversionTarget noBundlesTarget(*ctxt);
  noBundlesTarget.markUnknownOpDynamicallyLegal(
      [](Operation *) { return true; });
  noBundlesTarget.addIllegalOp<PackBundleOp>();
  noBundlesTarget.addIllegalOp<UnpackBundleOp>();
  RewritePatternSet bundlePatterns(&getContext());
  bundlePatterns.add<CanonicalizerOpLowering<PackBundleOp>>(&getContext());
  bundlePatterns.add<CanonicalizerOpLowering<UnpackBundleOp>>(&getContext());
  if (failed(applyPartialConversion(getOperation(), noBundlesTarget,
                                    std::move(bundlePatterns)))) {
    signalPassFailure();
    return;
  }
 
  // Set up a conversion and give it a set of laws.
  ConversionTarget pass1Target(*ctxt);
  pass1Target.addLegalDialect<comb::CombDialect>();
  pass1Target.addLegalDialect<HWDialect>();
  pass1Target.addLegalDialect<SVDialect>();
  pass1Target.addLegalDialect<seq::SeqDialect>();
  pass1Target.addLegalOp<WrapValidReadyOp, UnwrapValidReadyOp, WrapFIFOOp,
                         UnwrapFIFOOp, WrapValidOnlyOp, UnwrapValidOnlyOp,
                         WrapWindow, UnwrapWindow>();
  pass1Target.addLegalOp<SnoopTransactionOp, SnoopValidReadyOp>();
 
  pass1Target.addIllegalOp<PipelineStageOp>();
  pass1Target.addIllegalOp<CompressedManifestOp>();
 
  // Add all the conversion patterns.
  ESIHWBuilder esiBuilder(top);
  RewritePatternSet pass1Patterns(ctxt);
  pass1Patterns.insert<PipelineStageLowering>(esiBuilder, ctxt);
  pass1Patterns.insert<CosimToHostLowering>(esiBuilder);
  pass1Patterns.insert<CosimFromHostLowering>(esiBuilder);
  pass1Patterns.insert<NullSourceOpLowering>(ctxt);
 
  if (platform == Platform::cosim)
    pass1Patterns.insert<CosimManifestLowering>(ctxt);
  else if (platform == Platform::fpga)
    pass1Patterns.insert<ManifestRomLowering>(ctxt);
  else
    pass1Patterns.insert<RemoveOpLowering<CompressedManifestOp>>(ctxt);
 
  // Run the conversion.
  if (failed(
          applyPartialConversion(top, pass1Target, std::move(pass1Patterns)))) {
    signalPassFailure();
    return;
  }
 
  // Lower all the snoop operations.
  ConversionTarget pass2Target(*ctxt);
  pass2Target.addLegalDialect<comb::CombDialect>();
  pass2Target.addLegalDialect<HWDialect>();
  pass2Target.addLegalDialect<SVDialect>();
  pass2Target.addIllegalOp<SnoopTransactionOp, SnoopValidReadyOp>();
  pass2Target.addLegalOp<WrapValidReadyOp, UnwrapValidReadyOp, WrapFIFOOp,
                         UnwrapFIFOOp, WrapValidOnlyOp, UnwrapValidOnlyOp>();
  RewritePatternSet pass2Patterns(ctxt);
  pass2Patterns.insert<RemoveSnoopOp>(ctxt);
  pass2Patterns.insert<RemoveSnoopTransactionOp>(ctxt);
  if (failed(
          applyPartialConversion(top, pass2Target, std::move(pass2Patterns)))) {
    signalPassFailure();
    return;
  }
 
  // Eliminate all channel ops (and channel-typed aggregates) via their
  // canonicalizers, including merging the adjacent wrap/unwrap pairs.
  canonicalizeChannelOps(top, ctxt);
 
  // The canonicalizers above are responsible for removing every ESI op and
  // channel-typed value. Verify that none remain.
  if (!verifyNoChannelsRemain(top, ctxt))
    signalPassFailure();
}
 
std::unique_ptr<OperationPass<ModuleOp>> circt::esi::createESItoHWPass() {
  return std::make_unique<ESItoHWPass>();
}