Skip to content

[cDAC] Implement GetPartialUserState for cDAC#127848

Open
barosiak wants to merge 1 commit intodotnet:mainfrom
barosiak:barosiak/GetPartialUserState
Open

[cDAC] Implement GetPartialUserState for cDAC#127848
barosiak wants to merge 1 commit intodotnet:mainfrom
barosiak:barosiak/GetPartialUserState

Conversation

@barosiak
Copy link
Copy Markdown
Member

@barosiak barosiak commented May 6, 2026

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

  • Add Interruptible to ThreadState enum (from m_State)
  • Add new ThreadStateNC enum and StateNC field (from m_StateNC)
  • Implement GetPartialUserState in DacDbiImpl with DEBUG cross-validation
  • Add CorDebugUserState typed enum to IDacDbiInterface
  • Update data descriptor, contract docs, and VM annotations
  • Add unit and dump tests

@barosiak barosiak requested review from max-charlamb, noahfalk and rcj1 May 6, 2026 01:56
@barosiak barosiak self-assigned this May 6, 2026
Copilot AI review requested due to automatic review settings May 6, 2026 01:56
@dotnet-policy-service
Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @steveisok, @tommcdon, @dotnet/dotnet-diag
See info in area-owners.md if you want to be subscribed.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Interruptible plus a new StateNC field (ThreadStateNC) and plumb it through descriptors, data model, and contract implementation.
  • Replace the legacy-delegation stub for GetPartialUserState with a managed implementation (plus DEBUG cross-validation against legacy DAC).
  • Add unit and dump tests validating state-flag mapping and GetPartialUserState results.

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.

Id = target.ReadField<uint>(address, type, nameof(Id));
OSId = target.ReadNUIntField(address, type, nameof(OSId));
State = target.ReadField<uint>(address, type, nameof(State));
StateNC = target.ReadField<uint>(address, type, nameof(StateNC));
Comment on lines +149 to +157
[Flags]
public enum CorDebugUserState
{
USER_BACKGROUND = 0x04,
USER_UNSTARTED = 0x08,
USER_STOPPED = 0x10,
USER_WAIT_SLEEP_JOIN = 0x20,
USER_THREADPOOL = 0x100,
}
Comment thread src/coreclr/vm/threads.h
TSNC_DebuggerSleepWaitJoin = 0x04000000, // Indicates to the debugger that this thread is in a sleep wait or join state
TSNC_DebuggerSleepWaitJoin = 0x04000000, // Indicates to the debugger that this thread is in a sleep wait or join state. [cDAC] [Thread]: Contract depends on this value.
// This almost mirrors the TS_Interruptible state however that flag can change
// during GC-preemptive mode whereas this one cannot.
Copy link
Copy Markdown
Member

@jkotas jkotas May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need this flag?

These flags seem to be always set together:

// Set the state bits.
thread->SetThreadState(Thread::TS_Interruptible);
thread->SetThreadStateNC(Thread::TSNC_DebuggerSleepWaitJoin);
}
extern "C" void QCALLTYPE ThreadNative_ClearWaitSleepJoinState(QCall::ThreadHandle thread)
{
CONTRACTL
{
QCALL_CHECK_NO_GC_TRANSITION;
PRECONDITION(thread != NULL);
}
CONTRACTL_END;
// Clear the state bits.
thread->ResetThreadState(Thread::TS_Interruptible);
thread->ResetThreadStateNC(Thread::TSNC_DebuggerSleepWaitJoin);
. The comment that say

ResetThreadState ((ThreadState)(TS_Interrupted | TS_Interruptible));
is one place where we clear TS_Interruptible, but leave TSNC_DebuggerSleepWaitJoin set. That looks like a bug.

I would suggest we delete TSNC_DebuggerSleepWaitJoin and just depend on TS_Interruptible

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jkoritzinsky, Do you have any more context on why we have these separated? It looks like you modified this relatively recently in #117788

There is some old comment about this being used to address a race condition.

// Don't report Thread::TS_AbortRequested
// The interruptible flag is unreliable (see issue 699245)
// The Debugger_SleepWaitJoin is always accurate when it is present, but it is still
// just a band-aid fix to cover some of the race conditions interruptible has.
if (ts & Thread::TS_Interruptible || pThread->HasThreadStateNC(Thread::TSNC_DebuggerSleepWaitJoin))
{
result |= USER_WAIT_SLEEP_JOIN;
}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Historically, the managed threading APIs had deep roots into the rest of the runtime. I think this is left-over of that. We have been working on untangling it for a while now.

The core (unmanaged) runtime does not actually care about the SleepWaitJoin state at all. This state just tracks whether you are inside Thread.Sleep or one of the managed Wait APIs. It would be perfectly fine to move this bit to the managed Thread (like it is done in Native AOT). I am not asking for that to be done as part of this PR- I am just trying to explain what this state really is.

Comment thread src/coreclr/vm/threads.h
TS_TPWorkerThread = 0x01000000, // is this a threadpool worker thread? [cDAC] [Thread]: Contract depends on this value.

TS_Interruptible = 0x02000000, // sitting in a Sleep(), Wait(), Join()
TS_Interruptible = 0x02000000, // sitting in a Sleep(), Wait(), Join(). [cDAC] [Thread]: Contract depends on this value.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should rename this to TS_WaitSleepJoin since that's what the same thing is called in public APIs: https://learn.microsoft.com/en-us/dotnet/api/system.threading.threadstate

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants