MooreToCore.cpp

Go to the documentation of this file.

//===----------------------------------------------------------------------===//
//
// 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 "circt/Conversion/MooreToCore.h"
#include "circt/Dialect/Comb/CombOps.h"
#include "circt/Dialect/Debug/DebugOps.h"
#include "circt/Dialect/HW/HWOps.h"
#include "circt/Dialect/HW/HWTypes.h"
#include "circt/Dialect/LLHD/LLHDOps.h"
#include "circt/Dialect/LTL/LTLOps.h"
#include "circt/Dialect/Moore/MooreOps.h"
#include "circt/Dialect/SV/SVAttributes.h"
#include "circt/Dialect/Sim/SimOps.h"
#include "circt/Dialect/Verif/VerifOps.h"
#include "circt/Support/ConversionPatternSet.h"
#include "circt/Transforms/Passes.h"
#include "mlir/Conversion/SCFToControlFlow/SCFToControlFlow.h"
#include "mlir/Dialect/Arith/IR/Arith.h"
#include "mlir/Dialect/Arith/IR/ArithAttributes.h"
#include "mlir/Dialect/ControlFlow/IR/ControlFlowOps.h"
#include "mlir/Dialect/ControlFlow/Transforms/StructuralTypeConversions.h"
#include "mlir/Dialect/Func/IR/FuncOps.h"
#include "mlir/Dialect/LLVMIR/LLVMDialect.h"
#include "mlir/Dialect/LLVMIR/LLVMTypes.h"
#include "mlir/Dialect/Math/IR/Math.h"
#include "mlir/Dialect/SCF/IR/SCF.h"
#include "mlir/Dialect/UB/IR/UBOps.h"
#include "mlir/IR/BuiltinDialect.h"
#include "mlir/IR/Iterators.h"
#include "mlir/Interfaces/SideEffectInterfaces.h"
#include "mlir/Pass/Pass.h"
#include "mlir/Transforms/DialectConversion.h"
#include "mlir/Transforms/RegionUtils.h"
#include "llvm/ADT/TypeSwitch.h"
#include "llvm/IR/DerivedTypes.h"
 
namespace circt {
#define GEN_PASS_DEF_CONVERTMOORETOCORE
#include "circt/Conversion/Passes.h.inc"
} // namespace circt
 
using namespace mlir;
using namespace circt;
using namespace moore;
 
using comb::ICmpPredicate;
using llvm::SmallDenseSet;
 
namespace {
 
/// Cache for identified structs and field GEP paths keyed by class symbol.
struct ClassTypeCache {
  struct TypeInfoInfo {
    LLVM::GlobalOp global;
  };
 
  struct ClassStructInfo {
    LLVM::LLVMStructType classBody;
    LLVM::LLVMStructType headerTy;
    TypeInfoInfo typeInfo;
 
    unsigned headerFieldIndex = 0;
    unsigned typeInfoFieldIndex = 0;
    unsigned vtableFieldIndex = 1;
 
    // field name -> GEP path inside ident (excluding the leading pointer index)
    DenseMap<StringRef, SmallVector<unsigned, 2>> propertyPath;
 
    // TODO: Add classVTable in here.
    /// Record/overwrite the field path to a single property for a class.
    void setFieldPath(StringRef propertyName, ArrayRef<unsigned> path) {
      this->propertyPath[propertyName] =
          SmallVector<unsigned, 2>(path.begin(), path.end());
    }
 
    /// Lookup the full GEP path for a (class, field).
    std::optional<ArrayRef<unsigned>>
    getFieldPath(StringRef propertySym) const {
      if (auto prop = this->propertyPath.find(propertySym);
          prop != this->propertyPath.end())
        return ArrayRef<unsigned>(prop->second);
      return std::nullopt;
    }
  };
 
  /// Record the identified struct body for a class.
  /// Implicitly finalizes the class to struct conversion.
  void setClassInfo(SymbolRefAttr classSym, const ClassStructInfo &info) {
    auto &dst = classToStructMap[classSym];
    dst = info;
  }
 
  /// Lookup the identified struct body for a class.
  std::optional<ClassStructInfo> getStructInfo(SymbolRefAttr classSym) const {
    if (auto it = classToStructMap.find(classSym); it != classToStructMap.end())
      return it->second;
    return std::nullopt;
  }
 
  std::optional<TypeInfoInfo> getTypeInfo(SymbolRefAttr classSym) const {
    if (auto it = classToTypeInfoMap.find(classSym);
        it != classToTypeInfoMap.end())
      return it->second;
    return std::nullopt;
  }
 
  void setTypeInfo(SymbolRefAttr classSym, const TypeInfoInfo &info) {
    classToTypeInfoMap[classSym] = info;
  }
 
private:
  // Keyed by the SymbolRefAttr of the class.
  // Kept private so all accesses are done with helpers which preserve
  // invariants
  DenseMap<Attribute, ClassStructInfo> classToStructMap;
  DenseMap<Attribute, TypeInfoInfo> classToTypeInfoMap;
};
 
/// Cache for external function declarations. Avoids redundant symbol table
/// lookups and ensures each function is declared at most once.
struct FunctionCache {
  FunctionCache(SymbolTable &symbolTable) : symbolTable(symbolTable) {}
 
  /// Look up a function by name. If it doesn't exist, invoke the callback to
  /// create it. The builder is repositioned to the start of the module body
  /// before the callback is invoked. The result is inserted into the symbol
  /// table and cache.
  func::FuncOp getOrCreate(OpBuilder &builder, StringRef name,
                           function_ref<func::FuncOp()> createFn) {
    auto &slot = map[name];
    if (slot)
      return slot;
    if (auto fn = symbolTable.lookup<func::FuncOp>(name))
      return slot = fn;
    auto mod = cast<ModuleOp>(symbolTable.getOp());
    OpBuilder::InsertionGuard g(builder);
    builder.setInsertionPointToStart(mod.getBody());
    slot = createFn();
    symbolTable.insert(slot);
    return slot;
  }
 
  /// Convenience wrapper that creates a private external function declaration
  /// with the given argument and result types.
  func::FuncOp getOrCreate(OpBuilder &builder, StringRef name,
                           TypeRange argTypes, TypeRange resultTypes) {
    return getOrCreate(builder, name, [&] {
      auto mod = cast<ModuleOp>(symbolTable.getOp());
      auto fnTy = builder.getFunctionType(argTypes, resultTypes);
      auto fn = func::FuncOp::create(builder, mod.getLoc(), name, fnTy);
      fn.setPrivate();
      return fn;
    });
  }
 
private:
  SymbolTable &symbolTable;
  llvm::StringMap<func::FuncOp> map;
};
 
/// Helper function to create an opaque LLVM Struct Type which corresponds
/// to the sym
static LLVM::LLVMStructType getOrCreateOpaqueStruct(MLIRContext *ctx,
                                                    SymbolRefAttr className) {
  return LLVM::LLVMStructType::getIdentified(ctx, className.getRootReference());
}
 
/// Create the canonical object header for lowered Moore class objects.
static LLVM::LLVMStructType getClassObjectHeaderType(MLIRContext *ctx) {
  return LLVM::LLVMStructType::getLiteral(
      ctx, SmallVector<Type>{LLVM::LLVMPointerType::get(ctx),
                             LLVM::LLVMPointerType::get(ctx)});
}
 
static std::string getTypeInfoName(SymbolRefAttr className) {
  return className.getRootReference().str() + "::typeinfo";
}
 
static FailureOr<ClassTypeCache::TypeInfoInfo>
getOrCreateTypeInfo(ModuleOp mod, SymbolRefAttr classSym,
                    ClassTypeCache &cache) {
  if (auto info = cache.getTypeInfo(classSym))
    return *info;
 
  MLIRContext *ctx = mod.getContext();
  auto ptrTy = LLVM::LLVMPointerType::get(ctx);
  auto typeInfoTy = LLVM::LLVMStructType::getLiteral(ctx, {ptrTy});
 
  auto globalName = getTypeInfoName(classSym);
  auto global = mod.lookupSymbol<LLVM::GlobalOp>(globalName);
  if (!global) {
    OpBuilder builder = OpBuilder::atBlockBegin(mod.getBody());
    global = LLVM::GlobalOp::create(
        builder, mod.getLoc(), typeInfoTy,
        /*isConstant=*/true, LLVM::Linkage::Internal, globalName, Attribute());
 
    Block *block = new Block();
    global.getInitializerRegion().push_back(block);
    builder.setInsertionPointToStart(block);
 
    if (auto *classOp = mod.lookupSymbol(classSym)) {
      auto classDecl = dyn_cast<ClassDeclOp>(classOp);
      if (classDecl && classDecl.getBaseAttr()) {
        auto baseInfo =
            getOrCreateTypeInfo(mod, classDecl.getBaseAttr(), cache);
        if (failed(baseInfo))
          return failure();
        auto baseAddr =
            LLVM::AddressOfOp::create(builder, mod.getLoc(), baseInfo->global);
        auto undef = LLVM::UndefOp::create(builder, mod.getLoc(), typeInfoTy)
                         .getResult();
        auto init = LLVM::InsertValueOp::create(builder, mod.getLoc(), undef,
                                                baseAddr.getResult(),
                                                ArrayRef<int64_t>{0});
        LLVM::ReturnOp::create(builder, mod.getLoc(), init);
        ClassTypeCache::TypeInfoInfo info{global};
        cache.setTypeInfo(classSym, info);
        return info;
      }
    }
 
    auto undef =
        LLVM::UndefOp::create(builder, mod.getLoc(), typeInfoTy).getResult();
    auto nullPtr =
        LLVM::ZeroOp::create(builder, mod.getLoc(), ptrTy).getResult();
    auto init = LLVM::InsertValueOp::create(builder, mod.getLoc(), undef,
                                            nullPtr, ArrayRef<int64_t>{0});
    LLVM::ReturnOp::create(builder, mod.getLoc(), init);
  }
 
  ClassTypeCache::TypeInfoInfo info{global};
  cache.setTypeInfo(classSym, info);
  return info;
}
static LogicalResult resolveClassStructBody(ClassDeclOp op,
                                            TypeConverter const &typeConverter,
                                            ClassTypeCache &cache) {
 
  auto classSym = SymbolRefAttr::get(op.getSymNameAttr());
  auto structInfo = cache.getStructInfo(classSym);
  if (structInfo)
    // We already have a resolved class struct body.
    return success();
 
  if (failed(getOrCreateTypeInfo(op->getParentOfType<ModuleOp>(), classSym,
                                 cache)))
    return op.emitOpError() << "Failed to create RTTI for class";
 
  // Otherwise we need to resolve.
  ClassTypeCache::ClassStructInfo structBody;
  SmallVector<Type> structBodyMembers;
  structBody.headerTy = getClassObjectHeaderType(op.getContext());
  structBody.typeInfo = *cache.getTypeInfo(classSym);
  structBodyMembers.push_back(structBody.headerTy);
 
  // Base-first (prefix) layout for single inheritance.
  unsigned derivedStartIdx = 1;
 
  if (auto baseClass = op.getBaseAttr()) {
 
    ModuleOp mod = op->getParentOfType<ModuleOp>();
    auto *opSym = mod.lookupSymbol(baseClass);
    auto classDeclOp = cast<ClassDeclOp>(opSym);
 
    if (failed(resolveClassStructBody(classDeclOp, typeConverter, cache)))
      return failure();
 
    // Process base class' struct layout first
    auto baseClassStruct = cache.getStructInfo(baseClass);
    structBodyMembers.push_back(baseClassStruct->classBody);
    derivedStartIdx = 2;
 
    // Inherit base field paths with a leading 1 to index into the base
    // subobject after the object header.
    for (auto &kv : baseClassStruct->propertyPath) {
      SmallVector<unsigned, 2> path;
      path.push_back(1); // into base subobject
      path.append(kv.second.begin(), kv.second.end());
      structBody.setFieldPath(kv.first, path);
    }
  }
 
  // Properties in source order.
  unsigned iterator = derivedStartIdx;
  auto &block = op.getBody().front();
  for (Operation &child : block) {
    if (auto prop = dyn_cast<ClassPropertyDeclOp>(child)) {
      Type mooreTy = prop.getPropertyType();
      Type llvmTy = typeConverter.convertType(mooreTy);
      if (!llvmTy)
        return prop.emitOpError()
               << "failed to convert property type " << mooreTy;
 
      structBodyMembers.push_back(llvmTy);
 
      // Derived field path: either {i} or {1+i} if base is present.
      SmallVector<unsigned, 2> path{iterator};
      structBody.setFieldPath(prop.getSymName(), path);
      ++iterator;
    }
  }
 
  // TODO: Handle vtable generation over ClassMethodDeclOp here.
  auto llvmStructTy = getOrCreateOpaqueStruct(op.getContext(), classSym);
  // Empty structs may be kept opaque
  if (!structBodyMembers.empty() &&
      failed(llvmStructTy.setBody(structBodyMembers, false)))
    return op.emitOpError() << "Failed to set LLVM Struct body";
 
  structBody.classBody = llvmStructTy;
  cache.setClassInfo(classSym, structBody);
 
  return success();
}
 
/// Convenience overload that looks up ClassDeclOp
static LogicalResult resolveClassStructBody(ModuleOp mod, SymbolRefAttr op,
                                            TypeConverter const &typeConverter,
                                            ClassTypeCache &cache) {
  auto classDeclOp = cast<ClassDeclOp>(*mod.lookupSymbol(op));
  return resolveClassStructBody(classDeclOp, typeConverter, cache);
}
 
/// Returns the passed value if the integer width is already correct.
/// Zero-extends if it is too narrow.
/// Truncates if the integer is too wide and the truncated part is zero, if it
/// is not zero it returns the max value integer of target-width.
static Value adjustIntegerWidth(OpBuilder &builder, Value value,
                                uint32_t targetWidth, Location loc) {
  uint32_t intWidth = value.getType().getIntOrFloatBitWidth();
  if (intWidth == targetWidth)
    return value;
 
  if (intWidth < targetWidth) {
    Value zeroExt = hw::ConstantOp::create(
        builder, loc, builder.getIntegerType(targetWidth - intWidth), 0);
    return comb::ConcatOp::create(builder, loc, ValueRange{zeroExt, value});
  }
 
  Value hi = comb::ExtractOp::create(builder, loc, value, targetWidth,
                                     intWidth - targetWidth);
  Value zero = hw::ConstantOp::create(
      builder, loc, builder.getIntegerType(intWidth - targetWidth), 0);
  Value isZero = comb::ICmpOp::create(builder, loc, comb::ICmpPredicate::eq, hi,
                                      zero, false);
  Value lo = comb::ExtractOp::create(builder, loc, value, 0, targetWidth);
  Value max = hw::ConstantOp::create(builder, loc,
                                     builder.getIntegerType(targetWidth), -1);
  return comb::MuxOp::create(builder, loc, isZero, lo, max, false);
}
 
/// Get the ModulePortInfo from a SVModuleOp.
static FailureOr<hw::ModulePortInfo>
getModulePortInfo(const TypeConverter &typeConverter, SVModuleOp op) {
  size_t inputNum = 0;
  size_t resultNum = 0;
  auto moduleTy = op.getModuleType();
  SmallVector<hw::PortInfo> ports;
  ports.reserve(moduleTy.getNumPorts());
 
  for (auto port : moduleTy.getPorts()) {
    Type portTy = typeConverter.convertType(port.type);
    if (!portTy) {
      return op.emitOpError("port '")
             << port.name << "' has unsupported type " << port.type
             << " that cannot be converted to hardware type";
    }
    if (port.dir == hw::ModulePort::Direction::Output) {
      ports.push_back(
          hw::PortInfo({{port.name, portTy, port.dir}, resultNum++, {}}));
    } else {
      // FIXME: Once we support net<...>, ref<...> type to represent type of
      // special port like inout or ref port which is not a input or output
      // port. It can change to generate corresponding types for direction of
      // port or do specified operation to it. Now inout and ref port is treated
      // as input port.
      ports.push_back(
          hw::PortInfo({{port.name, portTy, port.dir}, inputNum++, {}}));
    }
  }
  return hw::ModulePortInfo(ports);
}
 
//===----------------------------------------------------------------------===//
// Structural Conversion
//===----------------------------------------------------------------------===//
 
struct SVModuleOpConversion : public OpConversionPattern<SVModuleOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(SVModuleOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.setInsertionPoint(op);
 
    // Create the hw.module to replace moore.module
    auto portInfo = getModulePortInfo(*typeConverter, op);
    if (failed(portInfo))
      return failure();
 
    auto hwModuleOp = hw::HWModuleOp::create(rewriter, op.getLoc(),
                                             op.getSymNameAttr(), *portInfo);
    if (auto svAttrs = sv::getSVAttributes(op))
      sv::setSVAttributes(hwModuleOp, svAttrs);
    // Make hw.module have the same visibility as the moore.module.
    // The entry/top level module is public, otherwise is private.
    SymbolTable::setSymbolVisibility(hwModuleOp,
                                     SymbolTable::getSymbolVisibility(op));
    rewriter.eraseBlock(hwModuleOp.getBodyBlock());
    if (failed(
            rewriter.convertRegionTypes(&op.getBodyRegion(), *typeConverter)))
      return failure();
    rewriter.inlineRegionBefore(op.getBodyRegion(), hwModuleOp.getBodyRegion(),
                                hwModuleOp.getBodyRegion().end());
 
    // Erase the original op
    rewriter.eraseOp(op);
    return success();
  }
};
 
struct OutputOpConversion : public OpConversionPattern<OutputOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(OutputOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<hw::OutputOp>(op, adaptor.getOperands());
    return success();
  }
};
 
struct InstanceOpConversion : public OpConversionPattern<InstanceOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(InstanceOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    auto instName = op.getInstanceNameAttr();
    auto moduleName = op.getModuleNameAttr();
 
    // Create the new hw instanceOp to replace the original one.
    rewriter.setInsertionPoint(op);
    auto instOp = hw::InstanceOp::create(
        rewriter, op.getLoc(), op.getResultTypes(), instName, moduleName,
        op.getInputs(), op.getInputNamesAttr(), op.getOutputNamesAttr(),
        /*Parameter*/ rewriter.getArrayAttr({}), /*InnerSymbol*/ nullptr,
        /*doNotPrint*/ nullptr);
 
    // Replace uses chain and erase the original op.
    op.replaceAllUsesWith(instOp.getResults());
    rewriter.eraseOp(op);
    return success();
  }
};
 
/// Position the rewriter right after the point where `value` becomes available.
static void setInsertionPointAfterDef(OpBuilder &rewriter, Value value) {
  if (auto *defOp = value.getDefiningOp())
    rewriter.setInsertionPointAfter(defOp);
  if (isa<BlockArgument>(value))
    rewriter.setInsertionPointToStart(value.getParentBlock());
}
 
static void getValuesToObserve(Region *region,
                               function_ref<void(Value)> setInsertionPoint,
                               const TypeConverter *typeConverter,
                               ConversionPatternRewriter &rewriter,
                               SmallVector<Value> &observeValues) {
  SmallDenseSet<Value> alreadyObserved;
  Location loc = region->getLoc();
 
  auto probeIfSignal = [&](Value value) -> Value {
    Type type = value.getType();
    if (auto refType = dyn_cast<llhd::RefType>(type)) {
      if (!hw::isHWValueType(refType.getNestedType()))
        return {};
      return llhd::ProbeOp::create(rewriter, loc, value);
    }
    if (!hw::isHWValueType(type))
      return {};
    return value;
  };
 
  region->getParentOp()->walk<WalkOrder::PreOrder, ForwardDominanceIterator<>>(
      [&](Operation *operation) {
        for (auto value : operation->getOperands()) {
          if (isa<BlockArgument>(value))
            value = rewriter.getRemappedValue(value);
 
          if (region->isAncestor(value.getParentRegion()))
            continue;
          if (auto *defOp = value.getDefiningOp();
              defOp && defOp->hasTrait<OpTrait::ConstantLike>())
            continue;
          if (!alreadyObserved.insert(value).second)
            continue;
 
          OpBuilder::InsertionGuard g(rewriter);
          if (auto remapped = rewriter.getRemappedValue(value)) {
            setInsertionPoint(remapped);
            if (auto observed = probeIfSignal(remapped))
              observeValues.push_back(observed);
          } else {
            setInsertionPoint(value);
            auto type = typeConverter->convertType(value.getType());
            auto converted = typeConverter->materializeTargetConversion(
                rewriter, loc, type, value);
            if (auto observed = probeIfSignal(converted))
              observeValues.push_back(observed);
          }
        }
      });
}
 
struct ProcedureOpConversion : public OpConversionPattern<ProcedureOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(ProcedureOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    // Collect values to observe before we do any modifications to the region.
    SmallVector<Value> observedValues;
    if (op.getKind() == ProcedureKind::AlwaysComb ||
        op.getKind() == ProcedureKind::AlwaysLatch) {
      auto setInsertionPoint = [&](Value value) {
        rewriter.setInsertionPoint(op);
      };
      getValuesToObserve(&op.getBody(), setInsertionPoint, typeConverter,
                         rewriter, observedValues);
    }
 
    auto loc = op.getLoc();
    if (failed(rewriter.convertRegionTypes(&op.getBody(), *typeConverter)))
      return failure();
 
    // Handle initial and final procedures. These lower to a corresponding
    // `llhd.process` or `llhd.final` op that executes the body and then halts.
    if (op.getKind() == ProcedureKind::Initial ||
        op.getKind() == ProcedureKind::Final) {
      Operation *newOp;
      if (op.getKind() == ProcedureKind::Initial)
        newOp = llhd::ProcessOp::create(rewriter, loc, TypeRange{});
      else
        newOp = llhd::FinalOp::create(rewriter, loc);
      auto &body = newOp->getRegion(0);
      rewriter.inlineRegionBefore(op.getBody(), body, body.end());
      for (auto returnOp :
           llvm::make_early_inc_range(body.getOps<ReturnOp>())) {
        rewriter.setInsertionPoint(returnOp);
        rewriter.replaceOpWithNewOp<llhd::HaltOp>(returnOp, ValueRange{});
      }
      rewriter.eraseOp(op);
      return success();
    }
 
    // All other procedures lower to a an `llhd.process`.
    auto newOp = llhd::ProcessOp::create(rewriter, loc, TypeRange{});
 
    // We need to add an empty entry block because it is not allowed in MLIR to
    // branch back to the entry block. Instead we put the logic in the second
    // block and branch to that.
    rewriter.createBlock(&newOp.getBody());
    auto *block = &op.getBody().front();
    cf::BranchOp::create(rewriter, loc, block);
    rewriter.inlineRegionBefore(op.getBody(), newOp.getBody(),
                                newOp.getBody().end());
 
    // Add special handling for `always_comb` and `always_latch` procedures.
    // These run once at simulation startup and then implicitly wait for any of
    // the values they access to change before running again. To implement this,
    // we create another basic block that contains the implicit wait, and make
    // all `moore.return` ops branch to that wait block instead of immediately
    // jumping back up to the body.
    if (op.getKind() == ProcedureKind::AlwaysComb ||
        op.getKind() == ProcedureKind::AlwaysLatch) {
      Block *waitBlock = rewriter.createBlock(&newOp.getBody());
      llhd::WaitOp::create(rewriter, loc, ValueRange{}, Value(), observedValues,
                           ValueRange{}, block);
      block = waitBlock;
    }
 
    // Make all `moore.return` ops branch back up to the beginning of the
    // process, or the wait block created above for `always_comb` and
    // `always_latch` procedures.
    for (auto returnOp : llvm::make_early_inc_range(newOp.getOps<ReturnOp>())) {
      rewriter.setInsertionPoint(returnOp);
      cf::BranchOp::create(rewriter, loc, block);
      rewriter.eraseOp(returnOp);
    }
 
    rewriter.eraseOp(op);
    return success();
  }
};
 
//===----------------------------------------------------------------------===//
// Coroutine Conversion
//===----------------------------------------------------------------------===//
 
struct CoroutineOpConversion : public OpConversionPattern<CoroutineOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(CoroutineOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    auto funcType = op.getFunctionType();
    TypeConverter::SignatureConversion sigConversion(funcType.getNumInputs());
    for (auto [i, type] : llvm::enumerate(funcType.getInputs())) {
      auto converted = typeConverter->convertType(type);
      if (!converted)
        return failure();
      sigConversion.addInputs(i, converted);
    }
    SmallVector<Type> resultTypes;
    if (failed(typeConverter->convertTypes(funcType.getResults(), resultTypes)))
      return failure();
 
    auto newFuncType = FunctionType::get(
        rewriter.getContext(), sigConversion.getConvertedTypes(), resultTypes);
    auto newOp = llhd::CoroutineOp::create(rewriter, op.getLoc(),
                                           op.getSymName(), newFuncType);
    newOp.setSymVisibilityAttr(op.getSymVisibilityAttr());
    if (auto dpiExport = op->getAttr("circt.dpi.export"))
      newOp->setAttr("circt.dpi.export", dpiExport);
    rewriter.inlineRegionBefore(op.getBody(), newOp.getBody(),
                                newOp.getBody().end());
    if (failed(rewriter.convertRegionTypes(&newOp.getBody(), *typeConverter,
                                           &sigConversion)))
      return failure();
 
    // Replace moore.return with llhd.return inside the coroutine body.
    for (auto returnOp :
         llvm::make_early_inc_range(newOp.getBody().getOps<ReturnOp>())) {
      rewriter.setInsertionPoint(returnOp);
      rewriter.replaceOpWithNewOp<llhd::ReturnOp>(returnOp, ValueRange{});
    }
 
    rewriter.eraseOp(op);
    return success();
  }
};
 
struct CallCoroutineOpConversion : public OpConversionPattern<CallCoroutineOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(CallCoroutineOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    SmallVector<Type> convResTypes;
    if (failed(typeConverter->convertTypes(op.getResultTypes(), convResTypes)))
      return failure();
    rewriter.replaceOpWithNewOp<llhd::CallCoroutineOp>(
        op, convResTypes, adaptor.getCallee(), adaptor.getOperands());
    return success();
  }
};
 
struct WaitEventOpConversion : public OpConversionPattern<WaitEventOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(WaitEventOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    // In order to convert the `wait_event` op we need to create three separate
    // blocks at the location of the op:
    //
    // - A "wait" block that reads the current state of any values used to
    //   detect events and then waits until any of those values change. When a
    //   change occurs, control transfers to the "check" block.
    // - A "check" block which is executed after any interesting signal has
    //   changed. This is where any `detect_event` ops read the current state of
    //   interesting values and compare them against their state before the wait
    //   in order to detect an event. If any events were detected, control
    //   transfers to the "resume" block; otherwise control goes back to the
    //   "wait" block.
    // - A "resume" block which holds any ops after the `wait_event` op. This is
    //   where control is expected to resume after an event has happened.
    //
    // Block structure before:
    //     opA
    //     moore.wait_event { ... }
    //     opB
    //
    // Block structure after:
    //     opA
    //     cf.br ^wait
    // ^wait:
    //     <read "before" values>
    //     llhd.wait ^check, ...
    // ^check:
    //     <read "after" values>
    //     <detect edges>
    //     cf.cond_br %event, ^resume, ^wait
    // ^resume:
    //     opB
    auto *resumeBlock =
        rewriter.splitBlock(op->getBlock(), ++Block::iterator(op));
 
    // If the 'wait_event' op has no 'detect_event' ops, we can lower it to a
    // 'llhd.wait' op without any observed values, but since the process will
    // never wake up from suspension anyway, we can also just terminate it using
    // the 'llhd.halt' op.
    SmallVector<DetectEventOp> detectOps(op.getBody().getOps<DetectEventOp>());
    if (detectOps.empty()) {
      // Let the cleanup iteration after the dialect conversion clean up all
      // remaining unreachable blocks.
      rewriter.replaceOpWithNewOp<llhd::HaltOp>(op, ValueRange{});
      return success();
    }
 
    auto *waitBlock = rewriter.createBlock(resumeBlock);
    auto *checkBlock = rewriter.createBlock(resumeBlock);
 
    auto loc = op.getLoc();
    rewriter.setInsertionPoint(op);
    cf::BranchOp::create(rewriter, loc, waitBlock);
 
    // We need to inline two copies of the `wait_event`'s body region: one is
    // used to determine the values going into `detect_event` ops before the
    // `llhd.wait`, and one will do the actual event detection after the
    // `llhd.wait`.
    //
    // Create a copy of the entire `wait_event` op in the wait block, which also
    // creates a copy of its region. Take note of all inputs to `detect_event`
    // ops and delete the `detect_event` ops in this copy.
    SmallVector<Value> valuesBefore;
    rewriter.setInsertionPointToEnd(waitBlock);
    auto clonedOp = cast<WaitEventOp>(rewriter.clone(*op));
    bool allDetectsAreAnyChange = true;
    for (auto detectOp :
         llvm::make_early_inc_range(clonedOp.getOps<DetectEventOp>())) {
      if (detectOp.getEdge() != Edge::AnyChange || detectOp.getCondition())
        allDetectsAreAnyChange = false;
      valuesBefore.push_back(detectOp.getInput());
      rewriter.eraseOp(detectOp);
    }
 
    // Determine the values used during event detection that are defined outside
    // the `wait_event`'s body region. We want to wait for a change on these
    // signals before we check if any interesting event happened.
    SmallVector<Value> observeValues;
    getValuesToObserve(
        &clonedOp.getBody(),
        [&](Value value) { setInsertionPointAfterDef(rewriter, value); },
        typeConverter, rewriter, observeValues);
 
    // Create the `llhd.wait` op that suspends the current process and waits for
    // a change in the interesting values listed in `observeValues`. When a
    // change is detected, execution resumes in the "check" block.
    auto waitOp = llhd::WaitOp::create(rewriter, loc, ValueRange{}, Value(),
                                       observeValues, ValueRange{}, checkBlock);
    rewriter.inlineBlockBefore(&clonedOp.getBody().front(), waitOp);
    rewriter.eraseOp(clonedOp);
 
    // Inline the `wait_event` body into the check block.
    rewriter.inlineBlockBefore(&op.getBody().front(), checkBlock,
                               checkBlock->end());
    rewriter.eraseOp(op);
 
    // Helper function to detect if a certain change occurred between a value
    // before the `llhd.wait` and after.
    auto computeTrigger = [&](Value before, Value after, Edge edge) -> Value {
      assert(before.getType() == after.getType() &&
             "mismatched types after clone op");
      auto beforeType = cast<IntType>(before.getType());
 
      // 9.4.2 IEEE 1800-2017: An edge event shall be detected only on the LSB
      // of the expression
      if (beforeType.getWidth() != 1 && edge != Edge::AnyChange) {
        constexpr int LSB = 0;
        beforeType =
            IntType::get(rewriter.getContext(), 1, beforeType.getDomain());
        before =
            moore::ExtractOp::create(rewriter, loc, beforeType, before, LSB);
        after = moore::ExtractOp::create(rewriter, loc, beforeType, after, LSB);
      }
 
      auto intType = rewriter.getIntegerType(beforeType.getWidth());
      before = typeConverter->materializeTargetConversion(rewriter, loc,
                                                          intType, before);
      after = typeConverter->materializeTargetConversion(rewriter, loc, intType,
                                                         after);
 
      if (edge == Edge::AnyChange)
        return comb::ICmpOp::create(rewriter, loc, ICmpPredicate::ne, before,
                                    after, true);
 
      SmallVector<Value> disjuncts;
      Value trueVal = hw::ConstantOp::create(rewriter, loc, APInt(1, 1));
 
      if (edge == Edge::PosEdge || edge == Edge::BothEdges) {
        Value notOldVal =
            comb::XorOp::create(rewriter, loc, before, trueVal, true);
        Value posedge =
            comb::AndOp::create(rewriter, loc, notOldVal, after, true);
        disjuncts.push_back(posedge);
      }
 
      if (edge == Edge::NegEdge || edge == Edge::BothEdges) {
        Value notCurrVal =
            comb::XorOp::create(rewriter, loc, after, trueVal, true);
        Value posedge =
            comb::AndOp::create(rewriter, loc, before, notCurrVal, true);
        disjuncts.push_back(posedge);
      }
 
      return rewriter.createOrFold<comb::OrOp>(loc, disjuncts, true);
    };
 
    // Convert all `detect_event` ops into a check for the corresponding event
    // between the value before and after the `llhd.wait`. The "before" value
    // has been collected into `valuesBefore` in the "wait" block; the "after"
    // value corresponds to the detect op's input.
    SmallVector<Value> triggers;
    for (auto [detectOp, before] : llvm::zip(detectOps, valuesBefore)) {
      if (!allDetectsAreAnyChange) {
        if (!isa<IntType>(before.getType()))
          return detectOp->emitError() << "requires int operand";
 
        rewriter.setInsertionPoint(detectOp);
        auto trigger =
            computeTrigger(before, detectOp.getInput(), detectOp.getEdge());
        if (detectOp.getCondition()) {
          auto condition = typeConverter->materializeTargetConversion(
              rewriter, loc, rewriter.getI1Type(), detectOp.getCondition());
          trigger =
              comb::AndOp::create(rewriter, loc, trigger, condition, true);
        }
        triggers.push_back(trigger);
      }
 
      rewriter.eraseOp(detectOp);
    }
 
    rewriter.setInsertionPointToEnd(checkBlock);
    if (triggers.empty()) {
      // If there are no triggers to check, we always branch to the resume
      // block. If there are no detect_event operations in the wait event, the
      // 'llhd.wait' operation will not have any observed values and thus the
      // process will hang there forever.
      cf::BranchOp::create(rewriter, loc, resumeBlock);
    } else {
      // If any `detect_event` op detected an event, branch to the "resume"
      // block which contains any code after the `wait_event` op. If no events
      // were detected, branch back to the "wait" block to wait for the next
      // change on the interesting signals.
      auto triggered = rewriter.createOrFold<comb::OrOp>(loc, triggers, true);
      cf::CondBranchOp::create(rewriter, loc, triggered, resumeBlock,
                               waitBlock);
    }
 
    return success();
  }
};
 
struct WaitLevelOpConversion : public OpConversionPattern<WaitLevelOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(WaitLevelOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    // The body of a `wait_level` op is executed once immediately and again
    // whenever any of the values it depends on changes, until any condition
    // passed to a `detect_level` op is true. Block structure before
    // conversion:
    //
    //     opA
    //     moore.wait_level {
    //       <body0>
    //       moore.detect_level %cond0
    //       <body1>
    //       moore.detect_level %cond1
    //     }
    //     opB
    //
    // Block structure after conversion:
    //
    //     opA
    //     cf.br ^check
    // ^check:
    //     <body0>
    //     <body1>
    //     %cond = comb.or %cond0, %cond1
    //     cf.cond_br %cond, ^resume, ^wait
    // ^wait:
    //     llhd.wait (<observed values>), ^check
    // ^resume:
    //     opB
    //
    // All body fragments, including those between `detect_level` ops, are
    // inlined into `^check` in order. The `detect_level` ops themselves are
    // replaced by the single `cf.cond_br` at the end of the block.
    auto loc = op.getLoc();
    auto detectOps = llvm::to_vector(op.getBody().getOps<DetectLevelOp>());
 
    // Without any `detect_level` ops the condition can never become true, so
    // the process would never wake up. Just terminate it using `llhd.halt`.
    auto *resumeBlock =
        rewriter.splitBlock(op->getBlock(), ++Block::iterator(op));
    if (detectOps.empty()) {
      // Let the cleanup iteration after the dialect conversion clean up all
      // remaining unreachable blocks.
      rewriter.replaceOpWithNewOp<llhd::HaltOp>(op, ValueRange{});
      return success();
    }
 
    // Determine the values to wait for before modifying the body.
    SmallVector<Value> observeValues;
    getValuesToObserve(
        &op.getBody(),
        [&](Value value) { setInsertionPointAfterDef(rewriter, value); },
        typeConverter, rewriter, observeValues);
 
    auto *waitBlock = rewriter.createBlock(resumeBlock);
    auto *checkBlock = rewriter.createBlock(waitBlock);
 
    rewriter.setInsertionPoint(op);
    cf::BranchOp::create(rewriter, loc, checkBlock);
 
    rewriter.setInsertionPointToEnd(waitBlock);
    llhd::WaitOp::create(rewriter, loc, ValueRange{}, Value(), observeValues,
                         ValueRange{}, checkBlock);
 
    rewriter.inlineBlockBefore(&op.getBody().front(), checkBlock,
                               checkBlock->end());
    rewriter.eraseOp(op);
 
    // Convert all `detect_level` ops into i1 conditions and resume if any of
    // them is true.
    SmallVector<Value> conditions;
    for (auto detectOp : detectOps) {
      rewriter.setInsertionPoint(detectOp);
      auto condition = typeConverter->materializeTargetConversion(
          rewriter, loc, rewriter.getI1Type(), detectOp.getCondition());
      if (!condition)
        return detectOp->emitError() << "cannot convert condition to i1";
      conditions.push_back(condition);
      rewriter.eraseOp(detectOp);
    }
 
    rewriter.setInsertionPointToEnd(checkBlock);
    auto triggered = rewriter.createOrFold<comb::OrOp>(loc, conditions, true);
    cf::CondBranchOp::create(rewriter, loc, triggered, resumeBlock, waitBlock);
    return success();
  }
};
 
// moore.wait_delay -> llhd.wait
static LogicalResult convert(WaitDelayOp op, WaitDelayOp::Adaptor adaptor,
                             ConversionPatternRewriter &rewriter) {
  auto *resumeBlock =
      rewriter.splitBlock(op->getBlock(), ++Block::iterator(op));
  rewriter.setInsertionPoint(op);
  rewriter.replaceOpWithNewOp<llhd::WaitOp>(op, ValueRange{},
                                            adaptor.getDelay(), ValueRange{},
                                            ValueRange{}, resumeBlock);
  rewriter.setInsertionPointToStart(resumeBlock);
  return success();
}
 
// moore.unreachable -> ub.unreachable
static LogicalResult convert(UnreachableOp op, UnreachableOp::Adaptor adaptor,
                             ConversionPatternRewriter &rewriter) {
  rewriter.replaceOpWithNewOp<ub::UnreachableOp>(op);
  return success();
}
 
//===----------------------------------------------------------------------===//
// Declaration Conversion
//===----------------------------------------------------------------------===//
 
static Value createZeroValue(Type type, Location loc,
                             ConversionPatternRewriter &rewriter) {
  // Handle pointers.
  if (isa<mlir::LLVM::LLVMPointerType>(type))
    return mlir::LLVM::ZeroOp::create(rewriter, loc, type);
 
  // Handle time values.
  if (isa<llhd::TimeType>(type)) {
    auto timeAttr =
        llhd::TimeAttr::get(type.getContext(), 0U, llvm::StringRef("ns"), 0);
    return llhd::ConstantTimeOp::create(rewriter, loc, timeAttr);
  }
 
  // Handle real values.
  if (auto floatType = dyn_cast<FloatType>(type)) {
    auto floatAttr = rewriter.getFloatAttr(floatType, 0.0);
    return mlir::arith::ConstantOp::create(rewriter, loc, floatAttr);
  }
 
  // Handle dynamic strings
  if (auto strType = dyn_cast<sim::DynamicStringType>(type))
    return sim::StringConstantOp::create(rewriter, loc, strType, "");
 
  // Handle associative arrays
  if (auto assocArrayType = dyn_cast<sim::AssocArrayType>(type))
    return sim::AssocArrayEmptyOp::create(rewriter, loc, assocArrayType);
 
  // Handle queues
  if (auto queueType = dyn_cast<sim::QueueType>(type))
    return sim::QueueEmptyOp::create(rewriter, loc, queueType);
 
  // Handle aggregate
  if (auto arrayType = dyn_cast<hw::ArrayType>(type)) {
    if (hw::getBitWidth(type) == -1) {
      Value zeroElement =
          createZeroValue(arrayType.getElementType(), loc, rewriter);
      if (!zeroElement)
        return {};
      SmallVector<Value> elements(arrayType.getNumElements(), zeroElement);
      return hw::ArrayCreateOp::create(rewriter, loc, elements);
    }
  }
 
  if (auto structType = dyn_cast<hw::StructType>(type)) {
    if (hw::getBitWidth(type) == -1) {
      SmallVector<Value> fields;
      for (auto field : structType.getElements()) {
        Value zeroField = createZeroValue(field.type, loc, rewriter);
        if (!zeroField)
          return {};
        fields.push_back(zeroField);
      }
      return hw::StructCreateOp::create(rewriter, loc, structType, fields);
    }
  }
 
  // Otherwise try to create a zero integer and bitcast it to the result type.
  int64_t width = hw::getBitWidth(type);
  if (width == -1)
    return {};
 
  // TODO: Once the core dialects support four-valued integers, this code
  // will additionally need to generate an all-X value for four-valued
  // variables.
  Value constZero = hw::ConstantOp::create(rewriter, loc, APInt(width, 0));
  return rewriter.createOrFold<hw::BitcastOp>(loc, type, constZero);
}
 
struct ClassPropertyRefOpConversion
    : public OpConversionPattern<circt::moore::ClassPropertyRefOp> {
  ClassPropertyRefOpConversion(TypeConverter &tc, MLIRContext *ctx,
                               ClassTypeCache &cache)
      : OpConversionPattern(tc, ctx), cache(cache) {}
 
  LogicalResult
  matchAndRewrite(circt::moore::ClassPropertyRefOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Location loc = op.getLoc();
    MLIRContext *ctx = rewriter.getContext();
 
    // Convert result type; we expect !llhd.ref<someT>.
    Type dstTy = getTypeConverter()->convertType(op.getPropertyRef().getType());
    // Operand is a !llvm.ptr
    Value instRef = adaptor.getInstance();
 
    // Resolve identified struct from cache.
    auto classRefTy =
        cast<circt::moore::ClassHandleType>(op.getInstance().getType());
    SymbolRefAttr classSym = classRefTy.getClassSym();
    ModuleOp mod = op->getParentOfType<ModuleOp>();
    if (failed(resolveClassStructBody(mod, classSym, *typeConverter, cache)))
      return rewriter.notifyMatchFailure(op,
                                         "Could not resolve class struct for " +
                                             classSym.getRootReference().str());
 
    auto structInfo = cache.getStructInfo(classSym);
    assert(structInfo && "class struct info must exist");
    auto structTy = structInfo->classBody;
 
    // Look up cached GEP path for the property.
    auto propSym = op.getProperty();
    auto pathOpt = structInfo->getFieldPath(propSym);
    if (!pathOpt)
      return rewriter.notifyMatchFailure(op,
                                         "no GEP path for property " + propSym);
 
    auto i32Ty = IntegerType::get(ctx, 32);
    SmallVector<Value> idxVals;
    for (unsigned idx : *pathOpt)
      idxVals.push_back(LLVM::ConstantOp::create(
          rewriter, loc, i32Ty, rewriter.getI32IntegerAttr(idx)));
 
    // GEP to the field (opaque ptr mode requires element type).
    auto ptrTy = LLVM::LLVMPointerType::get(ctx);
    auto gep =
        LLVM::GEPOp::create(rewriter, loc, ptrTy, structTy, instRef, idxVals);
 
    // Wrap pointer back to !llhd.ref<someT>.
    Value fieldRef = UnrealizedConversionCastOp::create(rewriter, loc, dstTy,
                                                        gep.getResult())
                         .getResult(0);
 
    rewriter.replaceOp(op, fieldRef);
    return success();
  }
 
private:
  ClassTypeCache &cache;
};
 
struct ClassUpcastOpConversion : public OpConversionPattern<ClassUpcastOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(ClassUpcastOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    // Expect lowered types like !llvm.ptr
    Type dstTy = getTypeConverter()->convertType(op.getResult().getType());
    Type srcTy = adaptor.getInstance().getType();
 
    if (!dstTy)
      return rewriter.notifyMatchFailure(op, "failed to convert result type");
 
    // If the types are already identical (opaque pointer mode), just forward.
    if (dstTy == srcTy && isa<LLVM::LLVMPointerType>(srcTy)) {
      rewriter.replaceOp(op, adaptor.getInstance());
      return success();
    }
    return rewriter.notifyMatchFailure(
        op, "Upcast applied to non-opaque pointers!");
  }
};
 
/// moore.class.new lowering: heap-allocate storage for the class object.
struct ClassNewOpConversion : public OpConversionPattern<ClassNewOp> {
  ClassNewOpConversion(TypeConverter &tc, MLIRContext *ctx,
                       ClassTypeCache &cache, FunctionCache &funcCache)
      : OpConversionPattern<ClassNewOp>(tc, ctx), cache(cache),
        funcCache(funcCache) {}
 
  LogicalResult
  matchAndRewrite(ClassNewOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Location loc = op.getLoc();
    MLIRContext *ctx = rewriter.getContext();
 
    auto handleTy = cast<ClassHandleType>(op.getResult().getType());
    auto sym = handleTy.getClassSym();
 
    ModuleOp mod = op->getParentOfType<ModuleOp>();
 
    if (failed(resolveClassStructBody(mod, sym, *typeConverter, cache)))
      return op.emitError() << "Could not resolve class struct for " << sym;
 
    auto structTy = cache.getStructInfo(sym)->classBody;
    auto typeInfo = cache.getStructInfo(sym)->typeInfo;
 
    // Check that all struct members have data layout support. Types like
    // !sim.dstring or !sim.queue don't have a known size, which would cause
    // a fatal error in DataLayout::getTypeSize below.
    for (auto memberTy : structTy.getBody()) {
      if (!LLVM::isCompatibleType(memberTy) &&
          !memberTy.hasTrait<DataLayoutTypeInterface::Trait>()) {
        return op.emitError()
               << "class struct has member types with no data layout";
      }
    }
 
    DataLayout dl(mod);
    // DataLayout::getTypeSize gives a byte count for LLVM types.
    uint64_t byteSize = dl.getTypeSize(structTy);
    auto i64Ty = IntegerType::get(ctx, 64);
    auto cSize = LLVM::ConstantOp::create(rewriter, loc, i64Ty,
                                          rewriter.getI64IntegerAttr(byteSize));
 
    // Get or declare malloc and call it.
    auto ptrTy = LLVM::LLVMPointerType::get(ctx); // opaque pointer result
    auto mallocFn = funcCache.getOrCreate(rewriter, "malloc", {i64Ty}, {ptrTy});
    auto call =
        func::CallOp::create(rewriter, loc, mallocFn, ValueRange{cSize});
 
    auto typeInfoAddr =
        LLVM::AddressOfOp::create(rewriter, loc, typeInfo.global);
    auto i32Ty = IntegerType::get(ctx, 32);
    auto headerIdx = LLVM::ConstantOp::create(
        rewriter, loc, i32Ty,
        rewriter.getI32IntegerAttr(cache.getStructInfo(sym)->headerFieldIndex));
    auto typeInfoIdx = LLVM::ConstantOp::create(
        rewriter, loc, i32Ty,
        rewriter.getI32IntegerAttr(
            cache.getStructInfo(sym)->typeInfoFieldIndex));
    auto headerPtr =
        LLVM::GEPOp::create(rewriter, loc, ptrTy, structTy, call.getResult(0),
                            ValueRange{headerIdx, typeInfoIdx});
    LLVM::StoreOp::create(rewriter, loc, typeInfoAddr, headerPtr);
 
    // Replace the new op with the malloc pointer (no cast needed with opaque
    // ptrs).
    rewriter.replaceOp(op, call.getResult(0));
    return success();
  }
 
private:
  ClassTypeCache &cache; // shared, owned by the pass
  FunctionCache &funcCache;
};
 
struct ClassDeclOpConversion : public OpConversionPattern<ClassDeclOp> {
  ClassDeclOpConversion(TypeConverter &tc, MLIRContext *ctx,
                        ClassTypeCache &cache)
      : OpConversionPattern<ClassDeclOp>(tc, ctx), cache(cache) {}
 
  LogicalResult
  matchAndRewrite(ClassDeclOp op, OpAdaptor,
                  ConversionPatternRewriter &rewriter) const override {
 
    if (failed(resolveClassStructBody(op, *typeConverter, cache)))
      return failure();
    // The declaration itself is a no-op
    rewriter.eraseOp(op);
    return success();
  }
 
private:
  ClassTypeCache &cache; // shared, owned by the pass
};
 
struct VariableOpConversion : public OpConversionPattern<VariableOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(VariableOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    auto loc = op.getLoc();
    auto resultType = typeConverter->convertType(op.getResult().getType());
    if (!resultType)
      return rewriter.notifyMatchFailure(op.getLoc(), "invalid variable type");
 
    auto refType = dyn_cast<llhd::RefType>(resultType);
    if (!refType)
      return rewriter.notifyMatchFailure(
          op.getLoc(), "variable type did not convert to llhd::RefType");
 
    Value init = adaptor.getInitial();
    auto sourceType =
        cast<moore::RefType>(op.getResult().getType()).getNestedType();
    // Statically sized four-valued variables start with an unknown value.
    // The core dialects cannot represent X yet, so leave them unconstrained.
    // Other variable types have a defined default value.
    if (!init && (sourceType.getDomain() == moore::Domain::TwoValued ||
                  !sourceType.getBitSize())) {
      init = createZeroValue(refType.getNestedType(), loc, rewriter);
      if (!init)
        return failure();
    }
 
    rewriter.replaceOpWithNewOp<llhd::SignalOp>(op, resultType,
                                                op.getNameAttr(), init);
    return success();
  }
};
 
struct NetOpConversion : public OpConversionPattern<NetOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(NetOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    auto loc = op.getLoc();
 
    auto resultType = typeConverter->convertType(op.getResult().getType());
    if (!resultType)
      return rewriter.notifyMatchFailure(loc, "invalid net type");
 
    auto elementType = cast<llhd::RefType>(resultType).getNestedType();
    int64_t width = hw::getBitWidth(elementType);
    if (width == -1)
      return failure();
 
    auto init =
        createInitialValue(op.getKind(), rewriter, loc, width, elementType);
    auto signal = rewriter.replaceOpWithNewOp<llhd::SignalOp>(
        op, resultType, op.getNameAttr(), init);
 
    if (auto assignedValue = adaptor.getAssignment()) {
      llhd::AssignOp::create(rewriter, loc, signal, assignedValue, Value{});
    }
 
    return success();
  }
 
  static mlir::Value createInitialValue(NetKind kind,
                                        ConversionPatternRewriter &rewriter,
                                        Location loc, int64_t width,
                                        Type elementType) {
    // TODO: Once the core dialects support four-valued integers, this code
    // will additionally need to generate an all-X value for four-valued nets.
    //
    // If no driver is connected to a net, its value shall be high-impedance (z)
    // unless the net is a trireg, in which case it shall hold the previously
    // driven value.
    //
    // See IEEE 1800-2017 § 6.6 "Net types".
    auto theInt = [&] {
      if (kind == NetKind::Supply1 || kind == NetKind::Tri1)
        return APInt::getAllOnes(width);
      return APInt::getZero(width);
    }();
    auto theConst = hw::ConstantOp::create(rewriter, loc, theInt);
    return rewriter.createOrFold<hw::BitcastOp>(loc, elementType, theConst);
  }
};
 
// moore.global_variable -> llhd.global_signal
static LogicalResult convert(GlobalVariableOp op,
                             GlobalVariableOp::Adaptor adaptor,
                             ConversionPatternRewriter &rewriter,
                             const TypeConverter &typeConverter) {
  auto type = typeConverter.convertType(op.getType());
  auto sig =
      llhd::GlobalSignalOp::create(rewriter, op.getLoc(), op.getSymNameAttr(),
                                   /*sym_visibility=*/{}, type);
  sig.getInitRegion().takeBody(op.getInitRegion());
  rewriter.eraseOp(op);
  return success();
}
 
// moore.get_global_variable -> llhd.get_global_signal
static LogicalResult convert(GetGlobalVariableOp op,
                             GetGlobalVariableOp::Adaptor adaptor,
                             ConversionPatternRewriter &rewriter,
                             const TypeConverter &typeConverter) {
  auto type = typeConverter.convertType(op.getType());
  rewriter.replaceOpWithNewOp<llhd::GetGlobalSignalOp>(op, type,
                                                       op.getGlobalNameAttr());
  return success();
}
 
//===----------------------------------------------------------------------===//
// Expression Conversion
//===----------------------------------------------------------------------===//
 
struct ConstantOpConv : public OpConversionPattern<ConstantOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(ConstantOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    // FIXME: Discard unknown bits and map them to 0 for now.
    auto value = op.getValue().toAPInt(false);
    auto type = rewriter.getIntegerType(value.getBitWidth());
    rewriter.replaceOpWithNewOp<hw::ConstantOp>(
        op, type, rewriter.getIntegerAttr(type, value));
    return success();
  }
};
 
struct ConstantRealOpConv : public OpConversionPattern<ConstantRealOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(ConstantRealOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<arith::ConstantOp>(op, op.getValueAttr());
    return success();
  }
};
 
struct ConstantTimeOpConv : public OpConversionPattern<ConstantTimeOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(ConstantTimeOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<llhd::ConstantTimeOp>(
        op, llhd::TimeAttr::get(op->getContext(), op.getValue(),
                                StringRef("fs"), 0));
    return success();
  }
};
 
struct ConstantStringOpConv : public OpConversionPattern<ConstantStringOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(moore::ConstantStringOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    const auto resultType =
        typeConverter->convertType(op.getResult().getType());
    const auto intType = mlir::cast<IntegerType>(resultType);
 
    const auto str = op.getValue();
    const unsigned byteWidth = intType.getWidth();
    APInt value(byteWidth, 0);
 
    // Pack ascii chars from the end of the string, until it fits.
    const size_t maxChars =
        std::min(str.size(), static_cast<size_t>(byteWidth / 8));
    for (size_t i = 0; i < maxChars; i++) {
      const size_t pos = str.size() - 1 - i;
      const auto asciiChar = static_cast<uint8_t>(str[pos]);
      value |= APInt(byteWidth, asciiChar) << (8 * i);
    }
 
    rewriter.replaceOpWithNewOp<hw::ConstantOp>(
        op, resultType, rewriter.getIntegerAttr(resultType, value));
    return success();
  }
};
 
struct ConcatOpConversion : public OpConversionPattern<ConcatOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(ConcatOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<comb::ConcatOp>(op, adaptor.getValues());
    return success();
  }
};
 
struct ReplicateOpConversion : public OpConversionPattern<ReplicateOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(ReplicateOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType = typeConverter->convertType(op.getResult().getType());
 
    rewriter.replaceOpWithNewOp<comb::ReplicateOp>(op, resultType,
                                                   adaptor.getValue());
    return success();
  }
};
 
struct ExtractOpConversion : public OpConversionPattern<ExtractOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(ExtractOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    // TODO: return X if the domain is four-valued for out-of-bounds accesses
    // once we support four-valued lowering
    Type resultType = typeConverter->convertType(op.getResult().getType());
    Value input = adaptor.getInput();
    Type inputType = input.getType();
    int32_t low = adaptor.getLowBit();
    auto loc = op.getLoc();
 
    // Bit-addressed extract out of an integer into any bitcastable result.
    if (isa<IntegerType>(inputType)) {
      int32_t inputWidth = inputType.getIntOrFloatBitWidth();
      int32_t resultWidth = hw::getBitWidth(resultType);
      if (resultWidth < 0)
        return failure();
 
      int32_t high = low + resultWidth;
      int32_t lsbPad = std::clamp(-low, 0, resultWidth);
      int32_t msbPad = std::clamp(high - inputWidth, 0, resultWidth - lsbPad);
      int32_t extractWidth = resultWidth - lsbPad - msbPad;
 
      SmallVector<Value> sbv;
      if (msbPad > 0)
        sbv.push_back(hw::ConstantOp::create(rewriter, loc, APInt(msbPad, 0)));
 
      if (extractWidth > 0)
        sbv.push_back(rewriter.createOrFold<comb::ExtractOp>(
            loc, rewriter.getIntegerType(extractWidth), input,
            std::max(low, 0)));
 
      if (lsbPad > 0)
        sbv.push_back(hw::ConstantOp::create(rewriter, loc, APInt(lsbPad, 0)));
 
      Value res = rewriter.createOrFold<comb::ConcatOp>(loc, sbv);
      if (res.getType() != resultType)
        res = rewriter.createOrFold<hw::BitcastOp>(loc, resultType, res);
 
      rewriter.replaceOp(op, res);
      return success();
    }
 
    // Element-addressed extract out of an array
    if (auto arrTy = dyn_cast<hw::ArrayType>(inputType)) {
      Type elementType = arrTy.getElementType();
      int32_t idxWidth = llvm::Log2_64_Ceil(arrTy.getNumElements());
      int32_t inputWidth = arrTy.getNumElements();
 
      // Array element
      if (resultType == elementType) {
        if (low < 0 || low >= inputWidth) {
          auto zeros = createZeroValue(resultType, loc, rewriter);
          if (!zeros)
            return failure();
          rewriter.replaceOp(op, zeros);
        } else {
          rewriter.replaceOpWithNewOp<hw::ArrayGetOp>(
              op, input,
              hw::ConstantOp::create(rewriter, loc,
                                     rewriter.getIntegerType(idxWidth), low));
        }
        return success();
      }
 
      // Array slice
      if (auto resArrTy = dyn_cast<hw::ArrayType>(resultType);
          resArrTy && resArrTy.getElementType() == elementType) {
        int32_t resultWidth = resArrTy.getNumElements();
        int32_t high = low + resultWidth;
 
        int32_t lsbPad = std::clamp(-low, 0, resultWidth);
        int32_t msbPad = std::clamp(high - inputWidth, 0, resultWidth - lsbPad);
        int32_t extractWidth = resultWidth - lsbPad - msbPad;
 
        SmallVector<Value> toConcat;
        if (msbPad > 0) {
          auto zeros = createZeroValue(hw::ArrayType::get(elementType, msbPad),
                                       loc, rewriter);
          if (!zeros)
            return failure();
          toConcat.push_back(zeros);
        }
 
        if (extractWidth > 0)
          toConcat.push_back(rewriter.createOrFold<hw::ArraySliceOp>(
              loc, hw::ArrayType::get(elementType, extractWidth), input,
              hw::ConstantOp::create(rewriter, loc,
                                     rewriter.getIntegerType(idxWidth),
                                     std::max(low, 0))));
 
        if (lsbPad > 0) {
          auto zeros = createZeroValue(hw::ArrayType::get(elementType, lsbPad),
                                       loc, rewriter);
          if (!zeros)
            return failure();
          toConcat.push_back(zeros);
        }
 
        rewriter.replaceOp(
            op, rewriter.createOrFold<hw::ArrayConcatOp>(loc, toConcat));
        return success();
      }
    }
 
    return failure();
  }
};
 
struct ExtractRefOpConversion : public OpConversionPattern<ExtractRefOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(ExtractRefOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    // TODO: properly handle out-of-bounds accesses
    Type resultType = typeConverter->convertType(op.getResult().getType());
    auto inputRefType = dyn_cast<llhd::RefType>(adaptor.getInput().getType());
    if (!inputRefType)
      return op.emitOpError(
          "extracts from a net which is not currently supported");
    auto inputType = inputRefType.getNestedType();
 
    if (auto intType = dyn_cast<IntegerType>(inputType)) {
      int64_t width = hw::getBitWidth(inputType);
      if (width == -1)
        return failure();
 
      Value lowBit = hw::ConstantOp::create(
          rewriter, op.getLoc(),
          rewriter.getIntegerType(llvm::Log2_64_Ceil(width)),
          adaptor.getLowBit());
      rewriter.replaceOpWithNewOp<llhd::SigExtractOp>(
          op, resultType, adaptor.getInput(), lowBit);
      return success();
    }
 
    if (auto arrType = dyn_cast<hw::ArrayType>(inputType)) {
      Value lowBit = hw::ConstantOp::create(
          rewriter, op.getLoc(),
          rewriter.getIntegerType(llvm::Log2_64_Ceil(arrType.getNumElements())),
          adaptor.getLowBit());
 
      // If the result type is not the same as the array's element type, then
      // it has to be a slice.
      if (arrType.getElementType() !=
          cast<llhd::RefType>(resultType).getNestedType()) {
        rewriter.replaceOpWithNewOp<llhd::SigArraySliceOp>(
            op, resultType, adaptor.getInput(), lowBit);
        return success();
      }
 
      rewriter.replaceOpWithNewOp<llhd::SigArrayGetOp>(op, adaptor.getInput(),
                                                       lowBit);
      return success();
    }
 
    return failure();
  }
};
 
struct DynExtractOpConversion : public OpConversionPattern<DynExtractOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(DynExtractOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType = typeConverter->convertType(op.getResult().getType());
    Type inputType = adaptor.getInput().getType();
 
    if (auto intType = dyn_cast<IntegerType>(inputType)) {
      Value amount = adjustIntegerWidth(rewriter, adaptor.getLowBit(),
                                        intType.getWidth(), op->getLoc());
      Value value = comb::ShrUOp::create(rewriter, op->getLoc(),
                                         adaptor.getInput(), amount);
 
      rewriter.replaceOpWithNewOp<comb::ExtractOp>(op, resultType, value, 0);
      return success();
    }
 
    if (auto arrType = dyn_cast<hw::ArrayType>(inputType)) {
      unsigned idxWidth = llvm::Log2_64_Ceil(arrType.getNumElements());
      Value idx = adjustIntegerWidth(rewriter, adaptor.getLowBit(), idxWidth,
                                     op->getLoc());
 
      bool isSingleElementExtract = arrType.getElementType() == resultType;
 
      if (isSingleElementExtract)
        rewriter.replaceOpWithNewOp<hw::ArrayGetOp>(op, adaptor.getInput(),
                                                    idx);
      else
        rewriter.replaceOpWithNewOp<hw::ArraySliceOp>(op, resultType,
                                                      adaptor.getInput(), idx);
 
      return success();
    }
 
    return failure();
  }
};
 
struct DynExtractRefOpConversion : public OpConversionPattern<DynExtractRefOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(DynExtractRefOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    // TODO: properly handle out-of-bounds accesses
    Type resultType = typeConverter->convertType(op.getResult().getType());
    auto inputRefType = dyn_cast<llhd::RefType>(adaptor.getInput().getType());
    if (!inputRefType)
      return op.emitOpError(
          "extracts from a net which is not currently supported");
    auto inputType = inputRefType.getNestedType();
 
    if (auto intType = dyn_cast<IntegerType>(inputType)) {
      int64_t width = hw::getBitWidth(inputType);
      if (width == -1)
        return failure();
 
      Value amount =
          adjustIntegerWidth(rewriter, adaptor.getLowBit(),
                             llvm::Log2_64_Ceil(width), op->getLoc());
      rewriter.replaceOpWithNewOp<llhd::SigExtractOp>(
          op, resultType, adaptor.getInput(), amount);
      return success();
    }
 
    if (auto arrType = dyn_cast<hw::ArrayType>(inputType)) {
      Value idx = adjustIntegerWidth(
          rewriter, adaptor.getLowBit(),
          llvm::Log2_64_Ceil(arrType.getNumElements()), op->getLoc());
 
      auto resultNestedType = cast<llhd::RefType>(resultType).getNestedType();
      bool isSingleElementExtract =
          arrType.getElementType() == resultNestedType;
 
      if (isSingleElementExtract)
        rewriter.replaceOpWithNewOp<llhd::SigArrayGetOp>(op, adaptor.getInput(),
                                                         idx);
      else
        rewriter.replaceOpWithNewOp<llhd::SigArraySliceOp>(
            op, resultType, adaptor.getInput(), idx);
 
      return success();
    }
 
    return failure();
  }
};
 
struct ArrayCreateOpConversion : public OpConversionPattern<ArrayCreateOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(ArrayCreateOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType = typeConverter->convertType(op.getResult().getType());
    rewriter.replaceOpWithNewOp<hw::ArrayCreateOp>(op, resultType,
                                                   adaptor.getElements());
    return success();
  }
};
 
struct StructCreateOpConversion : public OpConversionPattern<StructCreateOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(StructCreateOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType = typeConverter->convertType(op.getResult().getType());
    rewriter.replaceOpWithNewOp<hw::StructCreateOp>(op, resultType,
                                                    adaptor.getFields());
    return success();
  }
};
 
struct StructExtractOpConversion : public OpConversionPattern<StructExtractOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(StructExtractOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<hw::StructExtractOp>(
        op, adaptor.getInput(), adaptor.getFieldNameAttr());
    return success();
  }
};
 
struct StructExtractRefOpConversion
    : public OpConversionPattern<StructExtractRefOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(StructExtractRefOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<llhd::SigStructExtractOp>(
        op, adaptor.getInput(), adaptor.getFieldNameAttr());
    return success();
  }
};
 
struct UnionCreateOpConversion : public OpConversionPattern<UnionCreateOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(UnionCreateOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType = typeConverter->convertType(op.getResult().getType());
    rewriter.replaceOpWithNewOp<hw::UnionCreateOp>(
        op, resultType, adaptor.getFieldNameAttr(), adaptor.getInput());
    return success();
  }
};
 
struct UnionExtractOpConversion : public OpConversionPattern<UnionExtractOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(UnionExtractOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<hw::UnionExtractOp>(op, adaptor.getInput(),
                                                    adaptor.getFieldNameAttr());
    return success();
  }
};
 
struct UnionExtractRefOpConversion
    : public OpConversionPattern<UnionExtractRefOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(UnionExtractRefOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<llhd::SigStructExtractOp>(
        op, adaptor.getInput(), adaptor.getFieldNameAttr());
    return success();
  }
};
 
struct ReduceAndOpConversion : public OpConversionPattern<ReduceAndOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(ReduceAndOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType = typeConverter->convertType(op.getInput().getType());
    Value max = hw::ConstantOp::create(rewriter, op->getLoc(), resultType, -1);
 
    rewriter.replaceOpWithNewOp<comb::ICmpOp>(op, comb::ICmpPredicate::eq,
                                              adaptor.getInput(), max);
    return success();
  }
};
 
struct ReduceOrOpConversion : public OpConversionPattern<ReduceOrOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(ReduceOrOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType = typeConverter->convertType(op.getInput().getType());
    Value zero = hw::ConstantOp::create(rewriter, op->getLoc(), resultType, 0);
 
    rewriter.replaceOpWithNewOp<comb::ICmpOp>(op, comb::ICmpPredicate::ne,
                                              adaptor.getInput(), zero);
    return success();
  }
};
 
struct ReduceXorOpConversion : public OpConversionPattern<ReduceXorOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(ReduceXorOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
 
    rewriter.replaceOpWithNewOp<comb::ParityOp>(op, adaptor.getInput());
    return success();
  }
};
 
struct BoolCastOpConversion : public OpConversionPattern<BoolCastOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(BoolCastOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType = typeConverter->convertType(op.getInput().getType());
    if (isa_and_nonnull<IntegerType>(resultType)) {
      Value zero =
          hw::ConstantOp::create(rewriter, op->getLoc(), resultType, 0);
      rewriter.replaceOpWithNewOp<comb::ICmpOp>(op, comb::ICmpPredicate::ne,
                                                adaptor.getInput(), zero);
      return success();
    }
    if (isa_and_nonnull<FloatType>(resultType)) {
      Value zero = arith::ConstantOp::create(
          rewriter, op->getLoc(), rewriter.getFloatAttr(resultType, 0.0));
      rewriter.replaceOpWithNewOp<arith::CmpFOp>(op, arith::CmpFPredicate::ONE,
                                                 adaptor.getInput(), zero);
      return success();
    }
    if (isa_and_nonnull<llhd::TimeType>(resultType)) {
      Value timeInt =
          llhd::TimeToIntOp::create(rewriter, op->getLoc(), adaptor.getInput());
      Value zero = hw::ConstantOp::create(rewriter, op->getLoc(),
                                          rewriter.getI64Type(), 0);
      rewriter.replaceOpWithNewOp<comb::ICmpOp>(op, comb::ICmpPredicate::ne,
                                                timeInt, zero);
      return success();
    }
    if (isa_and_nonnull<hw::StructType, hw::ArrayType, hw::UnionType>(
            resultType)) {
      int64_t width = hw::getBitWidth(resultType);
      if (width < 0)
        return failure();
      auto intTy = rewriter.getIntegerType(width);
      Value input = rewriter.createOrFold<hw::BitcastOp>(op->getLoc(), intTy,
                                                         adaptor.getInput());
      Value zero = hw::ConstantOp::create(rewriter, op->getLoc(), intTy, 0);
      rewriter.replaceOpWithNewOp<comb::ICmpOp>(op, comb::ICmpPredicate::ne,
                                                input, zero);
      return success();
    }
    return failure();
  }
};
 
struct NotOpConversion : public OpConversionPattern<NotOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(NotOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType =
        ConversionPattern::typeConverter->convertType(op.getResult().getType());
    Value max = hw::ConstantOp::create(rewriter, op.getLoc(), resultType, -1);
 
    rewriter.replaceOpWithNewOp<comb::XorOp>(op, adaptor.getInput(), max);
    return success();
  }
};
 
struct NegOpConversion : public OpConversionPattern<NegOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(NegOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType =
        ConversionPattern::typeConverter->convertType(op.getResult().getType());
    Value zero = hw::ConstantOp::create(rewriter, op.getLoc(), resultType, 0);
 
    rewriter.replaceOpWithNewOp<comb::SubOp>(op, zero, adaptor.getInput());
    return success();
  }
};
 
struct NegRealOpConversion : public OpConversionPattern<NegRealOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(NegRealOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<arith::NegFOp>(op, adaptor.getInput());
    return success();
  }
};
 
template <typename SourceOp, typename TargetOp>
struct BinaryOpConversion : public OpConversionPattern<SourceOp> {
  using OpConversionPattern<SourceOp>::OpConversionPattern;
  using OpAdaptor = typename SourceOp::Adaptor;
 
  LogicalResult
  matchAndRewrite(SourceOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<TargetOp>(op, adaptor.getLhs(),
                                          adaptor.getRhs(), false);
    return success();
  }
};
 
template <typename SourceOp, typename TargetOp>
struct BinaryRealOpConversion : public OpConversionPattern<SourceOp> {
  using OpConversionPattern<SourceOp>::OpConversionPattern;
  using OpAdaptor = typename SourceOp::Adaptor;
 
  LogicalResult
  matchAndRewrite(SourceOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<TargetOp>(op, adaptor.getLhs(),
                                          adaptor.getRhs());
    return success();
  }
};
 
struct HypotBIOpConversion : public OpConversionPattern<HypotBIOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(HypotBIOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Value lhs = adaptor.getLhs();
    Value rhs = adaptor.getRhs();
    ImplicitLocOpBuilder b(op->getLoc(), rewriter);
    auto left = arith::MulFOp::create(b, lhs, lhs);
    auto right = arith::MulFOp::create(b, rhs, rhs);
    auto sum = arith::AddFOp::create(b, left, right);
    auto out = math::SqrtOp::create(b, sum);
    rewriter.replaceOp(op, out);
    return success();
  }
};
 
template <typename SourceOp, typename TargetOp>
struct RealMathFunc : public OpConversionPattern<SourceOp> {
  using OpConversionPattern<SourceOp>::OpConversionPattern;
  using OpAdaptor = typename SourceOp::Adaptor;
 
  LogicalResult
  matchAndRewrite(SourceOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<TargetOp>(op, adaptor.getValue());
    return success();
  }
};
 
template <typename SourceOp, ICmpPredicate pred>
struct ICmpOpConversion : public OpConversionPattern<SourceOp> {
  using OpConversionPattern<SourceOp>::OpConversionPattern;
  using OpAdaptor = typename SourceOp::Adaptor;
 
  LogicalResult
  matchAndRewrite(SourceOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType =
        ConversionPattern::typeConverter->convertType(op.getResult().getType());
 
    rewriter.replaceOpWithNewOp<comb::ICmpOp>(
        op, resultType, pred, adaptor.getLhs(), adaptor.getRhs());
    return success();
  }
};
 
template <typename SourceOp>
struct NullOpConversion : public OpConversionPattern<SourceOp> {
  using OpConversionPattern<SourceOp>::OpConversionPattern;
  using OpConversionPattern<SourceOp>::getTypeConverter;
  using OpAdaptor = typename SourceOp::Adaptor;
 
  LogicalResult
  matchAndRewrite(SourceOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type ptrTy = getTypeConverter()->convertType(op.getResult().getType());
    if (!ptrTy)
      return rewriter.notifyMatchFailure(op, "failed to convert null type");
    rewriter.replaceOpWithNewOp<LLVM::ZeroOp>(op, ptrTy);
    return success();
  }
};
 
template <typename SourceOp, LLVM::ICmpPredicate pred>
struct HandleCmpOpConversion : public OpConversionPattern<SourceOp> {
  using OpConversionPattern<SourceOp>::OpConversionPattern;
  using OpAdaptor = typename SourceOp::Adaptor;
 
  LogicalResult
  matchAndRewrite(SourceOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<LLVM::ICmpOp>(op, pred, adaptor.getLhs(),
                                              adaptor.getRhs());
    return success();
  }
};
 
template <typename SourceOp, arith::CmpFPredicate pred>
struct FCmpOpConversion : public OpConversionPattern<SourceOp> {
  using OpConversionPattern<SourceOp>::OpConversionPattern;
  using OpAdaptor = typename SourceOp::Adaptor;
 
  LogicalResult
  matchAndRewrite(SourceOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType =
        ConversionPattern::typeConverter->convertType(op.getResult().getType());
 
    rewriter.replaceOpWithNewOp<arith::CmpFOp>(
        op, resultType, pred, adaptor.getLhs(), adaptor.getRhs());
    return success();
  }
};
 
/// The four-valued value of `value` if a `moore.constant` defines it.
static std::optional<FVInt> getFourValuedConstant(Value value) {
  if (auto constOp = value.getDefiningOp<ConstantOp>())
    return constOp.getValue();
  return std::nullopt;
}
 
/// Lower a comparison in which some bits of a constant operand are
/// wildcards (`ignored`) and every other bit must match exactly, X and Z
/// included (`===`/`!==` ignore no bit, `casez` items ignore their Z bits,
/// `casex` items their X and Z bits, `==?`/`!=?` the X and Z bits of the right
/// operand).  The lowering is two-valued: a constant's X and Z bits become 0
/// and a value that is not a constant has no X or Z bit at all.  So a constant
/// with an X or Z bit outside `ignored` never matches a non-constant operand
/// (IEEE 1800 11.4.5, 12.5.1); converting that bit to 0 and comparing would
/// match a 0 instead.  So `a === 2'bxx` is 0 for every `a`, and a `case` or
/// `casez` item with an x bit never matches (casez only skips z and `?` bits).
static Value lowerMaskedCaseCompare(ConversionPatternRewriter &rewriter,
                                    Location loc, Value lhsOrig, Value rhsOrig,
                                    Value lhs, Value rhs, APInt ignoredBits,
                                    ICmpPredicate pred, bool negate) {
  auto lhsConst = getFourValuedConstant(lhsOrig);
  auto rhsConst = getFourValuedConstant(rhsOrig);
  auto constantResult = [&](bool equal) -> Value {
    return hw::ConstantOp::create(rewriter, loc, APInt(1, equal != negate));
  };
  if (lhsConst && rhsConst) {
    // Both constant: compare the bits that are not ignored exactly.
    APInt keep = ~ignoredBits;
    bool equal =
        (lhsConst->getRawValue() & keep) == (rhsConst->getRawValue() & keep) &&
        (lhsConst->getRawUnknown() & keep) ==
            (rhsConst->getRawUnknown() & keep);
    return constantResult(equal);
  }
  for (auto &constant : {lhsConst, rhsConst})
    if (constant && !(constant->getUnknownBits() & ~ignoredBits).isZero())
      return constantResult(false);
  if (!ignoredBits.isZero()) {
    auto maskOp = hw::ConstantOp::create(rewriter, loc, ~ignoredBits);
    lhs = rewriter.createOrFold<comb::AndOp>(loc, lhs, maskOp);
    rhs = rewriter.createOrFold<comb::AndOp>(loc, rhs, maskOp);
  }
  return comb::ICmpOp::create(rewriter, loc, pred, lhs, rhs);
}
 
/// `===` and `!==`: no bit is a wildcard.
template <typename SourceOp, ICmpPredicate pred, bool negate>
struct CaseEqOpConversion : public OpConversionPattern<SourceOp> {
  using OpConversionPattern<SourceOp>::OpConversionPattern;
  using OpAdaptor = typename SourceOp::Adaptor;
 
  LogicalResult
  matchAndRewrite(SourceOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    unsigned bitWidth = op.getLhs().getType().getWidth();
    rewriter.replaceOp(op, lowerMaskedCaseCompare(
                               rewriter, op.getLoc(), op.getLhs(), op.getRhs(),
                               adaptor.getLhs(), adaptor.getRhs(),
                               APInt::getZero(bitWidth), pred, negate));
    return success();
  }
};
 
/// `==?` and `!=?`: the X and Z bits of a constant right operand are
/// wildcards.  The left operand's X and Z bits are not (IEEE 1800 11.4.6 makes
/// the result X there); a constant left operand with such bits is lowered as
/// before (X and Z read as 0) rather than guessed.
template <typename SourceOp, ICmpPredicate pred, bool negate>
struct WildcardEqOpConversion : public OpConversionPattern<SourceOp> {
  using OpConversionPattern<SourceOp>::OpConversionPattern;
  using OpAdaptor = typename SourceOp::Adaptor;
 
  LogicalResult
  matchAndRewrite(SourceOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    unsigned bitWidth = op.getLhs().getType().getWidth();
    auto lhsConst = getFourValuedConstant(op.getLhs());
    auto rhsConst = getFourValuedConstant(op.getRhs());
    Value lhs = adaptor.getLhs();
    Value rhs = adaptor.getRhs();
    if (lhsConst && lhsConst->hasUnknown()) {
      rewriter.replaceOpWithNewOp<comb::ICmpOp>(op, pred, lhs, rhs);
      return success();
    }
    APInt ignoredBits =
        rhsConst ? rhsConst->getUnknownBits() : APInt::getZero(bitWidth);
    rewriter.replaceOp(op, lowerMaskedCaseCompare(
                               rewriter, op.getLoc(), op.getLhs(), op.getRhs(),
                               lhs, rhs, ignoredBits, pred, negate));
    return success();
  }
};
 
/// `casez` (withoutX: an item's Z bits are wildcards) and `casex` (its X and Z
/// bits are).
template <typename SourceOp, bool withoutX>
struct CaseXZEqOpConversion : public OpConversionPattern<SourceOp> {
  using OpConversionPattern<SourceOp>::OpConversionPattern;
  using OpAdaptor = typename SourceOp::Adaptor;
 
  LogicalResult
  matchAndRewrite(SourceOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    // Check each operand if it is a known constant and extract the X and/or Z
    // bits to be ignored.
    // TODO: Once the core dialects support four-valued integers, we will have
    // to create ops that extract X and Z bits from the operands, since we also
    // have to do the right casez/casex comparison on non-constant inputs.
    unsigned bitWidth = op.getLhs().getType().getWidth();
    auto ignoredBits = APInt::getZero(bitWidth);
    auto detectIgnoredBits = [&](Value value) {
      auto constValue = getFourValuedConstant(value);
      if (!constValue)
        return;
      if (withoutX)
        ignoredBits |= constValue->getZBits();
      else
        ignoredBits |= constValue->getUnknownBits();
    };
    detectIgnoredBits(op.getLhs());
    detectIgnoredBits(op.getRhs());
 
    rewriter.replaceOp(op, lowerMaskedCaseCompare(
                               rewriter, op.getLoc(), op.getLhs(), op.getRhs(),
                               adaptor.getLhs(), adaptor.getRhs(), ignoredBits,
                               ICmpPredicate::ceq, /*negate=*/false));
    return success();
  }
};
 
//===----------------------------------------------------------------------===//
// Conversions
//===----------------------------------------------------------------------===//
 
template <typename SourceOp>
struct BitcastConversion : public OpConversionPattern<SourceOp> {
  using OpConversionPattern<SourceOp>::OpConversionPattern;
  using OpAdaptor = typename SourceOp::Adaptor;
  using ConversionPattern::typeConverter;
 
  LogicalResult
  matchAndRewrite(SourceOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    auto type = typeConverter->convertType(op.getResult().getType());
    if (type == adaptor.getInput().getType())
      rewriter.replaceOp(op, adaptor.getInput());
    else
      rewriter.replaceOpWithNewOp<hw::BitcastOp>(op, type, adaptor.getInput());
    return success();
  }
};
 
/// For casts that are automatically resolved by type conversion
template <typename SourceOp>
struct NoOpConversion : public OpConversionPattern<SourceOp> {
  using OpConversionPattern<SourceOp>::OpConversionPattern;
  using OpAdaptor = typename SourceOp::Adaptor;
  using ConversionPattern::typeConverter;
 
  LogicalResult
  matchAndRewrite(SourceOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOp(op, adaptor.getInput());
    return success();
  }
};
 
struct TruncOpConversion : public OpConversionPattern<TruncOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(TruncOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<comb::ExtractOp>(op, adaptor.getInput(), 0,
                                                 op.getType().getWidth());
    return success();
  }
};
 
struct ZExtOpConversion : public OpConversionPattern<ZExtOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(ZExtOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    auto targetWidth = op.getType().getWidth();
    auto inputWidth = op.getInput().getType().getWidth();
 
    auto zeroExt = hw::ConstantOp::create(
        rewriter, op.getLoc(),
        rewriter.getIntegerType(targetWidth - inputWidth), 0);
 
    rewriter.replaceOpWithNewOp<comb::ConcatOp>(
        op, ValueRange{zeroExt, adaptor.getInput()});
    return success();
  }
};
 
struct SExtOpConversion : public OpConversionPattern<SExtOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(SExtOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    auto type = typeConverter->convertType(op.getType());
    auto value =
        comb::createOrFoldSExt(rewriter, op.getLoc(), adaptor.getInput(), type);
    rewriter.replaceOp(op, value);
    return success();
  }
};
 
struct SIntToRealOpConversion : public OpConversionPattern<SIntToRealOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(SIntToRealOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<arith::SIToFPOp>(
        op, typeConverter->convertType(op.getType()), adaptor.getInput());
    return success();
  }
};
 
struct UIntToRealOpConversion : public OpConversionPattern<UIntToRealOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(UIntToRealOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<arith::UIToFPOp>(
        op, typeConverter->convertType(op.getType()), adaptor.getInput());
    return success();
  }
};
 
struct IntToStringOpConversion : public OpConversionPattern<IntToStringOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(IntToStringOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<sim::IntToStringOp>(op, adaptor.getInput());
    return success();
  }
};
 
struct StringToIntOpConversion : public OpConversionPattern<StringToIntOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(StringToIntOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultTy = typeConverter->convertType(op.getType());
    if (!resultTy)
      return failure();
    rewriter.replaceOpWithNewOp<sim::StringToIntOp>(op, resultTy,
                                                    adaptor.getInput());
    return success();
  }
};
 
struct FormatStringToStringOpConversion
    : public OpConversionPattern<FormatStringToStringOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(FormatStringToStringOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<sim::FormatToStringOp>(op,
                                                       adaptor.getFmtstring());
    return success();
  }
};
 
struct RealToIntOpConversion : public OpConversionPattern<RealToIntOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(RealToIntOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<arith::FPToSIOp>(
        op, typeConverter->convertType(op.getType()), adaptor.getInput());
    return success();
  }
};
 
struct ConvertRealOpConversion : public OpConversionPattern<ConvertRealOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(ConvertRealOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    auto resultType = typeConverter->convertType(op.getType());
    if (op.getInput().getType().getWidth() <
        op.getResult().getType().getWidth()) {
      arith::ExtFOp::Properties properties{};
      arith::ExtFOp::populateDefaultProperties(
          OperationName(arith::ExtFOp::getOperationName(),
                        rewriter.getContext()),
          properties);
      rewriter.replaceOpWithNewOp<arith::ExtFOp>(op, TypeRange{resultType},
                                                 ValueRange{adaptor.getInput()},
                                                 properties);
    } else {
      arith::TruncFOp::Properties properties{};
      arith::TruncFOp::populateDefaultProperties(
          OperationName(arith::TruncFOp::getOperationName(),
                        rewriter.getContext()),
          properties);
      rewriter.replaceOpWithNewOp<arith::TruncFOp>(
          op, TypeRange{resultType}, ValueRange{adaptor.getInput()},
          properties);
    }
    return success();
  }
};
 
template <typename SourceOp>
struct RealBitcastOpConversion : public OpConversionPattern<SourceOp> {
  using OpConversionPattern<SourceOp>::OpConversionPattern;
  using OpAdaptor = typename SourceOp::Adaptor;
 
  LogicalResult
  matchAndRewrite(SourceOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultTy =
        ConversionPattern::typeConverter->convertType(op.getResult().getType());
    rewriter.replaceOpWithNewOp<arith::BitcastOp>(op, resultTy,
                                                  adaptor.getValue());
    return success();
  }
};
 
//===----------------------------------------------------------------------===//
// Statement Conversion
//===----------------------------------------------------------------------===//
 
struct HWInstanceOpConversion : public OpConversionPattern<hw::InstanceOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(hw::InstanceOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    SmallVector<Type> convResTypes;
    if (typeConverter->convertTypes(op.getResultTypes(), convResTypes).failed())
      return failure();
 
    rewriter.replaceOpWithNewOp<hw::InstanceOp>(
        op, convResTypes, op.getInstanceName(), op.getModuleName(),
        adaptor.getOperands(), op.getArgNames(),
        op.getResultNames(), /*Parameter*/
        rewriter.getArrayAttr({}), /*InnerSymbol*/ nullptr);
 
    return success();
  }
};
 
struct ReturnOpConversion : public OpConversionPattern<func::ReturnOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(func::ReturnOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<func::ReturnOp>(op, adaptor.getOperands());
    return success();
  }
};
 
struct CallOpConversion : public OpConversionPattern<func::CallOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(func::CallOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    SmallVector<Type> convResTypes;
    if (typeConverter->convertTypes(op.getResultTypes(), convResTypes).failed())
      return failure();
    rewriter.replaceOpWithNewOp<func::CallOp>(
        op, adaptor.getCallee(), convResTypes, adaptor.getOperands());
    return success();
  }
};
 
struct FuncDPICallOpConversion
    : public OpConversionPattern<moore::FuncDPICallOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(moore::FuncDPICallOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    SmallVector<Type> convResTypes;
    if (typeConverter->convertTypes(op.getResultTypes(), convResTypes).failed())
      return failure();
    rewriter.replaceOpWithNewOp<sim::DPICallOp>(
        op, convResTypes, op.getCalleeAttr(), /*clock=*/Value(),
        /*enable=*/Value(), adaptor.getInputs());
    return success();
  }
};
 
struct DPIFuncOpConversion : public OpConversionPattern<moore::DPIFuncOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(moore::DPIFuncOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    // Map Moore DPIArgDirection to sim::DPIDirection.
    auto toDPIDir = [](moore::DPIArgDirection dir) -> sim::DPIDirection {
      switch (dir) {
      case moore::DPIArgDirection::In:
        return sim::DPIDirection::Input;
      case moore::DPIArgDirection::Out:
        return sim::DPIDirection::Output;
      case moore::DPIArgDirection::InOut:
        return sim::DPIDirection::InOut;
      case moore::DPIArgDirection::Return:
        return sim::DPIDirection::Return;
      }
      llvm_unreachable("unknown DPIArgDirection");
    };
 
    // Reconstruct sim::DPIFunctionType from Moore's argument arrays.
    auto dirs = op.getDpiArgDirs();
    auto names = op.getDpiArgNames();
    SmallVector<Type> argTypes;
    op.getDPIArgTypes(argTypes);
 
    SmallVector<sim::DPIArgument> dpiArguments;
    for (auto [dirAttr, nameAttr, mooreType] :
         llvm::zip(dirs, names, argTypes)) {
      auto dir = toDPIDir(cast<moore::DPIArgDirectionAttr>(dirAttr).getValue());
      auto name = cast<StringAttr>(nameAttr);
      Type coreType = typeConverter->convertType(mooreType);
      if (!coreType)
        return op.emitOpError("argument '")
               << name << "' has unsupported type " << mooreType;
      dpiArguments.push_back({name, coreType, dir});
    }
 
    auto coreDPIFuncType =
        sim::DPIFunctionType::get(rewriter.getContext(), dpiArguments);
    auto simFunc = sim::DPIFuncOp::create(
        rewriter, op.getLoc(), op.getSymNameAttr(), coreDPIFuncType,
        op.getArgumentLocsAttr(), op.getVerilogNameAttr());
    SymbolTable::setSymbolVisibility(simFunc,
                                     SymbolTable::getSymbolVisibility(op));
    rewriter.eraseOp(op);
    return success();
  }
};
 
struct UnrealizedConversionCastConversion
    : public OpConversionPattern<UnrealizedConversionCastOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(UnrealizedConversionCastOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    SmallVector<Type> convResTypes;
    if (typeConverter->convertTypes(op.getResultTypes(), convResTypes).failed())
      return failure();
 
    // Drop the cast if the operand and result types agree after type
    // conversion.
    if (convResTypes == adaptor.getOperands().getTypes()) {
      rewriter.replaceOp(op, adaptor.getOperands());
      return success();
    }
 
    rewriter.replaceOpWithNewOp<UnrealizedConversionCastOp>(
        op, convResTypes, adaptor.getOperands());
    return success();
  }
};
 
struct ShlOpConversion : public OpConversionPattern<ShlOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(ShlOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType = typeConverter->convertType(op.getResult().getType());
 
    // Comb shift operations require the same bit-width for value and amount
    Value amount =
        adjustIntegerWidth(rewriter, adaptor.getAmount(),
                           resultType.getIntOrFloatBitWidth(), op->getLoc());
    rewriter.replaceOpWithNewOp<comb::ShlOp>(op, resultType, adaptor.getValue(),
                                             amount, false);
    return success();
  }
};
 
struct ShrOpConversion : public OpConversionPattern<ShrOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(ShrOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType = typeConverter->convertType(op.getResult().getType());
 
    // Comb shift operations require the same bit-width for value and amount
    Value amount =
        adjustIntegerWidth(rewriter, adaptor.getAmount(),
                           resultType.getIntOrFloatBitWidth(), op->getLoc());
    rewriter.replaceOpWithNewOp<comb::ShrUOp>(
        op, resultType, adaptor.getValue(), amount, false);
    return success();
  }
};
 
struct PowUOpConversion : public OpConversionPattern<PowUOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(PowUOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType = typeConverter->convertType(op.getResult().getType());
 
    Location loc = op->getLoc();
 
    Value zeroVal = hw::ConstantOp::create(rewriter, loc, APInt(1, 0));
    // zero extend both LHS & RHS to ensure the unsigned integers are
    // interpreted correctly when calculating power
    auto lhs = comb::ConcatOp::create(rewriter, loc, zeroVal, adaptor.getLhs());
    auto rhs = comb::ConcatOp::create(rewriter, loc, zeroVal, adaptor.getRhs());
 
    // lower the exponentiation via MLIR's math dialect
    auto pow = mlir::math::IPowIOp::create(rewriter, loc, lhs, rhs);
 
    rewriter.replaceOpWithNewOp<comb::ExtractOp>(op, resultType, pow, 0);
    return success();
  }
};
 
struct PowSOpConversion : public OpConversionPattern<PowSOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(PowSOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType = typeConverter->convertType(op.getResult().getType());
 
    // utilize MLIR math dialect's math.ipowi to handle the exponentiation of
    // expression
    rewriter.replaceOpWithNewOp<mlir::math::IPowIOp>(
        op, resultType, adaptor.getLhs(), adaptor.getRhs());
    return success();
  }
};
 
struct Clog2BIOpConversion : public OpConversionPattern<Clog2BIOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(Clog2BIOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType = typeConverter->convertType(op.getResult().getType());
    Location loc = op.getLoc();
    unsigned width = resultType.getIntOrFloatBitWidth();
    Value value = adaptor.getValue();
 
    // Ceiling of log2 can be computed as follows:
    // if (x == 0) return 0;
    // else bitWidth(x) - countLeadingZeros(x - 1);
    Value zero = hw::ConstantOp::create(rewriter, loc, APInt(width, 0));
    Value one = hw::ConstantOp::create(rewriter, loc, APInt(width, 1));
    Value bitWidth = hw::ConstantOp::create(rewriter, loc, APInt(width, width));
 
    Value valueMinusOne = comb::SubOp::create(rewriter, loc, value, one, false);
    Value clz =
        mlir::math::CountLeadingZerosOp::create(rewriter, loc, valueMinusOne);
    Value bitLength = comb::SubOp::create(rewriter, loc, bitWidth, clz, false);
 
    Value isZero = comb::ICmpOp::create(rewriter, loc, comb::ICmpPredicate::eq,
                                        value, zero, false);
    rewriter.replaceOpWithNewOp<comb::MuxOp>(op, isZero, zero, bitLength,
                                             false);
    return success();
  }
};
 
struct AShrOpConversion : public OpConversionPattern<AShrOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(AShrOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType = typeConverter->convertType(op.getResult().getType());
 
    // Comb shift operations require the same bit-width for value and amount
    Value amount =
        adjustIntegerWidth(rewriter, adaptor.getAmount(),
                           resultType.getIntOrFloatBitWidth(), op->getLoc());
    rewriter.replaceOpWithNewOp<comb::ShrSOp>(
        op, resultType, adaptor.getValue(), amount, false);
    return success();
  }
};
 
struct ReadOpConversion : public OpConversionPattern<ReadOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(ReadOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    if (isa<llhd::NetType>(adaptor.getInput().getType()))
      rewriter.replaceOpWithNewOp<llhd::ProbeNetOp>(op, adaptor.getInput());
    else
      rewriter.replaceOpWithNewOp<llhd::ProbeOp>(op, adaptor.getInput());
    return success();
  }
};
 
struct AssignedVariableOpConversion
    : public OpConversionPattern<AssignedVariableOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(AssignedVariableOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<hw::WireOp>(op, adaptor.getInput(),
                                            adaptor.getNameAttr());
    return success();
  }
};
 
template <typename OpTy>
struct AssignOpConversion : public OpConversionPattern<OpTy> {
  using OpConversionPattern<OpTy>::OpConversionPattern;
  using OpAdaptor = typename OpTy::Adaptor;
 
  LogicalResult
  matchAndRewrite(OpTy op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    // Blocking and continuous assignments take effect immediately.
    if constexpr (std::is_same_v<OpTy, ContinuousAssignOp> ||
                  std::is_same_v<OpTy, BlockingAssignOp>) {
      if (isa<llhd::NetType>(adaptor.getDst().getType()))
        rewriter.replaceOpWithNewOp<llhd::AssignNetOp>(
            op, adaptor.getDst(), adaptor.getSrc(), Value{});
      else
        rewriter.replaceOpWithNewOp<llhd::AssignOp>(op, adaptor.getDst(),
                                                    adaptor.getSrc(), Value{});
      return success();
    } else {
      Value delay;
      if constexpr (std::is_same_v<OpTy, NonBlockingAssignOp>) {
        // Non-blocking assignments get a 0ns 1d delay.
        delay = llhd::ConstantTimeOp::create(
            rewriter, op->getLoc(),
            llhd::TimeAttr::get(op->getContext(), 0U, "ns", 1));
      } else {
        // Delayed assignments have a delay operand.
        delay = adaptor.getDelay();
      }
 
      rewriter.replaceOpWithNewOp<llhd::DriveOp>(
          op, adaptor.getDst(), adaptor.getSrc(), delay, Value{});
      return success();
    }
  }
};
 
struct ConditionalOpConversion : public OpConversionPattern<ConditionalOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(ConditionalOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    // TODO: This lowering is only correct if the condition is two-valued. If
    // the condition is X or Z, both branches of the conditional must be
    // evaluated and merged with the appropriate lookup table. See documentation
    // for `ConditionalOp`.
    auto type = typeConverter->convertType(op.getType());
 
    auto hasNoWriteEffect = [](Region &region) {
      auto result = region.walk([](Operation *operation) {
        if (auto memOp = dyn_cast<MemoryEffectOpInterface>(operation))
          if (!memOp.hasEffect<MemoryEffects::Write>() &&
              !memOp.hasEffect<MemoryEffects::Free>())
            return WalkResult::advance();
 
        if (operation->hasTrait<OpTrait::HasRecursiveMemoryEffects>())
          return WalkResult::advance();
 
        return WalkResult::interrupt();
      });
      return !result.wasInterrupted();
    };
 
    if (hasNoWriteEffect(op.getTrueRegion()) &&
        hasNoWriteEffect(op.getFalseRegion())) {
      Operation *trueTerm = op.getTrueRegion().front().getTerminator();
      Operation *falseTerm = op.getFalseRegion().front().getTerminator();
 
      rewriter.inlineBlockBefore(&op.getTrueRegion().front(), op);
      rewriter.inlineBlockBefore(&op.getFalseRegion().front(), op);
 
      Value convTrueVal = typeConverter->materializeTargetConversion(
          rewriter, op.getLoc(), type, trueTerm->getOperand(0));
      Value convFalseVal = typeConverter->materializeTargetConversion(
          rewriter, op.getLoc(), type, falseTerm->getOperand(0));
 
      rewriter.eraseOp(trueTerm);
      rewriter.eraseOp(falseTerm);
 
      rewriter.replaceOpWithNewOp<comb::MuxOp>(op, adaptor.getCondition(),
                                               convTrueVal, convFalseVal);
      return success();
    }
 
    auto ifOp =
        scf::IfOp::create(rewriter, op.getLoc(), type, adaptor.getCondition());
    rewriter.inlineRegionBefore(op.getTrueRegion(), ifOp.getThenRegion(),
                                ifOp.getThenRegion().end());
    rewriter.inlineRegionBefore(op.getFalseRegion(), ifOp.getElseRegion(),
                                ifOp.getElseRegion().end());
    rewriter.replaceOp(op, ifOp);
    return success();
  }
};
 
struct YieldOpConversion : public OpConversionPattern<YieldOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(YieldOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Operation *parent = op->getParentOp();
    if (isa<llhd::GlobalSignalOp>(parent))
      rewriter.replaceOpWithNewOp<llhd::YieldOp>(op, adaptor.getResult());
    else if (isa<scf::ExecuteRegionOp, scf::ForOp, scf::IfOp,
                 scf::IndexSwitchOp, scf::WhileOp>(parent))
      rewriter.replaceOpWithNewOp<scf::YieldOp>(op, adaptor.getResult());
    else
      return rewriter.notifyMatchFailure(
          op, "yield parent has not been converted to a legal region op yet");
    return success();
  }
};
 
template <typename SourceOp>
struct InPlaceOpConversion : public OpConversionPattern<SourceOp> {
  using OpConversionPattern<SourceOp>::OpConversionPattern;
  using OpAdaptor = typename SourceOp::Adaptor;
 
  LogicalResult
  matchAndRewrite(SourceOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.modifyOpInPlace(op,
                             [&]() { op->setOperands(adaptor.getOperands()); });
    return success();
  }
};
 
template <typename MooreOpTy, typename VerifOpTy>
struct AssertLikeOpConversion : public OpConversionPattern<MooreOpTy> {
  using OpConversionPattern<MooreOpTy>::OpConversionPattern;
  using OpAdaptor = typename MooreOpTy::Adaptor;
 
  LogicalResult
  matchAndRewrite(MooreOpTy op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    StringAttr label =
        op.getLabel().has_value()
            ? StringAttr::get(op->getContext(), op.getLabel().value())
            : StringAttr::get(op->getContext());
    rewriter.replaceOpWithNewOp<VerifOpTy>(op, adaptor.getCond(), mlir::Value(),
                                           label);
    return success();
  }
};
 
//===----------------------------------------------------------------------===//
// Format String Conversion
//===----------------------------------------------------------------------===//
 
struct FormatLiteralOpConversion : public OpConversionPattern<FormatLiteralOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(FormatLiteralOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<sim::FormatLiteralOp>(op, adaptor.getLiteral());
    return success();
  }
};
 
struct FormatStringOpConversion : public OpConversionPattern<FormatStringOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(FormatStringOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    char padChar =
        op.getPadding().value_or(IntPadding::Space) == IntPadding::Space ? 32
                                                                         : 48;
    IntegerAttr padCharAttr = rewriter.getI8IntegerAttr(padChar);
    auto widthAttr = adaptor.getWidthAttr();
 
    bool isLeftAligned =
        op.getAlignment().value_or(IntAlign::Right) == IntAlign::Left;
    BoolAttr isLeftAlignedAttr = rewriter.getBoolAttr(isLeftAligned);
 
    rewriter.replaceOpWithNewOp<sim::FormatStringOp>(
        op, adaptor.getString(), isLeftAlignedAttr, padCharAttr, widthAttr);
    return success();
  }
};
 
struct FormatConcatOpConversion : public OpConversionPattern<FormatConcatOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(FormatConcatOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<sim::FormatStringConcatOp>(op,
                                                           adaptor.getInputs());
    return success();
  }
};
 
struct FormatHierPathOpConversion
    : public OpConversionPattern<FormatHierPathOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(FormatHierPathOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<sim::FormatHierPathOp>(op,
                                                       adaptor.getUseEscapes());
    return success();
  }
};
 
struct FormatIntOpConversion : public OpConversionPattern<FormatIntOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(FormatIntOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
 
    char padChar = adaptor.getPadding() == IntPadding::Space ? 32 : 48;
    IntegerAttr padCharAttr = rewriter.getI8IntegerAttr(padChar);
    auto widthAttr = adaptor.getSpecifierWidthAttr();
 
    bool isLeftAligned = adaptor.getAlignment() == IntAlign::Left;
    BoolAttr isLeftAlignedAttr = rewriter.getBoolAttr(isLeftAligned);
 
    switch (op.getFormat()) {
    case IntFormat::Decimal:
      rewriter.replaceOpWithNewOp<sim::FormatDecOp>(
          op, adaptor.getValue(), isLeftAlignedAttr, padCharAttr, widthAttr,
          adaptor.getIsSignedAttr());
      return success();
    case IntFormat::Binary:
      rewriter.replaceOpWithNewOp<sim::FormatBinOp>(
          op, adaptor.getValue(), isLeftAlignedAttr, padCharAttr, widthAttr);
      return success();
    case IntFormat::Octal:
      rewriter.replaceOpWithNewOp<sim::FormatOctOp>(
          op, adaptor.getValue(), isLeftAlignedAttr, padCharAttr, widthAttr);
      return success();
    case IntFormat::HexLower:
      rewriter.replaceOpWithNewOp<sim::FormatHexOp>(
          op, adaptor.getValue(), rewriter.getBoolAttr(false),
          isLeftAlignedAttr, padCharAttr, widthAttr);
      return success();
    case IntFormat::HexUpper:
      rewriter.replaceOpWithNewOp<sim::FormatHexOp>(
          op, adaptor.getValue(), rewriter.getBoolAttr(true), isLeftAlignedAttr,
          padCharAttr, widthAttr);
      return success();
    }
    return rewriter.notifyMatchFailure(op, "unsupported int format");
  }
};
 
struct FormatRealOpConversion : public OpConversionPattern<FormatRealOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(FormatRealOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    auto fracDigitsAttr = adaptor.getFracDigitsAttr();
 
    auto fieldWidthAttr = adaptor.getFieldWidthAttr();
    bool isLeftAligned = adaptor.getAlignment() == IntAlign::Left;
    mlir::BoolAttr isLeftAlignedAttr = rewriter.getBoolAttr(isLeftAligned);
 
    switch (op.getFormat()) {
    case RealFormat::General:
      rewriter.replaceOpWithNewOp<sim::FormatGeneralOp>(
          op, adaptor.getValue(), isLeftAlignedAttr, fieldWidthAttr,
          fracDigitsAttr);
      return success();
    case RealFormat::Float:
      rewriter.replaceOpWithNewOp<sim::FormatFloatOp>(
          op, adaptor.getValue(), isLeftAlignedAttr, fieldWidthAttr,
          fracDigitsAttr);
      return success();
    case RealFormat::Exponential:
      rewriter.replaceOpWithNewOp<sim::FormatScientificOp>(
          op, adaptor.getValue(), isLeftAlignedAttr, fieldWidthAttr,
          fracDigitsAttr);
      return success();
    }
  }
};
 
struct FormatCharOpConversion
    : public OpConversionPattern<moore::FormatCharOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(moore::FormatCharOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<sim::FormatCharOp>(op, adaptor.getValue());
    return success();
  }
};
 
struct StringLenOpConversion : public OpConversionPattern<StringLenOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(StringLenOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<sim::StringLengthOp>(op, adaptor.getStr());
    return success();
  }
};
 
struct StringConcatOpConversion : public OpConversionPattern<StringConcatOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(StringConcatOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<sim::StringConcatOp>(op, adaptor.getInputs());
    return success();
  }
};
 
struct StringGetOpConversion : public OpConversionPattern<StringGetOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(StringGetOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<sim::StringGetOp>(op, adaptor.getStr(),
                                                  adaptor.getIndex());
    return success();
  }
};
 
struct QueueSizeBIOpConversion : public OpConversionPattern<QueueSizeBIOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(QueueSizeBIOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<sim::QueueSizeOp>(op, adaptor.getQueue());
    return success();
  }
};
 
struct DynQueueExtractOpConversion
    : public OpConversionPattern<DynQueueExtractOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(DynQueueExtractOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    bool isSingleElementExtract =
        op.getInput().getType().getElementType() == op.getResult().getType();
 
    if (isSingleElementExtract) {
      rewriter.replaceOpWithNewOp<sim::QueueGetOp>(op, adaptor.getInput(),
                                                   adaptor.getLowerIdx());
    } else {
      rewriter.replaceOpWithNewOp<sim::QueueSliceOp>(
          op, adaptor.getInput(), adaptor.getLowerIdx(), adaptor.getUpperIdx());
    }
 
    return success();
  }
};
 
// Given a reference `ref` to some Moore type, this function emits a
// `ProbeOp` to read the contained value, then passes it to the function `func`.
// It finally emits an `AssignOp` to write the result of the function back to
// the referenced signal.
//
// This is useful for converting impure operations (such as the Moore ops for
// manipulating queues) into pure operations. (Which do not mutate the source
// value, instead returning a modified value.)
static void probeRefAndAssignResult(OpBuilder &builder, Location loc, Value ref,
                                    const std::function<Value(Value)> &func) {
 
  Value v = llhd::ProbeOp::create(builder, loc, ref);
 
  llhd::AssignOp::create(builder, loc, ref, func(v), Value{});
}
 
struct QueuePushBackOpConversion : public OpConversionPattern<QueuePushBackOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(QueuePushBackOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    probeRefAndAssignResult(
        rewriter, op.getLoc(), adaptor.getQueue(), [&](Value queue) {
          return sim::QueuePushBackOp::create(rewriter, op->getLoc(), queue,
                                              adaptor.getElement());
        });
 
    rewriter.eraseOp(op);
    return success();
  }
};
 
struct QueuePushFrontOpConversion
    : public OpConversionPattern<QueuePushFrontOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(QueuePushFrontOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
 
    probeRefAndAssignResult(
        rewriter, op.getLoc(), adaptor.getQueue(), [&](Value queue) {
          return sim::QueuePushFrontOp::create(rewriter, op->getLoc(), queue,
                                               adaptor.getElement());
        });
 
    rewriter.eraseOp(op);
    return success();
  }
};
 
struct QueuePopBackOpConversion : public OpConversionPattern<QueuePopBackOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(QueuePopBackOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Value popped;
    probeRefAndAssignResult(
        rewriter, op.getLoc(), adaptor.getQueue(), [&](Value queue) {
          auto popBack =
              sim::QueuePopBackOp::create(rewriter, op->getLoc(), queue);
          popped = popBack.getPopped();
          return popBack.getOutQueue();
        });
    rewriter.replaceOp(op, popped);
 
    return success();
  }
};
 
struct QueuePopFrontOpConversion : public OpConversionPattern<QueuePopFrontOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(QueuePopFrontOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Value popped;
    probeRefAndAssignResult(
        rewriter, op.getLoc(), adaptor.getQueue(), [&](Value queue) {
          auto popFront =
              sim::QueuePopFrontOp::create(rewriter, op->getLoc(), queue);
          popped = popFront.getPopped();
          return popFront.getOutQueue();
        });
    rewriter.replaceOp(op, popped);
 
    return success();
  }
};
 
struct QueueClearOpConversion : public OpConversionPattern<QueueClearOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(QueueClearOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    auto refType = cast<llhd::RefType>(adaptor.getQueue().getType());
    auto queueType = refType.getNestedType();
    Value emptyQueue =
        sim::QueueEmptyOp::create(rewriter, op->getLoc(), queueType);
 
    // Replace with an assignment to an empty queue
    llhd::AssignOp::create(rewriter, op.getLoc(), adaptor.getQueue(),
                           emptyQueue, Value{});
 
    rewriter.eraseOp(op);
    return success();
  }
};
 
struct QueueInsertOpConversion : public OpConversionPattern<QueueInsertOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(QueueInsertOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    probeRefAndAssignResult(
        rewriter, op.getLoc(), adaptor.getQueue(), [&](Value queue) {
          auto insert =
              sim::QueueInsertOp::create(rewriter, op->getLoc(), queue,
                                         adaptor.getIndex(), adaptor.getItem());
 
          return insert.getOutQueue();
        });
    rewriter.eraseOp(op);
 
    return success();
  }
};
 
struct QueueDeleteOpConversion : public OpConversionPattern<QueueDeleteOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(QueueDeleteOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    probeRefAndAssignResult(
        rewriter, op.getLoc(), adaptor.getQueue(), [&](Value queue) {
          auto delOp = sim::QueueDeleteOp::create(rewriter, op->getLoc(), queue,
                                                  adaptor.getIndex());
 
          return delOp.getOutQueue();
        });
    rewriter.eraseOp(op);
 
    return success();
  };
};
 
struct QueueResizeOpConversion : public OpConversionPattern<QueueResizeOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(QueueResizeOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
 
    rewriter.replaceOpWithNewOp<sim::QueueResizeOp>(
        op, getTypeConverter()->convertType(op.getResult().getType()),
        adaptor.getInput());
    return success();
  }
};
 
struct QueueSetOpConversion : public OpConversionPattern<QueueSetOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(QueueSetOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    probeRefAndAssignResult(
        rewriter, op->getLoc(), adaptor.getQueue(), [&](Value queue) {
          auto setOp =
              sim::QueueSetOp::create(rewriter, op.getLoc(), queue,
                                      adaptor.getIndex(), adaptor.getItem());
          return setOp.getOutQueue();
        });
    rewriter.eraseOp(op);
    return success();
  }
};
 
// SystemVerilog unpacked array elements may be of any type. Bitcast handles
// statically-sized elements; reals bypass it so NaN/signed zero still compare
// correctly. Everything else recurses or dispatches to the matching comparison
// op.
static Value buildUArrayElementEq(ConversionPatternRewriter &rewriter,
                                  Location loc, Value lhs, Value rhs, Type type,
                                  UArrayCmpPredicate pred) {
  bool isEq = pred == UArrayCmpPredicate::eq;
 
  if (isa<mlir::FloatType>(type))
    return arith::CmpFOp::create(
        rewriter, loc,
        isEq ? arith::CmpFPredicate::OEQ : arith::CmpFPredicate::UNE, lhs, rhs);
 
  if (int64_t width = hw::getBitWidth(type); width != -1) {
    auto intTy = rewriter.getIntegerType(width);
    Value lhsInt = hw::BitcastOp::create(rewriter, loc, intTy, lhs);
    Value rhsInt = hw::BitcastOp::create(rewriter, loc, intTy, rhs);
    return comb::ICmpOp::create(rewriter, loc,
                                isEq ? ICmpPredicate::eq : ICmpPredicate::ne,
                                lhsInt, rhsInt);
  }
 
  if (isa<sim::DynamicStringType>(type))
    return sim::StringCmpOp::create(rewriter, loc,
                                    isEq ? sim::StringCmpPredicate::eq
                                         : sim::StringCmpPredicate::ne,
                                    lhs, rhs);
 
  if (isa<sim::QueueType>(type)) {
    auto pred = sim::UArrayCmpPredicateAttr::get(
        rewriter.getContext(),
        isEq ? sim::UArrayCmpPredicate::eq : sim::UArrayCmpPredicate::ne);
    return sim::QueueCmpOp::create(rewriter, loc, pred, lhs, rhs);
  }
 
  if (isa<sim::AssocArrayType>(type)) {
    auto pred = sim::UArrayCmpPredicateAttr::get(
        rewriter.getContext(),
        isEq ? sim::UArrayCmpPredicate::eq : sim::UArrayCmpPredicate::ne);
    return sim::AssocArrayCmpOp::create(rewriter, loc, pred, lhs, rhs);
  }
 
  auto arrayTy = dyn_cast<hw::ArrayType>(type);
  if (!arrayTy)
    return {};
 
  unsigned size = arrayTy.getNumElements();
  if (size == 0)
    return hw::ConstantOp::create(rewriter, loc, APInt(1, isEq ? 1 : 0));
 
  unsigned idxWidth = size == 1 ? 1 : llvm::Log2_64_Ceil(size);
  auto idxTy = rewriter.getIntegerType(idxWidth);
 
  SmallVector<Value> elemEqs;
  elemEqs.reserve(size);
  for (unsigned i = 0; i < size; ++i) {
    Value idx = hw::ConstantOp::create(rewriter, loc, idxTy, i);
    Value lhsElem = hw::ArrayGetOp::create(rewriter, loc, lhs, idx);
    Value rhsElem = hw::ArrayGetOp::create(rewriter, loc, rhs, idx);
    Value elemEq = buildUArrayElementEq(rewriter, loc, lhsElem, rhsElem,
                                        arrayTy.getElementType(), pred);
    if (!elemEq)
      return {};
    elemEqs.push_back(elemEq);
  }
 
  return (isEq ? comb::AndOp::create(rewriter, loc, elemEqs, /*twoState=*/true)
                     .getResult()
               : comb::OrOp::create(rewriter, loc, elemEqs, /*twoState=*/true)
                     .getResult());
}
 
struct QueueCmpOpConversion : public OpConversionPattern<QueueCmpOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(QueueCmpOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    // Per IEEE 1800-2017 7.4.2, queues are themselves a form of unpacked array,
    // so this reuses the same element-comparison dispatch as
    // UArrayCmpOpConversion (see buildUArrayElementEq), for a QueueType operand
    // it resolves directly to `sim.queue.cmp`.
    Value lhs = adaptor.getLhs();
    Value result =
        buildUArrayElementEq(rewriter, op.getLoc(), lhs, adaptor.getRhs(),
                             lhs.getType(), op.getPredicate());
    rewriter.replaceOp(op, result);
    return success();
  }
};
 
struct QueueFromUnpackedArrayOpConversion
    : public OpConversionPattern<QueueFromUnpackedArrayOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(QueueFromUnpackedArrayOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<sim::QueueFromArrayOp>(
        op, getTypeConverter()->convertType(op.getResult().getType()),
        adaptor.getInput());
    return success();
  }
};
 
struct QueueConcatOpConversion : public OpConversionPattern<QueueConcatOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(QueueConcatOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<sim::QueueConcatOp>(
        op, getTypeConverter()->convertType(op.getResult().getType()),
        adaptor.getInputs());
    return success();
  }
};
 
struct AssocArrayExtractOpConversion
    : public OpConversionPattern<AssocArrayExtractOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(AssocArrayExtractOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Type resultType = getTypeConverter()->convertType(op.getResult().getType());
    if (!resultType)
      return failure();
 
    Value zero = createZeroValue(resultType, op.getLoc(), rewriter);
    if (!zero)
      return failure();
    Value raw =
        sim::AssocArrayGetOp::create(rewriter, op.getLoc(), resultType,
                                     adaptor.getInput(), adaptor.getIndex());
    Value exists = sim::AssocArrayExistsOp::create(
        rewriter, op.getLoc(), adaptor.getInput(), adaptor.getIndex());
    Value zeroI32 = hw::ConstantOp::create(rewriter, op.getLoc(), APInt(32, 0));
    Value existsBit = comb::ICmpOp::create(
        rewriter, op.getLoc(), comb::ICmpPredicate::ne, exists, zeroI32, false);
    rewriter.replaceOpWithNewOp<comb::MuxOp>(op, existsBit, raw, zero, false);
    return success();
  }
};
 
struct UArrayCmpOpConversion : public OpConversionPattern<UArrayCmpOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(UArrayCmpOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Value lhs = adaptor.getLhs();
    Value rhs = adaptor.getRhs();
    auto pred = op.getPredicate();
    Value eq = buildUArrayElementEq(rewriter, op.getLoc(), lhs, rhs,
                                    lhs.getType(), pred);
 
    if (!eq)
      return rewriter.notifyMatchFailure(
          op, "unpacked array element type does not support comparison");
 
    rewriter.replaceOp(op, eq);
    return success();
  }
};
 
struct AssocArraySetOpConversion : public OpConversionPattern<AssocArraySetOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(AssocArraySetOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    probeRefAndAssignResult(
        rewriter, op.getLoc(), adaptor.getAssocArray(), [&](Value array) {
          return sim::AssocArraySetOp::create(rewriter, op.getLoc(), array,
                                              adaptor.getIndex(),
                                              adaptor.getValue())
              .getOutArray();
        });
    rewriter.eraseOp(op);
    return success();
  }
};
 
struct AssocArrayDeleteOpConversion
    : public OpConversionPattern<AssocArrayDeleteOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(AssocArrayDeleteOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    probeRefAndAssignResult(
        rewriter, op.getLoc(), adaptor.getAssocArray(), [&](Value array) {
          return sim::AssocArrayDeleteOp::create(rewriter, op.getLoc(), array,
                                                 adaptor.getIndex())
              .getOutArray();
        });
    rewriter.eraseOp(op);
    return success();
  }
};
 
struct AssocArrayClearOpConversion
    : public OpConversionPattern<AssocArrayClearOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(AssocArrayClearOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    auto refType = cast<llhd::RefType>(adaptor.getAssocArray().getType());
    Value emptyArray = sim::AssocArrayEmptyOp::create(rewriter, op->getLoc(),
                                                      refType.getNestedType());
    llhd::AssignOp::create(rewriter, op.getLoc(), adaptor.getAssocArray(),
                           emptyArray, Value{});
    rewriter.eraseOp(op);
    return success();
  }
};
 
struct AssocArraySizeOpConversion
    : public OpConversionPattern<AssocArraySizeOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(AssocArraySizeOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Value array =
        llhd::ProbeOp::create(rewriter, op.getLoc(), adaptor.getAssocArray());
    rewriter.replaceOpWithNewOp<sim::AssocArraySizeOp>(op, array);
    return success();
  }
};
 
struct AssocArrayExistsOpConversion
    : public OpConversionPattern<AssocArrayExistsOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(AssocArrayExistsOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Value array =
        llhd::ProbeOp::create(rewriter, op.getLoc(), adaptor.getAssocArray());
    rewriter.replaceOpWithNewOp<sim::AssocArrayExistsOp>(op, array,
                                                         adaptor.getIndex());
    return success();
  }
};
 
template <typename MooreOpTy, typename SimOpTy>
struct AssocArrayEndpointOpConversion : public OpConversionPattern<MooreOpTy> {
  using OpConversionPattern<MooreOpTy>::OpConversionPattern;
  using OpAdaptor = typename MooreOpTy::Adaptor;
  LogicalResult
  matchAndRewrite(MooreOpTy op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Value array =
        llhd::ProbeOp::create(rewriter, op.getLoc(), adaptor.getAssocArray());
    auto endpointOp = SimOpTy::create(rewriter, op.getLoc(), array);
    Value curIndex =
        llhd::ProbeOp::create(rewriter, op.getLoc(), adaptor.getIndex());
    Value zero = hw::ConstantOp::create(rewriter, op.getLoc(), APInt(32, 0));
    Value foundBit =
        comb::ICmpOp::create(rewriter, op.getLoc(), comb::ICmpPredicate::ne,
                             endpointOp->getResult(0), zero, false);
    Value newIndex =
        comb::MuxOp::create(rewriter, op.getLoc(), foundBit,
                            endpointOp->getResult(1), curIndex, false);
    llhd::AssignOp::create(rewriter, op.getLoc(), adaptor.getIndex(), newIndex,
                           Value{});
    rewriter.replaceOp(op, endpointOp->getResult(0));
    return success();
  }
};
 
template <typename MooreOpTy, typename SimOpTy>
struct AssocArrayStepOpConversion : public OpConversionPattern<MooreOpTy> {
  using OpConversionPattern<MooreOpTy>::OpConversionPattern;
  using OpAdaptor = typename MooreOpTy::Adaptor;
  LogicalResult
  matchAndRewrite(MooreOpTy op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Value array =
        llhd::ProbeOp::create(rewriter, op.getLoc(), adaptor.getAssocArray());
    Value curIndex =
        llhd::ProbeOp::create(rewriter, op.getLoc(), adaptor.getIndex());
    auto stepOp = SimOpTy::create(rewriter, op.getLoc(), array, curIndex);
    llhd::AssignOp::create(rewriter, op.getLoc(), adaptor.getIndex(),
                           stepOp->getResult(1), Value{});
    rewriter.replaceOp(op, stepOp->getResult(0));
    return success();
  }
};
 
using AssocArrayFirstOpConversion =
    AssocArrayEndpointOpConversion<AssocArrayFirstOp, sim::AssocArrayFirstOp>;
using AssocArrayLastOpConversion =
    AssocArrayEndpointOpConversion<AssocArrayLastOp, sim::AssocArrayLastOp>;
using AssocArrayNextOpConversion =
    AssocArrayStepOpConversion<AssocArrayNextOp, sim::AssocArrayNextOp>;
using AssocArrayPrevOpConversion =
    AssocArrayStepOpConversion<AssocArrayPrevOp, sim::AssocArrayPrevOp>;
 
struct DisplayBIOpConversion : public OpConversionPattern<DisplayBIOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(DisplayBIOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<sim::PrintFormattedProcOp>(
        op, adaptor.getMessage());
    return success();
  }
};
 
struct FDisplayBIOpConversion : public OpConversionPattern<FDisplayBIOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(FDisplayBIOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    auto stream = sim::SVChannelToOutputStreamOp::create(rewriter, op.getLoc(),
                                                         adaptor.getFd());
    rewriter.replaceOpWithNewOp<sim::PrintFormattedProcOp>(
        op, adaptor.getMessage(), stream.getStream());
    return success();
  }
};
 
struct FOpenBIOpConversion : public OpConversionPattern<FOpenBIOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(FOpenBIOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    sim::SVFOpenModeAttr simMode;
    if (auto modeAttr = op.getModeAttr()) {
      auto mapMode = [](moore::FOpenMode m) -> sim::SVFOpenMode {
        switch (m) {
        case moore::FOpenMode::Read:
          return sim::SVFOpenMode::Read;
        case moore::FOpenMode::Write:
          return sim::SVFOpenMode::Write;
        case moore::FOpenMode::Append:
          return sim::SVFOpenMode::Append;
        case moore::FOpenMode::ReadUpdate:
          return sim::SVFOpenMode::ReadUpdate;
        case moore::FOpenMode::WriteUpdate:
          return sim::SVFOpenMode::WriteUpdate;
        case moore::FOpenMode::AppendUpdate:
          return sim::SVFOpenMode::AppendUpdate;
        }
        llvm_unreachable("unknown FOpenMode");
      };
      simMode = sim::SVFOpenModeAttr::get(op.getContext(),
                                          mapMode(modeAttr.getValue()));
    }
    rewriter.replaceOpWithNewOp<sim::SVFOpenOp>(op, adaptor.getFilename(),
                                                simMode);
    return success();
  }
};
 
struct PlusArgsTestBIOpConversion
    : public OpConversionPattern<PlusArgsTestBIOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(PlusArgsTestBIOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<sim::PlusArgsTestOp>(op, rewriter.getI1Type(),
                                                     op.getFormatStringAttr());
    return success();
  }
};
 
struct PlusArgsValueBIOpConversion
    : public OpConversionPattern<PlusArgsValueBIOp> {
  using OpConversionPattern::OpConversionPattern;
  LogicalResult
  matchAndRewrite(PlusArgsValueBIOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    auto resultType = typeConverter->convertType(op.getResult().getType());
    if (!resultType)
      return rewriter.notifyMatchFailure(op, "unsupported result type");
    rewriter.replaceOpWithNewOp<sim::PlusArgsValueOp>(
        op, rewriter.getI1Type(), resultType, op.getFormatStringAttr());
    return success();
  }
};
 
struct FCloseBIOpConversion : public OpConversionPattern<FCloseBIOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(FCloseBIOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<sim::SVFCloseOp>(op, adaptor.getFd());
    return success();
  }
};
 
struct FFlushBIOpConversion : public OpConversionPattern<FFlushBIOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(FFlushBIOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    if (!adaptor.getFd()) {
      rewriter.replaceOpWithNewOp<sim::SVFFlushAllOp>(op);
    } else {
      auto stream = sim::SVChannelToOutputStreamOp::create(
          rewriter, op.getLoc(), adaptor.getFd());
      rewriter.replaceOpWithNewOp<sim::FlushOp>(op, stream);
    }
    return success();
  }
};
 
struct StringCmpOpConversion : public OpConversionPattern<StringCmpOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(StringCmpOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    sim::StringCmpPredicate pred;
    switch (op.getPredicate()) {
    case moore::StringCmpPredicate::eq:
      pred = sim::StringCmpPredicate::eq;
      break;
    case moore::StringCmpPredicate::ne:
      pred = sim::StringCmpPredicate::ne;
      break;
    case moore::StringCmpPredicate::lt:
      pred = sim::StringCmpPredicate::lt;
      break;
    case moore::StringCmpPredicate::le:
      pred = sim::StringCmpPredicate::le;
      break;
    case moore::StringCmpPredicate::gt:
      pred = sim::StringCmpPredicate::gt;
      break;
    case moore::StringCmpPredicate::ge:
      pred = sim::StringCmpPredicate::ge;
      break;
    }
    rewriter.replaceOpWithNewOp<sim::StringCmpOp>(op, pred, adaptor.getLhs(),
                                                  adaptor.getRhs());
    return success();
  }
};
 
struct StringCompareOpConversion : public OpConversionPattern<StringCompareOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(StringCompareOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<sim::StringCompareOp>(op, adaptor.getLhs(),
                                                      adaptor.getRhs());
    return success();
  }
};
 
struct StringICompareOpConversion
    : public OpConversionPattern<StringICompareOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(StringICompareOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Location loc = op.getLoc();
    Value lowerLhs =
        sim::StringToLowerOp::create(rewriter, loc, adaptor.getLhs());
    Value lowerRhs =
        sim::StringToLowerOp::create(rewriter, loc, adaptor.getRhs());
    rewriter.replaceOpWithNewOp<sim::StringCompareOp>(op, lowerLhs, lowerRhs);
    return success();
  }
};
 
struct StringToLowerOpConversion : public OpConversionPattern<StringToLowerOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(StringToLowerOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<sim::StringToLowerOp>(op, adaptor.getStr());
    return success();
  }
};
 
struct StringToUpperOpConversion : public OpConversionPattern<StringToUpperOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(StringToUpperOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    rewriter.replaceOpWithNewOp<sim::StringToUpperOp>(op, adaptor.getStr());
    return success();
  }
};
 
struct StringSubstrOpConversion : public OpConversionPattern<StringSubstrOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(StringSubstrOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Location loc = op.getLoc();
    Value str = adaptor.getStr();
    Value start = adaptor.getStart();
    Value end = adaptor.getEnd();
 
    Value zero = createZeroValue(rewriter.getI32Type(), loc, rewriter);
    Value emptyString = createZeroValue(str.getType(), loc, rewriter);
    Value len = sim::StringLengthOp::create(rewriter, loc, str);
 
    Value startGeZero = arith::CmpIOp::create(
        rewriter, loc, arith::CmpIPredicate::sge, start, zero);
    Value endGeStart = arith::CmpIOp::create(
        rewriter, loc, arith::CmpIPredicate::sge, end, start);
    Value endLeLen = arith::CmpIOp::create(rewriter, loc,
                                           arith::CmpIPredicate::sle, end, len);
 
    Value isWithinBounds = arith::AndIOp::create(
        rewriter, loc, endLeLen,
        arith::AndIOp::create(rewriter, loc, startGeZero, endGeStart));
 
    Value subStr = sim::StringSubstrOp::create(
        rewriter, loc, str, adaptor.getStart(), adaptor.getEnd());
 
    rewriter.replaceOpWithNewOp<arith::SelectOp>(op, isWithinBounds, subStr,
                                                 emptyString);
 
    return success();
  }
};
 
struct ReadMemBIOpConversion : public OpConversionPattern<ReadMemBIOp> {
  using OpConversionPattern::OpConversionPattern;
 
  LogicalResult
  matchAndRewrite(ReadMemBIOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    auto loc = op.getLoc();
    Value memory = llhd::ProbeOp::create(rewriter, loc, adaptor.getDest());
    Value loaded = sim::SVReadMemOp::create(
        rewriter, loc, memory.getType(), adaptor.getFilename(), memory,
        rewriter.getBoolAttr(op.getBase() == MemBase::Binary),
        adaptor.getStartAddr(), adaptor.getFinishAddr(), adaptor.getSliceLeft(),
        adaptor.getSliceRight(), op.getDimLowsAttr(), op.getDimDescendingAttr(),
        op.getEnumValuesAttr());
    rewriter.replaceOpWithNewOp<llhd::AssignOp>(op, adaptor.getDest(), loaded,
                                                Value{});
    return success();
  }
};
 
} // namespace
 
//===----------------------------------------------------------------------===//
// Simulation Control Conversion
//===----------------------------------------------------------------------===//
 
// moore.builtin.stop -> sim.pause
static LogicalResult convert(StopBIOp op, StopBIOp::Adaptor adaptor,
                             ConversionPatternRewriter &rewriter) {
  rewriter.replaceOpWithNewOp<sim::PauseOp>(op, /*verbose=*/false);
  return success();
}
 
// moore.builtin.finish -> sim.terminate
static LogicalResult convert(FinishBIOp op, FinishBIOp::Adaptor adaptor,
                             ConversionPatternRewriter &rewriter) {
  rewriter.replaceOpWithNewOp<sim::TerminateOp>(op, op.getExitCode() == 0,
                                                /*verbose=*/false);
  return success();
}
 
// moore.builtin.severity -> sim.proc.print
static LogicalResult convert(SeverityBIOp op, SeverityBIOp::Adaptor adaptor,
                             ConversionPatternRewriter &rewriter) {
 
  std::string severityString;
 
  switch (op.getSeverity()) {
  case (Severity::Fatal):
    severityString = "Fatal: ";
    break;
  case (Severity::Error):
    severityString = "Error: ";
    break;
  case (Severity::Warning):
    severityString = "Warning: ";
    break;
  case (Severity::Info):
    severityString = "Info: ";
    break;
  }
 
  auto prefix =
      sim::FormatLiteralOp::create(rewriter, op.getLoc(), severityString);
  auto message = sim::FormatStringConcatOp::create(
      rewriter, op.getLoc(), ValueRange{prefix, adaptor.getMessage()});
  rewriter.replaceOpWithNewOp<sim::PrintFormattedProcOp>(op, message);
  return success();
}
 
//===----------------------------------------------------------------------===//
// Random Builtin Conversion
//===----------------------------------------------------------------------===//
 
/// moore.builtin.urandom_range -> call @__circt_urandom_range(i32, i32, ptr)
///
/// The seed pointer is null when no seed is provided. When a seed ref is
/// present, we probe the current value into an alloca before the call, and
/// drive the (potentially mutated) value back after.
static LogicalResult convert(UrandomRangeBIOp op,
                             UrandomRangeBIOp::Adaptor adaptor,
                             ConversionPatternRewriter &rewriter,
                             FunctionCache &funcCache) {
  auto loc = op.getLoc();
  auto i32Ty = rewriter.getI32Type();
  auto ptrTy = LLVM::LLVMPointerType::get(rewriter.getContext());
  auto fn = funcCache.getOrCreate(rewriter, "__circt_urandom_range",
                                  {i32Ty, i32Ty, ptrTy}, {i32Ty});
 
  Value seedPtr;
  if (auto seedRef = adaptor.getSeed()) {
    // Allocate a temporary, probe the current seed value into it.
    auto one = hw::ConstantOp::create(rewriter, loc, i32Ty, 1);
    seedPtr = LLVM::AllocaOp::create(rewriter, loc, ptrTy, i32Ty, one);
    auto seedVal = llhd::ProbeOp::create(rewriter, loc, seedRef);
    LLVM::StoreOp::create(rewriter, loc, seedVal, seedPtr);
  } else {
    seedPtr = LLVM::ZeroOp::create(rewriter, loc, ptrTy);
  }
 
  auto call = func::CallOp::create(
      rewriter, loc, fn,
      ValueRange{adaptor.getMinval(), adaptor.getMaxval(), seedPtr});
 
  // Assign the potentially mutated seed back.
  if (adaptor.getSeed()) {
    auto newSeed = LLVM::LoadOp::create(rewriter, loc, i32Ty, seedPtr);
    llhd::AssignOp::create(rewriter, loc, adaptor.getSeed(), newSeed, Value{});
  }
 
  rewriter.replaceOp(op, call.getResult(0));
  return success();
}
 
// moore.builtin.finish_message
static LogicalResult convert(FinishMessageBIOp op,
                             FinishMessageBIOp::Adaptor adaptor,
                             ConversionPatternRewriter &rewriter) {
  // We don't support printing termination/pause messages yet.
  rewriter.eraseOp(op);
  return success();
}
 
//===----------------------------------------------------------------------===//
// Timing Control Conversion
//===----------------------------------------------------------------------===//
 
// moore.builtin.time
static LogicalResult convert(TimeBIOp op, TimeBIOp::Adaptor adaptor,
                             ConversionPatternRewriter &rewriter) {
  rewriter.replaceOpWithNewOp<llhd::CurrentTimeOp>(op);
  return success();
}
 
// moore.logic_to_time
static LogicalResult convert(LogicToTimeOp op, LogicToTimeOp::Adaptor adaptor,
                             ConversionPatternRewriter &rewriter) {
  rewriter.replaceOpWithNewOp<llhd::IntToTimeOp>(op, adaptor.getInput());
  return success();
}
 
// moore.time_to_logic
static LogicalResult convert(TimeToLogicOp op, TimeToLogicOp::Adaptor adaptor,
                             ConversionPatternRewriter &rewriter) {
  rewriter.replaceOpWithNewOp<llhd::TimeToIntOp>(op, adaptor.getInput());
  return success();
}
 
//===----------------------------------------------------------------------===//
// Conversion Infrastructure
//===----------------------------------------------------------------------===//
 
static void populateLegality(ConversionTarget &target,
                             const TypeConverter &converter) {
  target.addIllegalDialect<MooreDialect>();
  target.addLegalDialect<comb::CombDialect>();
  target.addLegalDialect<hw::HWDialect>();
  target.addLegalDialect<seq::SeqDialect>();
  target.addLegalDialect<llhd::LLHDDialect>();
  target.addLegalDialect<ltl::LTLDialect>();
  target.addLegalDialect<mlir::BuiltinDialect>();
  target.addLegalDialect<mlir::math::MathDialect>();
  target.addLegalDialect<sim::SimDialect>();
  target.addLegalDialect<mlir::LLVM::LLVMDialect>();
  target.addLegalDialect<mlir::ub::UBDialect>();
  target.addLegalDialect<verif::VerifDialect>();
  target.addLegalDialect<arith::ArithDialect>();
 
  target.addLegalOp<debug::ScopeOp>();
 
  target.addDynamicallyLegalOp<scf::YieldOp, func::CallOp, func::ReturnOp,
                               UnrealizedConversionCastOp, hw::OutputOp,
                               hw::InstanceOp, debug::ArrayOp, debug::StructOp,
                               debug::VariableOp, arith::SelectOp>(
      [&](Operation *op) { return converter.isLegal(op); });
 
  target.addDynamicallyLegalOp<scf::IfOp, scf::ForOp, scf::ExecuteRegionOp,
                               scf::WhileOp, scf::ForallOp>([&](Operation *op) {
    return converter.isLegal(op) && !op->getParentOfType<llhd::ProcessOp>();
  });
 
  target.addDynamicallyLegalOp<func::FuncOp>([&](func::FuncOp op) {
    return converter.isSignatureLegal(op.getFunctionType());
  });
 
  target.addDynamicallyLegalOp<hw::HWModuleOp>([&](hw::HWModuleOp op) {
    return converter.isSignatureLegal(op.getModuleType().getFuncType()) &&
           converter.isLegal(&op.getBody());
  });
}
 
static void populateTypeConversion(TypeConverter &typeConverter) {
  typeConverter.addConversion([&](IntType type) {
    return IntegerType::get(type.getContext(), type.getWidth());
  });
 
  typeConverter.addConversion([&](RealType type) -> mlir::Type {
    MLIRContext *ctx = type.getContext();
    switch (type.getWidth()) {
    case moore::RealWidth::f32:
      return mlir::Float32Type::get(ctx);
    case moore::RealWidth::f64:
      return mlir::Float64Type::get(ctx);
    }
  });
 
  typeConverter.addConversion(
      [&](TimeType type) { return llhd::TimeType::get(type.getContext()); });
 
  typeConverter.addConversion([&](FormatStringType type) {
    return sim::FormatStringType::get(type.getContext());
  });
 
  typeConverter.addConversion([&](StringType type) {
    return sim::DynamicStringType::get(type.getContext());
  });
 
  typeConverter.addConversion([&](QueueType type) {
    return sim::QueueType::get(type.getContext(),
                               typeConverter.convertType(type.getElementType()),
                               type.getBound());
  });
 
  typeConverter.addConversion([&](sim::QueueType type) -> std::optional<Type> {
    if (auto elementType = typeConverter.convertType(type.getElementType()))
      return sim::QueueType::get(type.getContext(), elementType,
                                 type.getBound());
    return {};
  });
 
  typeConverter.addConversion([&](ArrayType type) -> std::optional<Type> {
    if (auto elementType = typeConverter.convertType(type.getElementType()))
      return hw::ArrayType::get(elementType, type.getSize());
    return {};
  });
 
  typeConverter.addConversion([&](AssocArrayType type) -> std::optional<Type> {
    auto elementType = typeConverter.convertType(type.getElementType());
    auto indexType = typeConverter.convertType(type.getIndexType());
    if (!elementType || !indexType)
      return {};
    return sim::AssocArrayType::get(type.getContext(), elementType, indexType);
  });
 
  // FIXME: Unpacked arrays support more element types than their packed
  // variants, and as such, mapping them to hw::Array is somewhat naive. See
  // also the analogous note below concerning unpacked struct type conversion.
  typeConverter.addConversion(
      [&](UnpackedArrayType type) -> std::optional<Type> {
        if (auto elementType = typeConverter.convertType(type.getElementType()))
          return hw::ArrayType::get(elementType, type.getSize());
        return {};
      });
 
  typeConverter.addConversion([&](OpenArrayType type) -> std::optional<Type> {
    return LLVM::LLVMPointerType::get(type.getContext());
  });
 
  typeConverter.addConversion(
      [&](OpenUnpackedArrayType type) -> std::optional<Type> {
        return LLVM::LLVMPointerType::get(type.getContext());
      });
 
  typeConverter.addConversion([&](StructType type) -> std::optional<Type> {
    SmallVector<hw::StructType::FieldInfo> fields;
    for (auto field : type.getMembers()) {
      hw::StructType::FieldInfo info;
      info.type = typeConverter.convertType(field.type);
      if (!info.type)
        return {};
      info.name = field.name;
      fields.push_back(info);
    }
    return hw::StructType::get(type.getContext(), fields);
  });
 
  // FIXME: Mapping unpacked struct type to struct type in hw dialect may be a
  // plain solution. The packed and unpacked data structures have some
  // differences though they look similarily. The packed data structure is
  // contiguous in memory but another is opposite. The differences will affect
  // data layout and granularity of event tracking in simulation.
  typeConverter.addConversion(
      [&](UnpackedStructType type) -> std::optional<Type> {
        SmallVector<hw::StructType::FieldInfo> fields;
        for (auto field : type.getMembers()) {
          hw::StructType::FieldInfo info;
          info.type = typeConverter.convertType(field.type);
          if (!info.type)
            return {};
          info.name = field.name;
          fields.push_back(info);
        }
        return hw::StructType::get(type.getContext(), fields);
      });
 
  // UnionType -> hw::UnionType
  typeConverter.addConversion([&](UnionType type) -> std::optional<Type> {
    SmallVector<hw::UnionType::FieldInfo> fields;
    for (auto field : type.getMembers()) {
      hw::UnionType::FieldInfo info;
      info.type = typeConverter.convertType(field.type);
      if (!info.type)
        return {};
      info.name = field.name;
      info.offset = 0; // packed union, all fields start at bit 0
      fields.push_back(info);
    }
    auto result = hw::UnionType::get(type.getContext(), fields);
    return result;
  });
 
  // UnpackedUnionType -> hw::UnionType
  typeConverter.addConversion(
      [&](UnpackedUnionType type) -> std::optional<Type> {
        SmallVector<hw::UnionType::FieldInfo> fields;
        for (auto field : type.getMembers()) {
          hw::UnionType::FieldInfo info;
          info.type = typeConverter.convertType(field.type);
          if (!info.type)
            return {};
          info.name = field.name;
          info.offset = 0;
          fields.push_back(info);
        }
        return hw::UnionType::get(type.getContext(), fields);
      });
 
  // Conversion of CHandle to LLVMPointerType
  typeConverter.addConversion([&](ChandleType type) -> std::optional<Type> {
    return LLVM::LLVMPointerType::get(type.getContext());
  });
 
  // Explicitly mark LLVMPointerType as a legal target
  typeConverter.addConversion(
      [](LLVM::LLVMPointerType t) -> std::optional<Type> { return t; });
 
  // ClassHandleType  ->  !llvm.ptr
  typeConverter.addConversion([&](ClassHandleType type) -> std::optional<Type> {
    return LLVM::LLVMPointerType::get(type.getContext());
  });
 
  // NullType -> !llvm.ptr
  typeConverter.addConversion([&](NullType type) -> std::optional<Type> {
    return LLVM::LLVMPointerType::get(type.getContext());
  });
 
  typeConverter.addConversion([&](RefType type) -> std::optional<Type> {
    if (isa<OpenArrayType, OpenUnpackedArrayType>(type.getNestedType()))
      return LLVM::LLVMPointerType::get(type.getContext());
    if (auto innerType = typeConverter.convertType(type.getNestedType()))
      return llhd::RefType::get(innerType);
    return {};
  });
 
  typeConverter.addConversion([&](NetType type) -> std::optional<Type> {
    if (auto innerType = typeConverter.convertType(type.getNestedType()))
      return llhd::NetType::get(innerType);
    return {};
  });
 
  // Valid target types.
  typeConverter.addConversion([](IntegerType type) { return type; });
  typeConverter.addConversion([](FloatType type) { return type; });
  typeConverter.addConversion([](sim::DynamicStringType type) { return type; });
  typeConverter.addConversion([](sim::FormatStringType type) { return type; });
  typeConverter.addConversion([](sim::AssocArrayType type) { return type; });
  typeConverter.addConversion([](llhd::TimeType type) { return type; });
  typeConverter.addConversion([](debug::ArrayType type) { return type; });
  typeConverter.addConversion([](debug::ScopeType type) { return type; });
  typeConverter.addConversion([](debug::StructType type) { return type; });
 
  typeConverter.addConversion([&](llhd::RefType type) -> std::optional<Type> {
    if (auto innerType = typeConverter.convertType(type.getNestedType()))
      return llhd::RefType::get(innerType);
    return {};
  });
 
  typeConverter.addConversion([&](llhd::NetType type) -> std::optional<Type> {
    if (auto innerType = typeConverter.convertType(type.getNestedType()))
      return llhd::NetType::get(innerType);
    return {};
  });
 
  typeConverter.addConversion([&](hw::ArrayType type) -> std::optional<Type> {
    if (auto elementType = typeConverter.convertType(type.getElementType()))
      return hw::ArrayType::get(elementType, type.getNumElements());
    return {};
  });
 
  typeConverter.addConversion([&](hw::StructType type) -> std::optional<Type> {
    SmallVector<hw::StructType::FieldInfo> fields;
    for (auto field : type.getElements()) {
      hw::StructType::FieldInfo info;
      info.type = typeConverter.convertType(field.type);
      if (!info.type)
        return {};
      info.name = field.name;
      fields.push_back(info);
    }
    return hw::StructType::get(type.getContext(), fields);
  });
 
  typeConverter.addConversion([&](hw::UnionType type) -> std::optional<Type> {
    SmallVector<hw::UnionType::FieldInfo> fields;
    for (auto field : type.getElements()) {
      hw::UnionType::FieldInfo info;
      info.type = typeConverter.convertType(field.type);
      if (!info.type)
        return {};
      info.name = field.name;
      info.offset = field.offset;
      fields.push_back(info);
    }
    return hw::UnionType::get(type.getContext(), fields);
  });
 
  typeConverter.addTargetMaterialization(
      [&](mlir::OpBuilder &builder, mlir::Type resultType,
          mlir::ValueRange inputs, mlir::Location loc) -> mlir::Value {
        if (inputs.size() != 1 || !inputs[0])
          return Value();
        return UnrealizedConversionCastOp::create(builder, loc, resultType,
                                                  inputs[0])
            .getResult(0);
      });
 
  typeConverter.addSourceMaterialization(
      [&](mlir::OpBuilder &builder, mlir::Type resultType,
          mlir::ValueRange inputs, mlir::Location loc) -> mlir::Value {
        if (inputs.size() != 1)
          return Value();
        return UnrealizedConversionCastOp::create(builder, loc, resultType,
                                                  inputs[0])
            ->getResult(0);
      });
}
 
static void populateOpConversion(ConversionPatternSet &patterns,
                                 TypeConverter &typeConverter,
                                 ClassTypeCache &classCache,
                                 FunctionCache &funcCache) {
 
  patterns.add<ClassDeclOpConversion>(typeConverter, patterns.getContext(),
                                      classCache);
  patterns.add<ClassNewOpConversion>(typeConverter, patterns.getContext(),
                                     classCache, funcCache);
  patterns.add<ClassPropertyRefOpConversion>(typeConverter,
                                             patterns.getContext(), classCache);
 
  // clang-format off
  patterns.add<
    ClassUpcastOpConversion,
    NullOpConversion<NullOp>,
    NullOpConversion<NullChandleOp>,
    NullOpConversion<NullClassOp>,
    // Patterns of declaration operations.
    VariableOpConversion,
    NetOpConversion,
 
    // Patterns for conversion operations.
    BitcastConversion<PackedToSBVOp>,
    BitcastConversion<SBVToPackedOp>,
    NoOpConversion<LogicToIntOp>,
    NoOpConversion<IntToLogicOp>,
    NoOpConversion<ToBuiltinIntOp>,
    NoOpConversion<FromBuiltinIntOp>,
    TruncOpConversion,
    ZExtOpConversion,
    SExtOpConversion,
    SIntToRealOpConversion,
    UIntToRealOpConversion,
    IntToStringOpConversion,
    StringToIntOpConversion,
    FormatStringToStringOpConversion,
    RealToIntOpConversion,
    ConvertRealOpConversion,
    RealBitcastOpConversion<RealtobitsBIOp>,
    RealBitcastOpConversion<BitstorealBIOp>,
    RealBitcastOpConversion<ShortrealtobitsBIOp>,
    RealBitcastOpConversion<BitstoshortrealBIOp>,
 
    // Patterns of miscellaneous operations.
    ConstantOpConv,
    ConstantRealOpConv,
    ConcatOpConversion,
    ReplicateOpConversion,
    ConstantTimeOpConv,
    ExtractOpConversion,
    DynExtractOpConversion,
    DynExtractRefOpConversion,
    ReadOpConversion,
    StructExtractOpConversion,
    StructExtractRefOpConversion,
    ExtractRefOpConversion,
    StructCreateOpConversion,
    UnionCreateOpConversion,
    UnionExtractOpConversion,
    UnionExtractRefOpConversion,
    ConditionalOpConversion,
    ArrayCreateOpConversion,
    UArrayCmpOpConversion,
    YieldOpConversion,
    OutputOpConversion,
    ConstantStringOpConv,
 
    // Patterns of unary operations.
    ReduceAndOpConversion,
    ReduceOrOpConversion,
    ReduceXorOpConversion,
    BoolCastOpConversion,
    NotOpConversion,
    NegOpConversion,
 
    // Patterns of binary operations.
    BinaryOpConversion<AddOp, comb::AddOp>,
    BinaryOpConversion<SubOp, comb::SubOp>,
    BinaryOpConversion<MulOp, comb::MulOp>,
    BinaryOpConversion<DivUOp, comb::DivUOp>,
    BinaryOpConversion<DivSOp, comb::DivSOp>,
    BinaryOpConversion<ModUOp, comb::ModUOp>,
    BinaryOpConversion<ModSOp, comb::ModSOp>,
    BinaryOpConversion<AndOp, comb::AndOp>,
    BinaryOpConversion<OrOp, comb::OrOp>,
    BinaryOpConversion<XorOp, comb::XorOp>,
 
    // Patterns for unary real operations.
    NegRealOpConversion,
 
    // Patterns for binary real operations.
    BinaryRealOpConversion<AddRealOp, arith::AddFOp>,
    BinaryRealOpConversion<SubRealOp, arith::SubFOp>,
    BinaryRealOpConversion<DivRealOp, arith::DivFOp>,
    BinaryRealOpConversion<MulRealOp, arith::MulFOp>,
    BinaryRealOpConversion<PowRealOp, math::PowFOp>,
 
    // Pattern for Verilog standard mathematical functions
    RealMathFunc<LnBIOp, math::LogOp>,
    RealMathFunc<Log10BIOp, math::Log10Op>,
    RealMathFunc<ExpBIOp, math::ExpOp>,
    RealMathFunc<SqrtBIOp, math::SqrtOp>,
    BinaryRealOpConversion<MinBIOp, arith::MinimumFOp>,
    BinaryRealOpConversion<MaxBIOp, arith::MaximumFOp>,
    RealMathFunc<AbsBIOp, math::AbsFOp>,
    RealMathFunc<FloorBIOp, math::FloorOp>,
    RealMathFunc<CeilBIOp, math::CeilOp>,
    RealMathFunc<SinBIOp, math::SinOp>,
    RealMathFunc<CosBIOp, math::CosOp>,
    RealMathFunc<TanBIOp, math::TanOp>,
    RealMathFunc<AsinBIOp, math::AsinOp>,
    RealMathFunc<AcosBIOp, math::AcosOp>,
    RealMathFunc<AtanBIOp, math::AtanOp>,
    BinaryRealOpConversion<Atan2BIOp, math::Atan2Op>,
    HypotBIOpConversion,
    RealMathFunc<SinhBIOp, math::SinhOp>,
    RealMathFunc<CoshBIOp, math::CoshOp>,
    RealMathFunc<TanhBIOp, math::TanhOp>,
    RealMathFunc<AsinhBIOp, math::AsinhOp>,
    RealMathFunc<AcoshBIOp, math::AcoshOp>,
    RealMathFunc<AtanhBIOp, math::AtanhOp>,
 
    // Patterns of power operations.
    PowUOpConversion, PowSOpConversion,
    Clog2BIOpConversion,
 
    // Patterns of relational operations.
    ICmpOpConversion<UltOp, ICmpPredicate::ult>,
    ICmpOpConversion<SltOp, ICmpPredicate::slt>,
    ICmpOpConversion<UleOp, ICmpPredicate::ule>,
    ICmpOpConversion<SleOp, ICmpPredicate::sle>,
    ICmpOpConversion<UgtOp, ICmpPredicate::ugt>,
    ICmpOpConversion<SgtOp, ICmpPredicate::sgt>,
    ICmpOpConversion<UgeOp, ICmpPredicate::uge>,
    ICmpOpConversion<SgeOp, ICmpPredicate::sge>,
    ICmpOpConversion<EqOp, ICmpPredicate::eq>,
    ICmpOpConversion<NeOp, ICmpPredicate::ne>,
    CaseEqOpConversion<CaseEqOp, ICmpPredicate::ceq, false>,
    CaseEqOpConversion<CaseNeOp, ICmpPredicate::cne, true>,
    WildcardEqOpConversion<WildcardEqOp, ICmpPredicate::weq, false>,
    WildcardEqOpConversion<WildcardNeOp, ICmpPredicate::wne, true>,
    FCmpOpConversion<NeRealOp, arith::CmpFPredicate::UNE>,
    FCmpOpConversion<FltOp, arith::CmpFPredicate::OLT>,
    FCmpOpConversion<FleOp, arith::CmpFPredicate::OLE>,
    FCmpOpConversion<FgtOp, arith::CmpFPredicate::OGT>,
    FCmpOpConversion<FgeOp, arith::CmpFPredicate::OGE>,
    FCmpOpConversion<EqRealOp, arith::CmpFPredicate::OEQ>,
    CaseXZEqOpConversion<CaseZEqOp, true>,
    CaseXZEqOpConversion<CaseXZEqOp, false>,
    HandleCmpOpConversion<HandleEqOp, LLVM::ICmpPredicate::eq>,
    HandleCmpOpConversion<HandleNeOp, LLVM::ICmpPredicate::ne>,
 
    // Patterns of structural operations.
    SVModuleOpConversion,
    InstanceOpConversion,
    ProcedureOpConversion,
    CoroutineOpConversion,
    CallCoroutineOpConversion,
    WaitEventOpConversion,
    WaitLevelOpConversion,
 
    // Patterns of shifting operations.
    ShrOpConversion,
    ShlOpConversion,
    AShrOpConversion,
 
    // Patterns of assignment operations.
    AssignOpConversion<ContinuousAssignOp>,
    AssignOpConversion<DelayedContinuousAssignOp>,
    AssignOpConversion<BlockingAssignOp>,
    AssignOpConversion<NonBlockingAssignOp>,
    AssignOpConversion<DelayedNonBlockingAssignOp>,
    AssignedVariableOpConversion,
 
    // Patterns of other operations outside Moore dialect.
    HWInstanceOpConversion,
    ReturnOpConversion,
    CallOpConversion,
    DPIFuncOpConversion,
    FuncDPICallOpConversion,
    UnrealizedConversionCastConversion,
    InPlaceOpConversion<debug::ArrayOp>,
    InPlaceOpConversion<debug::StructOp>,
    InPlaceOpConversion<debug::VariableOp>,
 
    // Patterns of assert-like operations
    AssertLikeOpConversion<AssertOp, verif::AssertOp>,
    AssertLikeOpConversion<AssumeOp, verif::AssumeOp>,
    AssertLikeOpConversion<CoverOp, verif::CoverOp>,
 
    // Format strings.
    FormatLiteralOpConversion,
    FormatStringOpConversion,
    FormatConcatOpConversion,
    FormatHierPathOpConversion,
    FormatIntOpConversion,
    FormatRealOpConversion,
    FormatCharOpConversion,
    DisplayBIOpConversion,
    FDisplayBIOpConversion,
 
    // File I/O operations
    FOpenBIOpConversion,
    FCloseBIOpConversion,
    FFlushBIOpConversion,
    ReadMemBIOpConversion,
 
    // Command line input operations
    PlusArgsTestBIOpConversion,
    PlusArgsValueBIOpConversion,
 
    // Dynamic string operations
    StringLenOpConversion,
    StringConcatOpConversion,
    StringGetOpConversion,
    StringCmpOpConversion,
    StringCompareOpConversion,
    StringICompareOpConversion,
    StringToLowerOpConversion,
    StringToUpperOpConversion,
    StringSubstrOpConversion,
 
    // Queue operations
    QueueSizeBIOpConversion,
    QueuePushBackOpConversion,
    QueuePushFrontOpConversion,
    QueuePopBackOpConversion,
    QueuePopFrontOpConversion,
    QueueDeleteOpConversion,
    QueueInsertOpConversion,
    QueueClearOpConversion,
    DynQueueExtractOpConversion,
    QueueResizeOpConversion,
    QueueSetOpConversion,
    QueueCmpOpConversion,
    QueueFromUnpackedArrayOpConversion,
    QueueConcatOpConversion,
 
    // Associative array operations
    AssocArrayExtractOpConversion,
    AssocArraySetOpConversion,
    AssocArrayDeleteOpConversion,
    AssocArrayClearOpConversion,
    AssocArraySizeOpConversion,
    AssocArrayExistsOpConversion,
    AssocArrayFirstOpConversion,
    AssocArrayLastOpConversion,
    AssocArrayNextOpConversion,
    AssocArrayPrevOpConversion
  >(typeConverter, patterns.getContext());
  // clang-format on
 
  // Structural operations
  patterns.add<WaitDelayOp>(convert);
  patterns.add<UnreachableOp>(convert);
  patterns.add<GlobalVariableOp>(convert);
  patterns.add<GetGlobalVariableOp>(convert);
 
  // Simulation control
  patterns.add<StopBIOp>(convert);
  patterns.add<SeverityBIOp>(convert);
  patterns.add<FinishBIOp>(convert);
  patterns.add<FinishMessageBIOp>(convert);
 
  // Random builtins
  patterns.add<UrandomRangeBIOp>(convert, funcCache);
 
  // Timing control
  patterns.add<TimeBIOp>(convert);
  patterns.add<LogicToTimeOp>(convert);
  patterns.add<TimeToLogicOp>(convert);
 
  mlir::populateAnyFunctionOpInterfaceTypeConversionPattern(patterns,
                                                            typeConverter);
  hw::populateHWModuleLikeTypeConversionPattern(
      hw::HWModuleOp::getOperationName(), patterns, typeConverter);
  populateSCFToControlFlowConversionPatterns(patterns);
  populateArithToCombPatterns(patterns, typeConverter);
}
 
//===----------------------------------------------------------------------===//
// Moore to Core Conversion Pass
//===----------------------------------------------------------------------===//
 
namespace {
struct MooreToCorePass
    : public circt::impl::ConvertMooreToCoreBase<MooreToCorePass> {
  void runOnOperation() override;
};
} // namespace
 
/// Create a Moore to core dialects conversion pass.
std::unique_ptr<OperationPass<ModuleOp>> circt::createConvertMooreToCorePass() {
  return std::make_unique<MooreToCorePass>();
}
 
/// This is the main entrypoint for the Moore to Core conversion pass.
void MooreToCorePass::runOnOperation() {
  MLIRContext &context = getContext();
  ModuleOp module = getOperation();
  ClassTypeCache classCache;
  auto &symbolTable = getAnalysis<SymbolTable>();
  FunctionCache funcCache(symbolTable);
 
  IRRewriter rewriter(module);
  (void)mlir::eraseUnreachableBlocks(rewriter, module->getRegions());
 
  TypeConverter typeConverter;
  populateTypeConversion(typeConverter);
 
  ConversionTarget target(context);
  populateLegality(target, typeConverter);
 
  ConversionPatternSet patterns(&context, typeConverter);
  populateOpConversion(patterns, typeConverter, classCache, funcCache);
  mlir::cf::populateCFStructuralTypeConversionsAndLegality(typeConverter,
                                                           patterns, target);
 
  if (failed(applyFullConversion(module, target, std::move(patterns))))
    signalPassFailure();
}