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

Print warning when extractor is too wide or narrow #3033

Merged

Conversation

albertchen-sifive
Copy link
Contributor

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 state the API impact?
  • Did you specify the code generation impact?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • bug fix

API Impact

none

Backend Code Generation Impact

none

Desired Merge Strategy

Squash

Release Notes

Warn when dynamic extract index is too wide or too narrow.

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels?
  • Did you mark the proper milestone (Bug fix: 3.4.x, [small] API extension: 3.5.x, API modification or big change: 3.6.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.

Copy link
Contributor

@jackkoenig jackkoenig left a comment

Choose a reason for hiding this comment

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

Looks good but I have some comments. I'd also like to see an FAQ page for these errors to tell people how to resolve them (using .pad or a bit extract, or both in the case of a generator where the width may be too large or too small under different circumstances).

core/src/main/scala/chisel3/Bits.scala Outdated Show resolved Hide resolved
core/src/main/scala/chisel3/Bits.scala Show resolved Hide resolved
core/src/main/scala/chisel3/Bits.scala Show resolved Hide resolved
core/src/main/scala/chisel3/Bits.scala Show resolved Hide resolved
@jackkoenig jackkoenig added this to the 3.6.0 milestone Feb 22, 2023
@albertchen-sifive
Copy link
Contributor Author

I noticed that the error message for zero-width extractee is printing twice. once from the dynamic index and then again when it does (this >> x)(0)

[error] src/test/scala/chiselTests/UIntOps.scala:412:18: Cannot extract from zero-width UIntOpsSpec_Anon.in: IO[UInt<0>]
[error] src/test/scala/chiselTests/UIntOps.scala:412:18: Cannot extract from zero-width
[error] There were 2 error(s) during hardware elaboration.

Is it fine to change the message back to just Cannot extract from zero-width so that they dedup?

albertchen-sifive and others added 2 commits February 23, 2023 17:49
Co-authored-by: Jack Koenig <jack.koenig3@gmail.com>
@mwachs5
Copy link
Contributor

mwachs5 commented Feb 23, 2023

This relates to #2946

core/src/main/scala/chisel3/Bits.scala Outdated Show resolved Hide resolved
core/src/main/scala/chisel3/Bits.scala Outdated Show resolved Hide resolved
core/src/main/scala/chisel3/Bits.scala Outdated Show resolved Hide resolved
@jackkoenig jackkoenig enabled auto-merge (squash) February 24, 2023 02:11
@jackkoenig jackkoenig added the Please Merge Accepted PRs that are ready to be merged. Useful when waiting on CI. label Feb 24, 2023
@jackkoenig jackkoenig merged commit 4cb44bc into chipsalliance:master Feb 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Please Merge Accepted PRs that are ready to be merged. Useful when waiting on CI.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants