Implement GC bridge in NativeAOT

Author: jkoritzinsky

src/coreclr/System.Private.CoreLib/System.Private.CoreLib.csproj

@@ -223,6 +223,7 @@
     <Compile Include="$(BclSourcesRoot)\System\Runtime\InteropServices\Marshal.CoreCLR.cs" />
     <Compile Include="$(BclSourcesRoot)\System\Runtime\InteropServices\MemoryMarshal.CoreCLR.cs" />
     <Compile Include="$(BclSourcesRoot)\System\Runtime\InteropServices\NativeLibrary.CoreCLR.cs" />
+    <Compile Include="$(BclSourcesRoot)\System\Runtime\InteropServices\Java\JavaMarshal.CoreCLR.cs" Condition="'$(FeatureJavaMarshal)' == 'true'" />
     <Compile Include="$(BclSourcesRoot)\System\Runtime\Intrinsics\X86\X86Base.CoreCLR.cs" />
     <Compile Include="$(BclSourcesRoot)\System\Runtime\Loader\AssemblyLoadContext.CoreCLR.cs" />
     <Compile Include="$(BclSourcesRoot)\System\RuntimeArgumentHandle.cs" />

…time/InteropServices/Java/JavaMarshal.cs …eropServices/Java/JavaMarshal.CoreCLR.cssrc/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/JavaMarshal.cs renamed to src/coreclr/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/JavaMarshal.CoreCLR.cs src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/JavaMarshal.cs renamed to src/coreclr/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/JavaMarshal.CoreCLR.cs

@@ -12,39 +12,24 @@ public static partial class JavaMarshal
     {
         public static unsafe void Initialize(delegate* unmanaged<MarkCrossReferencesArgs*, void> markCrossReferences)
         {
-#if NATIVEAOT
-            throw new NotImplementedException();
-#elif FEATURE_JAVAMARSHAL
             ArgumentNullException.ThrowIfNull(markCrossReferences);
 
             if (!InitializeInternal((IntPtr)markCrossReferences))
             {
                 throw new InvalidOperationException(SR.InvalidOperation_ReinitializeJavaMarshal);
             }
-#else
-            throw new PlatformNotSupportedException();
-#endif
         }
 
         public static unsafe GCHandle CreateReferenceTrackingHandle(object obj, void* context)
         {
-#if NATIVEAOT
-            throw new NotImplementedException();
-#elif FEATURE_JAVAMARSHAL
             ArgumentNullException.ThrowIfNull(obj);
 
             IntPtr handle = CreateReferenceTrackingHandleInternal(ObjectHandleOnStack.Create(ref obj), context);
             return GCHandle.FromIntPtr(handle);
-#else
-            throw new PlatformNotSupportedException();
-#endif
         }
 
         public static unsafe void* GetContext(GCHandle obj)
         {
-#if NATIVEAOT
-            throw new NotImplementedException();
-#elif FEATURE_JAVAMARSHAL
             IntPtr handle = GCHandle.ToIntPtr(obj);
             if (handle == IntPtr.Zero
                 || !GetContextInternal(handle, out void* context))
@@ -53,31 +38,21 @@ public static unsafe GCHandle CreateReferenceTrackingHandle(object obj, void* co
             }
 
             return context;
-#else
-            throw new PlatformNotSupportedException();
-#endif
         }
 
         public static unsafe void FinishCrossReferenceProcessing(
             MarkCrossReferencesArgs* crossReferences,
             ReadOnlySpan<GCHandle> unreachableObjectHandles)
         {
-#if NATIVEAOT
-            throw new NotImplementedException();
-#elif FEATURE_JAVAMARSHAL
             fixed (GCHandle* pHandles = unreachableObjectHandles)
             {
                 FinishCrossReferenceProcessing(
                     crossReferences,
                     (nuint)unreachableObjectHandles.Length,
                     pHandles);
             }
-#else
-            throw new PlatformNotSupportedException();
-#endif
         }
 
-#if FEATURE_JAVAMARSHAL && !NATIVEAOT
         [LibraryImport(RuntimeHelpers.QCall, EntryPoint = "JavaMarshal_Initialize")]
         [return: MarshalAs(UnmanagedType.Bool)]
         private static partial bool InitializeInternal(IntPtr callback);
@@ -92,6 +67,5 @@ public static unsafe void FinishCrossReferenceProcessing(
         [SuppressGCTransition]
         [return: MarshalAs(UnmanagedType.Bool)]
         private static unsafe partial bool GetContextInternal(IntPtr handle, out void* context);
-#endif
     }
 }

src/coreclr/nativeaot/CMakeLists.txt

@@ -30,7 +30,14 @@ endif (CLR_CMAKE_HOST_UNIX)
 
 if(CLR_CMAKE_TARGET_ANDROID)
     add_definitions(-DFEATURE_EMULATED_TLS)
+    set(FEATURE_JAVAMARSHAL 1)
 endif()
 
+if(NOT DEFINED FEATURE_JAVAMARSHAL)
+  set(FEATURE_JAVAMARSHAL $<IF:$<CONFIG:Debug,Checked>,1,0>)
+endif()
+
+add_compile_definitions($<${FEATURE_JAVAMARSHAL}:FEATURE_JAVAMARSHAL>)
+
 add_subdirectory(Bootstrap)
 add_subdirectory(Runtime)

src/coreclr/nativeaot/Runtime/CMakeLists.txt

@@ -20,6 +20,7 @@ set(COMMON_RUNTIME_SOURCES
     gcenv.ee.cpp
     GcStressControl.cpp
     HandleTableHelpers.cpp
+    interoplibinterface_java.cpp
     MathHelpers.cpp
     MiscHelpers.cpp
     TypeManager.cpp
@@ -38,6 +39,7 @@ set(COMMON_RUNTIME_SOURCES
     yieldprocessornormalized.cpp
 
     ${GC_DIR}/gceventstatus.cpp
+    ${GC_DIR}/gcbridge.cpp
     ${GC_DIR}/gcload.cpp
     ${GC_DIR}/gcconfig.cpp
     ${GC_DIR}/gchandletable.cpp

src/coreclr/nativeaot/Runtime/HandleTableHelpers.cpp

@@ -6,6 +6,7 @@
 #include "objecthandle.h"
 #include "RestrictedCallouts.h"
 #include "gchandleutilities.h"
+#include "interoplibinterface.h"
 
 
 FCIMPL2(OBJECTHANDLE, RhpHandleAlloc, Object *pObject, int type)
@@ -64,6 +65,27 @@ FCIMPL2(void, RhUnregisterRefCountedHandleCallback, void * pCallout, MethodTable
 }
 FCIMPLEND
 
+FCIMPL2(OBJECTHANDLE, RhpHandleAllocCrossReference, Object *pPrimary, void *pContext)
+{
+    return GCHandleUtilities::GetGCHandleManager()->GetGlobalHandleStore()->CreateHandleWithExtraInfo(pPrimary, HNDTYPE_CROSSREFERENCE, pContext);
+}
+FCIMPLEND
+
+FCIMPL2(FC_BOOL_RET, RhHandleTryGetCrossReferenceContext, OBJECTHANDLE handle, void **pContext)
+{
+    *pContext = nullptr;
+
+    IGCHandleManager* gcHandleManager = GCHandleUtilities::GetGCHandleManager();
+    if (gcHandleManager->HandleFetchType(handle) != HNDTYPE_CROSSREFERENCE)
+    {
+        FC_RETURN_BOOL(false);
+    }
+
+    *pContext = gcHandleManager->GetExtraInfoFromHandle(handle);
+    FC_RETURN_BOOL(true);
+}
+FCIMPLEND
+
 // This structure mirrors the managed type System.Runtime.InteropServices.ComWrappers.ManagedObjectWrapper.
 struct ManagedObjectWrapper
 {

src/coreclr/nativeaot/Runtime/gcenv.ee.cpp

@@ -809,4 +809,11 @@ void GCToEEInterface::FreeStringConfigValue(const char* value)
     delete[] value;
 }
 
+void GCToEEInterface::TriggerClientBridgeProcessing(MarkCrossReferencesArgs* args)
+{
+#ifdef FEATURE_JAVAMARSHAL
+    JavaMarshalNative::TriggerClientBridgeProcessing(args);
+#endif
+}
+
 #endif // !DACCESS_COMPILE

src/coreclr/nativeaot/Runtime/interoplibinterface.h

@@ -22,3 +22,15 @@ class ObjCMarshalNative
 };
 
 #endif // FEATURE_OBJCMARSHAL
+
+#ifdef FEATURE_JAVAMARSHAL
+
+struct MarkCrossReferencesArgs;
+
+class JavaMarshalNative
+{
+public:
+    static void TriggerClientBridgeProcessing(
+        MarkCrossReferencesArgs* args);
+};
+#endif

src/coreclr/nativeaot/Runtime/interoplibinterface_java.cpp

@@ -0,0 +1,157 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+#ifdef FEATURE_JAVAMARSHAL
+
+// Runtime headers
+#include "common.h"
+#include "gcenv.h"
+#include "gcenv.ee.h"
+#include "gcheaputilities.h"
+#include "gchandleutilities.h"
+#include "thread.h"
+#include "threadstore.h"
+#include "threadstore.inl"
+#include "event.h"
+
+#include "interoplibinterface.h"
+
+using CrossreferenceHandleCallback = void(__stdcall *)(MarkCrossReferencesArgs*);
+
+namespace
+{
+    volatile CrossreferenceHandleCallback g_MarkCrossReferences = NULL;
+
+    Volatile<bool> g_GCBridgeActive = false;
+    CLREventStatic g_bridgeFinished;
+
+    void ReleaseGCBridgeArgumentsWorker(
+        MarkCrossReferencesArgs* args)
+    {
+        // Memory was allocated for the collections by the GC.
+        // See callers of GCToEEInterface::TriggerGCBridge().
+
+        // Free memory in each of the SCCs
+        for (size_t i = 0; i < args->ComponentCount; i++)
+        {
+            delete[] args->Components[i].Contexts;
+        }
+        delete[] args->Components;
+        delete[] args->CrossReferences;
+        delete args;
+    }
+}
+
+void JavaMarshalNative::TriggerClientBridgeProcessing(
+    _In_ MarkCrossReferencesArgs* args)
+{
+    _ASSERTE(GCHeapUtilities::IsGCInProgress());
+
+    if (g_GCBridgeActive)
+    {
+        // Release the memory allocated since the GCBridge
+        // is already running and we're not passing them to it.
+        ReleaseGCBridgeArgumentsWorker(args);
+        return;
+    }
+
+    bool gcBridgeTriggered = false;
+    // Not initialized
+    if (g_MarkCrossReferences != NULL)
+    {
+        g_MarkCrossReferences(args);
+        gcBridgeTriggered = true;
+    }
+
+    if (!gcBridgeTriggered)
+    {
+        // Release the memory allocated since the GCBridge
+        // wasn't trigger for some reason.
+        ReleaseGCBridgeArgumentsWorker(args);
+        return;
+    }
+
+    // This runs during GC while the world is stopped, no synchronisation required
+    g_bridgeFinished.Reset();
+
+    // Mark the GCBridge as active.
+    g_GCBridgeActive = true;
+}
+
+extern "C" BOOL QCALLTYPE JavaMarshal_Initialize(
+    void* markCrossReferences)
+{
+    _ASSERTE(markCrossReferences != NULL);
+
+    BOOL success = FALSE;
+
+
+    // Switch to Cooperative mode since we are setting callbacks that
+    // will be used during a GC and we want to ensure a GC isn't occurring
+    // while they are being set.
+    {
+        bool wasCooperative = false;
+        Thread* pThisThread = ThreadStore::GetCurrentThreadIfAvailable();
+        pThisThread->DeferTransitionFrame();
+        pThisThread->DisablePreemptiveMode();
+
+        if (PalInterlockedCompareExchangePointer((void* volatile*)&g_MarkCrossReferences, (void*)markCrossReferences, NULL) == NULL)
+        {
+            success = g_bridgeFinished.CreateManualEventNoThrow(false);
+        }
+
+        pThisThread->EnablePreemptiveMode();
+    }
+
+    return success;
+}
+
+extern "C" void QCALLTYPE JavaMarshal_FinishCrossReferenceProcessing(
+    MarkCrossReferencesArgs *crossReferences,
+    size_t length,
+    void* unreachableObjectHandles)
+{
+    _ASSERTE(crossReferences->ComponentCount >= 0);
+
+    _ASSERTE(g_GCBridgeActive);
+
+    // Mark the GCBridge as inactive.
+    // This must be synchronized with the GC so switch to cooperative mode.
+    {
+        bool wasCooperative = false;
+        Thread* pThisThread = ThreadStore::GetCurrentThreadIfAvailable();
+        pThisThread->DeferTransitionFrame();
+        pThisThread->DisablePreemptiveMode();
+
+        GCHeapUtilities::GetGCHeap()->NullBridgeObjectsWeakRefs(length, unreachableObjectHandles);
+
+        IGCHandleManager* pHandleManager = GCHandleUtilities::GetGCHandleManager();
+        for (size_t i = 0; i < length; i++)
+            pHandleManager->DestroyHandleOfUnknownType(((OBJECTHANDLE*)unreachableObjectHandles)[i]);
+
+        g_GCBridgeActive = false;
+        g_bridgeFinished.Set();
+
+        pThisThread->EnablePreemptiveMode();
+    }
+
+    ReleaseGCBridgeArgumentsWorker(crossReferences);
+}
+
+FCIMPL0(FC_BOOL_RET, RhIsGCBridgeActive)
+{
+    FC_RETURN_BOOL(g_GCBridgeActive);
+}
+FCIMPLEND
+
+extern "C" void QCALLTYPE JavaMarshal_WaitForGCBridgeFinish()
+{
+    // We will transition to pre-emptive mode to wait for the bridge to finish.
+    Thread* pThisThread = ThreadStore::GetCurrentThreadIfAvailable();
+    while (g_GCBridgeActive)
+    {
+        g_bridgeFinished.Wait(INFINITE, false, false);
+    }
+}
+
+#endif // FEATURE_JAVAMARSHAL

src/coreclr/nativeaot/System.Private.CoreLib/src/System.Private.CoreLib.csproj

@@ -159,6 +159,7 @@
     <Compile Include="System\CrashInfo.cs" />
     <Compile Include="System\Runtime\InteropServices\ComAwareWeakReference.NativeAot.cs" />
     <Compile Include="System\Runtime\InteropServices\CriticalHandle.NativeAot.cs" />
+    <Compile Include="System\Runtime\InteropServices\Java\JavaMarshal.NativeAot.cs" Condition="'$(FeatureJavaMarshal)' == 'true'" />
     <Compile Include="System\Activator.NativeAot.cs" />
     <Compile Include="System\AppContext.NativeAot.cs" />
     <Compile Include="System\ArgIterator.cs" />

src/coreclr/nativeaot/System.Private.CoreLib/src/System/Runtime/InteropServices/GCHandle.NativeAot.cs

@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.Runtime.InteropServices.Java;
+
 namespace System.Runtime.InteropServices
 {
     public partial struct GCHandle
@@ -14,9 +16,14 @@ public partial struct GCHandle
         internal static void InternalSet(IntPtr handle, object? value) => RuntimeImports.RhHandleSet(handle, value);
 
 #if FEATURE_JAVAMARSHAL
-        // FIXME implement waiting for bridge processing
         internal static object? InternalGetBridgeWait(IntPtr handle)
         {
+            if (RuntimeImports.RhIsGCBridgeActive())
+            {
+#pragma warning disable CA1416 // Validate platform compatibility
+                JavaMarshal.WaitForGCBridgeFinish();
+#pragma warning restore CA1416 // Validate platform compatibility
+            }
             return InternalGet(handle);
         }
 #endif