Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[HW] Enable parametric polymorphism for module parameters #8040

Merged
merged 8 commits into from
Jan 24, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
add code and test
bubblepipe42 committed Jan 8, 2025
commit e751c89366ed022b29317631567e22db9f73e3b2
1 change: 1 addition & 0 deletions include/circt/Dialect/HW/HWInstanceImplementation.h
Original file line number Diff line number Diff line change
@@ -62,6 +62,7 @@ LogicalResult verifyOutputs(ArrayAttr resultNames, ArrayAttr moduleResultNames,
/// Verify that the parameter lists of the instance and the module match in
/// terms of length, names, and types.
LogicalResult verifyParameters(ArrayAttr parameters, ArrayAttr moduleParameters,
ArrayRef<Type> resolvedModParametersRefs,
const EmitErrorFn &emitError);

/// Combines verifyReferencedModule, verifyInputs, verifyOutputs, and
34 changes: 30 additions & 4 deletions lib/Dialect/HW/HWInstanceImplementation.cpp
Original file line number Diff line number Diff line change
@@ -149,6 +149,7 @@ LogicalResult instance_like_impl::verifyOutputs(
LogicalResult
instance_like_impl::verifyParameters(ArrayAttr parameters,
ArrayAttr moduleParameters,
ArrayRef<Type> resolvedModParametersRefs,
const EmitErrorFn &emitError) {
// Check parameters match up.
auto numParameters = parameters.size();
@@ -164,6 +165,7 @@ instance_like_impl::verifyParameters(ArrayAttr parameters,
for (size_t i = 0; i != numParameters; ++i) {
auto param = cast<ParamDeclAttr>(parameters[i]);
auto modParam = cast<ParamDeclAttr>(moduleParameters[i]);
auto resolvedModParamType = resolvedModParametersRefs[i];

auto paramName = param.getName();
if (paramName != modParam.getName()) {
@@ -175,7 +177,7 @@ instance_like_impl::verifyParameters(ArrayAttr parameters,
return failure();
}

if (param.getType() != modParam.getType()) {
if (param.getType() != resolvedModParamType) {
emitError([&](auto &diag) {
diag << "parameter " << paramName << " should have type "
<< modParam.getType() << " but has type " << param.getType();
@@ -226,7 +228,15 @@ LogicalResult instance_like_impl::verifyInstanceOfHWModule(
auto modResultNames =
ArrayAttr::get(instance->getContext(), mod.getOutputNames());


// note : getModuleType(module).getInputs() is before resolution,
ArrayRef<Type> resolvedModInputTypesRef = getModuleType(module).getInputs();

// for (auto type : getModuleType(module).getInputs()) {
// llvm::errs() << "Input Type: " << type << "\n";
// }
// exit(0);

SmallVector<Type> resolvedModInputTypes;
if (parameters) {
if (failed(instance_like_impl::resolveParametricTypes(
@@ -235,6 +245,8 @@ LogicalResult instance_like_impl::verifyInstanceOfHWModule(
return failure();
resolvedModInputTypesRef = resolvedModInputTypes;
}

// note: at this position, resolvedModInputTypesRef contains the resolved types of the module inputs
if (failed(instance_like_impl::verifyInputs(
argNames, modArgNames, inputs.getTypes(), resolvedModInputTypesRef,
emitError)))
@@ -256,10 +268,24 @@ LogicalResult instance_like_impl::verifyInstanceOfHWModule(
return failure();

if (parameters) {
SmallVector<Type> rawModParameters;
SmallVector<Type> resolvedModParameters;
ArrayRef<Type> resolvedModParametersRefs;

auto modParameters = module->getAttrOfType<ArrayAttr>("parameters");
for (auto param : modParameters) {
auto paramDecl = cast<ParamDeclAttr>(param);
rawModParameters.push_back(paramDecl.getType());
}

if (failed(instance_like_impl::resolveParametricTypes(
instance->getLoc(), parameters, rawModParameters,
resolvedModParameters, emitError)))
return failure();
resolvedModParametersRefs = resolvedModParameters;

// Check that the parameters are consistent with the referenced module.
ArrayAttr modParameters = module->getAttrOfType<ArrayAttr>("parameters");
if (failed(instance_like_impl::verifyParameters(parameters, modParameters,
emitError)))
if (failed(instance_like_impl::verifyParameters(parameters, modParameters, resolvedModParametersRefs, emitError)))
return failure();
}

38 changes: 38 additions & 0 deletions test/Conversion/SeqToSV/x.mlir
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// RUN: circt-opt %s -verify-diagnostics --lower-seq-to-sv | FileCheck %s

// module {
// hw.module.extern @param_in_param<VLD_RST_VALUE: i1 = false, DATA_RST_VALUE: !hw.int<#hw.param.decl.ref<"DATA_WIDTH">>, RST_EN: i1 = true, DATA_WIDTH: i32 = 32>(in %input : !hw.int<#hw.param.decl.ref<"DATA_WIDTH">>, in %clk : !seq.clock, in %xStall : i1, in %xFlush : i1, in %xValid : i1, in %yStall : i1, in %yFlush : i1, in %rstVal : !hw.int<#hw.param.decl.ref<"DATA_WIDTH">>, in %rst : i1, in %vldRstVal : i1, out output : !hw.int<#hw.param.decl.ref<"DATA_WIDTH">>, out yValid : i1) attributes {verilogName = "param_in_param"}
// hw.module @xx(in %input : i96, in %clk : !seq.clock, in %xStall : i1, in %xFlush : i1, in %xValid : i1, in %yStall : i1, in %yFlush : i1, in %rstVal : i96, in %rst : i1, in %vldRstVal : i1, out output : i96, out yValid : i1) {
// %x:2 = seq.sf_dff sym @x name "x" input %input, clock %clk, xStall %xStall, xFlush %xFlush, xValid %xValid, yStall %yStall, yFlush %yFlush, reset %rst, dataResetValue %rstVal, validResetValue %vldRstVal : i96
// hw.output %x#0, %x#1 : i96, i1
// }
// }

module {
hw.module.extern @param_in_param < DATA_RST_VALUE: !hw.int<#hw.param.decl.ref<"DATA_WIDTH">>
, DATA_WIDTH: i32 = 32>
( in %input : !hw.int<#hw.param.decl.ref<"DATA_WIDTH">>
, in %clk : i1
, in %rst : i1
, out output : !hw.int<#hw.param.decl.ref<"DATA_WIDTH">>
) attributes {verilogName = "param_in_param"}

hw.module @xx
( in %input : i96
, in %clk : i1
, in %rst : i1
, out output : i96
) {

%x.output = hw.instance "pipe_reg111" @param_in_param < DATA_RST_VALUE: i96 = 0
, DATA_WIDTH: i32 = 96
>
( input: %input: i96
, clk: %clk: i1
, rst: %rst: i1
) ->
( output: i96
)
hw.output %x.output : i96
}
}