Add ElaboratedCircuit and deprecate use of internal ir Circuit (backport #4683) #4693
+283
−84
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When I tried out #4643 internally at SiFive, I realized that despite
chisel3.internal.firrtl.ir
being a package private object,ir.Circuit
still leaks out viaChiselCircuitAnnotation
and it can be used freely. This leaks full access to the Chisel internal IR in a way that makes it really hard to change things.This is my attempt to "spackle" that leak by providing the new
ElaboratedCircuit
API as the intended public interface to give to users to let them do what they want to do, while letting us muck with the internals. I think we should feel free to add and deprecate then remove APIs fromElaboratedCircuit
as long as we take care to keep the actual internals private.Before merging this, I intend to test it internally and redo #4643 on top of it because I still want to backport the annotation deprecations as well. Technically #4643 does not need this, but I think this makes the story of what changes I want to make in 7.0 a lot cleaner without having to worry about changes to
ir.Circuit
accidentally breaking user code.Contributor Checklist
docs/src
?Type of Improvement
Desired Merge Strategy
Release Notes
Change ChiselCircuitAnnotation and CircuitSerializationAnnotation to no longer be case classes to help with the transition to ElaboratedCircuit.
Reviewer Checklist (only modified by reviewer)
3.6.x
,5.x
, or6.x
depending on impact, API modification or big change:7.0
)?Enable auto-merge (squash)
and clean up the commit message.Create a merge commit
.This is an automatic backport of pull request #4683 done by [Mergify](https://mergify.com).