Skip to content

Track managed array pinning in Mat #1691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions src/OpenCvSharp/Modules/core/Mat/Mat.cs
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ protected Mat(Mat m)

NativeMethods.HandleException(
NativeMethods.core_Mat_new12(m.ptr, out ptr));
pinLifetime = m.pinLifetime?.Ref();
if (ptr == IntPtr.Zero)
throw new OpenCvSharpException("imread failed.");
}
Expand Down Expand Up @@ -312,10 +313,10 @@ public static Mat FromPixelData(int rows, int cols, MatType type, IntPtr data, l
/// If the parameter is missing (set to AUTO_STEP ), no padding is assumed and the actual step is calculated as cols*elemSize() .</param>
protected Mat(int rows, int cols, MatType type, Array data, long step = 0)
{
var handle = AllocGCHandle(data);
pinLifetime = new ArrayPinningLifetime(data);
NativeMethods.HandleException(
NativeMethods.core_Mat_new8(rows, cols, type,
handle.AddrOfPinnedObject(), new IntPtr(step), out ptr));
pinLifetime.DataPtr, new IntPtr(step), out ptr));
}

/// <summary>
Expand Down Expand Up @@ -390,22 +391,22 @@ protected Mat(IEnumerable<int> sizes, MatType type, Array data, IEnumerable<long
if (data is null)
throw new ArgumentNullException(nameof(data));

var handle = AllocGCHandle(data);
pinLifetime = new ArrayPinningLifetime(data);
#pragma warning disable CA1508
var sizesArray = sizes as int[] ?? sizes.ToArray();
#pragma warning restore CA1508
if (steps is null)
{
NativeMethods.HandleException(
NativeMethods.core_Mat_new9(sizesArray.Length, sizesArray,
type, handle.AddrOfPinnedObject(), IntPtr.Zero, out ptr));
type, pinLifetime.DataPtr, IntPtr.Zero, out ptr));
}
else
{
var stepsArray = steps.Select(s => new IntPtr(s)).ToArray();
NativeMethods.HandleException(
NativeMethods.core_Mat_new9(sizesArray.Length, sizesArray,
type, handle.AddrOfPinnedObject(), stepsArray, out ptr));
type, pinLifetime.DataPtr, stepsArray, out ptr));
}
}

Expand Down Expand Up @@ -2472,6 +2473,9 @@ public Mat SubMat(int rowStart, int rowEnd, int colStart, int colEnd)
NativeMethods.core_Mat_subMat1(ptr, rowStart, rowEnd, colStart, colEnd, out var ret));
GC.KeepAlive(this);
var retVal = new Mat(ret);

// If this is a managed array, keep the array pinned as long as the Mat is alive
retVal.pinLifetime = pinLifetime?.Ref();
return retVal;
}

Expand Down
70 changes: 70 additions & 0 deletions src/OpenCvSharp/Modules/core/Mat/MatPinning.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
using System.Runtime.InteropServices;

namespace OpenCvSharp;

public partial class Mat
{
private ArrayPinningLifetime? pinLifetime;

/// <inheritdoc/>
protected override void DisposeManaged()
{
pinLifetime?.Dispose();
base.DisposeManaged();
}

/// <summary>
/// Pins an array and unpins it when all references are released.
/// </summary>
private class ArrayPinningLifetime : IDisposable
{
private GCHandle handle;
private int refCount;

/// <summary>
/// Creates an instance of the <see cref="ArrayPinningLifetime"/> class.
/// </summary>
/// <param name="array">The array to be pinned.</param>
public ArrayPinningLifetime(Array array)
{
handle = GCHandle.Alloc(array, GCHandleType.Pinned);
}

/// <summary>
/// Gets the data pointer of the pinned <see cref="Array"/>.
/// </summary>
/// <exception cref="ObjectDisposedException">Thrown when the handle has been deallocated.</exception>
public IntPtr DataPtr => handle.IsAllocated ? handle.AddrOfPinnedObject() : throw new ObjectDisposedException(nameof(ArrayPinningLifetime));

/// <summary>Increments the reference count of the pinned array.</summary>
/// <returns>Returns a reference to this <see cref="ArrayPinningLifetime"/> instance.</returns>
public ArrayPinningLifetime Ref()
{
Interlocked.Increment(ref refCount);
return this;
}

/// <summary>
/// Decrements the reference count of the pinned array. If the reference count reaches zero, the array will be
/// unpinned.
/// </summary>
public void Dispose()
{
if (Interlocked.Decrement(ref refCount) != 0 || !handle.IsAllocated)
{
return;
}

handle.Free();
GC.SuppressFinalize(this);
}

~ArrayPinningLifetime()
{
if (handle.IsAllocated)
{
handle.Free();
}
}
}
}
Loading