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

Layers: color check all not any and don't consider enabled layers. #4434

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dtzSiFive
Copy link
Member

Drop test specifically checking this incorrect behavior.

Add tests checking don't need to be under a layer block to define a probe with more colors, and that enabled layers don't change what is allowed to be defined.

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • API modification
  • Bugfix

Desired Merge Strategy

  • Squash: The PR will be squashed and merged (choose this if you have no preference).

Release Notes

Fix checking of layer-color probes to avoid rejecting valid uses and to detect actual problems that would otherwise be caught by CIRCT.

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.6.x, 5.x, or 6.x depending on impact, API modification or big change: 7.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

Drop test specifically checking this incorrect behavior.

Add tests checking don't need to be under a layer block to define
a probe with more colors, and that enabled layers don't change what
is allowed to be defined.
@dtzSiFive dtzSiFive added the Bugfix Fixes a bug, will be included in release notes label Oct 2, 2024
Comment on lines +173 to +176
matchesAndOmits(ChiselStage.emitCHIRRTL(new Foo))(
"define x = probe(a)",
"define y = probe(b)"
)()
Copy link
Member

@seldridge seldridge Oct 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ChiselStage.elaborate is sufficient to only check that it doesn't error.

Ditto below.

val b = Wire(Bool())
define(a, ProbeValue(b))
}
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great to remove this (and fix the checking) given that this emits with an illegal reference. This could be made to work, but we don't even have a way to describe this in the FIRRTL spec, i.e., there is no layerblock A.C.

(You know all this! I'm more leaving comments for bread crumbs if others come back to this later...)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Breadcrumbs are great! Thanks! I'm unsure about this one, let's check!

I think the code in the test should not be supported as the probe target is not guaranteed to exist when A is enabled (C must be enabled, so the probe must at least have that color).

Additionally, enabling a layer should still allow sending out probes that aren't colored (not required to have color A [1].

This matches CIRCT's interpretation, AFAIK (FWIW).

I'm not sure what the mentioned A.C would be, and if it's some sort of sets-of-layers specification (?) not sure that changes anything here?

@@ -180,8 +180,7 @@ package object internal {
color
case _ => return
}
val enabledLayers = Builder.enabledLayers.view ++ Builder.layerStack.headOption
if (enabledLayers.exists(_.canWriteTo(destLayer))) {
if (Builder.layerStack.headOption.forall(_.canWriteTo(destLayer))) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clever use of forall. 👍

Copy link
Member

@seldridge seldridge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bugfix Fixes a bug, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants