[cDAC] Stackwalk DacDbi APIs#129091
Conversation
|
Tagging subscribers to this area: @steveisok, @tommcdon, @dotnet/dotnet-diag |
There was a problem hiding this comment.
Pull request overview
This PR expands the cDAC StackWalk and Debugger contracts to support runtime hijack-stub detection and hijacked-context recovery, updates context retrieval to use caller-provided aligned buffers with HRESULT-based error reporting, and wires up corresponding DacDbi stack-walk APIs with updated tests and documentation.
Changes:
- Add Debugger contract support for hijack stub range table (
RgHijackFunction+MemoryRange) and implementIDebugger.IsRuntimeUnwindableStub. - Extend StackWalk contract with hijack-context recovery and seed-context stack-walk support; change
GetContextto fill a caller-provided, 16-byte-aligned buffer and return HRESULTs. - Implement DacDbi stack-walk methods (create/delete/set/get/unwind/check) on top of the cDAC contracts, with test and dump-test updates for alignment and signature changes.
Show a summary per file
| File | Description |
|---|---|
| src/native/managed/cdac/tests/UnitTests/DebuggerTests.cs | Adds unit tests and mock-target plumbing for hijack-stub detection via RgHijackFunction/MemoryRange. |
| src/native/managed/cdac/tests/UnitTests/DacDbiImplTests.cs | Updates tests to match CheckContext signature change (byte* instead of nint). |
| src/native/managed/cdac/tests/TestInfrastructure/TestPlaceholderTarget.cs | Updates TryGetThreadContext override to return HRESULT (int). |
| src/native/managed/cdac/tests/DumpTests/StackWalkDumpTests.cs | Updates dump test to use aligned native memory and validate HRESULT-based GetContext. |
| src/native/managed/cdac/tests/DumpTests/DacDbi/DacDbiStackWalkDumpTests.cs | Updates dump tests to use aligned buffers when calling contract GetContext. |
| src/native/managed/cdac/tests/DataGenerator/TestTarget.cs | Updates TryGetThreadContext override to return HRESULT (int). |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader/ContractDescriptorTarget.cs | Changes TryGetThreadContext to return HRESULT from the underlying data-target delegate. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Legacy/Dbi/IDacDbiInterface.cs | Updates COM surface signatures for stack-walk context pointers (byte*) and adds CorDebugSetContextFlags. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Legacy/Dbi/Helpers/StackWalkHandleData.cs | Introduces managed handle state for cDAC-backed DacDbi stack walking. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Legacy/Dbi/DacDbiImpl.cs | Implements DacDbi stack-walk APIs using cDAC StackWalk + Debugger contracts, with optional legacy mirroring/debug validation. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Contracts/Microsoft.Diagnostics.DataContractReader.Contracts.csproj | Adds System.HResults to enable HRESULT constants in contracts. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Contracts/DataType.cs | Adds DataType.MemoryRange for hijack table entries. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Contracts/Data/MemoryRange.cs | Adds cDAC MemoryRange data descriptor type (start + size). |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Contracts/Data/Debugger.cs | Adds RgHijackFunction field for hijack function range table pointer. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Contracts/Contracts/StackWalk/StackWalk_1.cs | Adds seed-context CreateStackWalk, hijacked-context recovery, HRESULT-buffer GetContext, and aligned scratch usage for OS context retrieval. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Contracts/Contracts/StackWalk/Context/IPlatformAgnosticContext.cs | Adds ContextAlignment constant (16) for CONTEXT buffer alignment requirements. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Contracts/Contracts/Debugger_1.cs | Implements IDebugger.IsRuntimeUnwindableStub using hijack range table scanning. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Contracts/Constants.cs | Adds MaxHijackFunctions global name used by Debugger hijack-table scanning. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Abstractions/Target.cs | Changes TryGetThreadContext to return HRESULT instead of bool (API contract shift). |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Abstractions/Contracts/IStackWalk.cs | Adds seed-context CreateStackWalk overload and changes GetContext to HRESULT + caller buffer; adds RetrieveHijackedContext. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Abstractions/Contracts/IDebugger.cs | Adds IsRuntimeUnwindableStub API to the Debugger contract abstraction. |
| src/coreclr/vm/datadescriptor/datadescriptor.inc | Exposes Debugger RgHijackFunction, introduces MemoryRange type descriptor, and adds MaxHijackFunctions global literal. |
| src/coreclr/inc/memoryrange.h | Adds cDAC exposure (cdac_data<MemoryRange>) for MemoryRange field offsets. |
| src/coreclr/debug/ee/debugger.h | Annotates hijack enum constant dependency; exposes hijack table pointer and constant via cdac_data<Debugger>. |
| src/coreclr/debug/di/rsstackwalk.cpp | Avoids fetching current context after unwind when already at end-of-stack. |
| docs/design/datacontracts/StackWalk.md | Updates contract documentation for new StackWalk APIs and aligned, caller-buffer GetContext. |
| docs/design/datacontracts/Debugger.md | Documents IsRuntimeUnwindableStub and the hijack-table globals/data descriptors. |
Copilot's findings
- Files reviewed: 27/27 changed files
- Comments generated: 6
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
The HResults looks weird on the stress log analyzer. I’m also not entirely sure how necessary it is to track the HR, that is, if we will likely ever encounter an HResult other than E_NOTIMPL that warrants a different response. I had only noticed it because of the alignment requirements not being met, but if those are met I’m not sure what else there is. |
noahfalk
left a comment
There was a problem hiding this comment.
I'm still looking through this but needed to stop for the night. I'll be back at it tomorrow.
max-charlamb
left a comment
There was a problem hiding this comment.
will continue reviewing tomorrow.
|
/ba-g timeouts :( |
IsRuntimeUnwindableStubDebugger cDAC APICreateStackWalkthat accepts an arbitrary seed contextTryGetThreadContextHRESULT for more accurate fallback handlingCreateStackWalk,DeleteStackWalk,SetStackWalkCurrentStackFrame,GetStackWalkCurrentStackFrame, andUnwindStackWalkFrameNote to Copilot code revise: Please DO NOT make ANY comments about breaking public APIs!!!