P/Invoke C++ DLL 用于填充托管缓冲区
Posted
技术标签:
【中文标题】P/Invoke C++ DLL 用于填充托管缓冲区【英文标题】:P/Invoke C++ DLL for filling a managed buffer 【发布时间】:2018-01-14 23:47:31 【问题描述】:基本上,我有一个用于研究的数据采集设备的 DLL 和头文件 (C++)。该设备有 8 个传感器,每个传感器都有 x、y、z 等数据点。我想在 WPF 中为此设备创建一个 UI 程序。到目前为止,我已经成功地能够通过不安全的代码实现与 .NET 中的设备进行通信,并将数据读入结构数组(其中每个结构对应于一个传感器)。但是,我想看看是否可以使用严格安全的代码实现来使其工作,但是我现在已经碰壁了一段时间。这是我第一次使用非托管代码和托管代码,所以请多多包涵。我在网上搜索了无数线程,兔子洞越来越深,所以我想请有经验的人给我一些建议。 API头文件基本上有一个函数,定义如下:
int GetSynchronousRecord(USHORT sensorID, void *pRecord, int recordSize);
本质上,我们通过引用向函数传递了一个缓冲区,然后将其填满。我可以选择获取单个传感器的数据,或者一次获取所有传感器,具体取决于我传递的 sensorID 参数。到目前为止(在托管世界中)已经对我有用的是,如果我执行以下操作:
[StructLayout(LayoutKind.Sequential)]
public struct DOUBLE_POSITION_ANGLES_TIME_Q_RECORD
public double x;
public double y;
public double z;
public double a;
public double e;
public double r;
public double time;
public ushort quality;
;
...
[DllImport("ATC3DG64.DLL", CallingConvention = CallingConvention.Cdecl)]
public static extern int GetSynchronousRecord(ushort sensorID, ref DOUBLE_POSITION_ANGLES_TIME_Q_RECORD record, int recordSize);
...
DOUBLE_POSITION_ANGLES_TIME_Q_RECORD record = new DOUBLE_POSITION_ANGLES_TIME_Q_RECORD();
// Get the data from SENSOR_1 only
errorCode = GetSynchronousRecord(1, ref record, Marshal.SizeOf(record));
所以这个实现工作正常,我可以以非常好的速度获取所有坐标数据。但是,我想一次获得所有传感器。在 C++ API 代码示例中,它们向 GetSynchronousRecord 函数传递一个 STRUCTS 数组,每个传感器一个结构。我尝试在 C# 中做同样的事情,如下所示:
[DllImport("ATC3DG64.DLL", CallingConvention = CallingConvention.Cdecl)]
public static extern int GetSynchronousRecord(ushort sensorID, ref DOUBLE_POSITION_ANGLES_TIME_Q_RECORD[] record, int recordSize);
// Define Array of Struct for each sensor
DOUBLE_POSITION_ANGLES_TIME_Q_RECORD[] record = new DOUBLE_POSITION_ANGLES_TIME_Q_RECORD[8];
while(recording)
...
// Get data from ALL sensors (0xffff)
errorCode = GetSynchronousRecord(0xffff, ref record, Marshal.SizeOf(record)*8);
...
但这直接导致我的程序因 System.ExecutionEngineException 错误而崩溃。我已经读过,因为我的函数需要一个 void* 指针,所以我应该使用 IntPtr 参数,但老实说,这种方法似乎很混乱。我尝试的另一件事是实际循环遍历每个传感器并调用传感器的函数,但这会将速度几乎降低到 1 条记录/秒(而不是 100 条记录/秒)。 stackexchange 上的许多其他类似线程都说要使用 out
参数,或者在函数定义中使用 [In, Out] 属性,但这些建议都没有奏效。
TL;DR: 如果我正确理解了我的情况,我有一个 MANAGED 结构数组,我需要正确地将其作为参数传递给 C++ 函数(通过引用传递),然后函数将使用来自数据采集设备的数据填充我的结构。
我为文字/代码墙道歉,非常感谢有经验的人为我提供的任何信息。
编辑:澄清一下,GetSynchronousRecord 函数位于 while 循环中,在每次迭代中,我都会为每个结构获取新的数据点。
【问题讨论】:
任何托管的“指针”必须是fixed
,以便GC在执行本机部分docs.microsoft.com/en-us/dotnet/csharp/language-reference/…时不会移动它
感谢 Sasha,但我不确定我的代码中的哪个位置是相关的,fixed
不是仅在不安全的上下文中使用吗?我认为我不需要不安全的代码。
您没有显示将第二个参数更改为 ref 传递的数组的 pinvoke 版本。这就是错误。很容易解决,但在问题完成之前我不会回答。
@David Heffernan 抱歉,为简洁起见,我没有包含它,但我更新了代码以在使用数组的情况下显示 P/Invoke 参数,我希望这就是你的意思。谢谢。
【参考方案1】:
您的第二个 p/invoke 声明是错误的。你有
[DllImport("ATC3DG64.DLL", CallingConvention = CallingConvention.Cdecl)]
public static extern int GetSynchronousRecord(
ushort sensorID,
ref DOUBLE_POSITION_ANGLES_TIME_Q_RECORD[] record,
int recordSize
);
问题是数组参数。因为您通过ref
传递该数组,这实际上使其成为双指针。相反,您只想删除 ref
并像这样声明导入:
[DllImport("ATC3DG64.DLL", CallingConvention = CallingConvention.Cdecl)]
public static extern int GetSynchronousRecord(
ushort sensorID,
[Out] DOUBLE_POSITION_ANGLES_TIME_Q_RECORD[] record,
int recordSize
);
[Out]
属性告诉封送器数据正在流出函数。没有它,默认假设是数据流入。
当你调用函数时,这样做:
errorCode = GetSynchronousRecord(0xffff, record, Marshal.SizeOf(record)*record.Length);
【讨论】:
只是一个小的修正,我必须在函数声明中的记录参数上添加一个 [Out] 属性,如下所示:[DllImport("ATC3DG64.DLL", CallingConvention = CallingConvention.Cdecl)]
public static extern int GetSynchronousRecord(ushort sensorID, [Out] DOUBLE_POSITION_ANGLES_TIME_Q_RECORD[] records, int recordSize);
但除此之外它的工作效果很好。非常感谢!
这让我很吃惊。您的实际记录类型是否包含使其不可 blittable 的其他字段。
我的意思是记录类型是DOUBLE_POSITION_ANGLES_TIME_Q_RECORD
结构,可以在我最初的帖子中看到。我认为这些字段中的任何一个都不是不可复制的。它只是double
和ushort
。【参考方案2】:
最好的方法可能是使用IntPtr
而不是ref DOUBLE_POSITION_ANGLES_TIME_Q_RECORD
。
我会将 P/Invoke 签名更改为:
[DllImport("ATC3DG64.DLL", CallingConvention = CallingConvention.Cdecl)]
public static extern int GetSynchronousRecord(ushort sensorID, IntPtr record, int recordSize);
创建一个指向所需内存空间的 IntPtr:
IntPtr ptr = Marshal.AllocHGlobal(Marshal.SizeOf<DOUBLE_POSITION_ANGLES_TIME_Q_RECORD>() * 8);
调用 P/Invoke 函数(它应该用结构填充内存):
errorCode = GetSynchronousRecord(0xffff, ptr, Marshal.SizeOf<DOUBLE_POSITION_ANGLES_TIME_Q_RECORD>() * 8);
从内存块中获取结构:
DOUBLE_POSITION_ANGLES_TIME_Q_RECORD[] records = new DOUBLE_POSITION_ANGLES_TIME_Q_RECORD[8];
for (i = 0; i < 8; i++)
records[i] = Marshal.PtrToStructure<DOUBLE_POSITION_ANGLES_TIME_Q_RECORD>(IntPtr.Add(ptr, i * Marshal.SizeOf<DOUBLE_POSITION_ANGLES_TIME_Q_RECORD>()));
Marshal.FreeHGlobal(ptr);
【讨论】:
在分配的数据传输到托管内存之后,即在记录数组已填充。 谢谢,这很有意义。我不确定我是否可以在这里提出后续问题?所以GetSynchronousRecord
函数其实是在一个循环里面不断的获取数据。我是否必须在每次循环迭代时释放 ptr
内存,或者每次迭代时旧数据会被新数据覆盖(然后我可以在采集终止后释放 ptr
)?
@LittleFinger 从您描述GetSynchronousRecord
函数的方式来看,不,它不会在for 循环中。只有在调用GetSynchronousRecord
函数之后,您才会循环获取每个结构,然后在循环完成后释放它(我已在答案中更新)
@ub3rst4r 对不起,我的意思是,所有这些代码都在一个 while 循环中,因为我需要不断地获取所有 8 个传感器数据。在每个while
循环迭代中,我知道我需要for
循环来遍历每个结构。但我的问题是我是否必须在每个 while
循环迭代中分配和释放 IntPtr?
@LittleFinger 与this answer explains 一样,无论是在循环外还是循环内,成本都没有变化。如果您正在执行许多小型分配,那么在循环之外分配内存可能会更好。以上是关于P/Invoke C++ DLL 用于填充托管缓冲区的主要内容,如果未能解决你的问题,请参考以下文章
在 C# 中为 p/invoke 创建一个基本的 C++ .dll