Skip to content

Fall back to MethodTable when generic type resolution produces a placeholder#1416

Merged
max-charlamb merged 1 commit intomicrosoft:mainfrom
max-charlamb:fix/canon-fallback-type
Apr 10, 2026
Merged

Fall back to MethodTable when generic type resolution produces a placeholder#1416
max-charlamb merged 1 commit intomicrosoft:mainfrom
max-charlamb:fix/canon-fallback-type

Conversation

@max-charlamb
Copy link
Copy Markdown
Contributor

When __Canon filtering (introduced in #1373) nulls a field's type and the metadata signature fallback resolves to a ClrGenericType placeholder (e.g. TStateMachine with no fields), fall back to resolving via the field's MethodTable directly.

This handles compiler-generated types nested inside open generic classes (e.g. async state machines in local functions) where GetTypeByName fails because it compares closed-generic names against open-generic TypeDefs.

The MethodTable resolves to __Canon, which restores the pre-#1373 behavior: the field reports IsObjectReference=true, so consumers use ReadObjectField to get the concrete type from the heap.

@max-charlamb max-charlamb marked this pull request as ready for review April 10, 2026 01:38
@max-charlamb max-charlamb requested a review from leculver April 10, 2026 01:38
…eholder

When __Canon filtering (introduced in microsoft#1373) nulls a field's type and
the metadata signature fallback resolves to a ClrGenericType placeholder
(e.g. 'TStateMachine' with no fields), fall back to resolving via the
field's MethodTable directly.

This handles compiler-generated types nested inside open generic classes
(e.g. async state machines in local functions) where GetTypeByName fails
because it compares closed-generic names against open-generic TypeDefs.

The MethodTable resolves to __Canon, which restores the pre-microsoft#1373
behavior: the field reports IsObjectReference=true, so consumers use
ReadObjectField to get the concrete type from the heap.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@max-charlamb max-charlamb force-pushed the fix/canon-fallback-type branch from 2b49b0f to db58d1a Compare April 10, 2026 15:23
@max-charlamb max-charlamb merged commit 58dadbc into microsoft:main Apr 10, 2026
8 checks passed
@max-charlamb max-charlamb deleted the fix/canon-fallback-type branch April 10, 2026 15:29
max-charlamb added a commit to dotnet/runtime that referenced this pull request Apr 14, 2026
## Summary

Fix two reference counting bugs in the legacy DAC's `DefaultCOMImpl`
template class, remove the corresponding compat workaround in the cDAC,
bump clrmd, and implement `CLRDATA_REQUEST_REVISION` in the cDAC.

> [!NOTE]
> This PR description was generated with the help of Copilot.

## Sibling PRs:
- dotnet/diagnostics#5789 (merged) — Bump clrmd
in diagnostics, adapt to 4.x API changes
- microsoft/clrmd#1414 (merged) — Fix
`ParseGenericTypeArgumentNames` for nested generic types
- microsoft/clrmd#1416 (merged) — Fall back to
MethodTable when generic type resolution produces a placeholder

## Bug 1: `Release()` uses post-decrement (dacimpl.h)

`DefaultCOMImpl::Release()` used post-decrement (`mRef--`) instead of
pre-decrement (`--mRef`):

```cpp
// Before (bug):
ULONG res = mRef--;  // captures value BEFORE decrement
if (res == 0)        // never true when mRef was 1
    delete this;     // object is never freed
```

Per the [IUnknown::Release
contract](https://learn.microsoft.com/en-us/windows/win32/api/unknwn/nf-unknwn-iunknown-release),
`Release` must return the **new** reference count and free the object
when it reaches 0. The post-decrement meant objects were never freed — a
memory leak affecting all `DefaultCOMImpl`-derived classes
(`DacHandleWalker`, `DacStackReferenceWalker`, `DacMemoryEnumerator`
subclasses, `DacMethodTableSlotEnumerator`,
`DacStackReferenceErrorEnum`).

## Bug 2: `DacMethodTableSlotEnumerator` missing `QueryInterface`
(request.cpp)

`GetMethodTableSlotEnumerator` returned the object via raw pointer
assignment without calling `QueryInterface`/`AddRef`, leaving `mRef` at
0:

```cpp
// Before (bug):
*enumerator = methodTableSlotEnumerator;  // mRef stays 0
```

Every other `DefaultCOMImpl` subclass correctly uses `QueryInterface`
before returning, which calls `AddRef` to give the caller an owning
reference. Fixed to match that pattern.

## cDAC compat removal (SOSDacImpl.cs)

The cDAC's `GetHandleEnum` and `GetHandleEnumForTypes` previously called
`ComInterfaceMarshaller.ConvertToUnmanaged` to intentionally leak a ref
count, matching the legacy DAC's broken behavior. Now that the legacy
bug is fixed, this compat workaround is removed.

## Version bump and cDAC revision

- Bumps `CLRDATA_REQUEST_REVISION` from 9 to 10 in the legacy DAC so
that ClrMD can detect the fixed ref counting behavior via
`IXCLRDataProcess::Request`.
- Implements `CLRDATA_REQUEST_REVISION` directly in the cDAC's
`SOSDacImpl.IXCLRDataProcess.Request` (with DEBUG validation against the
legacy DAC) so consumers get the correct revision without requiring the
legacy DAC fallback.

## ClrMD bump

Updates `Microsoft.Diagnostics.Runtime` from `3.1.512801` to
`4.0.0-beta.26210.1`. The new version includes:
- CLRDATA_REQUEST_REVISION 10 detection to avoid double-freeing
(microsoft/clrmd#1398)
- `ParseGenericTypeArgumentNames` fix for nested generic types
(microsoft/clrmd#1414)
- `GetTypeByName` cached generic instantiation fix
(microsoft/clrmd#1412)
- Canon fallback to MethodTable for compiler-generated types
(microsoft/clrmd#1416)

## cdacstress.cpp double Release removal

Removes the compensating double `pEnum->Release()` in `CollectStackRefs`
that was working around the broken post-decrement in
`DefaultCOMImpl::Release()`.

---------

Co-authored-by: Max Charlamb <maxcharlamb@microsoft.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants