TypeMap API (Dynamic implementation) #113954

AaronRobinsonMSFT · 2025-03-26T23:57:49Z

Definition of TypeMaps APIs in BCL
CoreCLR implementation of TypeMap APIs

Contributes to #110691

Definition of TypeMaps APIs in BCL CoreCLR implementation of TypeMap APIs

dotnet-issue-labeler · 2025-03-26T23:57:54Z

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

dotnet-issue-labeler · 2025-03-26T23:57:55Z

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

dotnet-policy-service · 2025-03-26T23:58:35Z

Tagging subscribers to this area: @dotnet/interop-contrib
See info in area-owners.md if you want to be subscribed.

AaronRobinsonMSFT · 2025-03-26T23:59:38Z

/cc @jkotas @MichalStrehovsky @jkoritzinsky @stephentoub @simonrozsival @ivanpovazan

src/coreclr/vm/assemblynative.cpp

src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapping.cs

...libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapLazyDictionary.cs

Copilot

Pull Request Overview

This PR implements the dynamic TypeMap API in the BCL with CoreCLR support and introduces new test cases to validate both external and proxy type mappings. Key changes include adding comprehensive tests in TypeMapApp.cs and related libraries, providing the API definitions and implementation in System.Runtime.InteropServices, and introducing lazy dictionaries for efficient type map creation.

Reviewed Changes

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

Show a summary per file

File	Description
src/tests/Interop/TypeMap/TypeMapApp.cs	Adds tests for external and proxy type mapping functionality
src/tests/Interop/TypeMap/Lib3.cs, Lib4.cs, GroupTypes.cs	Provides supporting types and assembly attributes for type mapping
src/libraries/System.Runtime.InteropServices/ref/System.Runtime.InteropServices.cs	Updates API definitions for TypeMap and related attributes
src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapping.cs	Implements the core TypeMapping API using lazy initialization
src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapLazyDictionary.cs	Implements lazy dictionaries for external and proxy type mappings
src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapAttribute*.cs and TypeMapAssemblyTargetAttribute.cs	Adds attribute definitions for type mapping configuration

Files not reviewed (9)

src/coreclr/vm/assemblynative.cpp: Language not supported
src/coreclr/vm/assemblynative.hpp: Language not supported
src/coreclr/vm/qcallentrypoints.cpp: Language not supported
src/libraries/System.Private.CoreLib/src/System.Private.CoreLib.Shared.projitems: Language not supported
src/tests/Interop/TypeMap/TypeMapApp.csproj: Language not supported
src/tests/Interop/TypeMap/TypeMapLib1.csproj: Language not supported
src/tests/Interop/TypeMap/TypeMapLib2.csproj: Language not supported
src/tests/Interop/TypeMap/TypeMapLib3.csproj: Language not supported
src/tests/Interop/TypeMap/TypeMapLib4.csproj: Language not supported

...libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapLazyDictionary.cs

src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapping.cs

...libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapLazyDictionary.cs

jkotas · 2025-03-27T23:36:31Z

...libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapLazyDictionary.cs

+        [RequiresUnreferencedCode("Lazy TypeMap isn't supported for Trimmer scenarios")]
+        private sealed class LazyProxyTypeDictionary : LazyTypeLoadDictionary<Type>
+        {
+            // We don't include the assembly name for the hash code since it is not


The FullName can include assembly names for generic components. Do we need to filter out the assembly names for the generic components here?

Yes, we do. That is a going to be a complication, I think.

...libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapLazyDictionary.cs

src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapping.cs

src/coreclr/vm/assemblynative.cpp

jkotas · 2025-03-28T00:01:21Z

Did you have a chance to check the perf of the type map building at runtime? What's the typical time and memory cost of a single entry?

Remove assembly name check on add.

src/tests/Interop/TypeMap/TypeMapApp.cs

...ies/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapAssociationAttribute.cs

src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapAttribute.cs

...ies/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapAssociationAttribute.cs

src/libraries/System.Runtime.InteropServices/ref/System.Runtime.InteropServices.cs

src/coreclr/vm/assemblynative.cpp

Add tests.

Add test cases. Instantiated generic type is currently broken.

Copilot

Pull Request Overview

This PR introduces a dynamic implementation of the TypeMap API within the BCL, together with corresponding tests and updates to supporting assemblies and reference libraries.

Added extensive tests in TypeMapApp.cs to validate both external and proxy type mappings.
Introduced new assembly attributes in Lib3.cs and Lib4.cs to facilitate mapping resolution across multiple assemblies and detect circular references.
Updated TypeMap attribute definitions and related TypeMapping implementation in System.Private.CoreLib and reference assemblies, with modifications in System.Reflection.Metadata to support the new API.

Reviewed Changes

Copilot reviewed 15 out of 23 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/tests/Interop/TypeMap/TypeMapApp.cs	New tests and assembly attribute definitions for dynamic TypeMap API validation.
src/tests/Interop/TypeMap/Lib3.cs, Lib4.cs, Lib2.cs, GroupTypes.cs	New type definitions and mapping assemblies to support the new API functionalities including circular reference checks.
src/libraries/System.Runtime.InteropServices/ref/System.Runtime.InteropServices.cs	Updated public API definitions to include new TypeMap attributes and TypeMapping helper methods.
src/libraries/System.Reflection.Metadata/src/System/Reflection/Metadata/TypeName*.cs	Adjusted implementation details for type name parsing to align with dynamic type mapping.
src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/*	New implementations for TypeMapping and associated attributes aligned with the dynamic API design.

Files not reviewed (8)

src/coreclr/vm/assemblynative.cpp: Language not supported
src/coreclr/vm/assemblynative.hpp: Language not supported
src/coreclr/vm/qcallentrypoints.cpp: Language not supported
src/libraries/System.Private.CoreLib/src/Resources/Strings.resx: Language not supported
src/libraries/System.Private.CoreLib/src/System.Private.CoreLib.Shared.projitems: Language not supported
src/tests/Interop/TypeMap/TypeMapApp.csproj: Language not supported
src/tests/Interop/TypeMap/TypeMapLib1.csproj: Language not supported
src/tests/Interop/TypeMap/TypeMapLib2.csproj: Language not supported

Comments suppressed due to low confidence (1)

src/libraries/System.Reflection.Metadata/src/System/Reflection/Metadata/TypeName.cs:592

Replacing an empty immutable array with null here might lead to null reference issues if later code expects a non-null collection. Consider using ImmutableArray.Empty instead.

genericTypeArguments: null,

jkotas · 2025-03-31T02:26:38Z

...libraries/System.Reflection.Metadata/src/System/Reflection/Metadata/TypeNameParserHelpers.cs

        [DoesNotReturn]
        internal static void ThrowInvalidOperation_NotSimpleName(string fullName)
        {
+            // This message is defined in both System.Private.CoreLib and System.Reflection.Metadata


The pattern used elsewhere is to throw an exception with full message under SYSTEM_REFLECTION_METADATA ifdef. E.g. check SYSTEM_REFLECTION_METADATA ifdef earlier in this file.

I'm not entirely sure I get the utility of the "simple name" check. I would imagine users can place typeof(int[]) as the type, which seems like it would match the notion of "array" mentioned in the check for IsSimple in the TypeName class.

The method will replace the assembly name for the top level TypeName only. It does not produce the expected result for non-simple names - that's why it throws, and it is not clear what the expected result should be once you get to generics.

...libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapLazyDictionary.cs

jkotas · 2025-03-31T04:24:39Z

...libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapLazyDictionary.cs

+        {
+            public void* Utf8TypeName { get; init; }
+            public int Utf8TypeNameLen { get; init; }
+            public void* Utf8AssemblyNameFallback { get; init; }


Instead of storing assembly name, it may be better to just store RuntimeAssembly here and then call TypeNameResolver.GetTypeHelper to resolve the type. TypeNameResolver.GetTypeHelper is the method that is used to resolve type name in attributes and it will substitute the assembly name as needed. We won't need to worry about substituting the assembly name here or making sure that it is done exactly same way.

...libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapLazyDictionary.cs

AaronRobinsonMSFT added 2 commits March 26, 2025 16:55

TypeMap API (Dynamic implementation)

bd76011

Definition of TypeMaps APIs in BCL CoreCLR implementation of TypeMap APIs

Add basic tests

a2bfc27

AaronRobinsonMSFT added the area-System.Runtime.InteropServices label Mar 26, 2025

AaronRobinsonMSFT added this to the 10.0.0 milestone Mar 26, 2025

dotnet-issue-labeler bot added the new-api-needs-documentation label Mar 26, 2025

dotnet-policy-service bot assigned AaronRobinsonMSFT Mar 26, 2025

AaronRobinsonMSFT mentioned this pull request Mar 26, 2025

Interop Type Mapping #110691

Open

8 tasks

AaronRobinsonMSFT commented Mar 27, 2025

View reviewed changes

src/coreclr/vm/assemblynative.cpp Outdated Show resolved Hide resolved

AaronRobinsonMSFT commented Mar 27, 2025

View reviewed changes

src/coreclr/vm/assemblynative.cpp Outdated Show resolved Hide resolved

AaronRobinsonMSFT commented Mar 27, 2025

View reviewed changes

src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapping.cs Outdated Show resolved Hide resolved

AaronRobinsonMSFT commented Mar 27, 2025

View reviewed changes

src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapping.cs Outdated Show resolved Hide resolved

AaronRobinsonMSFT commented Mar 27, 2025

View reviewed changes

...libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapLazyDictionary.cs Outdated Show resolved Hide resolved

AaronRobinsonMSFT commented Mar 27, 2025

View reviewed changes

...libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapLazyDictionary.cs Outdated Show resolved Hide resolved

AaronRobinsonMSFT added 2 commits March 27, 2025 12:00

Feedback and fixes from testing.

7ed138b

Testing for all attributes

2205ac8

AaronRobinsonMSFT marked this pull request as ready for review March 27, 2025 19:02

AaronRobinsonMSFT requested a review from Copilot March 27, 2025 19:02

Copilot AI reviewed Mar 27, 2025

View reviewed changes

...libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapLazyDictionary.cs Show resolved Hide resolved

build-analysis bot mentioned this pull request Mar 27, 2025

System.Net.Requests test timeout #113883

Open

jkotas reviewed Mar 27, 2025

View reviewed changes

src/coreclr/vm/assemblynative.cpp Outdated Show resolved Hide resolved

build-analysis bot mentioned this pull request Mar 28, 2025

System.Net.Quic.Tests.MsQuicTests.WriteTests failed with "System.Net.Quic.QuicException : The connection timed out from inactivity." #105177

Open

Convert Tuple<,> to private type.

91862d1

Remove assembly name check on add.

jkotas reviewed Mar 28, 2025

View reviewed changes

src/tests/Interop/TypeMap/TypeMapApp.cs Show resolved Hide resolved

MichalStrehovsky reviewed Mar 28, 2025

View reviewed changes

AaronRobinsonMSFT added 2 commits March 28, 2025 17:50

Feedback pass 1

cf32158

Always fallback and validate TypeSpec.

60e18c9

jkotas reviewed Mar 29, 2025

View reviewed changes

src/coreclr/vm/assemblynative.cpp Outdated Show resolved Hide resolved

jkotas reviewed Mar 29, 2025

View reviewed changes

src/coreclr/vm/assemblynative.cpp Show resolved Hide resolved

AaronRobinsonMSFT added 2 commits March 28, 2025 18:30

Handle exceptions from managed callbacks.

fb1e1a6

Add tests.

Convert assert to explicit check for TypeSpec.

04d9b10

This was referenced Mar 29, 2025

[QUIC & HTTP/3] Handshake Timeout on tests #104426

Open

ProcessThreadTests.TestStartTimeProperty failure in CI #105526

Open

Delay parsing contents until needed.

49c5ad6

Add test cases. Instantiated generic type is currently broken.

AaronRobinsonMSFT requested a review from Copilot March 30, 2025 21:50

Copilot AI reviewed Mar 30, 2025

View reviewed changes

AaronRobinsonMSFT mentioned this pull request Mar 30, 2025

[API Proposal]: Type Mapping API #113362

Open

build-analysis bot mentioned this pull request Mar 30, 2025

Intermittent build failure in AfterSourceBuild: "Could not write state file" #76488

Open

jkotas reviewed Mar 31, 2025

View reviewed changes

...libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapLazyDictionary.cs Show resolved Hide resolved

AaronRobinsonMSFT added 2 commits March 30, 2025 20:15

Fix build

479c15b

Call Return on ArrayPool array.

e7f9e6a

jkotas reviewed Mar 31, 2025

View reviewed changes

...libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapLazyDictionary.cs Outdated Show resolved Hide resolved

jkotas reviewed Mar 31, 2025

View reviewed changes

...libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapLazyDictionary.cs Outdated Show resolved Hide resolved

jkotas reviewed Mar 31, 2025

View reviewed changes

...libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/TypeMapLazyDictionary.cs Show resolved Hide resolved

AaronRobinsonMSFT added 3 commits March 30, 2025 21:47

Remove unnecessary lock.

eb9e9e2

Stop processing on error.

380b809

Use GetMaxCharCount to estimate needed buffer length.

e94234f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TypeMap API (Dynamic implementation) #113954

TypeMap API (Dynamic implementation) #113954

AaronRobinsonMSFT commented Mar 26, 2025

dotnet-issue-labeler bot commented Mar 26, 2025

dotnet-issue-labeler bot commented Mar 26, 2025

dotnet-policy-service bot commented Mar 26, 2025

AaronRobinsonMSFT commented Mar 26, 2025

Copilot AI left a comment

jkotas Mar 27, 2025

AaronRobinsonMSFT Mar 29, 2025

jkotas commented Mar 28, 2025

Copilot AI left a comment

jkotas Mar 31, 2025 •

edited

Loading

AaronRobinsonMSFT Mar 31, 2025

jkotas Mar 31, 2025 •

edited

Loading

jkotas Mar 31, 2025 •

edited

Loading

TypeMap API (Dynamic implementation) #113954

Are you sure you want to change the base?

TypeMap API (Dynamic implementation) #113954

Conversation

AaronRobinsonMSFT commented Mar 26, 2025

dotnet-issue-labeler bot commented Mar 26, 2025

dotnet-issue-labeler bot commented Mar 26, 2025

dotnet-policy-service bot commented Mar 26, 2025

AaronRobinsonMSFT commented Mar 26, 2025

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

jkotas Mar 27, 2025

Choose a reason for hiding this comment

AaronRobinsonMSFT Mar 29, 2025

Choose a reason for hiding this comment

jkotas commented Mar 28, 2025

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

jkotas Mar 31, 2025 • edited Loading

Choose a reason for hiding this comment

AaronRobinsonMSFT Mar 31, 2025

Choose a reason for hiding this comment

jkotas Mar 31, 2025 • edited Loading

Choose a reason for hiding this comment

jkotas Mar 31, 2025 • edited Loading

Choose a reason for hiding this comment

jkotas Mar 31, 2025 •

edited

Loading

jkotas Mar 31, 2025 •

edited

Loading

jkotas Mar 31, 2025 •

edited

Loading