Merge pull request #2327 from stefannikolei/stefannikolei/nullable/memory

Remove nullable disable from Memory.Allocators

Author: JimBobSquarePants

src/ImageSharp/Memory/Allocators/Internals/Gen2GcCallback.cs

@@ -1,6 +1,5 @@
 // Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
-#nullable disable
 
 // Port of BCL internal utility:
 // https://github.com/dotnet/runtime/blob/57bfe474518ab5b7cfe6bf7424a79ce3af9d6657/src/libraries/System.Private.CoreLib/src/System/Gen2GcCallback.cs
@@ -15,8 +14,8 @@ namespace SixLabors.ImageSharp.Memory.Internals;
 /// </summary>
 internal sealed class Gen2GcCallback : CriticalFinalizerObject
 {
-    private readonly Func<bool> callback0;
-    private readonly Func<object, bool> callback1;
+    private readonly Func<bool>? callback0;
+    private readonly Func<object, bool>? callback1;
     private GCHandle weakTargetObj;
 
     private Gen2GcCallback(Func<bool> callback) => this.callback0 = callback;
@@ -32,7 +31,7 @@ private Gen2GcCallback(Func<object, bool> callback, object targetObj)
         if (this.weakTargetObj.IsAllocated)
         {
             // Check to see if the target object is still alive.
-            object targetObj = this.weakTargetObj.Target;
+            object? targetObj = this.weakTargetObj.Target;
             if (targetObj == null)
             {
                 // The target object is dead, so this callback object is no longer needed.
@@ -43,7 +42,7 @@ private Gen2GcCallback(Func<object, bool> callback, object targetObj)
             // Execute the callback method.
             try
             {
-                if (!this.callback1(targetObj))
+                if (!this.callback1!(targetObj))
                 {
                     // If the callback returns false, this callback object is no longer needed.
                     this.weakTargetObj.Free();
@@ -64,7 +63,7 @@ private Gen2GcCallback(Func<object, bool> callback, object targetObj)
             // Execute the callback method.
             try
             {
-                if (!this.callback0())
+                if (!this.callback0!())
                 {
                     // If the callback returns false, this callback object is no longer needed.
                     return;

src/ImageSharp/Memory/Allocators/Internals/RefCountedMemoryLifetimeGuard.cs

@@ -1,6 +1,5 @@
 // Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
-#nullable disable
 
 using SixLabors.ImageSharp.Diagnostics;
 
@@ -15,7 +14,7 @@ internal abstract class RefCountedMemoryLifetimeGuard : IDisposable
     private int refCount = 1;
     private int disposed;
     private int released;
-    private string allocationStackTrace;
+    private string? allocationStackTrace;
 
     protected RefCountedMemoryLifetimeGuard()
     {

src/ImageSharp/Memory/Allocators/Internals/SharedArrayPoolBuffer{T}.cs

@@ -1,9 +1,9 @@
 // Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
-#nullable disable
 
 using System.Buffers;
 using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
 using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
 
@@ -22,7 +22,7 @@ public SharedArrayPoolBuffer(int lengthInElements)
         this.lifetimeGuard = new LifetimeGuard(this.Array);
     }
 
-    public byte[] Array { get; private set; }
+    public byte[]? Array { get; private set; }
 
     protected override void Dispose(bool disposing)
     {
@@ -41,7 +41,11 @@ public override Span<T> GetSpan()
         return MemoryMarshal.Cast<byte, T>(this.Array.AsSpan(0, this.lengthInBytes));
     }
 
-    protected override object GetPinnableObject() => this.Array;
+    protected override object GetPinnableObject()
+    {
+        this.CheckDisposed();
+        return this.Array;
+    }
 
     public void AddRef()
     {
@@ -52,6 +56,7 @@ public void AddRef()
     public void ReleaseRef() => this.lifetimeGuard.ReleaseRef();
 
     [Conditional("DEBUG")]
+    [MemberNotNull(nameof(Array))]
     private void CheckDisposed()
     {
         if (this.Array == null)
@@ -62,7 +67,7 @@ private void CheckDisposed()
 
     private sealed class LifetimeGuard : RefCountedMemoryLifetimeGuard
     {
-        private byte[] array;
+        private byte[]? array;
 
         public LifetimeGuard(byte[] array) => this.array = array;
 
@@ -73,7 +78,7 @@ protected override void Release()
             // This is not ideal, but subsequent leaks will end up returning arrays to per-cpu buckets,
             // meaning likely a different bucket than it was rented from,
             // but this is PROBABLY better than not returning the arrays at all.
-            ArrayPool<byte>.Shared.Return(this.array);
+            ArrayPool<byte>.Shared.Return(this.array!);
             this.array = null;
         }
     }

src/ImageSharp/Memory/Allocators/Internals/UniformUnmanagedMemoryPool.cs

@@ -1,6 +1,5 @@
 // Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
-#nullable disable
 
 using System.Diagnostics;
 
@@ -13,7 +12,7 @@ internal partial class UniformUnmanagedMemoryPool : System.Runtime.ConstrainedEx
 {
     private static int minTrimPeriodMilliseconds = int.MaxValue;
     private static readonly List<WeakReference<UniformUnmanagedMemoryPool>> AllPools = new();
-    private static Timer trimTimer;
+    private static Timer? trimTimer;
 
     private static readonly Stopwatch Stopwatch = Stopwatch.StartNew();
 
@@ -97,7 +96,7 @@ public UnmanagedMemoryHandle Rent()
     /// <summary>
     /// Rent <paramref name="bufferCount"/> buffers or return 'null' if the pool is full.
     /// </summary>
-    public UnmanagedMemoryHandle[] Rent(int bufferCount)
+    public UnmanagedMemoryHandle[]? Rent(int bufferCount)
     {
         UnmanagedMemoryHandle[] buffersLocal = this.buffers;
 
@@ -248,7 +247,7 @@ private static void TimerCallback()
 
             foreach (WeakReference<UniformUnmanagedMemoryPool> weakPoolRef in AllPools)
             {
-                if (weakPoolRef.TryGetTarget(out UniformUnmanagedMemoryPool pool))
+                if (weakPoolRef.TryGetTarget(out UniformUnmanagedMemoryPool? pool))
                 {
                     pool.Trim();
                 }

src/ImageSharp/Memory/Allocators/Internals/UnmanagedMemoryHandle.cs

@@ -1,6 +1,5 @@
 // Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
-#nullable disable
 
 using System.Runtime.InteropServices;
 
@@ -20,7 +19,7 @@ internal struct UnmanagedMemoryHandle : IEquatable<UnmanagedMemoryHandle>
     private static long totalOomRetries;
 
     // A Monitor to wait/signal when we are low on memory.
-    private static object lowMemoryMonitor;
+    private static object? lowMemoryMonitor;
 
     public static readonly UnmanagedMemoryHandle NullHandle;
 
@@ -114,17 +113,17 @@ public void Free()
         if (Volatile.Read(ref lowMemoryMonitor) != null)
         {
             // We are low on memory. Signal all threads waiting in AllocateHandle().
-            Monitor.Enter(lowMemoryMonitor);
-            Monitor.PulseAll(lowMemoryMonitor);
-            Monitor.Exit(lowMemoryMonitor);
+            Monitor.Enter(lowMemoryMonitor!);
+            Monitor.PulseAll(lowMemoryMonitor!);
+            Monitor.Exit(lowMemoryMonitor!);
         }
 
         this.lengthInBytes = 0;
     }
 
     public bool Equals(UnmanagedMemoryHandle other) => this.handle.Equals(other.handle);
 
-    public override bool Equals(object obj) => obj is UnmanagedMemoryHandle other && this.Equals(other);
+    public override bool Equals(object? obj) => obj is UnmanagedMemoryHandle other && this.Equals(other);
 
     public override int GetHashCode() => this.handle.GetHashCode();
 }

src/ImageSharp/Memory/Allocators/UniformUnmanagedMemoryPoolMemoryAllocator.cs

@@ -135,7 +135,7 @@ internal override MemoryGroup<T> AllocateGroup<T>(
         }
 
         // Attempt to rent the whole group from the pool, allocate a group of unmanaged buffers if the attempt fails:
-        if (MemoryGroup<T>.TryAllocate(this.pool, totalLength, bufferAlignment, options, out MemoryGroup<T> poolGroup))
+        if (MemoryGroup<T>.TryAllocate(this.pool, totalLength, bufferAlignment, options, out MemoryGroup<T>? poolGroup))
         {
             return poolGroup;
         }

src/ImageSharp/Memory/DiscontiguousBuffers/MemoryGroupExtensions.cs

@@ -106,7 +106,7 @@ internal static void CopyTo<T>(this ReadOnlySpan<T> source, IMemoryGroup<T> targ
         }
     }
 
-    internal static void CopyTo<T>(this IMemoryGroup<T> source, IMemoryGroup<T> target)
+    internal static void CopyTo<T>(this IMemoryGroup<T>? source, IMemoryGroup<T>? target)
         where T : struct
     {
         Guard.NotNull(source, nameof(source));

src/ImageSharp/Memory/DiscontiguousBuffers/MemoryGroupSpanCache.cs

@@ -13,7 +13,7 @@ namespace SixLabors.ImageSharp.Memory;
 internal unsafe struct MemoryGroupSpanCache
 {
     public SpanCacheMode Mode;
-    public byte[] SingleArray;
+    public byte[]? SingleArray;
     public void* SinglePointer;
     public void*[] MultiPointer;
 

src/ImageSharp/Memory/DiscontiguousBuffers/MemoryGroupView{T}.cs

@@ -1,9 +1,9 @@
 // Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
-#nullable disable
 
 using System.Buffers;
 using System.Collections;
+using System.Diagnostics.CodeAnalysis;
 using System.Runtime.CompilerServices;
 
 namespace SixLabors.ImageSharp.Memory;
@@ -21,7 +21,7 @@ namespace SixLabors.ImageSharp.Memory;
 internal class MemoryGroupView<T> : IMemoryGroup<T>
     where T : struct
 {
-    private MemoryGroup<T> owner;
+    private MemoryGroup<T>? owner;
     private readonly MemoryOwnerWrapper[] memoryWrappers;
 
     public MemoryGroupView(MemoryGroup<T> owner)
@@ -63,6 +63,7 @@ public long TotalLength
         }
     }
 
+    [MemberNotNullWhen(true, nameof(owner))]
     public bool IsValid => this.owner != null;
 
     public Memory<T> this[int index]
@@ -99,6 +100,7 @@ internal void Invalidate()
         this.owner = null;
     }
 
+    [MemberNotNull(nameof(owner))]
     private void EnsureIsValid()
     {
         if (!this.IsValid)

src/ImageSharp/Memory/DiscontiguousBuffers/MemoryGroup{T}.Owned.cs

@@ -1,8 +1,8 @@
 // Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
-#nullable disable
 
 using System.Buffers;
+using System.Diagnostics.CodeAnalysis;
 using System.Runtime.CompilerServices;
 using SixLabors.ImageSharp.Memory.Internals;
 
@@ -15,8 +15,8 @@ internal abstract partial class MemoryGroup<T>
     /// </summary>
     public sealed class Owned : MemoryGroup<T>, IEnumerable<Memory<T>>
     {
-        private IMemoryOwner<T>[] memoryOwners;
-        private RefCountedMemoryLifetimeGuard groupLifetimeGuard;
+        private IMemoryOwner<T>[]? memoryOwners;
+        private RefCountedMemoryLifetimeGuard? groupLifetimeGuard;
 
         public Owned(IMemoryOwner<T>[] memoryOwners, int bufferLength, long totalLength, bool swappable)
             : base(bufferLength, totalLength)
@@ -149,7 +149,7 @@ public override void Dispose()
             }
             else
             {
-                foreach (IMemoryOwner<T> memoryOwner in this.memoryOwners)
+                foreach (IMemoryOwner<T> memoryOwner in this.memoryOwners!)
                 {
                     memoryOwner.Dispose();
                 }
@@ -161,6 +161,7 @@ public override void Dispose()
         }
 
         [MethodImpl(InliningOptions.ShortMethod)]
+        [MemberNotNull(nameof(memoryOwners))]
         private void EnsureNotDisposed()
         {
             if (this.memoryOwners is null)
@@ -170,6 +171,7 @@ private void EnsureNotDisposed()
         }
 
         [MethodImpl(MethodImplOptions.NoInlining)]
+        [DoesNotReturn]
         private static void ThrowObjectDisposedException() => throw new ObjectDisposedException(nameof(MemoryGroup<T>));
 
         // When the MemoryGroup points to multiple buffers via `groupLifetimeGuard`,