Add OverrideSerializationClass for custom annotation serialization #4953
+109
−66
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
seldridge
approved these changes
Jun 13, 2025
Comment on lines
+180
to
+187
| val tags = mutable.ListBuffer.empty[Class[_]] | ||
| val seenTags = mutable.Set.empty[Class[_]] | ||
| def addTag(clazz: Class[_]): Unit = { | ||
| if (!seenTags(clazz)) { | ||
| tags += clazz | ||
| seenTags += clazz | ||
| } | ||
| } |
There was a problem hiding this comment.
I didn't realize that ListBuffer has constant time prepend and append. This looked like a performance issue, but it isn't.
There was a problem hiding this comment.
Yeah, and .toList is constant time (copy-on-write to original ListBuffer object). It's how Scala makes List relatively fast all things considered.
Comment on lines
+121
to
+123
| res should include(""""class":"firrtl.annotations.UnserializeableAnnotation",""") | ||
| res should include(""""error":"Classes defined in method bodies are not supported.",""") | ||
| res should include(""""content":"MyAnno(3)"""") |
There was a problem hiding this comment.
FileCheck would be better. 😉 However, I don't think FileCheck is available in this compilation unit.
Co-authored-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Contributor Checklist
docs/src?Type of Improvement
Desired Merge Strategy
Release Notes
Annotations can now mixin
OverrideSerializationClassto customize the "class" field in annotation serialization. This allows annotation classes to reside in a different package than firtool is expecting for theclassfield. Note that this breaks automatic deserialization which does not matter to firtool but would matter for annotations communicating information between Chisel generator invocations.Reviewer Checklist (only modified by reviewer)
3.6.x,5.x, or6.xdepending on impact, API modification or big change:7.0)?Enable auto-merge (squash)and clean up the commit message.Create a merge commit.