Support references to unmanaged function pointers in Reflection.Emit

[jgh07]

This fixes #120909.

There is one small issue with the tests when the calling conventions are encoded as modopts: The PersistedAssemblyBuilder from the test specifies System.Private.CoreLib as its core assembly, which prevents the runtime from matching the signatures with the ones defined in C# (where the modifier types are from System.Runtime). This is seemingly not an issue with parameter types, but only with modifiers. @jkotas or anyone else, do you have an idea how to fix this? If the AssemblyBuilder used the same core assembly as the C# program, it should work. For now, I have commented out this specific field reference.

[Copilot]

Pull Request Overview

This PR adds support for emitting references to unmanaged function pointer types in Reflection.Emit, addressing issue #120909. Previously, attempting to reference fields or methods with unmanaged function pointer signatures would fail.

Key Changes:

• Modified signature encoding to properly handle function pointer types by using UnderlyingSystemType for non-function-pointer types
• Updated member reference handling to retrieve modified types for function pointer fields and method parameters/returns
• Expanded test coverage to include both fields and methods with various function pointer signatures

Reviewed Changes

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

File	Description
AssemblySaveTypeBuilderTests.cs	Expanded tests from just fields to include methods with function pointer signatures; uncommented previously broken test cases
SignatureHelper.cs	Added logic to use UnderlyingSystemType for non-function-pointer types when writing signatures
ModuleBuilderImpl.cs	Enhanced member reference handling to use modified types (GetModifiedFieldType, GetModifiedParameterType) for function pointers

[dotnet-policy-service]

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

[jkotas]

The PersistedAssemblyBuilder from the test specifies System.Private.CoreLib as its core assembly, which prevents the runtime from matching the signatures with the ones defined in C# (where the modifier types are from System.Runtime).

I have tried a small standalone test and I do not see a problem with this. Also, I have checked the runtime implementation and it does take assembly forwarding into account, so modopts referencing System.Runtime and System.Private.Corelib are expected to match.

I think it is something else.

[jkotas]

Wrt Mono failures: It is ok to disable this test on Mono

[jkotas]

I think it is something else.

The problem is that the order of modopts is getting swapped.

The defining assembly has CallConvSuppressGCTransition first:

method unmanaged valuetype [System.Numerics.Vectors]System.Numerics.Vector`1<int32> modopt([System.Runtime]System.Runtime.CompilerServices.CallConvSuppressGCTransition) modopt([System.Runtime]System.Runtime.CompilerServices.CallConvCdecl) *(valuetype [System.Numerics.Vectors]System.Numerics.Vector`1<int32>) field4

The reference has the modopts in opposite order - CallConvCdecl is first:

method unmanaged valuetype [System.Private.CoreLib]System.Numerics.Vector`1<int32> modopt([System.Private.CoreLib]System.Runtime.CompilerServices.CallConvCdecl) modopt([System.Private.CoreLib]System.Runtime.CompilerServices.CallConvSuppressGCTransition) *(valuetype [System.Private.CoreLib]System.Numerics.Vector`1<int32>) [System.Reflection.Emit.Tests]System.Reflection.Emit.Tests.ClassWithFunctionPointerMembers::field4

The order must match.

[jgh07]

I am currently looking into it more thoroughly, of course using the modified type only when the type itself is a function pointer was too conservative of a condition.

I switched to using modified types all the time, but I stumbled on some strange behavior regarding generics:

using System;
using System.Reflection;

// Generic type left open on purpose
FieldInfo field = typeof(Container<>).GetField("Field");

Console.WriteLine(field.FieldType.GetFunctionPointerReturnType().IsGenericParameter);
Console.WriteLine(field.GetModifiedFieldType().GetFunctionPointerReturnType().IsGenericParameter);

// Output:
// True
// False

public unsafe class Container<T>
{
    public static delegate*<T> Field;
    public static delegate* unmanaged[Cdecl]<T, U> Method<U>() => null;
}

To me this makes no sense, or am I overseeing something? The type being modified should not interfere with IsGenericParameter. This caused a bunch of other tests dealing with generics to fail as well.

[jkotas]

To me this makes no sense, or am I overseeing something?

Looks like a bug in the ModifiedType implementation

[jgh07]

Works now for all cases covered by tests. None of the Reflection.Emit APIs implement GetModifiedFieldType/GetModifiedParameterType, so in those cases I just used the regular type, which still works if the field/method is constructed correctly.

I imagine there might be some edge cases, such as when you use a type parameter of a generic TypeBuilder in a function pointer signature. But I failed to get an example running, constructing function pointers with generic parameters through the reflection API is very hacky and unpleasant.

[jkotas]

None of the Reflection.Emit APIs implement GetModifiedFieldType/GetModifiedParameterType

What would it take to implement these APIs on these types? Special casing the Reflection.Emit APIs by type name does not look good.

[jgh07]

None of the Reflection.Emit APIs implement GetModifiedFieldType/GetModifiedParameterType

What would it take to implement these APIs on these types? Special casing the Reflection.Emit APIs by type name does not look good.

For the new implementation (FieldBuilderImpl) the only issue is that the internals of System.Private.CoreLib are not accessible. In this case simply returning the regular field type works for function pointers, but it would lose all modifiers for "normal" modified types. I looked at using the same TypeDelegator trick that I used to construct the function pointers, but I'm not sure yet how to store the calling convention, if it is not encoded via modopts.

As for the types defined in System.Private.CoreLib (e.g. FieldOnTypeBuilderInstantiation), I have not looked at those, but I imagine it could look similar to the implementation in RtFieldInfo.

[jkotas]

There are failing tests on Mono:

    System.Reflection.Emit.Tests.AssemblySaveTypeBuilderTests.ConsumeFunctionPointerMembers [FAIL]
      System.Exception : Parent's SignatureHolderInfo cannot be null
      Stack Trace:
        /_/src/mono/System.Private.CoreLib/src/System/Reflection/ModifiedType.Mono.cs(135,0): at System.Reflection.ModifiedType.GetTypeParameter(Type unmodifiedType, Int32 index)
        /_/src/libraries/System.Private.CoreLib/src/System/Reflection/ModifiedGenericType.cs(28,0): at System.Reflection.ModifiedGenericType.<GetGenericArguments>g__Initialize|2_0()
        /_/src/libraries/System.Private.CoreLib/src/System/Reflection/ModifiedGenericType.cs(21,0): at System.Reflection.ModifiedGenericType.GetGenericArguments()
        /_/src/libraries/System.Reflection.Emit/src/System/Reflection/Emit/SignatureHelper.cs(200,0): at System.Reflection.Emit.MetadataSignatureHelper.WriteSignatureForType(SignatureTypeEncoder signature, Type type, ModuleBuilderImpl module)
        /_/src/libraries/System.Reflection.Emit/src/System/Reflection/Emit/SignatureHelper.cs(281,0): at System.Reflection.Emit.MetadataSignatureHelper.WriteSignatureForFunctionPointerType(SignatureTypeEncoder signature, Type type, ModuleBuilderImpl module)
        /_/src/libraries/System.Reflection.Emit/src/System/Reflection/Emit/SignatureHelper.cs(230,0): at System.Reflection.Emit.MetadataSignatureHelper.WriteSignatureForType(SignatureTypeEncoder signature, Type type, ModuleBuilderImpl module)
        /_/src/libraries/System.Reflection.Emit/src/System/Reflection/Emit/SignatureHelper.cs(34,0): at System.Reflection.Emit.MetadataSignatureHelper.GetFieldSignature(Type fieldType, Type[] requiredCustomModifiers, Type[] optionalCustomModifiers, ModuleBuilderImpl module)
        /_/src/libraries/System.Reflection.Emit/src/System/Reflection/Emit/ModuleBuilderImpl.cs(747,0): at System.Reflection.Emit.ModuleBuilderImpl.GetMemberReferenceHandle(MemberInfo memberInfo)

Could you please either fix if it is something simple, or disable these tests on Mono (you can use existing issue tracks RefEmit failures on Mono - [ActiveIssue("https://github.com/dotnet/runtime/issues/2383", TestRuntimes.Mono)]).

[jgh07]

There are failing tests on Mono:

    System.Reflection.Emit.Tests.AssemblySaveTypeBuilderTests.ConsumeFunctionPointerMembers [FAIL]
      System.Exception : Parent's SignatureHolderInfo cannot be null
      Stack Trace:
        /_/src/mono/System.Private.CoreLib/src/System/Reflection/ModifiedType.Mono.cs(135,0): at System.Reflection.ModifiedType.GetTypeParameter(Type unmodifiedType, Int32 index)
        /_/src/libraries/System.Private.CoreLib/src/System/Reflection/ModifiedGenericType.cs(28,0): at System.Reflection.ModifiedGenericType.<GetGenericArguments>g__Initialize|2_0()
        /_/src/libraries/System.Private.CoreLib/src/System/Reflection/ModifiedGenericType.cs(21,0): at System.Reflection.ModifiedGenericType.GetGenericArguments()
        /_/src/libraries/System.Reflection.Emit/src/System/Reflection/Emit/SignatureHelper.cs(200,0): at System.Reflection.Emit.MetadataSignatureHelper.WriteSignatureForType(SignatureTypeEncoder signature, Type type, ModuleBuilderImpl module)
        /_/src/libraries/System.Reflection.Emit/src/System/Reflection/Emit/SignatureHelper.cs(281,0): at System.Reflection.Emit.MetadataSignatureHelper.WriteSignatureForFunctionPointerType(SignatureTypeEncoder signature, Type type, ModuleBuilderImpl module)
        /_/src/libraries/System.Reflection.Emit/src/System/Reflection/Emit/SignatureHelper.cs(230,0): at System.Reflection.Emit.MetadataSignatureHelper.WriteSignatureForType(SignatureTypeEncoder signature, Type type, ModuleBuilderImpl module)
        /_/src/libraries/System.Reflection.Emit/src/System/Reflection/Emit/SignatureHelper.cs(34,0): at System.Reflection.Emit.MetadataSignatureHelper.GetFieldSignature(Type fieldType, Type[] requiredCustomModifiers, Type[] optionalCustomModifiers, ModuleBuilderImpl module)
        /_/src/libraries/System.Reflection.Emit/src/System/Reflection/Emit/ModuleBuilderImpl.cs(747,0): at System.Reflection.Emit.ModuleBuilderImpl.GetMemberReferenceHandle(MemberInfo memberInfo)

Could you please either fix if it is something simple, or disable these tests on Mono (you can use existing issue tracks RefEmit failures on Mono - [ActiveIssue("https://github.com/dotnet/runtime/issues/2383", TestRuntimes.Mono)]).

I have disabled this test for now. I might look over it in the future, but right now I don't have an environment where I can work on this or test it effectively on Mono.

[jkotas]

LGTM. @AaronRobinsonMSFT Could you please review this as well?

[AaronRobinsonMSFT]

[AaronRobinsonMSFT]

/ba-g Unrelated wasm failures on FireFox.