Update UWP Jupiter interaction interface methods defined in .NET Core (dotnet/coreclr...

Update Jupiter host interface method names defined in .NET Core to match officially documented method names. The interface names are still different, but all function names now match.

Commit migrated from https://github.com/dotnet/coreclr/commit/9504d23951bc29b98e8f3d55138493d51abaff87

diff --git a/src/coreclr/src/System.Private.CoreLib/src/System/Runtime/InteropServices/WindowsRuntime/ICustomPropertyProvider.cs b/src/coreclr/src/System.Private.CoreLib/src/System/Runtime/InteropServices/WindowsRuntime/ICustomPropertyProvider.cs
index 3944670..819d570 100644 (file)
--- a/src/coreclr/src/System.Private.CoreLib/src/System/Runtime/InteropServices/WindowsRuntime/ICustomPropertyProvider.cs
+++ b/src/coreclr/src/System.Private.CoreLib/src/System/Runtime/InteropServices/WindowsRuntime/ICustomPropertyProvider.cs
@@ -117,7 +117,7 @@ namespace System.Runtime.InteropServices.WindowsRuntime
     // (such as the adapter code that addresses behavior differences between IBindableVector & List
     // as well as simplify forwarding code (except for IEnumerable)
     //
-    // 2. ICLRServices.CreateManagedReference will hand out ICCW* of a new instance of this object
+    // 2. ICLRServices.GetTrackerTarget will hand out ICCW* of a new instance of this object
     // and will hold the other object alive
     //
     //

diff --git a/src/coreclr/src/vm/jupiterobject.h b/src/coreclr/src/vm/jupiterobject.h
index ae3f4ab..2ae42c1 100644 (file)
--- a/src/coreclr/src/vm/jupiterobject.h
+++ b/src/coreclr/src/vm/jupiterobject.h
@@ -27,10 +27,10 @@ class ICCW;
 class DECLSPEC_UUID("29a71c6a-3c42-4416-a39d-e2825a07a773") ICLRServices : public IUnknown
 {
 public :
-    STDMETHOD(GarbageCollect)(DWORD dwFlags) = 0;
-    STDMETHOD(FinalizerThreadWait)() = 0;
-    STDMETHOD(DisconnectRCWsInCurrentApartment)() = 0;
-    STDMETHOD(CreateManagedReference)(IUnknown *pJupiterObject, ICCW **ppNewReference) = 0;
+    STDMETHOD(DisconnectUnusedReferenceSources)(DWORD dwFlags) = 0;
+    STDMETHOD(ReleaseDisconnectedReferenceSources)() = 0;
+    STDMETHOD(NotifyEndOfReferenceTrackingOnThread)() = 0;
+    STDMETHOD(GetTrackerTarget)(IUnknown *pJupiterObject, ICCW **ppNewReference) = 0;
     STDMETHOD(AddMemoryPressure)(UINT64 bytesAllocated) = 0;
     STDMETHOD(RemoveMemoryPressure)(UINT64 bytesAllocated) = 0;
 };
@@ -39,10 +39,10 @@ public :
 class DECLSPEC_UUID("3cf184b4-7ccb-4dda-8455-7e6ce99a3298") IJupiterGCManager : public IUnknown
 {
 public :
-    STDMETHOD(OnGCStarted)() = 0;
-    STDMETHOD(OnRCWWalkFinished)(BOOL bWalkFailed) = 0;
-    STDMETHOD(OnGCFinished)() = 0;
-    STDMETHOD(SetCLRServices)(/* [in] */ ICLRServices *pCLRServices) = 0;
+    STDMETHOD(ReferenceTrackingStarted)() = 0;
+    STDMETHOD(FindTrackerTargetsCompleted)(BOOL bWalkFailed) = 0;
+    STDMETHOD(ReferenceTrackingCompleted)() = 0;
+    STDMETHOD(SetReferenceTrackerHost)(/* [in] */ ICLRServices *pCLRServices) = 0;
 };
 
 // Windows.UI.Xaml.Hosting.IReferenceTrackerTarget
@@ -50,8 +50,8 @@ class DECLSPEC_UUID("64bd43f8-bfee-4ec4-b7eb-2935158dae21") ICCW : public IUnkno
 {
 
 public :
-    STDMETHOD_(ULONG, AddReferenceFromJupiter)() = 0;    
-    STDMETHOD_(ULONG, ReleaseFromJupiter)() = 0;
+    STDMETHOD_(ULONG, AddRefFromReferenceTracker)() = 0;
+    STDMETHOD_(ULONG, ReleaseFromReferenceTracker)() = 0;
     STDMETHOD(Peg)() = 0;
     STDMETHOD(Unpeg)() = 0;
 };
@@ -61,24 +61,24 @@ class DECLSPEC_UUID("04b3486c-4687-4229-8d14-505ab584dd88") IFindDependentWrappe
 {
 
 public :
-    STDMETHOD(OnFoundDependentWrapper)(/* [in] */ ICCW *pCCW) = 0;
+    STDMETHOD(FoundTrackerTarget)(/* [in] */ ICCW *pCCW) = 0;
 };
 
 // Windows.UI.Xaml.Hosting.IReferenceTracker
 class DECLSPEC_UUID("11d3b13a-180e-4789-a8be-7712882893e6") IJupiterObject : public IUnknown
 {
 public :
-    STDMETHOD(Connect)() = 0;           // Notify Jupiter that we've created a new RCW
-    STDMETHOD(Disconnect)() = 0;        // Notify Jupiter that we are about to destroy this RCW
-    STDMETHOD(FindDependentWrappers)(/* [in] */ IFindDependentWrappersCallback *pCallback) = 0;
-                                        // Find list of dependent CCWs for this RCW
-    STDMETHOD(GetJupiterGCManager)(/* [out, retval] */ IJupiterGCManager **ppJupiterGCManager) = 0;
-                                        // Retrieve IJupiterGCManager interface
-    STDMETHOD(AfterAddRef)() = 0;       // Notify Jupiter that we've done a AddRef()
-    STDMETHOD(BeforeRelease)() = 0;     // Notify Jupiter that we are about to do a Release()
-    STDMETHOD(Peg)() = 0;               // Notify Jupiter that we've returned this IJupiterObject as
-                                        // [out] parameter and this IJupiterObject object including 
-                                        // all its reachable CCWs should be pegged
+    STDMETHOD(ConnectFromTrackerSource)() = 0;     // Notify Jupiter that we've created a new RCW
+    STDMETHOD(DisconnectFromTrackerSource)() = 0;  // Notify Jupiter that we are about to destroy this RCW
+    STDMETHOD(FindTrackerTargets)(/* [in] */ IFindDependentWrappersCallback *pCallback) = 0;
+                                                // Find list of dependent CCWs for this RCW
+    STDMETHOD(GetReferenceTrackerManager)(/* [out, retval] */ IJupiterGCManager **ppJupiterGCManager) = 0;
+                                                // Retrieve IJupiterGCManager interface
+    STDMETHOD(AddRefFromTrackerSource)() = 0;   // Notify Jupiter that we've done a AddRef()
+    STDMETHOD(ReleaseFromTrackerSource)() = 0;  // Notify Jupiter that we are about to do a Release()
+    STDMETHOD(PegFromTrackerSource)() = 0;      // Notify Jupiter that we've returned this IJupiterObject as
+                                                // [out] parameter and this IJupiterObject object including
+                                                // all its reachable CCWs should be pegged
 };
 
 extern const IID IID_ICCW;

diff --git a/src/coreclr/src/vm/rcwwalker.cpp b/src/coreclr/src/vm/rcwwalker.cpp
index daab205..8b0fa24 100644 (file)
--- a/src/coreclr/src/vm/rcwwalker.cpp
+++ b/src/coreclr/src/vm/rcwwalker.cpp
@@ -42,19 +42,19 @@ SVAL_IMPL_INIT(BOOL,            RCWWalker, s_bIsGlobalPeggingOn, TRUE);     // D
 
 #ifndef DACCESS_COMPILE
 
-// Our implementation of ICLRServices provided to Jupiter via IJupiterGCManager::SetCLRServices.
+// Our implementation of ICLRServices provided to Jupiter via IJupiterGCManager::SetReferenceTrackerHost.
 class CLRServicesImpl : public IUnknownCommon<ICLRServices>
 {
 private:
-    // flags for CollectGarbage(DWORD dwFlags)
+    // flags for DisconnectUnusedReferenceSources(DWORD dwFlags)
     enum {
         GC_FOR_APPX_SUSPEND = 0x00000001
     };
 public:
-    STDMETHOD(GarbageCollect)(DWORD dwFlags);
-    STDMETHOD(FinalizerThreadWait)();
-    STDMETHOD(DisconnectRCWsInCurrentApartment)();
-    STDMETHOD(CreateManagedReference)(IUnknown *pJupiterObject, ICCW **ppNewReference);
+    STDMETHOD(DisconnectUnusedReferenceSources)(DWORD dwFlags);
+    STDMETHOD(ReleaseDisconnectedReferenceSources)();
+    STDMETHOD(NotifyEndOfReferenceTrackingOnThread)();
+    STDMETHOD(GetTrackerTarget)(IUnknown *pJupiterObject, ICCW **ppNewReference);
     STDMETHOD(AddMemoryPressure)(UINT64 bytesAllocated);
     STDMETHOD(RemoveMemoryPressure)(UINT64 bytesAllocated);
 };
@@ -95,7 +95,7 @@ inline LONG RCWWalker_UnhandledExceptionFilter(EXCEPTION_POINTERS* pExceptionPoi
 // Release context-bound RCWs and Jupiter RCWs (which are free-threaded but context-bound)
 // in the current apartment
 //
-STDMETHODIMP CLRServicesImpl::DisconnectRCWsInCurrentApartment()
+STDMETHODIMP CLRServicesImpl::NotifyEndOfReferenceTrackingOnThread()
 {
     CONTRACTL
     {
@@ -114,7 +114,7 @@ STDMETHODIMP CLRServicesImpl::DisconnectRCWsInCurrentApartment()
     return hr;
 }
 
-STDMETHODIMP CLRServicesImpl::GarbageCollect(DWORD dwFlags)
+STDMETHODIMP CLRServicesImpl::DisconnectUnusedReferenceSources(DWORD dwFlags)
 {
     CONTRACTL
     {
@@ -175,7 +175,7 @@ STDMETHODIMP CLRServicesImpl::RemoveMemoryPressure(UINT64 bytesAllocated)
 }
 
 
-STDMETHODIMP CLRServicesImpl::FinalizerThreadWait()
+STDMETHODIMP CLRServicesImpl::ReleaseDisconnectedReferenceSources()
 {
     CONTRACTL
     {
@@ -215,7 +215,7 @@ STDMETHODIMP CLRServicesImpl::FinalizerThreadWait()
 //  ppNewReference  - The ICCW* for the proxy created
 //                    Jupiter will call ICCW to establish a jupiter reference
 //
-STDMETHODIMP CLRServicesImpl::CreateManagedReference(IUnknown *pTarget, ICCW **ppNewReference)
+STDMETHODIMP CLRServicesImpl::GetTrackerTarget(IUnknown *pTarget, ICCW **ppNewReference)
 {
     CONTRACTL
     {
@@ -400,7 +400,7 @@ void RCWWalker::OnJupiterRCWCreated(RCW *pRCW, IJupiterObject *pJupiterObject)
     if (!s_pGCManager)
     {
         SafeComHolderPreemp<IJupiterGCManager> pGCManager;
-        HRESULT hr = pJupiterObject->GetJupiterGCManager(&pGCManager);
+        HRESULT hr = pJupiterObject->GetReferenceTrackerManager(&pGCManager);
         if (SUCCEEDED(hr))
         {
             if (pGCManager == NULL)
@@ -432,8 +432,8 @@ void RCWWalker::OnJupiterRCWCreated(RCW *pRCW, IJupiterObject *pJupiterObject)
                 pCLRServicesImpl.SuppressRelease();
                 pCLRServices.SuppressRelease();
 
-                LOG((LF_INTEROP, LL_INFO100, "\t[RCW Walker] Calling IGCManager::SetCLRServices(0x%p)\n", (void *)pCLRServices));
-                pGCManager->SetCLRServices(pCLRServices);
+                LOG((LF_INTEROP, LL_INFO100, "\t[RCW Walker] Calling IGCManager::SetReferenceTrackerHost(0x%p)\n", (void *)pCLRServices));
+                pGCManager->SetReferenceTrackerHost(pCLRServices);
             }
         }
         else
@@ -468,23 +468,23 @@ void RCWWalker::AfterJupiterRCWCreated(RCW *pRCW)
           
     //
     // Notify Jupiter that we've created a new RCW for this Jupiter object
-    // To avoid surprises, we should notify them before we fire the first AfterAddRef
+    // To avoid surprises, we should notify them before we fire the first AddRefFromTrackerSource
     //
-    STRESS_LOG2(LF_INTEROP, LL_INFO100, "[RCW Walker] Calling IJupiterObject::Connect (IJupiterObject = 0x%p, RCW = 0x%p)\n", pJupiterObject, pRCW);
-    pJupiterObject->Connect();
+    STRESS_LOG2(LF_INTEROP, LL_INFO100, "[RCW Walker] Calling IJupiterObject::ConnectFromTrackerSource (IJupiterObject = 0x%p, RCW = 0x%p)\n", pJupiterObject, pRCW);
+    pJupiterObject->ConnectFromTrackerSource();
     
     //
-    // Send out AfterAddRef callbacks to notify Jupiter we've done AddRef for certain interfaces
+    // Send out AddRefFromTrackerSource callbacks to notify Jupiter we've done AddRef for certain interfaces
     // We should do this *after* we made a AddRef because we should never
     // be in a state where report refs > actual refs
     //
 
-    // Send out AfterAddRef for cached IUnknown
+    // Send out AddRefFromTrackerSource for cached IUnknown
     RCWWalker::AfterInterfaceAddRef(pRCW);
     
     if (!pRCW->IsURTAggregated())
     {        
-        // Send out AfterAddRef for cached IJupiterObject
+        // Send out AddRefFromTrackerSource for cached IJupiterObject
         RCWWalker::AfterInterfaceAddRef(pRCW);
     }
     
@@ -519,8 +519,8 @@ void RCWWalker::BeforeJupiterRCWDestroyed(RCW *pRCW)
     // We only call this inside GC, so don't need to switch to preemptive here
     // Ignore the failure as there is no way we can handle that failure during GC
     //
-    STRESS_LOG2(LF_INTEROP, LL_INFO100, "[RCW Walker] Calling IJupiterObject::Disconnect (IJupiterObject = 0x%p, RCW = 0x%p)\n", pJupiterObject, pRCW);
-    pJupiterObject->Disconnect();
+    STRESS_LOG2(LF_INTEROP, LL_INFO100, "[RCW Walker] Calling IJupiterObject::DisconnectFromTrackerSource (IJupiterObject = 0x%p, RCW = 0x%p)\n", pJupiterObject, pRCW);
+    pJupiterObject->DisconnectFromTrackerSource();
     
     LOG((LF_INTEROP, LL_INFO100, "[RCW Walker] ----- RCWWalker::BeforeJupiterRCWDestroyed (RCW = 0x%p) ENDS   ----- \n", pRCW));
 }
@@ -611,9 +611,9 @@ void RCWWalker::WalkRCWs()
     //
     // Note: IGCManager should be free-threaded as it will be called on arbitary threads
     //
-    LOG((LF_INTEROP, LL_INFO100, "[RCW Walker] Calling IGCManager::OnRCWWalkFinished on 0x%p, bWalkFailed = %d\n", s_pGCManager, bWalkFailed));        
+    LOG((LF_INTEROP, LL_INFO100, "[RCW Walker] Calling IGCManager::FindTrackerTargetsCompleted on 0x%p, bWalkFailed = %d\n", s_pGCManager, bWalkFailed));
     _ASSERTE(s_pGCManager);
-    s_pGCManager->OnRCWWalkFinished(bWalkFailed);
+    s_pGCManager->FindTrackerTargetsCompleted(bWalkFailed);
         
     STRESS_LOG0 (LF_INTEROP, LL_INFO100, "[RCW Walker] RCW Walk finished\n");    
 }
@@ -661,17 +661,17 @@ public :
     }
 
     
-    STDMETHOD(OnFoundDependentWrapper)(ICCW *pUnk)
+    STDMETHOD(FoundTrackerTarget)(ICCW *pUnk)
     {
 #ifdef _DEBUG    
-        _ASSERTE(SUCCEEDED(m_hr) && W("Should not receive OnFoundDependentWrapper again if failed"));
+        _ASSERTE(SUCCEEDED(m_hr) && W("Should not receive FoundTrackerTarget again if failed"));
 #endif // _DEBUG
         _ASSERTE(pUnk != NULL);
         
         ComCallWrapper *pCCW = MapIUnknownToWrapper(pUnk);
         _ASSERTE(pCCW != NULL);
 
-        LOG((LF_INTEROP, LL_INFO1000, "\t[RCW Walker] IFindDependentWrappersCallback::OnFoundDependentWrapper being called: RCW 0x%p, CCW 0x%p\n", m_pRCW, pCCW));
+        LOG((LF_INTEROP, LL_INFO1000, "\t[RCW Walker] IFindDependentWrappersCallback::FoundTrackerTarget being called: RCW 0x%p, CCW 0x%p\n", m_pRCW, pCCW));
 
         //
         // Skip dependent handle creation if RCW/CCW points to the same managed object
@@ -772,13 +772,13 @@ HRESULT RCWWalker::WalkOneRCW(RCW *pRCW, RCWRefCache *pRCWRefCache)
 
     STRESS_LOG2 (LF_INTEROP, LL_INFO1000, "\t[RCW Walker] Walking RCW 0x%p (Managed Object = 0x%p)\n", pRCW, OBJECTREFToObject(pRCW->GetExposedObject()));
     
-    LOG((LF_INTEROP, LL_INFO1000, "\t[RCW Walker] Calling IJupiterObject::FindDependentWrappers\n", pRCW));
-    hr = pJupiterObject->FindDependentWrappers(&callback);
+    LOG((LF_INTEROP, LL_INFO1000, "\t[RCW Walker] Calling IJupiterObject::FindTrackerTargets\n", pRCW));
+    hr = pJupiterObject->FindTrackerTargets(&callback);
 
 #ifdef _DEBUG
     if (FAILED(callback.GetHRESULT()))
     {
-        _ASSERTE(callback.GetHRESULT() == hr && W("FindDepedentWrappers should return the failed result from the callback method OnFoundDependentWrapper"));
+        _ASSERTE(callback.GetHRESULT() == hr && W("FindDepedentWrappers should return the failed result from the callback method FoundTrackerTarget"));
     }
 
     LOG((LF_INTEROP, LL_INFO1000, "\t[RCW Walker] Total %d refs created for RCW 0x%p\n", callback.GetCreatedRefs(), pRCW));
@@ -920,12 +920,12 @@ void RCWWalker::OnGCStartedWorker()
     
     // 
     // Let Jupiter know we are about to walk RCWs so that they can lock their reference cache
-    // Note that Jupiter doesn't need to unpeg all CCWs at this point and they can do the pegging/unpegging in OnRCWWalkFinished
+    // Note that Jupiter doesn't need to unpeg all CCWs at this point and they can do the pegging/unpegging in FindTrackerTargetsCompleted
     //
     // Note: IGCManager should be free-threaded as it will be called on arbitary threads
     //
-    LOG((LF_INTEROP, LL_INFO100, "[RCW Walker] Calling IGCManager::OnGCStarted on 0x%p\n", s_pGCManager));
-    s_pGCManager->OnGCStarted();   
+    LOG((LF_INTEROP, LL_INFO100, "[RCW Walker] Calling IGCManager::ReferenceTrackingStarted on 0x%p\n", s_pGCManager));
+    s_pGCManager->ReferenceTrackingStarted();
     
     // From this point, jupiter decides whether a CCW should be pegged or not as global pegging flag is now off
     s_bIsGlobalPeggingOn = FALSE;
@@ -957,8 +957,8 @@ void RCWWalker::OnGCFinishedWorker()
     // Note: We can IJupiterGCManager from any thread and it is guaranteed by Jupiter
     //
     _ASSERTE(s_pGCManager);
-    LOG((LF_INTEROP, LL_INFO100, "[RCW Walker] Calling IGCManager::OnGCFinished on 0x%p\n", s_pGCManager));        
-    s_pGCManager->OnGCFinished();
+    LOG((LF_INTEROP, LL_INFO100, "[RCW Walker] Calling IGCManager::ReferenceTrackingCompleted on 0x%p\n", s_pGCManager));
+    s_pGCManager->ReferenceTrackingCompleted();
     
     s_bIsGlobalPeggingOn = TRUE;
     LOG((LF_INTEROP, LL_INFO100, "[RCW Walker] Global pegging flag is on\n"));    

diff --git a/src/coreclr/src/vm/rcwwalker.h b/src/coreclr/src/vm/rcwwalker.h
index 3549d1c..7bb7299 100644 (file)
--- a/src/coreclr/src/vm/rcwwalker.h
+++ b/src/coreclr/src/vm/rcwwalker.h
@@ -46,7 +46,7 @@ public :
     static void OnEEShutdown();
 
     //
-    // Send out a AfterAddRef callback to notify Jupiter we've done a AddRef
+    // Send out a AddRefFromTrackerSource callback to notify Jupiter we've done a AddRef
     // We should do this *after* we made a AddRef because we should never
     // be in a state where reported refs > actual refs
     //
@@ -63,13 +63,13 @@ public :
         IJupiterObject *pJupiterObject = pRCW->GetJupiterObject();
         if (pJupiterObject)
         {
-            STRESS_LOG2(LF_INTEROP, LL_INFO100, "[RCW Walker] Calling IJupiterObject::AfterAddRef (IJupiterObject = 0x%p, RCW = 0x%p)\n", pJupiterObject, pRCW);
-            pJupiterObject->AfterAddRef();
+            STRESS_LOG2(LF_INTEROP, LL_INFO100, "[RCW Walker] Calling IJupiterObject::AddRefFromTrackerSource (IJupiterObject = 0x%p, RCW = 0x%p)\n", pJupiterObject, pRCW);
+            pJupiterObject->AddRefFromTrackerSource();
         }
     }
     
     //
-    // Send out BeforeRelease callback for every cached interface pointer
+    // Send out ReleaseFromTrackerSource callback for every cached interface pointer
     // This needs to be made before call Release because we should never be in a 
     // state that reported refs > actual refs 
     //
@@ -85,8 +85,8 @@ public :
         IJupiterObject *pJupiterObject = pRCW->GetJupiterObject();
         if (pJupiterObject)
         {
-            STRESS_LOG2(LF_INTEROP, LL_INFO100, "[RCW Walker] Calling IJupiterObject::BeforeRelease before Release (IJupiterObject = 0x%p, RCW = 0x%p)\n", pJupiterObject, pRCW);
-            pJupiterObject->BeforeRelease();
+            STRESS_LOG2(LF_INTEROP, LL_INFO100, "[RCW Walker] Calling IJupiterObject::ReleaseFromTrackerSource before Release (IJupiterObject = 0x%p, RCW = 0x%p)\n", pJupiterObject, pRCW);
+            pJupiterObject->ReleaseFromTrackerSource();
         }
     }