Skip to content

[cDAC] Fix stale contract docs and README - #135472

Merged
rcj1 merged 3 commits into
dotnet:mainfrom
pcshrosbree:cdac-docs-drift
Oct 12, 2026
Merged

rcj1 merged 3 commits into
dotnet:mainfrom
pcshrosbree:cdac-docs-drift

Conversation

@pcshrosbree

@pcshrosbree pcshrosbree commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Each item was checked against the current source.

  • Exception.md. The GetNestedExceptionInfo pseudo-code dereferences ExceptionInfo::ThrownObject as a handle. The field is ExInfo::m_exception, an OBJECTREF. The implementation returns the field's address as the pseudo-handle and its value as the object (Exception_1.cs). The descriptor meaning said "Handle to the thrown exception object". It is corrected, and the generated tables in Exception.md, Thread.md and WindowsErrorReporting.md are regenerated with CdacUsageGraph docs.
  • Thread.md. GetThreadData still reads the FeatureEHFunclets global, which [cDAC] Remove references to FEATURE_EH_FUNCLETS #116743 removed. Thread_1 always reads through Thread::ExceptionTracker.
  • ReJIT.md. The GetRejitIds pseudo-code drops the Source == ReJIT check that both the cDAC implementation and ReJitManager::GetReJITIDs apply.
  • cdac README.md.
    • It says a Debug runtime is required for the legacy DAC to delegate to the cDAC. When the cDAC is enabled, delegation works in Debug, Checked and Release runtime builds on the platforms that support it: CAN_USE_CDAC depends only on USE_DAC_TABLE_RVA, and the Release-runtime SOS legs run the cDAC configurations. The #if DEBUG cross-validation still needs a legacy DAC that matches the runtime build, and the README now says so.
    • It says the SOS tests run on Windows x64. runtime-diagnostics.yml runs them on all seven sosPlatforms.

CdacUsageGraph docs --check and Usage.Tests pass.

Note

This PR was prepared with AI assistance (Anthropic Claude, reviewed with OpenAI Codex). Each claim was checked against the source locally.

Each fix was checked against the current source:

- Exception.md: ExceptionInfo::ThrownObject is ExInfo::m_exception,
  an object reference, not a handle. GetNestedExceptionInfo returns
  the field's address as the pseudo-handle and its value as the
  object (Exception_1.cs). The descriptor meaning is corrected and
  the generated tables in Exception.md, Thread.md and
  WindowsErrorReporting.md are regenerated.
- Thread.md: GetThreadData read a FeatureEHFunclets global that was
  removed in dotnet#116743; Thread::ExceptionTracker is always read through.
- ReJIT.md: GetRejitIds is the IReJITExtensions extension method, not
  a contract API, and like ReJitManager::GetReJITIDs it only counts
  versions whose source is ReJIT.
- cdac README: a Debug runtime is not required for the legacy DAC to
  delegate to the cDAC (CAN_USE_CDAC depends only on
  USE_DAC_TABLE_RVA), and runtime-diagnostics runs SOS.Tests on all
  seven sosPlatforms, not only Windows x64.
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 2 pipeline(s).
14 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

Comment thread docs/design/datacontracts/ReJIT.md Outdated
Review feedback: that GetRejitIds is implemented as an extension
method is an implementation detail the contract doc does not need to
expose. Restore it to the API list with its original signature, and
keep only the corrected pseudo-code: like ReJitManager::GetReJITIDs,
it counts only versions whose source is ReJIT.
Comment thread src/native/managed/cdac/README.md Outdated
Comment thread src/native/managed/cdac/README.md Outdated
Wrap the runtime-configuration paragraph to the file's line width,
and say that the `#if DEBUG` cross-validation still needs a legacy
DAC that matches the runtime build.
@rcj1

rcj1 commented Oct 12, 2026

Copy link
Copy Markdown
Contributor

/ba-g unrelated fail

@rcj1
rcj1 merged commit 05a1078 into dotnet:main Oct 12, 2026
60 of 62 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-Diagnostics-cdac community-contribution Indicates that the PR has been added by a community member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants