[RGen] Generate the post conversion calls for the native invoker. #23019

mandel-macaque · 2025-06-10T18:03:52Z

Creates any call that has to be executed after the call to the native invoker, in most of the cases we need to add a GC.KeepAlive to ensure that the handle is not removed by the GC while it is in used by the native code.

The changes will get the native object representations (string -> NSString) so that we can call the native invoker.

Creates any call that has to be executed after the call to the native invoker, in most of the cases we need to add a GC.KeepAlive to ensure that the handle is not removed by the GC while it is in used by the native code.

Copilot

Pull Request Overview

This PR adds post-invoke GC.KeepAlive generation for trampoline parameters and updates existing property emitters to use the new helper.

Introduces GetTrampolinePostNativeInvokeArgumentConversions to emit GC.KeepAlive calls for managed-to-native parameters.
Adds a KeepAlive helper in BindingSyntaxFactory.Runtime and wires it through KnownTypes and ClassEmitter.
Updates all expected-property-test files to fully qualify global::System.GC.KeepAlive.

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
tests/rgen/.../BindingSyntaxFactoryTrampolineTests.cs	New data-driven tests for post-native-invoke `GC.KeepAlive` logic
tests/rgen/.../tvOSExpectedPropertyTests.cs (and other platform variants)	Updated expected outputs to use `global::System.GC.KeepAlive`
src/rgen/.../Emitters/ClassEmitter.cs	Replaced inline `GC.KeepAlive(this)` with the `KeepAlive` helper
src/rgen/.../Emitters/BindingSyntaxFactory.Trampoline.cs	Added `GetTrampolinePostNativeInvokeArgumentConversions` switch
src/rgen/.../Emitters/BindingSyntaxFactory.Runtime.cs	Added `KeepAlive(string)` invocation helper
src/rgen/.../Emitters/BindingSyntaxFactory.KnownTypes.cs	Introduced a `GC` `TypeSyntax` reference for code generation

Comments suppressed due to low confidence (1)

tests/rgen/Microsoft.Macios.Generator.Tests/Emitters/BindingSyntaxFactoryTrampolineTests.cs:4627

Add a test case for IsProtocol parameters to ensure that GetTrampolinePostNativeInvokeArgumentConversions correctly emits a GC.KeepAlive call for protocol-bound objects.

Copilot · 2025-06-10T18:36:07Z

src/rgen/Microsoft.Macios.Generator/Emitters/ClassEmitter.cs

 	{ExpressionStatement (invocations.Getter.SendSuper)}
 }}
-GC.KeepAlive (this);
+{KeepAlive ("this")};


[nitpick] Consider wrapping the KeepAlive invocation in an ExpressionStatement (e.g., ExpressionStatement(KeepAlive("this"))) instead of inserting a raw invocation with a semicolon. This will align with how other generated statements are formatted and reuse the existing helper.

Suggested change

{KeepAlive ("this")};

{ExpressionStatement(KeepAlive("this"))};

Copilot · 2025-06-10T18:36:08Z

src/rgen/Microsoft.Macios.Generator/Emitters/BindingSyntaxFactory.Trampoline.cs

+	{
+		// decide the type of conversion we need to do based on the type of the parameter
+#pragma warning disable format
+		return parameter.Type switch { 


[nitpick] Several cases emit identical KeepAlive calls for different types (e.g., string arrays, NSObject/INativeObject arrays). You might consolidate these patterns—group array element handling or merge the NSObject/INativeObject paths—to reduce duplication and simplify the switch.

dartasen · 2025-06-11T11:16:42Z

src/rgen/Microsoft.Macios.Generator/Emitters/BindingSyntaxFactory.Trampoline.cs

+					Nomenclator.GetNameForVariableType (parameter.Name, Nomenclator.VariableType.BindFrom)!
+				))],
+
+			// boolean, convert it to byte


comment seems wrong

vs-mobiletools-engineering-service2 · 2025-06-11T16:57:12Z

✅ [CI Build #9946845] Build passed (Build packages) ✅

Pipeline on Agent
Hash: 9946845e0e29b777da613d3d9a59d53c0faa9d71 [PR build]

vs-mobiletools-engineering-service2 · 2025-06-11T16:58:56Z

✅ [PR Build #9946845] Build passed (Detect API changes) ✅

Pipeline on Agent
Hash: 9946845e0e29b777da613d3d9a59d53c0faa9d71 [PR build]

vs-mobiletools-engineering-service2 · 2025-06-11T17:25:46Z

✅ API diff for current PR / commit

.NET ( No breaking changes )

iOS: vsdrops gist ( No breaking changes )
tvOS: vsdrops gist ( No breaking changes )
MacCatalyst: vsdrops gist ( No breaking changes )
macOS: vsdrops gist ( No breaking changes )

✅ API diff vs stable

.NET ( No breaking changes )

iOS: vsdrops gist ( No breaking changes )
tvOS: vsdrops gist ( No breaking changes )
MacCatalyst: vsdrops gist ( No breaking changes )
macOS: vsdrops gist ( No breaking changes )

ℹ️ Generator diff

Generator Diff: vsdrops (html) vsdrops (raw diff) gist (raw diff) - Please review changes)

Pipeline on Agent
Hash: 9946845e0e29b777da613d3d9a59d53c0faa9d71 [PR build]

vs-mobiletools-engineering-service2 · 2025-06-11T18:03:49Z

✅ [CI Build #9946845] Build passed (Build macOS tests) ✅

Pipeline on Agent
Hash: 9946845e0e29b777da613d3d9a59d53c0faa9d71 [PR build]

vs-mobiletools-engineering-service2 · 2025-06-11T18:18:13Z

💻 [CI Build #9946845] Tests on macOS X64 - Mac Sonoma (14) passed 💻

✅ All tests on macOS X64 - Mac Sonoma (14) passed.

Pipeline on Agent
Hash: 9946845e0e29b777da613d3d9a59d53c0faa9d71 [PR build]

vs-mobiletools-engineering-service2 · 2025-06-11T18:22:07Z

💻 [CI Build #9946845] Tests on macOS M1 - Mac Monterey (12) passed 💻

✅ All tests on macOS M1 - Mac Monterey (12) passed.

Pipeline on Agent
Hash: 9946845e0e29b777da613d3d9a59d53c0faa9d71 [PR build]

vs-mobiletools-engineering-service2 · 2025-06-11T18:23:23Z

💻 [CI Build #9946845] Tests on macOS arm64 - Mac Sequoia (15) passed 💻

✅ All tests on macOS arm64 - Mac Sequoia (15) passed.

Pipeline on Agent
Hash: 9946845e0e29b777da613d3d9a59d53c0faa9d71 [PR build]

vs-mobiletools-engineering-service2 · 2025-06-11T18:23:56Z

💻 [CI Build #9946845] Tests on macOS M1 - Mac Ventura (13) passed 💻

✅ All tests on macOS M1 - Mac Ventura (13) passed.

Pipeline on Agent
Hash: 9946845e0e29b777da613d3d9a59d53c0faa9d71 [PR build]

vs-mobiletools-engineering-service2 · 2025-06-11T19:44:37Z

🚀 [CI Build #9946845] Test results 🚀

Test results

✅ All tests passed on VSTS: test results.

🎉 All 119 tests passed 🎉

Tests counts

✅ cecil: All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (iOS): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (MacCatalyst): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (macOS): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (Multiple platforms): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (tvOS): All 1 tests passed. Html Report (VSDrops) Download
✅ framework: All 2 tests passed. Html Report (VSDrops) Download
✅ fsharp: All 4 tests passed. Html Report (VSDrops) Download
✅ generator: All 5 tests passed. Html Report (VSDrops) Download
✅ interdependent-binding-projects: All 4 tests passed. Html Report (VSDrops) Download
✅ introspection: All 4 tests passed. Html Report (VSDrops) Download
✅ linker: All 44 tests passed. Html Report (VSDrops) Download
✅ monotouch (iOS): All 8 tests passed. Html Report (VSDrops) Download
✅ monotouch (MacCatalyst): All 15 tests passed. Html Report (VSDrops) Download
✅ monotouch (macOS): All 9 tests passed. Html Report (VSDrops) Download
✅ monotouch (tvOS): All 8 tests passed. Html Report (VSDrops) Download
✅ msbuild: All 2 tests passed. Html Report (VSDrops) Download
✅ windows: All 3 tests passed. Html Report (VSDrops) Download
✅ xcframework: All 4 tests passed. Html Report (VSDrops) Download
✅ xtro: All 1 tests passed. Html Report (VSDrops) Download

Pipeline on Agent
Hash: 9946845e0e29b777da613d3d9a59d53c0faa9d71 [PR build]

mandel-macaque and others added 4 commits June 10, 2025 12:29

[RGen] Generate the lowering of the parameters for the native invoker.

c8de0ce

The changes will get the native object representations (string -> NSString) so that we can call the native invoker.

Auto-format source code

e22dfa4

[RGen] Generate the post conversion calls for the native invoker.

320ffe5

Creates any call that has to be executed after the call to the native invoker, in most of the cases we need to add a GC.KeepAlive to ensure that the handle is not removed by the GC while it is in used by the native code.

Auto-format source code

7a2889a

This comment has been minimized.

Sign in to view

mandel-macaque requested a review from Copilot June 10, 2025 18:33

Copilot AI reviewed Jun 10, 2025

View reviewed changes

This comment has been minimized.

Sign in to view

dalexsoto approved these changes Jun 10, 2025

View reviewed changes

dartasen reviewed Jun 11, 2025

View reviewed changes

rolfbjarne approved these changes Jun 11, 2025

View reviewed changes

Base automatically changed from dev/mandel/pre-native-invoque-conversions to main June 11, 2025 16:20

Address some comments from the reviews.

30c1b73

Merge branch 'main' into dev/mandel/post-native-invoke-conversions

9946845

mandel-macaque merged commit a25dccc into main Jun 11, 2025
42 of 44 checks passed

mandel-macaque deleted the dev/mandel/post-native-invoke-conversions branch June 11, 2025 20:22

	{KeepAlive ("this")};
	{ExpressionStatement(KeepAlive("this"))};

[RGen] Generate the post conversion calls for the native invoker. #23019

[RGen] Generate the post conversion calls for the native invoker. #23019

Uh oh!

Conversation

mandel-macaque commented Jun 10, 2025

Uh oh!

This comment has been minimized.

This comment has been minimized.

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

dartasen Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 11, 2025

✅ [CI Build #9946845] Build passed (Build packages) ✅

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 11, 2025

✅ [PR Build #9946845] Build passed (Detect API changes) ✅

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 11, 2025

✅ API diff for current PR / commit

✅ API diff vs stable

ℹ️ Generator diff

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 11, 2025

✅ [CI Build #9946845] Build passed (Build macOS tests) ✅

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 11, 2025

💻 [CI Build #9946845] Tests on macOS X64 - Mac Sonoma (14) passed 💻

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 11, 2025

💻 [CI Build #9946845] Tests on macOS M1 - Mac Monterey (12) passed 💻

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 11, 2025

💻 [CI Build #9946845] Tests on macOS arm64 - Mac Sequoia (15) passed 💻

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 11, 2025

💻 [CI Build #9946845] Tests on macOS M1 - Mac Ventura (13) passed 💻

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 11, 2025

🚀 [CI Build #9946845] Test results 🚀

Test results

Tests counts

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants