[cDAC] Implement GetPartialUserState for cDAC#127848
Conversation
There was a problem hiding this comment.
Pull request overview
Implements DacDbiImpl.GetPartialUserState in the managed cDAC reader by mapping thread state flags from the IThread contract (including new Interruptible and StateNC/ThreadStateNC) to a typed CorDebugUserState, and adds unit + dump-based tests to validate the mapping.
Changes:
- Extend the Thread contract surface to expose
Interruptibleplus a newStateNCfield (ThreadStateNC) and plumb it through descriptors, data model, and contract implementation. - Replace the legacy-delegation stub for
GetPartialUserStatewith a managed implementation (plus DEBUG cross-validation against legacy DAC). - Add unit and dump tests validating state-flag mapping and
GetPartialUserStateresults.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/native/managed/cdac/tests/ThreadTests.cs | Adds a unit test ensuring raw state fields map to ThreadState / ThreadStateNC. |
| src/native/managed/cdac/tests/MockDescriptors/MockDescriptors.Thread.cs | Extends mock Thread layout to include StateNC and exposes setters. |
| src/native/managed/cdac/tests/DumpTests/DacDbi/DacDbiThreadDumpTests.cs | Adds dump test cross-validating GetPartialUserState against IThread contract data. |
| src/native/managed/cdac/tests/ClrDataExceptionStateTests.cs | Updates mocks constructing ThreadData to include the new StateNC field. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Legacy/Dbi/IDacDbiInterface.cs | Introduces typed CorDebugUserState and updates GetPartialUserState signature. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Legacy/Dbi/DacDbiImpl.cs | Implements GetPartialUserState using thread contract data and DEBUG cross-validation. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Contracts/Data/Thread.cs | Reads new StateNC field from the Thread data descriptor. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Contracts/Contracts/Thread_1.cs | Maps StateNC into ThreadData and adds Interruptible mapping. |
| src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Abstractions/Contracts/IThread.cs | Extends ThreadState, adds ThreadStateNC, and adds StateNC to ThreadData. |
| src/coreclr/vm/threads.h | Annotates thread state bits and adds m_StateNC to the cDAC data offsets. |
| src/coreclr/vm/datadescriptor/datadescriptor.inc | Adds Thread.StateNC field to the cDAC data descriptor. |
| docs/design/datacontracts/Thread.md | Documents new ThreadState.Interruptible, ThreadStateNC, and ThreadData.StateNC. |
|
Tagging subscribers to this area: @steveisok, @tommcdon, @dotnet/dotnet-diag |
Co-authored-by: Jan Kotas <jkotas@microsoft.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (2)
src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Legacy/Dbi/IDacDbiInterface.cs:163
- This adds new public API surface (
public enum CorDebugUserStateand apublicCOM interface method signature change using it), but the PR description doesn't link anapi-approvedissue/proposal. If this surface is intended to be consumable outside this assembly, it should go through API review; otherwise consider making the enum (and/or the updated signature surface)internalto avoid committing to a public contract prematurely.
[Flags]
public enum CorDebugUserState
{
USER_BACKGROUND = 0x04,
USER_UNSTARTED = 0x08,
USER_STOPPED = 0x10,
USER_WAIT_SLEEP_JOIN = 0x20,
USER_THREADPOOL = 0x100,
}
// Name-surface projection of IDacDbiInterface in native method order for COM binding validation.
// Parameter shapes are intentionally coarse placeholders and will be refined with method implementation work.
[GeneratedComInterface]
[Guid("DB505C1B-A327-4A46-8C32-AF55A56F8E09")]
public unsafe partial interface IDacDbiInterface
src/coreclr/debug/daccess/dacdbiimpl.cpp:5698
GetPartialUserStateno longer uses the historical workaround for Wait/Sleep/Join detection (previously checkingTS_InterruptibleOR the non-concurrencyTSNC_DebuggerSleepWaitJoinbit, with an in-code note thatTS_Interruptiblewas unreliable). This change makes debugger/DAC user state depend solely onTS_WaitSleepJoinbeing accurate in all cases. If the underlying reliability concern is still relevant, this could be a behavior regression; if it has been fixed, please add an updated comment (or test coverage) documenting why the NC bit is no longer needed. Related changes are inthreads.h(removing the TSNC flag) andcomsynchronizable.cpp(no longer setting it).
// Don't report a StopRequested if the thread has actually stopped.
if (ts & Thread::TS_Stopped)
{
result |= USER_STOPPED;
}
if (ts & Thread::TS_WaitSleepJoin)
{
result |= USER_WAIT_SLEEP_JOIN;
}
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Summary
Replaces the legacy-delegation stub in DacDbiImpl.GetPartialUserState with a managed implementation using the IThread contract, mirroring the native C++ logic in dacdbiimpl.cpp that maps thread state flags to CorDebugUserState.
Changes