Support serializing large (> 2 GiB) annotation files #3905
Merged
Conversation
This file contains 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
Previous API serializing to a String is limited by JVM max size of 2 GiB Strings.
seldridge
approved these changes
Mar 5, 2024
| * @param out Writer to which the serialized annotations will be written | ||
| * @return | ||
| */ | ||
| def serializeTry[W <: Writer](annos: Iterable[Annotation], out: W): Try[W] = { |
There was a problem hiding this comment.
An alternative is to make this private. There is then nothing to actually test here (other than seeing if 2GiB of annotations work... 😓). I'm really questioning if this is necessary to make public.
There was a problem hiding this comment.
I assumed I'd have to call it from Chisel but ended up not needing to. That being said, the current test is in package firrtlTests so would have to mess with that. We have already deprecated any import of package firrtl (via the compiler plugin) so I'm a bit 🤷♀️ about it.
mergify bot
pushed a commit
that referenced
this pull request
Mar 5, 2024
* Support serializing Annotations to a Writer Previous API serializing to a String is limited by JVM max size of 2 GiB Strings. * Serialize to Writer instead of String in WriteOutputAnnotations (cherry picked from commit 736f1a7)
14 tasks
mergify bot
pushed a commit
that referenced
this pull request
Mar 5, 2024
* Support serializing Annotations to a Writer Previous API serializing to a String is limited by JVM max size of 2 GiB Strings. * Serialize to Writer instead of String in WriteOutputAnnotations (cherry picked from commit 736f1a7)
14 tasks
chiselbot
pushed a commit
that referenced
this pull request
Mar 5, 2024
* Support serializing Annotations to a Writer Previous API serializing to a String is limited by JVM max size of 2 GiB Strings. * Serialize to Writer instead of String in WriteOutputAnnotations (cherry picked from commit 736f1a7) Co-authored-by: Jack Koenig <koenig@sifive.com>
chiselbot
pushed a commit
that referenced
this pull request
Mar 5, 2024
* Support serializing Annotations to a Writer Previous API serializing to a String is limited by JVM max size of 2 GiB Strings. * Serialize to Writer instead of String in WriteOutputAnnotations (cherry picked from commit 736f1a7) Co-authored-by: Jack Koenig <koenig@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.
This probably also improves performance and reduces memory since creating a large String is expensive.
Contributor Checklist
docs/src?Type of Improvement
Desired Merge Strategy
Release Notes
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), clean up the commit message, and label withPlease Merge.Create a merge commit.