Repository navigation
Conversation
|
Azure Pipelines: Successfully started running 4 pipeline(s). 12 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
Contributor
|
Tagging subscribers to this area: @steveisok, @tommcdon, @dotnet/dotnet-diag |
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Moderate compatibility issues remain around handling newly added IPC events.
Get a fresh assessment by requesting another Copilot review.
Review effort: Lite
Findings: 2
Open (2)
What changed in this PR
Documents runtime/debugger IPC protocol versioning to support DBI separation and compatibility checks.
Changes:
- Renames protocol fields and updates transport/runtime initialization.
- Adds runtime and debugger protocol history documentation.
- Validates runtime versions against debugger-supported bounds.
| File | Reviewed changes |
|---|---|
src/coreclr/debug/shared/dbgtransportsession.cpp |
Updates protocol field marshalling. |
src/coreclr/debug/inc/IPCRuntimeProtocol.md |
Documents runtime protocol history. |
src/coreclr/debug/inc/IPCDebuggerProtocol.md |
Documents debugger protocol history. |
src/coreclr/debug/inc/dbgipcevents.h |
Defines versioning rules and renamed fields. |
src/coreclr/debug/ee/rcthread.cpp |
Initializes runtime protocol versions. |
src/coreclr/debug/di/process.cpp |
Publishes debugger versions and validates compatibility. |
Comment on lines
+223
to
+227
| ULONG m_runtimeProtocol; // Current protocol version for the Left Side. | ||
| ULONG m_runtimeProtocolMinSupported; // Minimum protocol the Left Side can support. Equal to m_runtimeProtocol. | ||
|
|
||
| ULONG m_rightSideProtocolCurrent; // Current protocol version for the Right Side. | ||
| ULONG m_rightSideProtocolMinSupported; // Minimum protocol the Right Side requires. | ||
| ULONG m_debuggerProtocolCurrent; // Current protocol version for the Right Side. | ||
| ULONG m_debuggerProtocolMinSupported; // Minimum protocol the Right Side requires. |
Clarify comments regarding protocol version requirements.
hoyosjs
reviewed
Sep 28, 2026
| @@ -0,0 +1,5 @@ | |||
| ### List of Debugger IPC protocol changes | |||
Member
There was a problem hiding this comment.
There should be a place where we baseline the definitions. Particularly we'll need to baseline the DCB which is needed to initiate protocol and the current set of events.
Contributor
Author
There was a problem hiding this comment.
Updated with the current protocol.
3 tasks
This branch has not been deployed
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.
Now that we are planning for the DBI to be shipping in a separate package as opposed to with the runtime - and in the long term to be built outside of the runtime repo - we have to consider the circumstance in which a DBI targets multiple runtime versions. Such runtime-specific concerns are largely delegated to the DacDbiInterface - however, the IPC events between runtime and DBI are an exception. #127772 was an attempt at routing some of this through the DacDbi; however, it proved to be cumbersome and did not cover adding or deleting IPC events.
We already expose version numbers in the DebuggerIPCControlBlock. The runtime and debugger version numbers must be bumped for a variety of changes. We also have to track the minimum supported runtime version for a given DBI version; this version must be bumped when a narrower set of changes to the IPC events are made. Specifically, the runtime version number is available to the DBI via memory read. This enables us to detect the runtime IPC event version, and create logic that accommodates changes; if no such logic is created, for example if the logic becomes very hard to maintain or prohibitively increases binary size, then dropping support would be indicated through the minimum supported runtime version.
To ensure compatibility, we check the runtime version, and ensure that it falls between the DBI current and minimum supported versions; otherwise we throw
CORDBG_E_INCOMPATIBLE_PROTOCOL.