[WIP] [cDAC] Adding symbols and using heap dumps by rcj1 · Pull Request #126385 · dotnet/runtime

rcj1 · 2026-03-31T23:44:28Z

For cDAC dump testing, we need metadata for our locally built System.Private.CoreLib for reading certain statics etc., as well as for debuggees for metadata tests. So that we can use heap dumps instead of full dumps, we add the symbol paths when we open the dump in ClrMD.

Copilot

Pull request overview

This PR updates the cDAC DumpTests infrastructure to prefer heap dumps (instead of full dumps) and makes dump analysis more reliable by providing ClrMD with local symbol/module search paths (including a self-contained symbol layout for Helix runs).

Changes:

Switch DumpTests to default to heap dumps (removing per-test DumpType => "full" overrides) and update debuggee projects to generate heap dumps.
Add symbol/module path discovery in DumpTestBase and plumb these paths into ClrMdDumpHost.Open.
Update Helix dump-generation to copy System.Private.CoreLib.dll and debuggee DLLs into a symbols/ folder alongside dumps so analysis can resolve modules without the original testhost layout.

Reviewed changes

Copilot reviewed 27 out of 27 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/native/managed/cdac/tests/DumpTests/SyncBlockDumpTests.cs	Removes full-dump override so the test uses default heap dump behavior.
src/native/managed/cdac/tests/DumpTests/StackWalkDumpTests.cs	Removes full-dump override so the test uses default heap dump behavior.
src/native/managed/cdac/tests/DumpTests/RCWDumpTests.cs	Removes full-dump override so the test uses default heap dump behavior.
src/native/managed/cdac/tests/DumpTests/RCWCleanupListDumpTests.cs	Removes full-dump override so the test uses default heap dump behavior.
src/native/managed/cdac/tests/DumpTests/LoaderDumpTests.cs	Removes full-dump override so the test uses default heap dump behavior.
src/native/managed/cdac/tests/DumpTests/IXCLRDataValueDumpTests.cs	Removes full-dump override so the test uses default heap dump behavior.
src/native/managed/cdac/tests/DumpTests/IXCLRDataFrameDumpTests.cs	Removes full-dump override so the test uses default heap dump behavior.
src/native/managed/cdac/tests/DumpTests/IXCLRDataAppDomainDumpTests.cs	Removes full-dump override so the test uses default heap dump behavior.
src/native/managed/cdac/tests/DumpTests/ISOSDacInterface13Tests.cs	Removes full-dump override so the test uses default heap dump behavior.
src/native/managed/cdac/tests/DumpTests/ExceptionHandlingInfoDumpTests.cs	Removes full-dump override so the test uses default heap dump behavior.
src/native/managed/cdac/tests/DumpTests/EcmaMetadataDumpTests.cs	Removes full-dump override so the test uses default heap dump behavior.
src/native/managed/cdac/tests/DumpTests/DumpTestBase.cs	Passes additional symbol paths to ClrMD and adds logic to discover symbol/module directories (Helix `symbols/` and local artifacts fallback).
src/native/managed/cdac/tests/DumpTests/ClrMdDumpHost.cs	Extends dump opening to accept additional symbol paths and configures ClrMD symbol search paths.
src/native/managed/cdac/tests/DumpTests/cdac-dump-helix.proj	Copies CoreLib + debuggee DLLs into a `symbols/` tree next to dumps to enable symbol/module resolution on Helix machines.
src/native/managed/cdac/tests/DumpTests/ComWrappersDumpTests.cs	Removes full-dump override so the test uses default heap dump behavior.
src/native/managed/cdac/tests/DumpTests/CCWDumpTests.cs	Removes full-dump override so the test uses default heap dump behavior.
src/native/managed/cdac/tests/DumpTests/AsyncContinuationDumpTests.cs	Removes full-dump override so the test uses default heap dump behavior.
src/native/managed/cdac/tests/DumpTests/Debuggees/SyncBlock/SyncBlock.csproj	Switches debuggee dump generation to heap dumps.
src/native/managed/cdac/tests/DumpTests/Debuggees/StackWalk/StackWalk.csproj	Switches debuggee dump generation to heap dumps.
src/native/managed/cdac/tests/DumpTests/Debuggees/RCWCleanupList/RCWCleanupList.csproj	Switches debuggee dump generation to heap dumps.
src/native/managed/cdac/tests/DumpTests/Debuggees/RCW/RCW.csproj	Switches debuggee dump generation to heap dumps.
src/native/managed/cdac/tests/DumpTests/Debuggees/MultiModule/MultiModule.csproj	Switches debuggee dump generation to heap dumps.
src/native/managed/cdac/tests/DumpTests/Debuggees/LocalVariables/LocalVariables.csproj	Switches debuggee dump generation to heap dumps.
src/native/managed/cdac/tests/DumpTests/Debuggees/ExceptionHandlingInfo/ExceptionHandlingInfo.csproj	Switches debuggee dump generation to heap dumps.
src/native/managed/cdac/tests/DumpTests/Debuggees/ComWrappers/ComWrappers.csproj	Switches debuggee dump generation to heap dumps.
src/native/managed/cdac/tests/DumpTests/Debuggees/CCW/CCW.csproj	Switches debuggee dump generation to heap dumps.
src/native/managed/cdac/tests/DumpTests/Debuggees/AsyncContinuation/AsyncContinuation.csproj	Switches debuggee dump generation to heap dumps (and removes prior “full dump needed” comment).

src/native/managed/cdac/tests/DumpTests/ClrMdDumpHost.cs

dotnet-policy-service · 2026-03-31T23:48:54Z

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

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 27 out of 27 changed files in this pull request and generated 4 comments.

Copilot · 2026-04-01T00:00:33Z

src/native/managed/cdac/tests/DumpTests/ClrMdDumpHost.cs

+        // Local paths first so they resolve before the network fallback.
+        string localPaths = additionalSymbolPaths is not null
+            ? string.Join(";", additionalSymbolPaths.Where(p => !string.IsNullOrEmpty(p)))
+            : string.Empty;
+
+        string symbolPaths = localPaths.Length > 0
+            ? localPaths + ";" + SymbolPath.MicrosoftSymbolServerPath


ClrMdDumpHost.Open always appends MicrosoftSymbolServerPath, which can introduce network dependency and latency/flakiness in Helix/offline environments even when local symbol/module paths are provided. Consider using only the provided local paths by default and gating the symbol server fallback behind an opt-in (e.g., env var) or only enabling it when no local paths are available.

Suggested change

// Local paths first so they resolve before the network fallback.

string localPaths = additionalSymbolPaths is not null

? string.Join(";", additionalSymbolPaths.Where(p => !string.IsNullOrEmpty(p)))

: string.Empty;

string symbolPaths = localPaths.Length > 0

? localPaths + ";" + SymbolPath.MicrosoftSymbolServerPath

// Local paths first; only fall back to the Microsoft symbol server when no local paths are provided.

string localPaths = additionalSymbolPaths is not null

? string.Join(";", additionalSymbolPaths.Where(p => !string.IsNullOrEmpty(p)))

: string.Empty;

string symbolPaths = localPaths.Length > 0

? localPaths

Copilot · 2026-04-01T00:00:34Z

src/native/managed/cdac/tests/DumpTests/DumpTestBase.cs

+                            foreach (string versionPath in Directory.GetDirectories(sharedFxDir))
+                                paths.Add(versionPath);


GetSymbolPaths adds every version directory under artifacts/bin/testhost/**/shared/Microsoft.NETCore.App/* to the symbol search path. If multiple runtime versions are present locally, ClrMD may resolve System.Private.CoreLib.dll from the wrong version (same filename), leading to metadata mismatches. Prefer selecting a single version directory that matches the dump/runtime under test (or otherwise disambiguate), rather than adding all versions.

Suggested change

foreach (string versionPath in Directory.GetDirectories(sharedFxDir))

paths.Add(versionPath);

string[] versionPaths = Directory.GetDirectories(sharedFxDir);

if (versionPaths.Length > 0)

{

string? preferredVersion = Path.GetFileName(versionDir);

string? selectedPath = null;

if (!string.IsNullOrEmpty(preferredVersion))

{

foreach (string candidate in versionPaths)

{

string candidateVersion = Path.GetFileName(candidate);

if (string.Equals(candidateVersion, preferredVersion, StringComparison.OrdinalIgnoreCase))

{

selectedPath = candidate;

break;

}

}

}

if (selectedPath is null)

{

Version? bestVersion = null;

foreach (string candidate in versionPaths)

{

string candidateVersion = Path.GetFileName(candidate);

if (Version.TryParse(candidateVersion, out Version? parsed))

{

if (bestVersion is null || parsed > bestVersion)

{

bestVersion = parsed;

selectedPath = candidate;

}

}

}

// If no directory name parsed as a Version, fall back to the first entry for deterministic behavior.

selectedPath ??= versionPaths[0];

}

paths.Add(selectedPath);

}

Copilot · 2026-04-01T00:00:34Z

src/native/managed/cdac/tests/DumpTests/cdac-dump-helix.proj

+          Include="mkdir %25HELIX_WORKITEM_PAYLOAD%25\dumps\local\symbols\runtime" />
+      <_HelixCommandLines Condition="'$(TargetOS)' == 'windows'"
+          Include="for /D %25%25v in (%25HELIX_CORRELATION_PAYLOAD%25\shared\Microsoft.NETCore.App\*) do copy &quot;%25%25v\System.Private.CoreLib.dll&quot; &quot;%25HELIX_WORKITEM_PAYLOAD%25\dumps\local\symbols\runtime\&quot; &gt;nul" />


The Windows symbol copy loop copies System.Private.CoreLib.dll from every directory under shared/Microsoft.NETCore.App into a single destination folder, so if multiple framework versions exist the file will be overwritten and the remaining version may not match the dump. Consider copying the versioned directory structure (or selecting the single runtime version used for dump generation) to avoid ambiguity.

Copilot · 2026-04-01T00:00:35Z

src/native/managed/cdac/tests/DumpTests/cdac-dump-helix.proj

+      <!-- Unix: copy SPC from testhost shared framework -->
+      <_HelixCommandLines Condition="'$(TargetOS)' != 'windows'"
+          Include="echo '=== Copying symbols ==='" />
+      <_HelixCommandLines Condition="'$(TargetOS)' != 'windows'"
+          Include="mkdir -p $HELIX_WORKITEM_PAYLOAD/dumps/local/symbols/runtime" />
+      <_HelixCommandLines Condition="'$(TargetOS)' != 'windows'"
+          Include="cp $HELIX_CORRELATION_PAYLOAD/shared/Microsoft.NETCore.App/*/System.Private.CoreLib.dll $HELIX_WORKITEM_PAYLOAD/dumps/local/symbols/runtime/" />


On Unix, the wildcard copy (.../Microsoft.NETCore.App/*/System.Private.CoreLib.dll) will copy from all matching versions into a single folder; if multiple versions exist this results in nondeterministic overwrites and potential version mismatch. Consider preserving version subfolders under symbols/runtime or resolving the single framework version used for dump generation.

Suggested change



<_HelixCommandLines Condition="'$(TargetOS)' != 'windows'"

Include="echo '=== Copying symbols ==='" />

<_HelixCommandLines Condition="'$(TargetOS)' != 'windows'"

Include="mkdir -p $HELIX_WORKITEM_PAYLOAD/dumps/local/symbols/runtime" />

<_HelixCommandLines Condition="'$(TargetOS)' != 'windows'"

Include="cp $HELIX_CORRELATION_PAYLOAD/shared/Microsoft.NETCore.App/*/System.Private.CoreLib.dll $HELIX_WORKITEM_PAYLOAD/dumps/local/symbols/runtime/" />



<_HelixCommandLines Condition="'$(TargetOS)' != 'windows'"

Include="echo '=== Copying symbols ==='" />

<_HelixCommandLines Condition="'$(TargetOS)' != 'windows'"

Include="mkdir -p $HELIX_WORKITEM_PAYLOAD/dumps/local/symbols/runtime" />

<_HelixCommandLines Condition="'$(TargetOS)' != 'windows'"

Include="for dir in $HELIX_CORRELATION_PAYLOAD/shared/Microsoft.NETCore.App/*; do if [ -f "$dir/System.Private.CoreLib.dll" ]; then ver=$(basename "$dir"); mkdir -p "$HELIX_WORKITEM_PAYLOAD/dumps/local/symbols/runtime/$ver"; cp "$dir/System.Private.CoreLib.dll" "$HELIX_WORKITEM_PAYLOAD/dumps/local/symbols/runtime/$ver/"; fi; done" />

Refactor symbol path handling in Open method.

Copilot

Pull request overview

Copilot reviewed 27 out of 27 changed files in this pull request and generated 1 comment.

Copilot · 2026-04-01T04:16:55Z

src/native/managed/cdac/tests/DumpTests/cdac-dump-helix.proj

+          Include="for /D %25%25v in (%25HELIX_CORRELATION_PAYLOAD%25\shared\Microsoft.NETCore.App\*) do copy &quot;%25%25v\System.Private.CoreLib.dll&quot; &quot;%25HELIX_WORKITEM_PAYLOAD%25\dumps\local\symbols\runtime\&quot; &gt;nul" />
+      <!-- Windows: copy each debuggee DLL -->
+      <_HelixCommandLines Condition="'$(TargetOS)' == 'windows'"
+          Include="@(_UniqueDebuggee->'mkdir %25HELIX_WORKITEM_PAYLOAD%25\dumps\local\symbols\debuggees\%(Identity)')" />
+      <_HelixCommandLines Condition="'$(TargetOS)' == 'windows'"
+          Include="@(_UniqueDebuggee->'copy &quot;%25HELIX_WORKITEM_PAYLOAD%25\debuggees\%(Identity)\%(Identity).dll&quot; &quot;%25HELIX_WORKITEM_PAYLOAD%25\dumps\local\symbols\debuggees\%(Identity)\&quot; &gt;nul')" />


On Windows this for /D ... do copy can execute multiple times if multiple shared framework version directories exist, and subsequent copy operations may prompt on overwrite (potentially hanging the Helix command). Adding copy /Y (or otherwise ensuring only one version is copied / removing any existing destination file) would make this more robust.

Suggested change

Include="for /D %25%25v in (%25HELIX_CORRELATION_PAYLOAD%25\shared\Microsoft.NETCore.App\*) do copy "%25%25v\System.Private.CoreLib.dll" "%25HELIX_WORKITEM_PAYLOAD%25\dumps\local\symbols\runtime\" >nul" />



<_HelixCommandLines Condition="'$(TargetOS)' == 'windows'"

Include="@(_UniqueDebuggee->'mkdir %25HELIX_WORKITEM_PAYLOAD%25\dumps\local\symbols\debuggees\%(Identity)')" />

<_HelixCommandLines Condition="'$(TargetOS)' == 'windows'"

Include="@(_UniqueDebuggee->'copy "%25HELIX_WORKITEM_PAYLOAD%25\debuggees\%(Identity)\%(Identity).dll" "%25HELIX_WORKITEM_PAYLOAD%25\dumps\local\symbols\debuggees\%(Identity)\" >nul')" />

Include="for /D %25%25v in (%25HELIX_CORRELATION_PAYLOAD%25\shared\Microsoft.NETCore.App\*) do copy /Y "%25%25v\System.Private.CoreLib.dll" "%25HELIX_WORKITEM_PAYLOAD%25\dumps\local\symbols\runtime\" >nul" />



<_HelixCommandLines Condition="'$(TargetOS)' == 'windows'"

Include="@(_UniqueDebuggee->'mkdir %25HELIX_WORKITEM_PAYLOAD%25\dumps\local\symbols\debuggees\%(Identity)')" />

<_HelixCommandLines Condition="'$(TargetOS)' == 'windows'"

Include="@(_UniqueDebuggee->'copy /Y "%25HELIX_WORKITEM_PAYLOAD%25\debuggees\%(Identity)\%(Identity).dll" "%25HELIX_WORKITEM_PAYLOAD%25\dumps\local\symbols\debuggees\%(Identity)\" >nul')" />

adding symbols and using heap dumps

416635e

rcj1 added NO-MERGE The PR is not ready for merge yet (see discussion for detailed reasons) NO-REVIEW Experimental/testing PR, do NOT review it labels Mar 31, 2026

Copilot AI review requested due to automatic review settings March 31, 2026 23:44

rcj1 marked this pull request as draft March 31, 2026 23:44

github-actions bot added the area-Diagnostics-coreclr label Mar 31, 2026

dotnet-policy-service bot assigned rcj1 Mar 31, 2026

rcj1 changed the title ~~[WIP] Adding symbols and using heap dumps~~ [WIP] [cDAC] Adding symbols and using heap dumps Mar 31, 2026

Copilot started reviewing on behalf of rcj1 March 31, 2026 23:45 View session

rcj1 removed the area-Diagnostics-coreclr label Mar 31, 2026

github-actions bot added the area-Diagnostics-coreclr label Mar 31, 2026

Copilot AI reviewed Mar 31, 2026

View reviewed changes

src/native/managed/cdac/tests/DumpTests/ClrMdDumpHost.cs Outdated Show resolved Hide resolved

Update src/native/managed/cdac/tests/DumpTests/ClrMdDumpHost.cs

b18f833

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings March 31, 2026 23:55

Copilot started reviewing on behalf of rcj1 March 31, 2026 23:56 View session

Copilot AI reviewed Apr 1, 2026

View reviewed changes

rcj1 added 2 commits March 31, 2026 18:42

Update ClrMdDumpHost.cs

8f48f67

Simplify loading dump with symbol paths

a739bba

Refactor symbol path handling in Open method.

Copilot AI review requested due to automatic review settings April 1, 2026 04:12

Copilot started reviewing on behalf of rcj1 April 1, 2026 04:13 View session

Copilot AI reviewed Apr 1, 2026

View reviewed changes

Fix variable reference in Helix command line for Windows

6e93a19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] [cDAC] Adding symbols and using heap dumps#126385

[WIP] [cDAC] Adding symbols and using heap dumps#126385
rcj1 wants to merge 5 commits intodotnet:mainfrom
rcj1:metadata-fallback

rcj1 commented Mar 31, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

dotnet-policy-service bot commented Mar 31, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 1, 2026

Uh oh!

Copilot AI Apr 1, 2026

Uh oh!

Copilot AI Apr 1, 2026

Uh oh!

Copilot AI Apr 1, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		foreach (string versionPath in Directory.GetDirectories(sharedFxDir))
		paths.Add(versionPath);

-                            foreach (string versionPath in Directory.GetDirectories(sharedFxDir))
-                                paths.Add(versionPath);
+                            string[] versionPaths = Directory.GetDirectories(sharedFxDir);
+                            if (versionPaths.Length > 0)
+                            {
+                                string? preferredVersion = Path.GetFileName(versionDir);
+                                string? selectedPath = null;
+                                if (!string.IsNullOrEmpty(preferredVersion))
+                                {
+                                    foreach (string candidate in versionPaths)
+                                    {
+                                        string candidateVersion = Path.GetFileName(candidate);
+                                        if (string.Equals(candidateVersion, preferredVersion, StringComparison.OrdinalIgnoreCase))
+                                        {
+                                            selectedPath = candidate;
+                                            break;
+                                        }
+                                    }
+                                }
+                                if (selectedPath is null)
+                                {
+                                    Version? bestVersion = null;
+                                    foreach (string candidate in versionPaths)
+                                    {
+                                        string candidateVersion = Path.GetFileName(candidate);
+                                        if (Version.TryParse(candidateVersion, out Version? parsed))
+                                        {
+                                            if (bestVersion is null || parsed > bestVersion)
+                                            {
+                                                bestVersion = parsed;
+                                                selectedPath = candidate;
+                                            }
+                                        }
+                                    }
+                                    // If no directory name parsed as a Version, fall back to the first entry for deterministic behavior.
+                                    selectedPath ??= versionPaths[0];
+                                }
+                                paths.Add(selectedPath);
+                            }

Conversation

rcj1 commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

dotnet-policy-service bot commented Mar 31, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rcj1 commented Mar 31, 2026 •

edited

Loading