Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Documentation/guides/internals/JavaJNI_Interop.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,8 @@ A Java-side constructor and a managed-side constructor do not allocate one share

On the managed side, [`TrimmableTypeMap`](../../../src/Mono.Android/Microsoft.Android.Runtime/TrimmableTypeMap.cs) uses generated mapping attributes to resolve a Java class and target type. Its [`JavaPeerProxy`](../../../src/Mono.Android/Java.Interop/JavaPeerProxy.cs) can create the managed object from a handle without late-bound `Activator.CreateInstance`; activation also accounts for an existing replaceable peer. [`TrimmableTypeMapTypeManager`](../../../src/Mono.Android/Microsoft.Android.Runtime/TrimmableTypeMapTypeManager.cs) resolves names/types, while [`TrimmableTypeMapValueManager`](../../../src/Mono.Android/Microsoft.Android.Runtime/TrimmableTypeMapValueManager.cs) checks for registered peers and handles construction/ownership.

Proxies for sealed managed types defined in `Mono.Android` pass `isSealed: true` to the `JavaPeerProxy` constructor. The resulting `JavaPeerProxy.IsSealed` property lets target-type lookups use `FindClass` and `IsInstanceOf` without inspecting `Type.Assembly` at runtime. Other peers pass `isSealed: false` and still use the object's actual Java class hierarchy, even for sealed app and library types: these classes can use a different class loader, so resolving their class by name could incorrectly reject a valid object.

Every generated JCW implements the Java [`IGCUserPeer`](../../../src/java-runtime/java/mono/android/IGCUserPeer.java) hooks `monodroidAddReference` and `monodroidClearReferences`. Managed [`JavaMarshalRegisteredPeers`](../../../src/Mono.Android/Microsoft.Android.Runtime/JavaMarshalRegisteredPeers.cs) tracks add/peek/remove/finalize operations, and the GC bridge coordinates the two collectors. Local and global JNI references have different lifetimes: a managed wrapper may need a global reference to keep its peer accessible after a JNI call returns. `JniHandleOwnership` records whether an incoming reference is transferred. Calling `Dispose()` can remove the association; a raw `IntPtr` retained afterward is not a safe substitute for a live managed peer. For invalid reference diagnostics, see [Debugging JNI Object Reference Crashes](debug-jni-objrefs.md).

## Diagnosing a broken interop path
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Reflection.Metadata.Ecma335;
using System.Reflection.PortableExecutable;
using System.Xml.Linq;
using Microsoft.Android.Sdk.TrimmableTypeMap;
using Microsoft.Android.Tasks;
Expand All @@ -14,6 +17,79 @@ namespace Xamarin.Android.Build.Tests {
[Parallelizable (ParallelScope.Children)]
public class GenerateTrimmableTypeMapTests : BaseTest {

[Test]
public void SealedFrameworkProxiesPassIsSealedToBase (
[Values ("Mono.Android", "Other")] string assemblyName,
[Values] bool isSealed,
[Values] bool alias,
[Values] bool generic)
{
var peer = new JavaPeerInfo {
JavaName = "example/Peer",
CompatJniName = "example/Peer",
ManagedTypeName = generic ? "Example.Peer`1" : "Example.Peer",
ManagedTypeNamespace = "Example",
ManagedTypeShortName = generic ? "Peer`1" : "Peer",
AssemblyName = assemblyName,
IsFrameworkAssembly = true,
IsSealed = isSealed,
IsGenericDefinition = generic,
DoNotGenerateAcw = true,
ActivationCtor = new ActivationCtorInfo {
DeclaringTypeName = generic ? "Example.Peer`1" : "Example.Peer",
DeclaringAssemblyName = assemblyName,
DeclaringType = new TypeRefData {
ManagedTypeName = generic ? "Example.Peer`1" : "Example.Peer",
AssemblyName = assemblyName,
},
Style = ActivationCtorStyle.XamarinAndroid,
},
JavaConstructors = [new JavaConstructorInfo { JniSignature = "()V", ConstructorIndex = 0 }],
};
var peers = new List<JavaPeerInfo> { peer };
if (alias) {
peers.Add (peer with {
ManagedTypeName = "Example.OtherPeer",
ManagedTypeShortName = "OtherPeer",
IsSealed = false,
IsGenericDefinition = false,
ActivationCtor = new ActivationCtorInfo {
DeclaringTypeName = "Example.OtherPeer",
DeclaringAssemblyName = assemblyName,
DeclaringType = new TypeRefData {
ManagedTypeName = "Example.OtherPeer",
AssemblyName = assemblyName,
},
Style = ActivationCtorStyle.XamarinAndroid,
},
});
}

var generator = new TypeMapAssemblyGenerator (new Version (12, 0));
var model = generator.CreateModel (peers, "_Example.TypeMap");
Comment thread
simonrozsival marked this conversation as resolved.
Resolved
using var stream = new MemoryStream ();
generator.Generate (model, stream, useSharedTypemapUniverse: true);
stream.Position = 0;
using var assembly = Mono.Cecil.AssemblyDefinition.ReadAssembly (stream);
Assert.AreEqual (alias ? 2 : 1, model.ProxyTypes.Count, "Every peer must emit a proxy.");
foreach (var proxy in model.ProxyTypes) {
bool eligible = assemblyName == "Mono.Android" && isSealed && proxy.TargetType.ManagedTypeName == peer.ManagedTypeName;
const string expectedBase = "Java.Interop.JavaPeerProxy";
var type = assembly.MainModule.Types.Single (type => type.Name == proxy.TypeName);
Assert.AreEqual (expectedBase, type.BaseType.FullName, type.FullName);
var constructor = type.Methods.Single (method => method.IsConstructor);
var baseCall = constructor.Body.Instructions
.Single (instruction => instruction.Operand is Mono.Cecil.MethodReference { Name: ".ctor" });
var baseConstructor = (Mono.Cecil.MethodReference) baseCall.Operand;
Assert.AreEqual (expectedBase, baseConstructor.DeclaringType.FullName, "The constructor must call the selected base.");
Assert.AreEqual (3, baseConstructor.Parameters.Count, "The constructor must pass IsSealed to the base.");
Assert.AreEqual ("System.Boolean", baseConstructor.Parameters [2].ParameterType.FullName);
var expectedIsSealed = eligible ? Mono.Cecil.Cil.Code.Ldc_I4_1 : Mono.Cecil.Cil.Code.Ldc_I4_0;
Assert.AreEqual (expectedIsSealed, baseCall.Previous.OpCode.Code, type.FullName);
Assert.IsFalse (type.Properties.Any (property => property.Name == "IsSealed"), "Proxies must not override IsSealed.");
}
}

[Test]
public void AssemblyQualifiedApplicationTypeReferencesSelectCorrectPeer ()
{
Expand Down Expand Up @@ -380,6 +456,57 @@ public void LoadCustomViewTypeNames_InvalidEntryThrows ()
StringAssert.Contains ("Invalid custom view map entry 'invalid'", exception?.Message);
}

[Test]
public void ScannerRecordsIsSealedFromTypeMetadata ()
{
var pe = new PEAssemblyBuilder (new Version (11, 0, 0, 0));
pe.EmitPreamble ("ScannerPeers", "ScannerPeers.dll");
var registerAttribute = pe.Metadata.AddTypeReference (
pe.MonoAndroidRef,
pe.Metadata.GetOrAddString ("Android.Runtime"),
pe.Metadata.GetOrAddString ("RegisterAttribute"));
var registerCtor = pe.AddMemberRef (registerAttribute, ".ctor",
sig => sig.MethodSignature (isInstanceMethod: true).Parameters (1,
rt => rt.Void (),
p => p.AddParameter ().Type ().String ()));
var objectType = pe.Metadata.AddTypeReference (
pe.SystemRuntimeRef,
pe.Metadata.GetOrAddString ("System"),
pe.Metadata.GetOrAddString ("Object"));
var nonsealedType = pe.Metadata.AddTypeDefinition (
TypeAttributes.Public | TypeAttributes.Class,
pe.Metadata.GetOrAddString ("Example"),
pe.Metadata.GetOrAddString ("NonsealedPeer"),
objectType,
MetadataTokens.FieldDefinitionHandle (1),
MetadataTokens.MethodDefinitionHandle (1));
var sealedType = pe.Metadata.AddTypeDefinition (
TypeAttributes.Public | TypeAttributes.Class | TypeAttributes.Sealed,
pe.Metadata.GetOrAddString ("Example"),
pe.Metadata.GetOrAddString ("SealedPeer"),
nonsealedType,
MetadataTokens.FieldDefinitionHandle (1),
MetadataTokens.MethodDefinitionHandle (1));
foreach (var (type, javaName) in new [] {
(nonsealedType, "example/NonsealedPeer"),
(sealedType, "example/SealedPeer"),
}) {
pe.Metadata.AddCustomAttribute (type, registerCtor, pe.BuildAttributeBlob (blob => blob.WriteSerializedString (javaName)));
}

using var stream = new MemoryStream ();
pe.WritePE (stream);
stream.Position = 0;
using var reader = new PEReader (stream);
using var scanner = new JavaPeerScanner ();
var peers = scanner.Scan ([new AssemblyInput ("ScannerPeers", "", reader)]);

var sealedPeer = peers.Single (peer => peer.JavaName == "example/SealedPeer");
var nonsealedPeer = peers.Single (peer => peer.JavaName == "example/NonsealedPeer");
Assert.IsTrue (sealedPeer.IsSealed, sealedPeer.ManagedTypeName);
Assert.IsFalse (nonsealedPeer.IsSealed, nonsealedPeer.ManagedTypeName);
}

[Test]
public void Execute_WithMonoAndroid_ProducesOutputs ()
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,29 @@ namespace Xamarin.Android.Build.Tests;
[TestFixture]
public class TrimmableTypeMapIncrementalTests
{
[TestCase (false)]
[TestCase (true)]
public void ChangingFrameworkSealednessRegeneratesTypeMap (bool isSealed)
{
var peer = CreatePeer ("Mono.Android", "Java.Lang.String", "java/lang/String") with {
IsSealed = isSealed,
};
var changedPeer = peer with { IsSealed = !isSealed };

CollectionAssert.AreEqual (
new [] { "_Mono.Android.TypeMap" },
GetChangedAssemblyNames ([peer], [changedPeer]));

var version = new Version (12, 0);
var generator = new TypeMapAssemblyGenerator (version);
var initial = generator.CreateModel ([peer], "_Mono.Android.TypeMap");
var changed = generator.CreateModel ([changedPeer], "_Mono.Android.TypeMap");
CollectionAssert.AreNotEqual (
MetadataHelper.ComputeFingerprints (initial, version, useSharedTypemapUniverse: true, includeIncremental: false).Content,
MetadataHelper.ComputeFingerprints (changed, version, useSharedTypemapUniverse: true, includeIncremental: false).Content,
"Changing the emitted base class must also change the deterministic MVID.");
}

[Test]
public void ChangedCrossAssemblyAliasRegeneratesOwner ()
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ public static ModelFingerprints ComputeFingerprints (
writer.WriteString (incremental, proxy.Namespace);
}
WriteTypeRef (writer, both, proxy.TargetType);
writer.WriteBoolean (both, proxy.CanResolveFromSealedTargetType);
if (includeIncremental) {
WriteOptionalTypeRef (writer, incremental, proxy.InvokerType);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,11 @@ sealed class JavaPeerProxyData
/// </summary>
public required TypeRefData TargetType { get; init; }

/// <summary>
/// True when the sealed Mono.Android target can use the runtime's class loader.
/// </summary>
public bool CanResolveFromSealedTargetType { get; init; }

/// <summary>
/// Reference to the invoker type (for interfaces/abstract types). Null if not applicable.
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,7 @@ static JavaPeerProxyData BuildProxyType (JavaPeerInfo peer, string jniName, Hash
},
IsAcw = isAcw,
IsGenericDefinition = peer.IsGenericDefinition,
CanResolveFromSealedTargetType = peer.IsSealed && string.Equals (peer.AssemblyName, "Mono.Android", StringComparison.Ordinal),
CannotRegisterInStaticConstructor = peer.CannotRegisterInStaticConstructor,
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -669,20 +669,20 @@ void EmitProxyType (JavaPeerProxyData proxy, Dictionary<UcoWrapperTargetData, En
// open generic definitions (whose T isn't available via the TypeMapLazyDictionary loader),
// and interfaces (which have no constructors). Peers are activated from their generated
// CreateInstance / InvokerType, never by reflecting over the target type.
var proxyBaseType = (EntityHandle) _javaPeerProxyRef;
var baseCtorRef = _pe.AddMemberRef (_javaPeerProxyRef, ".ctor",
sig => sig.MethodSignature (isInstanceMethod: true).Parameters (2,
sig => sig.MethodSignature (isInstanceMethod: true).Parameters (3,
rt => rt.Void (),
p => {
p.AddParameter ().Type ().String ();
p.AddParameter ().Type ().Type (_systemTypeRef, false);
p.AddParameter ().Type ().Boolean ();
}));

var typeDefHandle = metadata.AddTypeDefinition (
TypeAttributes.Public | TypeAttributes.Sealed | TypeAttributes.Class,
metadata.GetOrAddString (proxy.Namespace),
metadata.GetOrAddString (proxy.TypeName),
proxyBaseType,
_javaPeerProxyRef,
MetadataTokens.FieldDefinitionHandle (metadata.GetRowCount (TableIndex.Field) + 1),
MetadataTokens.MethodDefinitionHandle (metadata.GetRowCount (TableIndex.MethodDef) + 1));

Expand All @@ -699,7 +699,8 @@ void EmitProxyType (JavaPeerProxyData proxy, Dictionary<UcoWrapperTargetData, En
encoder.LoadString (metadata.GetOrAddUserString (proxy.JniName));
encoder.LoadToken (targetTypeRef);
encoder.Call (_getTypeFromHandleRef, parameterCount: 1, returnsValue: true);
encoder.Call (baseCtorRef, parameterCount: 2, isInstance: true);
encoder.LoadConstantI4 (proxy.CanResolveFromSealedTargetType ? 1 : 0);
encoder.Call (baseCtorRef, parameterCount: 3, isInstance: true);
encoder.Return ();
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ public sealed record JavaPeerInfo

public bool IsInterface { get; init; }
public bool IsAbstract { get; init; }
public bool IsSealed { get; init; }

/// <summary>
/// If true, this is a Managed Callable Wrapper (MCW) binding type.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -428,6 +428,7 @@ void ScanAssembly (AssemblyIndex index, Dictionary<(string ManagedName, string A
var isGenericDefinition = typeDef.GetGenericParameters ().Count > 0;
var isInterface = (typeDef.Attributes & TypeAttributes.Interface) != 0;
var isAbstract = (typeDef.Attributes & TypeAttributes.Abstract) != 0;
var isSealed = (typeDef.Attributes & TypeAttributes.Sealed) != 0;

var isFrameworkAssembly = frameworkAssemblyNames.Contains (index.AssemblyName);
var isUnconditional = !isFrameworkAssembly &&
Expand Down Expand Up @@ -483,6 +484,7 @@ void ScanAssembly (AssemblyIndex index, Dictionary<(string ManagedName, string A
Annotations = annotationParser.Parse (typeDef.GetCustomAttributes (), index),
IsInterface = isInterface,
IsAbstract = isAbstract,
IsSealed = isSealed,
Comment thread
simonrozsival marked this conversation as resolved.
Resolved
DoNotGenerateAcw = doNotGenerateAcw,
IsFromJniTypeSignature = registerInfo?.IsFromJniTypeSignature ?? false,
IsUnconditional = isUnconditional,
Expand Down
15 changes: 15 additions & 0 deletions src/Mono.Android/Java.Interop/JavaPeerProxy.cs
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,18 @@ public sealed class JavaPeerAliasesAttribute : Attribute
public abstract class JavaPeerProxy : Attribute
{
protected JavaPeerProxy (string jniName, Type targetType)
: this (jniName, targetType, false)
{
}

protected JavaPeerProxy (string jniName, Type targetType, bool isSealed)
{
ArgumentNullException.ThrowIfNull (jniName);
ArgumentNullException.ThrowIfNull (targetType);

JniName = jniName;
TargetType = targetType;
IsSealed = isSealed;
}

/// <summary>
Expand All @@ -69,6 +75,15 @@ protected JavaPeerProxy (string jniName, Type targetType)
/// </summary>
public Type TargetType { get; }

/// <summary>
/// Gets whether the sealed target can be resolved directly using the runtime's class loader.
/// </summary>
/// <remarks>
/// Generated proxies pass <see langword="true"/> only for sealed Mono.Android targets. External
/// targets pass <see langword="false"/> even when sealed, because they can use a different class loader.
/// </remarks>
public bool IsSealed { get; }

/// <summary>
/// Returns <see langword="true"/> when the UCO constructor callback should skip
/// activation because a managed peer already exists for the given JNI handle
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -298,14 +298,10 @@ bool TryResolveProxyFromSealedTargetType (
{
proxy = null;
// App peers can use class loaders which differ from the runtime fallback loader.
// The generator marks only sealed Mono.Android targets as safe for this lookup.
if (targetType is null ||
!targetType.IsSealed ||
targetType.Assembly != typeof (Java.Lang.Object).Assembly) {
return false;
}

var targetProxy = GetProxyForManagedType (targetType);
if (targetProxy is null) {
GetProxyForManagedType (targetType) is not { IsSealed: true } targetProxy) {
Comment thread
simonrozsival marked this conversation as resolved.
Resolved
return false;
}

Expand Down
2 changes: 2 additions & 0 deletions src/Mono.Android/PublicAPI/API-37/PublicAPI.Unshipped.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8356,7 +8356,9 @@ Java.Interop.JavaPeerCallbackFormatAttribute
Java.Interop.JavaPeerCallbackFormatAttribute.JavaPeerCallbackFormatAttribute(int version) -> void
Java.Interop.JavaPeerCallbackFormatAttribute.Version.get -> int
Java.Interop.JavaPeerProxy
Java.Interop.JavaPeerProxy.IsSealed.get -> bool
Java.Interop.JavaPeerProxy.JavaPeerProxy(string! jniName, System.Type! targetType) -> void
Java.Interop.JavaPeerProxy.JavaPeerProxy(string! jniName, System.Type! targetType, bool isSealed) -> void
Java.Interop.JavaPeerProxy.JniName.get -> string!
Java.Interop.JavaPeerProxy.TargetType.get -> System.Type!
Java.Interop.JniMarshalTyped
Expand Down
Loading
Loading