[cdac] Physical contract descriptor spec #100365
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
dotnet-issue-labeler
bot
added
the
needs-area-label
lambdageek
added
documentation
elinor-fung
reviewed
Mar 27, 2024
jkotas
reviewed
Mar 28, 2024
jkotas
reviewed
Mar 28, 2024
lambdageek
force-pushed
the
cdac-contract-descriptor
branch
3 times, most recently
from
f37c8a8
to
4bd9a58
Compare
jkotas
reviewed
Mar 29, 2024
lambdageek
force-pushed
the
cdac-contract-descriptor
branch
from
4bd9a58
to
77afeac
Compare
the issue is that we can't dereference pointers until we know the target endianness and pointer size. which we can only discover by reading the actual descriptor magic and flags
if there are multiple hosted runtimes, diagnostic tooling should look in each loaded module to discover the contract descriptor
elinor-fung
approved these changes
Apr 2, 2024
Comment on lines
25
to
26
| uint32_t aux_data_count; | ||
| uint32_t descriptor_size; |
There was a problem hiding this comment.
Can we put the count/size right before or after the descriptor/aux_data instead?
jkotas
reviewed
Apr 2, 2024
|
|
||
| To aid in the discovery the contract descriptor should be exported by the module hosting the .NET | ||
| runtime with the name `DotNetRuntimeContractDescriptor`. (Using the C symbol conventions of the | ||
| target platform. That is, on platforms where such symbols typically have an `_` prepended, this |
There was a problem hiding this comment.
What are those platforms?
FWIW, the existing DotNetRuntimeDebugHeader seems to be exported without _ everywhere:
jkotas
reviewed
Apr 2, 2024
| If `ptrSize` is 0, the architecture is 64-bit. If it is 1, the architecture is 32-bit. The | ||
| reserved bits should be written as zero. Diagnostic tooling may ignore non-zero reserved bits. | ||
|
|
||
| The `descriptor` is a pointer to a JSON string described in [data descriptor physical layout](./data_descriptor.md#Physical_JSON_descriptor). The total length (including nul terminator character) is given by `descriptor_size`. |
There was a problem hiding this comment.
Nit: I would omit the terminating null in the descriptor_size.
The data contract reader cannot assume that the descriptor is null terminated. It needs to be robust against malicious input. Including the terminating null does not seem to be beneficial, it just adds extra logic to the reader to verify that there is a null at the end and strip it.
Co-authored-by: Elinor Fung <[email protected]>
- put the aux data and descriptor sizes closer to the pointers - Don't include trailing nul `descriptor_size`. Clarify it is counting bytes and that `descriptor` is in UTF-8 - Simplify `DotNetRuntimeContractDescriptor` naming discussion
matouskozak
pushed a commit
to matouskozak/runtime
that referenced
this pull request
Apr 30, 2024
Building on dotnet#100253 , describe an in-memory representation of the toplevel contract descriptor, comprisied of: * some target architecture properties * a data descriptor * a collection of compatible contracts Contributes to dotnet#99298 Fixes dotnet#99299 --- * [cdac] Physical contract descriptor spec * Add "contracts" to the data descriptor * one runtime per module if there are multiple hosted runtimes, diagnostic tooling should look in each loaded module to discover the contract descriptor * Apply suggestions from code review * Review feedback - put the aux data and descriptor sizes closer to the pointers - Don't include trailing nul `descriptor_size`. Clarify it is counting bytes and that `descriptor` is in UTF-8 - Simplify `DotNetRuntimeContractDescriptor` naming discussion --------- Co-authored-by: Elinor Fung <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Building on #100253 , describe an in-memory representation of the toplevel contract descriptor, comprisied of:
Contributes to #99298
Fixes #99299