[tools] Mark the Invoke methods for the type to create block proxies when using the static registrar. by rolfbjarne · Pull Request #24344 · dotnet/macios

rolfbjarne · 2025-12-01T22:20:38Z

Add a custom linker step to mark the Invoke method for the type pointed to by
the DelegateProxy attribute, because this method may only be referenced from
the native code the static registrar generates.

Fixes the following test failure for the "Release (all optimizations)" test variation:

MonoTouchFixtures.ObjCRuntime.RegistrarTest
    [FAIL] BlockReturnTest : ObjCRuntime.RuntimeException : Invalid DelegateProxyAttribute for the return value for the method MonoTouchFixtures.ObjCRuntime.RegistrarTest+BlockReturnTestClass.MethodReturningBlock: DelegateType (ObjCRuntime.Trampolines+SDRegistrarTestBlock) specifies a type without a 'Handler' field. Please file a bug report at https://github.com/dotnet/macios/issues/new.
           at ObjCRuntime.BlockLiteral.GetBlockForDelegate(MethodInfo , Object , UInt32 , String )
           at ObjCRuntime.Runtime.CreateDelegateProxy(IntPtr , IntPtr , IntPtr , UInt32 )
           at ObjCRuntime.Runtime.create_delegate_proxy(IntPtr method, IntPtr block, IntPtr signature, UInt32 token_ref, IntPtr* exception_gchandle)
        --- End of stack trace from previous location ---
           at ObjCRuntime.Runtime.RethrowManagedException(IntPtr )
           at ObjCRuntime.Runtime.rethrow_managed_exception(IntPtr original_exception_gchandle, IntPtr* exception_gchandle)
           at Bindings.Test.ObjCRegistrarTest.TestBlocks()
           at MonoTouchFixtures.ObjCRuntime.RegistrarTest.BlockReturnTest()
           at System.Reflection.MethodBaseInvoker.InterpretedInvoke_Method(Object obj, IntPtr* args)
           at System.Reflection.MethodBaseInvoker.InvokeWithNoArgs(Object , BindingFlags )

…when using the static registrar. Add a custom linker step to mark the Invoke method for the type pointed to by the DelegateProxy attribute, because this method may only be referenced from the native code the static registrar generates. Fixes the following test failure for the "Release (all optimizations)" test variation: MonoTouchFixtures.ObjCRuntime.RegistrarTest [FAIL] BlockReturnTest : ObjCRuntime.RuntimeException : Invalid DelegateProxyAttribute for the return value for the method MonoTouchFixtures.ObjCRuntime.RegistrarTest+BlockReturnTestClass.MethodReturningBlock: DelegateType (ObjCRuntime.Trampolines+SDRegistrarTestBlock) specifies a type without a 'Handler' field. Please file a bug report at https://github.com/dotnet/macios/issues/new. at ObjCRuntime.BlockLiteral.GetBlockForDelegate(MethodInfo , Object , UInt32 , String ) at ObjCRuntime.Runtime.CreateDelegateProxy(IntPtr , IntPtr , IntPtr , UInt32 ) at ObjCRuntime.Runtime.create_delegate_proxy(IntPtr method, IntPtr block, IntPtr signature, UInt32 token_ref, IntPtr* exception_gchandle) --- End of stack trace from previous location --- at ObjCRuntime.Runtime.RethrowManagedException(IntPtr ) at ObjCRuntime.Runtime.rethrow_managed_exception(IntPtr original_exception_gchandle, IntPtr* exception_gchandle) at Bindings.Test.ObjCRegistrarTest.TestBlocks() at MonoTouchFixtures.ObjCRuntime.RegistrarTest.BlockReturnTest() at System.Reflection.MethodBaseInvoker.InterpretedInvoke_Method(Object obj, IntPtr* args) at System.Reflection.MethodBaseInvoker.InvokeWithNoArgs(Object , BindingFlags )

Copilot

Pull request overview

This PR adds a custom linker step to preserve Invoke methods in delegate proxy types when using the static registrar with block literal optimizations. This prevents the linker from removing methods that are only referenced from native code generated by the static registrar, fixing a test failure in the "Release (all optimizations)" test variation where the Invoke method was being trimmed away.

Key changes:

Added a new MarkForStaticRegistrar linker step to mark delegate proxy Invoke methods for preservation
Refactored GetDelegateProxyType to work without an ObjCMethod instance for use from the linker
Added error handling and a new error code (MX8060) for missing Invoke methods

Reviewed changes

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

Show a summary per file

File	Description
tools/dotnet-linker/MarkForStaticRegistrar.cs	New linker step to mark delegate proxy `Invoke` methods for preservation when using the static registrar
tools/dotnet-linker/Steps/MarkDispatcher.cs	Integrates the new `MarkForStaticRegistrar` step into the linker pipeline
tools/common/StaticRegistrar.cs	Refactors `GetDelegateProxyType` to support calling without an `ObjCMethod` instance; adds `CollectAllProtocolsInHierarchy` helper; makes `GetExportAttribute` public for linker access
src/ObjCRuntime/Registrar.cs	Changes `GetExportAttribute(TMethod)` visibility from protected to public to allow access from the linker step
src/ObjCRuntime/Blocks.cs	Adds explicit error handling for missing `Invoke` methods instead of allowing NullReferenceException
tools/mtouch/Errors.resx	Adds new error message MX8060 for missing `Invoke` method in delegate proxy types

You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

Copilot · 2025-12-01T22:30:33Z

tools/common/StaticRegistrar.cs

+		List<TypeDefinition> CollectAllProtocolsInHierarchy (TypeDefinition type, List<TypeDefinition>? allProtocols = null)
+		{
+			var rv = new List<TypeDefinition> ();
+			CollectInterfaces (ref rv, type);
+			return rv;
+		}


The allProtocols parameter in the method signature is unused. The method always creates a new list and doesn't use the parameter at all. Either remove the parameter or use it as the initial list if provided.

tools/common/StaticRegistrar.cs

vs-mobiletools-engineering-service2 · 2025-12-02T10:07:10Z

✅ [CI Build #88e08d7] Build passed (Build packages) ✅

Pipeline on Agent
Hash: 88e08d7d25ab0d863c77e42e5d268e3779e89130 [PR build]

vs-mobiletools-engineering-service2 · 2025-12-02T10:08:30Z

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

Pipeline on Agent
Hash: 88e08d7d25ab0d863c77e42e5d268e3779e89130 [PR build]

vs-mobiletools-engineering-service2 · 2025-12-02T10:35:04Z

✅ API diff for current PR / commit

NET (empty diffs)

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 (empty diffs)

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: 88e08d7d25ab0d863c77e42e5d268e3779e89130 [PR build]

vs-mobiletools-engineering-service2 · 2025-12-02T10:42:36Z

✅ [CI Build #88e08d7] Build passed (Build macOS tests) ✅

Pipeline on Agent
Hash: 88e08d7d25ab0d863c77e42e5d268e3779e89130 [PR build]

vs-mobiletools-engineering-service2 · 2025-12-02T10:53:26Z

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

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

Pipeline on Agent
Hash: 88e08d7d25ab0d863c77e42e5d268e3779e89130 [PR build]

vs-mobiletools-engineering-service2 · 2025-12-02T10:59:40Z

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

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

Pipeline on Agent
Hash: 88e08d7d25ab0d863c77e42e5d268e3779e89130 [PR build]

vs-mobiletools-engineering-service2 · 2025-12-02T11:01:08Z

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

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

Pipeline on Agent
Hash: 88e08d7d25ab0d863c77e42e5d268e3779e89130 [PR build]

vs-mobiletools-engineering-service2 · 2025-12-02T11:03:52Z

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

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

Pipeline on Agent
Hash: 88e08d7d25ab0d863c77e42e5d268e3779e89130 [PR build]

vs-mobiletools-engineering-service2 · 2025-12-02T11:07:20Z

💻 [CI Build #88e08d7] Tests on macOS arm64 - Mac Tahoe (26) passed 💻

✅ All tests on macOS arm64 - Mac Tahoe (26) passed.

Pipeline on Agent
Hash: 88e08d7d25ab0d863c77e42e5d268e3779e89130 [PR build]

vs-mobiletools-engineering-service2 · 2025-12-02T12:32:03Z

🚀 [CI Build #88e08d7] Test results 🚀

Test results

✅ All tests passed on VSTS: test results.

🎉 All 122 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. [attempt 2] 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 6 tests passed. [attempt 2] Html Report (VSDrops) Download
✅ linker: All 44 tests passed. Html Report (VSDrops) Download
✅ monotouch (iOS): All 9 tests passed. Html Report (VSDrops) Download
✅ monotouch (MacCatalyst): All 11 tests passed. Html Report (VSDrops) Download
✅ monotouch (macOS): All 12 tests passed. [attempt 2] Html Report (VSDrops) Download
✅ monotouch (tvOS): All 9 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: 88e08d7d25ab0d863c77e42e5d268e3779e89130 [PR build]

rolfbjarne enabled auto-merge (squash) December 1, 2025 22:20

rolfbjarne requested a review from Copilot December 1, 2025 22:20

Copilot started reviewing on behalf of rolfbjarne December 1, 2025 22:21 View session

Copilot finished reviewing on behalf of rolfbjarne December 1, 2025 22:24

Auto-format source code

6ae47a3

Copilot AI reviewed Dec 1, 2025

View reviewed changes

This comment has been minimized.

Sign in to view

Fix build.

5343d47

This comment has been minimized.

Sign in to view

Remove unused parameter.

88e08d7

This comment has been minimized.

Sign in to view

dalexsoto approved these changes Dec 2, 2025

View reviewed changes

rolfbjarne merged commit b6939d0 into main Dec 2, 2025
45 checks passed

Conversation

rolfbjarne commented Dec 1, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 1, 2025

Choose a reason for hiding this comment

Uh oh!

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.

vs-mobiletools-engineering-service2 commented Dec 2, 2025

✅ [CI Build #88e08d7] Build passed (Build packages) ✅

Uh oh!

vs-mobiletools-engineering-service2 commented Dec 2, 2025

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

Uh oh!

vs-mobiletools-engineering-service2 commented Dec 2, 2025

✅ API diff for current PR / commit

✅ API diff vs stable

ℹ️ Generator diff

Uh oh!

vs-mobiletools-engineering-service2 commented Dec 2, 2025

✅ [CI Build #88e08d7] Build passed (Build macOS tests) ✅

Uh oh!

vs-mobiletools-engineering-service2 commented Dec 2, 2025

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

Uh oh!

vs-mobiletools-engineering-service2 commented Dec 2, 2025

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

Uh oh!

vs-mobiletools-engineering-service2 commented Dec 2, 2025

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

Uh oh!

vs-mobiletools-engineering-service2 commented Dec 2, 2025

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

Uh oh!

vs-mobiletools-engineering-service2 commented Dec 2, 2025

💻 [CI Build #88e08d7] Tests on macOS arm64 - Mac Tahoe (26) passed 💻

Uh oh!

This comment has been minimized.

vs-mobiletools-engineering-service2 commented Dec 2, 2025

🚀 [CI Build #88e08d7] Test results 🚀

Test results

Tests counts

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants