static void ValidateWrappersInstanceIsolation()
{
Console.WriteLine($"Running {nameof(ValidateWrappersInstanceIsolation)}...");
var cw1 = new TestComWrappers();
var cw2 = new TestComWrappers();
var testObj = new Test();
// Allocate a wrapper for the object
IntPtr comWrapper1 = cw1.GetOrCreateComInterfaceForObject(testObj, CreateComInterfaceFlags.TrackerSupport);
IntPtr comWrapper2 = cw2.GetOrCreateComInterfaceForObject(testObj, CreateComInterfaceFlags.TrackerSupport);
Assert.AreNotEqual(comWrapper1, IntPtr.Zero);
Assert.AreNotEqual(comWrapper2, IntPtr.Zero);
Assert.AreNotEqual(comWrapper1, comWrapper2);
IntPtr comWrapper3 = cw1.GetOrCreateComInterfaceForObject(testObj, CreateComInterfaceFlags.TrackerSupport);
IntPtr comWrapper4 = cw2.GetOrCreateComInterfaceForObject(testObj, CreateComInterfaceFlags.TrackerSupport);
Assert.AreNotEqual(comWrapper3, comWrapper4);
Assert.AreEqual(comWrapper1, comWrapper3);
Assert.AreEqual(comWrapper2, comWrapper4);
Marshal.Release(comWrapper1);
Marshal.Release(comWrapper2);
Marshal.Release(comWrapper3);
Marshal.Release(comWrapper4);
// Get an object from a tracker runtime.
IntPtr trackerObjRaw = MockReferenceTrackerRuntime.CreateTrackerObject();
// Create objects for the COM instance
var trackerObj1 = (ITrackerObjectWrapper)cw1.GetOrCreateObjectForComInstance(trackerObjRaw, CreateObjectFlags.TrackerObject);
var trackerObj2 = (ITrackerObjectWrapper)cw2.GetOrCreateObjectForComInstance(trackerObjRaw, CreateObjectFlags.TrackerObject);
Assert.AreNotEqual(trackerObj1, trackerObj2);
var trackerObj3 = (ITrackerObjectWrapper)cw1.GetOrCreateObjectForComInstance(trackerObjRaw, CreateObjectFlags.TrackerObject);
var trackerObj4 = (ITrackerObjectWrapper)cw2.GetOrCreateObjectForComInstance(trackerObjRaw, CreateObjectFlags.TrackerObject);
Assert.AreNotEqual(trackerObj3, trackerObj4);
Assert.AreEqual(trackerObj1, trackerObj3);
Assert.AreEqual(trackerObj2, trackerObj4);
Marshal.Release(trackerObjRaw);
}
private static IntPtr SetWeakReferenceTarget(WeakReference <WeakReferenceableWrapper> wr, TestComWrappers cw)
{
IntPtr objRaw = WeakReferenceNative.CreateWeakReferencableObject();
var obj = (WeakReferenceableWrapper)cw.GetOrCreateObjectForComInstance(objRaw, CreateObjectFlags.None);
wr.SetTarget(obj);
ValidateWeakReferenceState(wr, expectedIsAlive: true, cw);
return(objRaw);
}
private static (WeakReference <WeakReferenceableWrapper>, IntPtr) GetWeakReference(TestComWrappers cw)
{
IntPtr objRaw = WeakReferenceNative.CreateWeakReferencableObject();
var obj = (WeakReferenceableWrapper)cw.GetOrCreateObjectForComInstance(objRaw, CreateObjectFlags.None);
var wr = new WeakReference <WeakReferenceableWrapper>(obj);
ValidateWeakReferenceState(wr, expectedIsAlive: true, cw);
return(wr, objRaw);
}
static (WeakReference <WeakReferencableWrapper>, IntPtr) GetWeakReference()
{
var cw = new TestComWrappers();
IntPtr objRaw = WeakReferenceNative.CreateWeakReferencableObject();
var obj = (WeakReferencableWrapper)cw.GetOrCreateObjectForComInstance(objRaw, CreateObjectFlags.None);
return(new WeakReference <WeakReferencableWrapper>(obj), objRaw);
}
static void ValidateRuntimeTrackerScenario()
{
Console.WriteLine($"Running {nameof(ValidateRuntimeTrackerScenario)}...");
var cw = new TestComWrappers();
// Get an object from a tracker runtime.
IntPtr trackerObjRaw = MockReferenceTrackerRuntime.CreateTrackerObject();
// Create a managed wrapper for the native object.
var trackerObj = (ITrackerObjectWrapper)cw.GetOrCreateObjectForComInstance(trackerObjRaw, CreateObjectFlags.TrackerObject);
// Ownership has been transferred to the wrapper.
Marshal.Release(trackerObjRaw);
var testWrapperIds = new List <int>();
for (int i = 0; i < 1000; ++i)
{
// Create a native wrapper for the managed object.
IntPtr testWrapper = cw.GetOrCreateComInterfaceForObject(new Test(), CreateComInterfaceFlags.TrackerSupport);
// Pass the managed object to the native object.
int id = trackerObj.AddObjectRef(testWrapper);
// Retain the managed object wrapper ptr.
testWrapperIds.Add(id);
Marshal.Release(testWrapper);
}
Assert.IsTrue(testWrapperIds.Count <= Test.InstanceCount);
GC.Collect();
GC.Collect();
GC.Collect();
GC.Collect();
GC.Collect();
Assert.IsTrue(testWrapperIds.Count <= Test.InstanceCount);
// Remove the managed object ref from the native object.
foreach (int id in testWrapperIds)
{
trackerObj.DropObjectRef(id);
}
testWrapperIds.Clear();
GC.Collect();
GC.Collect();
GC.Collect();
GC.Collect();
GC.Collect();
}
static void ValidateCreateObjectCachingScenario()
{
Console.WriteLine($"Running {nameof(ValidateCreateObjectCachingScenario)}...");
var cw = new TestComWrappers();
// Get an object from a tracker runtime.
IntPtr trackerObjRaw = MockReferenceTrackerRuntime.CreateTrackerObject();
var trackerObj1 = (ITrackerObjectWrapper)cw.GetOrCreateObjectForComInstance(trackerObjRaw, CreateObjectFlags.TrackerObject);
var trackerObj2 = (ITrackerObjectWrapper)cw.GetOrCreateObjectForComInstance(trackerObjRaw, CreateObjectFlags.TrackerObject);
Assert.AreEqual(trackerObj1, trackerObj2);
// Ownership has been transferred to the wrapper.
Marshal.Release(trackerObjRaw);
var trackerObj3 = (ITrackerObjectWrapper)cw.GetOrCreateObjectForComInstance(trackerObjRaw, CreateObjectFlags.TrackerObject | CreateObjectFlags.UniqueInstance);
Assert.AreNotEqual(trackerObj1, trackerObj3);
}
static (WeakReference <WeakReferencableWrapper>, IntPtr) GetWeakReference()
{
var cw = new TestComWrappers();
IntPtr objRaw = WeakReferenceNative.CreateWeakReferencableObject();
var obj = (WeakReferencableWrapper)cw.GetOrCreateObjectForComInstance(objRaw, CreateObjectFlags.None);
// The returned WeakReferencableWrapper from ComWrappers takes ownership
// of the ref returned from CreateWeakReferencableObject.
// Call Marshal.AddRef to ensure that objRaw owns a reference.
Marshal.AddRef(objRaw);
return(new WeakReference <WeakReferencableWrapper>(obj), objRaw);
}
static void ValidateQueryInterfaceAfterManagedObjectCollected()
{
Console.WriteLine($"Running {nameof(ValidateQueryInterfaceAfterManagedObjectCollected)}...");
var cw = new TestComWrappers();
{
// Activate the Reference Tracker system in the .NET runtime by consuming an IReferenceTracker instance.
IntPtr trackerObjRaw = MockReferenceTrackerRuntime.CreateTrackerObject();
var trackerObj = (ITrackerObjectWrapper)cw.GetOrCreateObjectForComInstance(trackerObjRaw, CreateObjectFlags.TrackerObject);
Marshal.Release(trackerObjRaw);
}
int refCount;
IntPtr refTrackerTarget;
{
// Create a native wrapper over a managed object.
IntPtr testWrapper = CreateWrapper(cw);
refTrackerTarget = MockReferenceTrackerRuntime.TrackerTarget_AddRefFromReferenceTrackerAndReturn(testWrapper);
// Ownership has been transferred to the IReferenceTrackerTarget instance.
// The COM reference count should be 0 and indicates to the GC the managed object
// can be collected.
refCount = Marshal.Release(testWrapper);
Assert.AreEqual(0, refCount);
}
ForceGC();
// Calling QueryInterface on an IReferenceTrackerTarget instance is permitted when
// the wrapper lifetime has been extended. However, the QueryInterface may fail
// if the associated managed object was collected. The failure here is an important
// part of the contract for a Reference Tracker runtime.
var iid = typeof(ITest).GUID;
IntPtr iTestComObject;
int hr = Marshal.QueryInterface(refTrackerTarget, ref iid, out iTestComObject);
const int COR_E_ACCESSING_CCW = unchecked ((int)0x80131544);
Assert.AreEqual(COR_E_ACCESSING_CCW, hr);
// Release the IReferenceTrackerTarget instance.
refCount = MockReferenceTrackerRuntime.TrackerTarget_ReleaseFromReferenceTracker(refTrackerTarget);
Assert.AreEqual(0, refCount);
static void ValidateComInterfaceCreationRoundTrip()
{
Console.WriteLine($"Running {nameof(ValidateComInterfaceCreationRoundTrip)}...");
var testObj = new Test();
var wrappers = new TestComWrappers();
// Allocate a wrapper for the object
IntPtr comWrapper = wrappers.GetOrCreateComInterfaceForObject(testObj, CreateComInterfaceFlags.None);
Assert.AreNotEqual(IntPtr.Zero, comWrapper);
var testObjUnwrapped = wrappers.GetOrCreateObjectForComInstance(comWrapper, CreateObjectFlags.Unwrap);
Assert.AreEqual(testObj, testObjUnwrapped);
// Release the wrapper
int count = Marshal.Release(comWrapper);
Assert.AreEqual(0, count);
}