Implement cDAC Memory Region APIs (GetHandleTableMemoryRegions, GetGCBookkeepingMemoryRegions, GetGCFreeRegions) by Copilot · Pull Request #124926 · dotnet/runtime

Copilot · 2026-02-26T22:09:17Z

Description

Three ISOSDacInterface13 APIs (GetHandleTableMemoryRegions, GetGCBookkeepingMemoryRegions, GetGCFreeRegions) previously delegated to the legacy DAC or returned E_NOTIMPL. This PR implements them natively in the cDAC by extending the IGC contract and following the existing SOSMethodEnum pattern. Re-implemented on top of latest main which includes PR #124875 infrastructure (handle table data types, TotalCpuCount global, etc.).

Managed interface definitions (`ISOSDacInterface.cs`)

Added SOSMemoryRegion struct and ISOSMemoryEnum COM interface
Changed ISOSDacInterface13 method signatures from void** to typed out ISOSMemoryEnum?

GC data descriptors (`datadescriptor.inc`, `datadescriptor.h`)

Added CDAC_TYPE blocks for CardTableInfo and RegionFreeList
Added GCHeap fields (with conditional compilation guards): FreeableSohSegment, FreeableUohSegment (#ifdef BACKGROUND_GC), FreeRegions (#ifdef USE_REGIONS)
Added BookkeepingStart as a static pointer to the PER_HEAP_ISOLATED field (unconditional global pointer, not a per-heap field)
Added global pointers: BookkeepingStart (unconditional), GlobalFreeHugeRegions, GlobalRegionsToDecommit (#ifdef USE_REGIONS), workstation free-region globals (GCHeapFreeableSohSegment under BACKGROUND_GC, GCHeapFreeRegions under USE_REGIONS)
Added global constants: HandleSegmentSize, CardTableInfoSize, CountFreeRegionKinds (#ifdef USE_REGIONS, using FREE_REGION_KINDS macro)

Managed Data classes and type registration

New Data classes: CardTableInfo.cs, RegionFreeList.cs
DataType enum entries for CardTableInfo, RegionFreeList
Constants.Globals entries for all new globals
IGCHeap/GCHeapSVR/GCHeapWKS extended with optional fields: FreeableSohSegment, FreeableUohSegment, FreeRegions

IGC contract extension (`IGC.cs`, `GC_1.cs`)

Added GCMemoryRegionData, FreeRegionKind types
GetHandleTableMemoryRegions(): walks handle_table_map → buckets → tables → segments (cap: 8192), using TotalCpuCount (processor count) for the number of table slots per bucket in server GC (per PR Fix GC handle dac bug #124875)
GetGCBookkeepingMemoryRegions(): reads bookkeeping_start from BookkeepingStart global pointer (works for both WKS and server GC since it's PER_HEAP_ISOLATED), walks card_table_info linked list (cap: 32)
GetGCFreeRegions(): enumerates global free huge regions, global regions to decommit, per-heap free regions + freeable SOH/UOH segments for both workstation and server GC (cap: 2048)

SOSMemoryEnum and SOSDacImpl integration

SOSMemoryEnum: [GeneratedComClass] implementing ISOSMemoryEnum with Next/Skip/Reset/GetCount
SOSMemoryEnum constructor accepts Target and uses ToClrDataAddress(target) for proper sign extension on 32-bit targets
SOSMemoryEnum.Next handles null memRegion parameter by returning E_POINTER
Three SOSDacImpl methods now call IGC contract methods, wrap results in SOSMemoryEnum, and include #if DEBUG cross-validation blocks against _legacyImpl13

cDAC documentation (`GC.md`)

Added new API types (FreeRegionKind, GCMemoryRegionData) and method signatures to the contract API section
Added data descriptor entries for CardTableInfo, RegionFreeList, and new GCHeap fields (FreeableSohSegment, FreeableUohSegment, FreeRegions)
Added new globals (HandleSegmentSize, CardTableInfoSize, CountFreeRegionKinds, BookkeepingStart, GlobalFreeHugeRegions, GlobalRegionsToDecommit, workstation free-region globals) and safety-cap constants
BookkeepingStart correctly listed only in the globals table (not as a GCHeap field, since it's PER_HEAP_ISOLATED)
Added pseudocode for GetHandleTableMemoryRegions, GetGCBookkeepingMemoryRegions, GetGCFreeRegions and helper methods (AddFreeList, AddSegmentList)

Native build fixes

Added #ifdef BACKGROUND_GC guards for FreeableSohSegment/FreeableUohSegment fields and WKS global pointers
Added #ifdef USE_REGIONS guards for FreeRegions, GlobalFreeHugeRegions, GlobalRegionsToDecommit, CountFreeRegionKinds
Changed BookkeepingStart from GC_HEAP_FIELD to static constexpr decltype(...) pointer (it's PER_HEAP_ISOLATED, not a per-heap instance field)
Moved BookkeepingStart to unconditional CDAC_GLOBAL_POINTER (accessible in both WKS and SERVER_GC builds)
Used FREE_REGION_KINDS macro (defined at global scope) instead of count_free_region_kinds enum (which is inside GC_NAMESPACE and not accessible in the datadescriptor context)

Unit tests (`GCMemoryRegionTests.cs`)

8 test methods × 4 architectures = 32 tests, all passing (928 total tests in suite)
GetHandleTableMemoryRegions: single segment, all-null buckets (empty result), multiple linked segments
GetGCBookkeepingMemoryRegions: single card table entry, missing global (empty result)
GetGCFreeRegions: single free region, no free regions (empty result), multiple free regions across kinds with linked segments

Dump tests (`ServerGCDumpTests.cs`, `WorkstationGCDumpTests.cs`)

Added 3 dump tests to ServerGCDumpTests and 3 to WorkstationGCDumpTests covering all three new APIs
GetHandleTableMemoryRegions: asserts at least one region with non-null start and non-zero size
GetGCBookkeepingMemoryRegions: asserts at least one region with non-null start and non-zero size
GetGCFreeRegions: validates any returned regions have non-null start and non-zero size (count may be zero since free regions depend on GC state)

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

dotnet-policy-service · 2026-02-26T22:17:42Z

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

… for memory region types Co-authored-by: max-charlamb <44248479+max-charlamb@users.noreply.github.com>

…p free region fields, and IGC contract methods Co-authored-by: max-charlamb <44248479+max-charlamb@users.noreply.github.com>

…Impl integration Co-authored-by: max-charlamb <44248479+max-charlamb@users.noreply.github.com>

Add GCMemoryRegionTests with three test methods covering: - GetHandleTableMemoryRegions: single map, bucket, and segment - GetGCBookkeepingMemoryRegions: single card table entry - GetGCFreeRegions: workstation GC with one free region All tests use [Theory] with [ClassData(typeof(MockTarget.StdArch))] to run across all four architecture combinations. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

max-charlamb · 2026-02-26T23:18:02Z

@copilot , we need to update the cDAC docs and write tests for these new APIs

Co-authored-by: max-charlamb <44248479+max-charlamb@users.noreply.github.com>

rcj1 · 2026-02-27T01:43:11Z

@copilot try again

…eeping entries, empty/multiple free regions Co-authored-by: rcj1 <77995559+rcj1@users.noreply.github.com>

Copilot · 2026-02-27T01:52:40Z

@copilot try again

Updated the cDAC docs (GC.md) with new API types, data descriptors, globals, constants, and pseudocode for all three methods. Added 6 additional test methods covering edge cases (empty buckets, multiple linked segments, multiple bookkeeping entries, empty/multiple free regions). Total: 9 test methods × 4 architectures = 36 tests, all passing. See commit 50041df6.

rcj1 · 2026-02-27T02:34:22Z

docs/design/datacontracts/GC.md

+
+    int maxSlots = 1;
+    if (IsServerGC())
+        maxSlots = (int)GetGCHeapCount();


@copilot this is incorrect. We need to ensure that we limit by the processor count in this case. See #124875

Fixed in 6320ebd1. Changed maxSlots to read from TotalCpuCount (the processor count) instead of using GetGCHeapCount() for server GC, matching the fix in PR #124875. Added the TotalCpuCount global pointer to datadescriptor.inc (under SERVER_GC), Constants.Globals, and updated the GC.md pseudocode accordingly.

rcj1 · 2026-02-27T02:35:09Z

@copilot fix the build break

rcj1 · 2026-02-27T02:37:24Z

Ah I will merge my changes into main and then this should work better

…it in server GC Co-authored-by: rcj1 <77995559+rcj1@users.noreply.github.com>

Co-authored-by: rcj1 <77995559+rcj1@users.noreply.github.com>

…ory-region-apis

…24875 infrastructure Co-authored-by: rcj1 <77995559+rcj1@users.noreply.github.com>

Rewrite test infrastructure usage to follow the proper pattern: - Use builder.CreateAllocator() instead of non-existent builder.BumpAllocator - Use builder.AddHeapFragment() to register allocated fragments - Use builder.BorrowAddressRange() + helpers to write data via Span<byte> - Use 32-bit compatible address ranges (0x0010_0000-0x0100_0000) - Wrap fragment addresses in TargetPointer for Assert.Equal comparisons Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…als, and pseudocode Co-authored-by: rcj1 <77995559+rcj1@users.noreply.github.com>

Copilot · 2026-02-27T03:23:33Z

@copilot please start over using the current main as a base. I added some important infrastructure and bug fixes that have already been reviewed and approved.

Started over from the latest main which includes PR #124875 infrastructure. All previous changes were reverted and re-implemented on top of the new base, reusing the HandleTableMap, HandleTableBucket, HandleTable, TableSegment data classes and TotalCpuCount global that were already merged. See commits starting from 8c95b439.

rcj1 · 2026-02-27T04:22:22Z

@copilot fix the build break

…d globals - Wrap FreeableSohSegment/FreeableUohSegment in #ifdef BACKGROUND_GC - Wrap FreeRegions/GlobalFreeHugeRegions/GlobalRegionsToDecommit/CountFreeRegionKinds in #ifdef USE_REGIONS - Change BookkeepingStart from GC_HEAP_FIELD to static pointer (it's PER_HEAP_ISOLATED) - Move BookkeepingStart to unconditional global pointer (not WKS-only) - Remove BookkeepingStart from IGCHeap interface (it's a global, not per-heap) - Simplify GetGCBookkeepingMemoryRegions to always use global pointer Co-authored-by: rcj1 <77995559+rcj1@users.noreply.github.com>

Copilot · 2026-02-27T04:39:18Z

@copilot fix the build break

Fixed in 6e3291fc. The build broke because GC datadescriptor fields and globals were referenced unconditionally but only exist under specific build configurations:

FreeableSohSegment/FreeableUohSegment require #ifdef BACKGROUND_GC
FreeRegions, GlobalFreeHugeRegions, GlobalRegionsToDecommit, CountFreeRegionKinds require #ifdef USE_REGIONS
BookkeepingStart is PER_HEAP_ISOLATED (static), not a per-heap field — changed to a global pointer accessible in both WKS and SERVER_GC builds

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

https://api.github.com/graphql
- Triggering command: /usr/bin/gh gh pr view --json number,headRefName (http block)
- Triggering command: /usr/bin/gh gh pr list --head copilot/implement-memory-region-apis --json number (http block)
- Triggering command: /usr/bin/gh gh pr list --head copilot/implement-memory-region-apis (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

rcj1 · 2026-02-28T15:33:34Z

@copilot still broken
/__w/1/s/src/coreclr/gc/datadescriptor/datadescriptor.inc:150:57: error: use of undeclared identifier 'count_free_region_kinds'

…unt_free_region_kinds Co-authored-by: rcj1 <77995559+rcj1@users.noreply.github.com>

Copilot · 2026-02-28T15:39:45Z

@copilot still broken
/__w/1/s/src/coreclr/gc/datadescriptor/datadescriptor.inc:150:57: error: use of undeclared identifier 'count_free_region_kinds'

Fixed in b3ddcf19. count_free_region_kinds is an enum defined inside the GC_NAMESPACE namespace (via gcpriv.h), so it's not visible at the datadescriptor.inc expansion scope. Replaced with FREE_REGION_KINDS, the equivalent macro defined at global scope in gcinterface.dac.h. There's a static_assert in gcpriv.h confirming they're always equal.

max-charlamb

@copilot address feedback

src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Legacy/SOSDacImpl.cs

max-charlamb · 2026-02-27T15:20:13Z

src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Legacy/SOSDacImpl.cs

+            }
+        }
+
+        int ISOSMemoryEnum.Next(uint count, SOSMemoryRegion[] memRegion, uint* pNeeded)


Can we handle a nullptr passed to memRegion like the DAC could?

Fixed in 99dd6293. Added if (memRegion is null) return HResults.E_POINTER; check before accessing the array.

src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Legacy/SOSDacImpl.cs

docs/design/datacontracts/GC.md

…egion, add #DEBUG blocks, fix GC.md docs Co-authored-by: max-charlamb <44248479+max-charlamb@users.noreply.github.com>

Copilot · 2026-03-02T19:08:30Z

@copilot address feedback

All five feedback items addressed in 99dd6293:

ToClrDataAddress conversion helper in SOSMemoryEnum constructor
Null check for memRegion in Next()
#DEBUG validation blocks on all three API methods
Removed BookkeepingStart from GCHeap fields table (global pointer only)
Renamed GCHeapBookkeepingStart → BookkeepingStart in globals table and pseudocode

max-charlamb · 2026-03-02T22:02:19Z

@copilot, can you add cDAC dumptests for these three new APIs

…MemoryRegions, GetGCFreeRegions Co-authored-by: max-charlamb <44248479+max-charlamb@users.noreply.github.com>

Copilot · 2026-03-02T22:19:49Z

@copilot, can you add cDAC dumptests for these three new APIs

Added in f9672e8e. Three dump tests added to each of ServerGCDumpTests.cs and WorkstationGCDumpTests.cs:

GetHandleTableMemoryRegions — asserts at least one region with non-null start and non-zero size
GetGCBookkeepingMemoryRegions — asserts at least one region with non-null start and non-zero size
GetGCFreeRegions — validates any returned regions have non-null start and non-zero size (count may be zero)

Initial plan

34f599c

Copilot AI assigned Copilot and max-charlamb Feb 26, 2026

Copilot started work on behalf of max-charlamb February 26, 2026 22:09 View session

github-actions bot added the area-Diagnostics-coreclr label Feb 26, 2026

Copilot AI and others added 4 commits February 26, 2026 22:41

Add ISOSMemoryEnum/SOSMemoryRegion interfaces and GC data descriptors…

50cb033

… for memory region types Co-authored-by: max-charlamb <44248479+max-charlamb@users.noreply.github.com>

Add managed Data classes, DataType entries, Constants.Globals, IGCHea…

04b43d8

…p free region fields, and IGC contract methods Co-authored-by: max-charlamb <44248479+max-charlamb@users.noreply.github.com>

Implement GC_1 memory region methods, SOSMemoryEnum class, and SOSDac…

4f6b717

…Impl integration Co-authored-by: max-charlamb <44248479+max-charlamb@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Implement native cDAC Memory Region APIs~~ Implement cDAC Memory Region APIs (GetHandleTableMemoryRegions, GetGCBookkeepingMemoryRegions, GetGCFreeRegions) Feb 26, 2026

Copilot finished work on behalf of max-charlamb February 26, 2026 23:06

Copilot started work on behalf of max-charlamb February 26, 2026 23:18 View session

Changes before error encountered

2c5d3f5

Co-authored-by: max-charlamb <44248479+max-charlamb@users.noreply.github.com>

Copilot started work on behalf of rcj1 February 27, 2026 01:43 View session

Add edge-case tests: empty buckets, multiple segments, multiple bookk…

50041df

…eeping entries, empty/multiple free regions Co-authored-by: rcj1 <77995559+rcj1@users.noreply.github.com>

Copilot finished work on behalf of rcj1 February 27, 2026 01:54

rcj1 reviewed Feb 27, 2026

View reviewed changes

Copilot started work on behalf of rcj1 February 27, 2026 02:34 View session

Use TotalCpuCount instead of GetGCHeapCount for handle table slot lim…

6320ebd

…it in server GC Co-authored-by: rcj1 <77995559+rcj1@users.noreply.github.com>

Copilot finished work on behalf of rcj1 February 27, 2026 02:43

Copilot started work on behalf of rcj1 February 27, 2026 02:43 View session

rcj1 marked this pull request as ready for review February 27, 2026 02:44

Copilot AI review requested due to automatic review settings February 27, 2026 02:44

Copilot AI and others added 5 commits February 27, 2026 02:54

Revert all previous changes to start fresh from base

0e2f8c9

Co-authored-by: rcj1 <77995559+rcj1@users.noreply.github.com>

Merge remote-tracking branch 'origin/main' into copilot/implement-mem…

7641ef4

…ory-region-apis

Re-implement cDAC Memory Region APIs on top of latest main with PR #1…

8c95b43

…24875 infrastructure Co-authored-by: rcj1 <77995559+rcj1@users.noreply.github.com>

Update GC.md documentation with new API types, data descriptors, glob…

d4af9be

…als, and pseudocode Co-authored-by: rcj1 <77995559+rcj1@users.noreply.github.com>

Copilot finished work on behalf of rcj1 February 27, 2026 03:27

Copilot started work on behalf of rcj1 February 27, 2026 04:22 View session

Copilot finished work on behalf of rcj1 February 27, 2026 04:41

build-analysis bot mentioned this pull request Feb 27, 2026

[android][arm64] System.Net.Sockets.Tests.SendTo_SyncForceNonBlocking.Datagram_UDP_ShouldImplicitlyBindLocalEndpoint fails with NetworkUnreachable #120526

Open

Copilot started work on behalf of rcj1 February 28, 2026 15:33 View session

Fix build break: use FREE_REGION_KINDS macro instead of namespaced co…

b3ddcf1

…unt_free_region_kinds Co-authored-by: rcj1 <77995559+rcj1@users.noreply.github.com>

Copilot finished work on behalf of rcj1 February 28, 2026 15:41

build-analysis bot mentioned this pull request Feb 28, 2026

[android][clr] No peer certificates when executing System.Net.Http.Functional.Tests on Android emulator #124526

Open

max-charlamb reviewed Mar 2, 2026

View reviewed changes

Copilot started work on behalf of max-charlamb March 2, 2026 18:57 View session

Address review feedback: use ToClrDataAddress helper, null-check memR…

99dd629

…egion, add #DEBUG blocks, fix GC.md docs Co-authored-by: max-charlamb <44248479+max-charlamb@users.noreply.github.com>

Copilot finished work on behalf of max-charlamb March 2, 2026 19:10

Merge branch 'main' into copilot/implement-memory-region-apis

f87a031

Copilot started work on behalf of max-charlamb March 2, 2026 22:12 View session

Add cDAC dump tests for GetHandleTableMemoryRegions, GetGCBookkeeping…

f9672e8

…MemoryRegions, GetGCFreeRegions Co-authored-by: max-charlamb <44248479+max-charlamb@users.noreply.github.com>

Copilot finished work on behalf of max-charlamb March 2, 2026 22:21

Conversation

Copilot AI commented Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Managed interface definitions (ISOSDacInterface.cs)

GC data descriptors (datadescriptor.inc, datadescriptor.h)

Managed Data classes and type registration

IGC contract extension (IGC.cs, GC_1.cs)

SOSMemoryEnum and SOSDacImpl integration

cDAC documentation (GC.md)

Native build fixes

Unit tests (GCMemoryRegionTests.cs)

Dump tests (ServerGCDumpTests.cs, WorkstationGCDumpTests.cs)

Uh oh!

dotnet-policy-service bot commented Feb 26, 2026

Uh oh!

max-charlamb commented Feb 26, 2026

Uh oh!

rcj1 commented Feb 27, 2026

Uh oh!

Copilot AI commented Feb 27, 2026

Uh oh!

rcj1 Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

rcj1 commented Feb 27, 2026

Uh oh!

rcj1 commented Feb 27, 2026

Uh oh!

Copilot AI commented Feb 27, 2026

Uh oh!

rcj1 commented Feb 27, 2026

Uh oh!

Copilot AI commented Feb 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

rcj1 commented Feb 28, 2026

Uh oh!

Copilot AI commented Feb 28, 2026

Uh oh!

max-charlamb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

max-charlamb Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Mar 2, 2026

Uh oh!

max-charlamb commented Mar 2, 2026

Uh oh!

Copilot AI commented Mar 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Feb 26, 2026 •

edited

Loading

Managed interface definitions (`ISOSDacInterface.cs`)

GC data descriptors (`datadescriptor.inc`, `datadescriptor.h`)

IGC contract extension (`IGC.cs`, `GC_1.cs`)

cDAC documentation (`GC.md`)

Unit tests (`GCMemoryRegionTests.cs`)

Dump tests (`ServerGCDumpTests.cs`, `WorkstationGCDumpTests.cs`)

Copilot AI commented Feb 27, 2026 •

edited

Loading