Merge pull request #183 from CommunityToolkit/dev/remove-spinlock-object-extension

Remove SpinLock extension taking an object

Author: Sergio0694

CommunityToolkit.HighPerformance/Extensions/SpinLockExtensions.cs

@@ -4,7 +4,9 @@
 
 using System.ComponentModel;
 using System.Runtime.CompilerServices;
+#if NETSTANDARD2_1_OR_GREATER
 using System.Runtime.Versioning;
+#endif
 using System.Threading;
 
 namespace CommunityToolkit.HighPerformance;
@@ -48,7 +50,7 @@ public readonly unsafe ref struct UnsafeLock
         private readonly SpinLock* spinLock;
 
         /// <summary>
-        /// A value indicating whether or not the lock is taken by this <see cref="Lock"/> instance.
+        /// A value indicating whether or not the lock is taken by this <see cref="UnsafeLock"/> instance.
         /// </summary>
         private readonly bool lockTaken;
 
@@ -57,7 +59,7 @@ public readonly unsafe ref struct UnsafeLock
         /// </summary>
         /// <param name="spinLock">The target <see cref="SpinLock"/> to use.</param>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        public UnsafeLock(SpinLock* spinLock)
+        internal UnsafeLock(SpinLock* spinLock)
         {
             this.spinLock = spinLock;
             this.lockTaken = false;
@@ -103,33 +105,6 @@ public static Lock Enter(ref this SpinLock spinLock)
     {
         return new(ref spinLock);
     }
-#else
-    /// <summary>
-    /// Enters a specified <see cref="SpinLock"/> instance and returns a wrapper to use to release the lock.
-    /// This extension should be used though a <see langword="using"/> block or statement:
-    /// <code>
-    /// private SpinLock spinLock = new SpinLock();
-    ///
-    /// public void Foo()
-    /// {
-    ///     using (SpinLockExtensions.Enter(this, ref spinLock))
-    ///     {
-    ///         // Thread-safe code here...
-    ///     }
-    /// }
-    /// </code>
-    /// The compiler will take care of releasing the SpinLock when the code goes out of that <see langword="using"/> scope.
-    /// </summary>
-    /// <param name="owner">The owner <see cref="object"/> to create a portable reference for.</param>
-    /// <param name="spinLock">The target <see cref="SpinLock"/> to use (it must be within <paramref name="owner"/>).</param>
-    /// <returns>A wrapper type that will release <paramref name="spinLock"/> when its <see cref="System.IDisposable.Dispose"/> method is called.</returns>
-    /// <remarks>The returned <see cref="Lock"/> value shouldn't be used directly: use this extension in a <see langword="using"/> block or statement.</remarks>
-    [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    public static Lock Enter(object owner, ref SpinLock spinLock)
-    {
-        return new(owner, ref spinLock);
-    }
-#endif
 
     /// <summary>
     /// A <see langword="struct"/> that is used to enter and hold a <see cref="SpinLock"/> through a <see langword="using"/> block or statement.
@@ -150,34 +125,18 @@ public readonly ref struct Lock
         /// </summary>
         private readonly bool lockTaken;
 
-#if NETSTANDARD2_1_OR_GREATER
         /// <summary>
         /// Initializes a new instance of the <see cref="Lock"/> struct.
         /// </summary>
         /// <param name="spinLock">The target <see cref="SpinLock"/> to use.</param>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        public Lock(ref SpinLock spinLock)
+        internal Lock(ref SpinLock spinLock)
         {
             this.spinLock = new Ref<SpinLock>(ref spinLock);
             this.lockTaken = false;
 
             spinLock.Enter(ref this.lockTaken);
         }
-#else
-        /// <summary>
-        /// Initializes a new instance of the <see cref="Lock"/> struct.
-        /// </summary>
-        /// <param name="owner">The owner <see cref="object"/> to create a portable reference for.</param>
-        /// <param name="spinLock">The target <see cref="SpinLock"/> to use (it must be within <paramref name="owner"/>).</param>
-        [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        public Lock(object owner, ref SpinLock spinLock)
-        {
-            this.spinLock = new Ref<SpinLock>(owner, ref spinLock);
-            this.lockTaken = false;
-
-            spinLock.Enter(ref this.lockTaken);
-        }
-#endif
 
         /// <summary>
         /// Implements the duck-typed <see cref="System.IDisposable.Dispose"/> method and releases the current <see cref="SpinLock"/> instance.
@@ -191,4 +150,5 @@ public void Dispose()
             }
         }
     }
+#endif
 }

tests/CommunityToolkit.HighPerformance.UnitTests/Extensions/Test_SpinLockExtensions.cs

@@ -33,6 +33,7 @@ public unsafe void Test_ArrayExtensions_Pointer()
         Assert.AreEqual(sum, 1000 * 10);
     }
 
+#if !NETFRAMEWORK
     [TestMethod]
     public void Test_ArrayExtensions_Ref()
     {
@@ -44,11 +45,7 @@ public void Test_ArrayExtensions_Ref()
         {
             for (int j = 0; j < 10; j++)
             {
-#if NETFRAMEWORK
-                using (SpinLockExtensions.Enter(spinLockOwner, ref spinLockOwner.Lock))
-#else
                 using (spinLockOwner.Lock.Enter())
-#endif
                 {
                     sum++;
                 }
@@ -57,6 +54,7 @@ public void Test_ArrayExtensions_Ref()
 
         Assert.AreEqual(sum, 1000 * 10);
     }
+#endif
 
     /// <summary>
     /// A dummy model that owns a <see cref="SpinLock"/> object.