[FIRRTL] Add FormatStringType #8342
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
seldridge
force-pushed
the
dev/seldridge/firrtl-add-printf-types
branch
2 times, most recently
from
e68c032 to
86de666
Compare
fabianschuiki
approved these changes
Mar 24, 2025
There was a problem hiding this comment.
This is really really cool. I love the direction of this. Rust has had some good results with this approach of statically parsing format strings into a fixed data structure.
I'm wondering if we shouldn't go all in on this, and remove string interpolation from printf entirely and use dedicated formatting ops. That would allow us to define string interpolation once in a bunch of ops, and then reuse it for printf, fprintf, assert, assume, cover, and other stuff I forgot 😁
Add a new type, `!firrtl.fstring.time`, and a single expression that can
create it: TimeOp / `firrtl.fstring.time`. These are used to model the
notion of simulation time that should be emitted into a format string.
Allow for this to be a legal substitution operand to the existing
PrintfOp. Add printing/parsing support for this which will convert the
special substitution `{{SimulationTime}}` into a `TimeOp` and an added
substitution at the correct location. Add emission support which inverts
this representational conversion.
Signed-off-by: Schuyler Eldridge <[email protected]>
[FIRRTL] Parse/emit special printf substitutions
Add parser and emitter support for new "special substitutions". These are
substitutions that take the form of `{{Name}}` where "Name" is a list of
keywords defined by the FIRRTL spec. This is intended to be used to
represent "simulation time" and "hierarchical path" and will be compiled
to `$time` and `%m` in Verilog.
Signed-off-by: Schuyler Eldridge <[email protected]>
seldridge
force-pushed
the
dev/seldridge/firrtl-add-printf-types
branch
from
e9cd52c to
db20bd8
Compare
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.
Add a format string type. This is intended to be used to improve the way we capture format strings and extend this to capturing more advanced concepts like "time" via attributes as opposed to resorting to enums and attributes.