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

Remove reflective naming #2562

Merged
merged 3 commits into from
Jun 7, 2022
Merged

Remove reflective naming #2562

merged 3 commits into from
Jun 7, 2022

Conversation

jackkoenig
Copy link
Contributor

@jackkoenig jackkoenig commented Jun 4, 2022

This is built on #2561 and will need to be rebased when that is merged. This PR reverts much of the logic added there (and deprecates some of it).

I'll note that while most reflective naming is gone, the reflective naming of val io in BlackBox remains. I think that should be removed as part of the deprecation/unification of BlackBox and ExtModule.

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

  • performance improvement
  • code refactoring
  • code cleanup

API Impact

This may change some names in generated hardware, see warning in #2561.

Backend Code Generation Impact

This may change some names in generated hardware

Desired Merge Strategy

  • Rebase

Release Notes

Remove reflective naming. In some uncommon circumstances, this may cause the names of some signals in the emitted Verilog to change. To determine if this will affect your code, please run your Chisel generator with --warn:reflective-naming (added in Chisel v3.5.4). Note that this option only works on the older version of FIRRTL, it is a no-op in Chisel 3.6.0 and newer.

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.

@jackkoenig
Copy link
Contributor Author

Marked DO NOT MERGE until #2561 is merged and this can be rebased.

@jackkoenig jackkoenig force-pushed the remove-reflective-naming branch from 122229f to c3b90fd Compare June 6, 2022 21:41
This includes both .*Name APIs and .toTarget
This includes removal of closeUnboundIds and _onModuleClose which were
hacks to support naming of non-hardware (ie. unbound) Data.

This can result in a substantial performance improvement for large
Modules with many public vals.
With reflective naming removed, this warning no longer does anything so
the option to enable it is deprecated.
@jackkoenig jackkoenig force-pushed the remove-reflective-naming branch from c3b90fd to bab0a60 Compare June 7, 2022 00:04
@jackkoenig jackkoenig requested a review from azidar June 7, 2022 00:06
@jackkoenig jackkoenig merged commit 0dd0d06 into master Jun 7, 2022
@jackkoenig jackkoenig deleted the remove-reflective-naming branch June 7, 2022 02:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants