Implement new COM interop API for RCW/CCW creation/management #32091

AaronRobinsonMSFT · 2020-02-11T03:22:49Z

Implementation of the proposed API found at #1845.

All new tests run and pass on Windows running under COMPlus_GCStress=0xC.

In order to allow code generators to make performant RCW/CCW implementations, the NativeCallableAttribute should be made public and the C# function pointers proposal should be implemented.

TODO:

Complete Peg/Unpeg API implementation.
Remove all new TODOs.
Finish E2E testing provided by the Mock Tracker Runtime project.
Add testing for skip cache scenarios when creating managed wrappers.
Handle build issues on non-Windows platforms.
Remove shutdown logic once Remove unused COM shutdown logic. #32381 is merged in.
Add logging to the runtime side of the interoplib library.
Investigate how the following COM APIs work with this API.
- ~~Marshal.ReleaseComObject()~~ - Properly handled.
- ~~Marshal.FinalReleaseComObject()~~ - Properly handled.
- ~~Marshal.GetIUnknownForObject()~~ - Calling this on a wrapper object created by this new API will passively create an old style CCW. Deferring any changes until customer reported.

Future issues to file:

~~Share additional code between existing RCW/CCW support and new API.~~
Update Marshal.GetIUnknownForObject() and Marshal.GetObjectForIUnknown() to check and possible use the globally registered ComWrappers instance - see Implement new COM interop API for RCW/CCW creation/management #32091 (comment).
- See Marshal.GetIUnknownForObject() and Marshal.GetObjectForIUnknown() should be updated to use ComWrappers API. #33329
Consider removing the existing built-in WinRT support - see Implement new COM interop API for RCW/CCW creation/management #32091 (comment).
- See Remove some WinRT code that was replaced by the new ComWrappers API. #33330.

/cc @jkotas @jkoritzinsky @Scottj1s @davidwrighton

src/coreclr/src/vm/ceemain.cpp

src/coreclr/src/interop/inc/interoplib.h

src/coreclr/src/vm/ceemain.cpp

src/coreclr/src/interop/agilereferences.cpp

src/coreclr/src/interop/comwrappers.cpp

...clr/src/System.Private.CoreLib/src/System/Runtime/CompilerServices/RuntimeHelpers.CoreCLR.cs

src/coreclr/src/dlls/mscorrc/mscorrc.rc

src/coreclr/src/System.Private.CoreLib/src/System/Runtime/InteropServices/ComWrappers.cs

src/coreclr/src/interop/inc/interoplib.h

src/coreclr/src/interop/comwrappers.h

src/coreclr/src/vm/interoplibinterface.cpp

AaronRobinsonMSFT · 2020-02-20T20:18:11Z

All green - w00t! @jkotas and @jkoritzinsky Any more feedback or thoughts? Still waiting for API review, but this is a large PR and will take some time. Thanks.

src/coreclr/src/System.Private.CoreLib/src/System/Runtime/InteropServices/ComWrappers.cs

This reverts commit d0f6a5b04adbaa8e53445e4474780a9182ff8bde.

defined wrapper. This will indicate to skip calling CallObject().

src/coreclr/src/interop/inc/interoplibimports.h

AaronRobinsonMSFT added os-windows area-Interop-coreclr labels Feb 11, 2020

AaronRobinsonMSFT added this to the 5.0 milestone Feb 11, 2020

AaronRobinsonMSFT self-assigned this Feb 11, 2020

jkotas reviewed Feb 11, 2020

View reviewed changes

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

jkotas reviewed Feb 11, 2020

View reviewed changes

src/coreclr/src/interop/inc/interoplib.h Outdated Show resolved Hide resolved

jkotas reviewed Feb 11, 2020

View reviewed changes

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

jkotas reviewed Feb 11, 2020

View reviewed changes

src/coreclr/src/interop/agilereferences.cpp Outdated Show resolved Hide resolved

MichalStrehovsky reviewed Feb 11, 2020

View reviewed changes

src/coreclr/src/interop/comwrappers.cpp Outdated Show resolved Hide resolved

lpereira reviewed Feb 11, 2020

View reviewed changes

...clr/src/System.Private.CoreLib/src/System/Runtime/CompilerServices/RuntimeHelpers.CoreCLR.cs Outdated Show resolved Hide resolved

jkotas reviewed Feb 11, 2020

View reviewed changes

src/coreclr/src/dlls/mscorrc/mscorrc.rc Outdated Show resolved Hide resolved

jkotas reviewed Feb 11, 2020

View reviewed changes

src/coreclr/src/System.Private.CoreLib/src/System/Runtime/InteropServices/ComWrappers.cs Outdated Show resolved Hide resolved

maryamariyan added the new-api-needs-documentation label Feb 12, 2020

AaronRobinsonMSFT force-pushed the winui_rcw_ccw_api branch from 2e9513a to d6ea59a Compare February 13, 2020 01:57

jkotas reviewed Feb 13, 2020

View reviewed changes

src/coreclr/src/interop/inc/interoplib.h Outdated Show resolved Hide resolved

jkotas reviewed Feb 14, 2020

View reviewed changes

src/coreclr/src/interop/comwrappers.h Outdated Show resolved Hide resolved

AaronRobinsonMSFT mentioned this pull request Feb 15, 2020

Remove unused COM shutdown logic. #32381

Merged

AaronRobinsonMSFT force-pushed the winui_rcw_ccw_api branch from 9767961 to 89b87b4 Compare February 15, 2020 23:40

AaronRobinsonMSFT marked this pull request as ready for review February 15, 2020 23:41

jkotas reviewed Feb 16, 2020

View reviewed changes

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

jkotas reviewed Feb 16, 2020

View reviewed changes

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

This was referenced Feb 17, 2020

Reduce the scope of the CCW cache or consider lock free #10787

Closed

NativeCallableAttribute should be a public API #32462

Closed

AaronRobinsonMSFT force-pushed the winui_rcw_ccw_api branch from 9b808da to 7b9871b Compare February 20, 2020 00:15

jkotas reviewed Feb 21, 2020

View reviewed changes

src/coreclr/src/System.Private.CoreLib/src/System/Runtime/InteropServices/ComWrappers.cs Outdated Show resolved Hide resolved

jkotas reviewed Feb 21, 2020

View reviewed changes

src/coreclr/src/System.Private.CoreLib/src/System/Runtime/InteropServices/ComWrappers.cs Outdated Show resolved Hide resolved

jkotas reviewed Feb 21, 2020

View reviewed changes

src/coreclr/src/System.Private.CoreLib/src/System/Runtime/InteropServices/ComWrappers.cs Outdated Show resolved Hide resolved

jkotas reviewed Feb 21, 2020

View reviewed changes

src/coreclr/src/System.Private.CoreLib/src/System/Runtime/InteropServices/ComWrappers.cs Outdated Show resolved Hide resolved

jkotas reviewed Feb 21, 2020

View reviewed changes

src/coreclr/src/System.Private.CoreLib/src/System/Runtime/InteropServices/ComWrappers.cs Outdated Show resolved Hide resolved

AaronRobinsonMSFT added 20 commits March 6, 2020 17:56

Add a ComWrappers feature flag.

8e97865

Remove duplicate entry.

5fa679c

Review feedback.

e836507

Add Type? to the GetOrCreateObjectForComInstance() API call.

e60bce2

Revert "Add Type? to the GetOrCreateObjectForComInstance() API call."

75e8401

This reverts commit d0f6a5b04adbaa8e53445e4474780a9182ff8bde.

Update GetOrCreateObjectForComInstance() to accept 'object?' as the

33194f9

defined wrapper. This will indicate to skip calling CallObject().

Validate failure for reuse of wrapper for external object.

7147244

Fix bug in failure case of attempting to reuse a wrapper.

1d87df4

Remove IAgileReference usage.

17b5404

Apply API review comments.

9cc5ccc

Update test to align with API changes.

1ae8587

Merge conflict.

96fa8cc

Review feedback.

fc2f20a

Add stub for AllocateTypeAssociatedMemory() in Mono build.

9c4ecd5

Style and name.

bc25078

Move RuntimeHelpers.AllocateTypeAssociatedMemory tests to src/libraries.

d96ef4b

Missed static

bfa455d

Skip tests on Mono.

b7c5c44

Unit test fix for RuntimeHelpers.AllocateTypeAssociatedMemory().

f305cb0

Bad merge on rebase.

642ca9b

AaronRobinsonMSFT force-pushed the winui_rcw_ccw_api branch from 27770f0 to 642ca9b Compare March 7, 2020 02:30

Minor rewording for the interoplib interface.

fa45add

jkotas reviewed Mar 7, 2020

View reviewed changes

src/coreclr/src/interop/inc/interoplibimports.h Outdated Show resolved Hide resolved

Feedback on naming.

c7c6839

This was referenced Mar 7, 2020

Marshal.GetIUnknownForObject() and Marshal.GetObjectForIUnknown() should be updated to use ComWrappers API. #33329

Closed

Remove some WinRT code that was replaced by the new ComWrappers API. #33330

Closed

AaronRobinsonMSFT merged commit b41296a into dotnet:master Mar 7, 2020

AaronRobinsonMSFT deleted the winui_rcw_ccw_api branch March 7, 2020 07:38

JeremyKuhne mentioned this pull request Oct 19, 2020

Using source generators for interop dotnet/winforms#4136

Closed

ghost locked as resolved and limited conversation to collaborators Dec 10, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Implement new COM interop API for RCW/CCW creation/management #32091

Implement new COM interop API for RCW/CCW creation/management #32091

Uh oh!

AaronRobinsonMSFT commented Feb 11, 2020 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AaronRobinsonMSFT commented Feb 20, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Implement new COM interop API for RCW/CCW creation/management #32091

Implement new COM interop API for RCW/CCW creation/management #32091

Uh oh!

Conversation

AaronRobinsonMSFT commented Feb 11, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AaronRobinsonMSFT commented Feb 20, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AaronRobinsonMSFT commented Feb 11, 2020 •

edited

Loading