[minor][abi] Document type alias lowering #117
+4
−0
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
darthscsi
reviewed
Jul 18, 2023
| @@ -142,6 +142,10 @@ payload as the first field and a packed bit vector as a second field. The | |||
| padding for each payload is set to ensure all padded payloads have the same bit | |||
| width as required by Verilog packed unions. | |||
|
|
|||
| Type aliases shall be lowered to Verilog `typedef`{.verilog} with their inner types | |||
| recursively following these rules. Type aliases will be dropped if inner types are | |||
There was a problem hiding this comment.
I'm not sure we want to encode dropping in the ABI. This would imply, maybe incorrectly, that if they have any name it is a bug. Perhaps "changes to the structure of a type will result in changes to the name of a type". Width/type/reset inference is actually a situation where we probably want to mutate the type but preserve it's name or at least of that option.
There was a problem hiding this comment.
i'm also a little leery of putting anything into the ABI for this. Aren't these aliases basically hints, and nothing is to be relied upon at the ABI level?
Should we say "there is no reliable mapping from type aliases to the emitted verilog, they are treated as hints only"?
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 sentence for type alias in abi