Python ctypes指向结构的指针作为没有成员访问的标识符

Question

我有两个不同的 C 函数，我想在 Python 中将它们与 ctypes 一起使用。

一个函数正在建立一个连接并返回一个指向结构的指针。该指针应用作第二个函数中的参数以重用已建立的连接。

C 代码：

customStruct * connect()
{
    customStruct *obj = connection_helper();
    return obj;
}

void foo(customStruct * obj)
{
    foo_helper(obj);
}

Python 代码：

from ctypes import *
lib = CDLL("./test.dll")

obj = lib.connect()
lib.foo(obj)

不幸的是，当我调用lib.foo() 时，我检索到访问冲突错误。我可以使用具有_fields_ 属性的类在Python 中重新创建customStruct 结构，但是由于该结构由许多其他结构组成，并且由于我不想访问Python 本身中的结构成员，所以我正在考虑另一种如何创建可重复使用的标识符。

我可以随意更改connect() 和foo() 的定义。如果我不必在 python 中重新创建结构，我还可以创建另一个“标识符”结构。

更新： 看来我必须使用函数byref() 来实现我想要的。 https://docs.python.org/3/library/ctypes.html#ctypes.byref

文档声明“返回的对象只能用作外部函数调用参数”，但我不确定在 connect() 中返回什么。

Answer 1

就像在 cmets 中提到的那样，您需要在 Python 端为 connect 函数设置 restype 并为 foo 函数设置 argtypes。

在代码中它看起来像这样：

from ctypes import *

lib = cdll.LoadLibrary("some.dll")
lib.connect.restype = c_void_p
lib.foo.argtypes = c_void_p,

obj = lib.connect()
lib.foo(obj)

测试

一个简短的测试应该验证这在 C 端的连接和 foo 函数中提供了相同的指针。

稍作修改的代码版本可能如下所示：

#include <stdlib.h>
#include <stdio.h>

typedef struct  {
    int x;
} customStruct;

static customStruct *connection_helper() {
    return malloc(sizeof(customStruct));
}

customStruct *connect()
{
    customStruct *obj = connection_helper();
    printf("connect: %p\n", obj);
    return obj;
}

void foo(customStruct * obj)
{
    printf("foo: %p\n", obj);
    //do something
}

如果你运行它，你会得到类似的东西：

connect: 0x7fa219e094a0
foo: 0x7fa219e094a0

Answer 2

如果你有一个不透明的结构（你不知道它的成员，或者不想知道它的成员），你仍然应该在 python 中创建一个类来表示该结构。然后，您可以使用此类正确键入您的函数。这将有助于防止您不小心将错误的对象作为“CustomStruct”指针传递的错误。

例如：

from ctypes import cdll, c_int, c_void_p

mylib = cdll.LoadLibrary('mylib')

class CustomStructP(c_void_p):
    # subclassing c_void_p creates an opaque pointer type that is distinct
    # from c_void_p, and can only be instantiated as a pointer
    pass

create = mylib.create
create.argtypes = [c_int]
create.restype = CustomStructP

display = mylib.display
display.argtypes = [CustomStructP]
display.restype = None

delete = mylib.delete
delete.argtypes = [CustomStructP]
delete.restype = None

obj = create(10)
display(obj)
delete(obj)

display(CustomStructP())  # passing a null pointer

现在，如果你尝试类似：display(c_void_p())，你会得到：

Traceback (most recent call last):
  File "C:\Users\User\Documents\python\src\main.py", line 31, in <module>
    display(c_void_p())
ctypes.ArgumentError: argument 1: <class 'TypeError'>: wrong type

我使用的 C 代码是：

#include <stdio.h>
#include <stdlib.h>

struct customStruct {
    int val;
};

struct customStruct *
create(int val) {
    struct customStruct *obj = malloc(sizeof(struct customStruct));
    obj->val = val;
    return obj;
}

void
display(struct customStruct *obj) {
    if (obj) {
        printf("customStruct(%d) @ %p\n", obj->val, obj);
    }
    else {
        puts("customStruct is NULL");
    }
}

void
delete(struct customStruct *obj) {
    free(obj);
}