Add RecommendedReaderVersion advisory mechanism to cDAC RuntimeInfo contract#125029
Merged
noahfalk merged 3 commits intodotnet:mainfrom Mar 5, 2026
Merged
Add RecommendedReaderVersion advisory mechanism to cDAC RuntimeInfo contract#125029noahfalk merged 3 commits intodotnet:mainfrom
noahfalk merged 3 commits intodotnet:mainfrom
Conversation
Contributor
|
Tagging subscribers to this area: @steveisok, @tommcdon, @dotnet/dotnet-diag |
Member
Author
|
This adds the freshness check that showed up in the latter portion of the discussion on #124448. I went back and forth on where two version properties should actually live on the API but ultimately putting both on the RuntimeInfo contract seemed like a reasonable choice. I could also see arguments to put the properties on a new contract or treat them as something special that lives outside the contract API entirely. Assuming we keep them where they are we could use the contract doc to describe what functionality each version change contains once we have a 2+ versions to describe. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an advisory “recommended reader version” mechanism to the cDAC RuntimeInfo contract so diagnostic tools can detect when newer contracts are available and suggest updating.
Changes:
- Introduces a new
RecommendedReaderVersionruntime global (backed byCDAC_RECOMMENDED_READER_VERSION) indatadescriptor.inc. - Extends
IRuntimeInfo/RuntimeInfo_1withCurrentReaderVersion(compile-time constant) andRecommendedReaderVersion(reads the runtime global, returns 0 if absent). - Adds unit tests and updates the
RuntimeInfodata contract documentation to describe the scheme.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/native/managed/cdac/tests/RuntimeInfoTests.cs | Adds tests covering RecommendedReaderVersion behavior and updates test target construction to inject numeric globals. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Contracts/Contracts/RuntimeInfo_1.cs | Implements CurrentReaderVersion and reads RecommendedReaderVersion from target globals. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Contracts/Constants.cs | Adds the RecommendedReaderVersion global name constant. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Abstractions/Contracts/IRuntimeInfo.cs | Adds the two new properties to the IRuntimeInfo contract surface. |
| src/coreclr/vm/datadescriptor/datadescriptor.inc | Defines CDAC_RECOMMENDED_READER_VERSION and exposes it as a new RecommendedReaderVersion cDAC global. |
| docs/design/datacontracts/RuntimeInfo.md | Documents the new global/property and the reader versioning scheme. |
...e/managed/cdac/Microsoft.Diagnostics.DataContractReader.Contracts/Contracts/RuntimeInfo_1.cs
Outdated
Show resolved
Hide resolved
...e/managed/cdac/Microsoft.Diagnostics.DataContractReader.Contracts/Contracts/RuntimeInfo_1.cs
Outdated
Show resolved
Hide resolved
…ontract Adds a new CDAC_RECOMMENDED_READER_VERSION constant and RecommendedReaderVersion global to datadescriptor.inc. The runtime team can increment this value when making changes where updating diagnostic tools is recommended. This is purely advisory and does not necessarily mean a breaking change occurred. The RuntimeInfo contract exposes two new properties: - CurrentReaderVersion: a compile-time constant representing the reader version this contract was authored against (currently 1) - RecommendedReaderVersion: reads the runtime global of the same name Diagnostic tools can compare these to determine whether to recommend an update to the user. When the runtime ships a higher RecommendedReaderVersion than a tool's CurrentReaderVersion, the tool knows newer contracts are available. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
d565cc0 to
30f63dc
Compare
This was referenced Mar 2, 2026
max-charlamb
approved these changes
Mar 3, 2026
...managed/cdac/Microsoft.Diagnostics.DataContractReader.Abstractions/Contracts/IRuntimeInfo.cs
Outdated
Show resolved
Hide resolved
Address review feedback: convert CurrentReaderVersion and RecommendedReaderVersion properties to GetCurrentReaderVersion() and GetRecommendedReaderVersion() methods to match the style of existing methods on the interface. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Member
Author
|
/ba-g change was already verified, I just only modified comments after that |
This was referenced Mar 5, 2026
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
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.
…ontract
Adds a new CDAC_RECOMMENDED_READER_VERSION constant and RecommendedReaderVersion global to datadescriptor.inc. The runtime team can increment this value when making changes where updating diagnostic tools is recommended. This is purely advisory and does not necessarily mean a breaking change occurred.
The RuntimeInfo contract exposes two new properties:
Diagnostic tools can compare these to determine whether to recommend an update to the user. When the runtime ships a higher RecommendedReaderVersion than a tool's CurrentReaderVersion, the tool knows newer contracts are available.