[Python]pytorch与C交互

ctypes是python的外部函数，提供了与c兼容的类型，并允许调用dll库中的函数。

c++库

要使函数能被python调用，需要编译为动态库：

# -fpic使得位置独立
# -shared代表这是动态库
g++ -fpic -shared -o libtest.so test.cpp

为保证函数接口能被外部识别，需要导出为纯c的：

#ifdef __cplusplus
extern "c"
{
#endif


void * callfortest(char *params);


#ifdef __cplusplus
};
#endif

ctypes

在python中要使用dll库，需要先通过cdll来加载（cdll载入按标准的 cdecl调用协议导出的函数）：

from ctypes import cdll

target = cdll.loadlibrary("libtest.so")

通过in_dll()可获取库中导出的变量：

# 获取 python 库本身的 py_optimizeflag
opt_flag = c_int.in_dll(pythonapi, "py_optimizeflag")

基础数据类型

ctypes 定义了一些和c兼容的基本数据类型，所有基础类型都继承自ctypes._simplecdata：

• value属性：包含实例的实际值。实例提取 value 属性时，通常每次会返回一个新的对象。

除了整数、字符串以及字节串之外，所有的python类型都必须使用它们对应的ctypes类型包装，才能够被正确地转换为所需的c语言类型。通过ctypes创建的类型是可变的（通过修改.value）：

i = c_int()
# i.value == 0
i.value = 99
# i.value == 99

c_wchar_p("hello, world")
# c.value == "hello, world"

当给指针类型的对象c_char_p, c_wchar_p 和 c_void_p等赋值时，将改变它们所指向的内存地址，而不是它们所指向的内存区域的内容。若底层函数可能会改变指针地址，则需要通过create_string_buffer创建：

p = create_string_buffer(3) # create a 3 byte buffer, initialized to nul bytes

p = create_string_buffer(b"hello") # create a buffer containing a nul terminated string

p = create_string_buffer(b"hello", 10) # create a 10 byte buffer
p.value = b"hi"
print(sizeof(p), repr(p.raw))
# 10 b'hi\x00lo\x00\x00\x00\x00\x00'

参数与返回值类型

以libc库为例：

cdll.loadlibrary("libc.so.6")

printf = libc.printf
# 通过设置argtypes属性来指定函数的必选参数类型
# 指定数据类型可以防止不合理的参数传递，并且会自动尝试将参数转换为需要的类型（否则必须手动转换）
printf.argtypes = [c_char_p, c_char_p, c_int, c_double]
printf(b"string '%s', int %d, double %f\n", b"hi", 10, 2.2)

strchr = libc.strchr
# 默认返回int，其他类型需通过restype属性来设定
strchr.restype = c_char_p
strchr.argtypes = [c_char_p, c_char]
strchr(b"abcdef", b"d")

# 构造缓冲区，获取输出
i = c_int()
f = c_float()
s = create_string_buffer(b'\x00' * 32) # 创建长度32，全部为null的缓冲区
libc.sscanf(b"1 3.14 hello", b"%d %f %s", byref(i), byref(f), s)
print(i.value, f.value, repr(s.value))
# 1 3.140000104904175 b'hello'

数组

数组是一个序列，包含指定个数元素，且必须类型相同。创建数组类型的推荐方式是使用一个类型乘以一个正数:

• _length_属性：指明数组中元素数量的正整数。
• _type_属性：指明每个元素的类型。

class point(structure):
  _fields_ = ("x", c_int), ("y", c_int)

pointsarray = point * 5
print(sizeof(pointsarray))
# 40

pa = pointarray(point(1,2), point(3,4)) # 后面三个全为0
print(sizeof(pa), len(pa))
# 40 5
for i in pa: print(i.x, i.y, end=";")
# 1 2;3 4;0 0;0 0;0 0;

指针

可以将ctypes类型数据传入pointer()函数创建指针：

• contents属性：返回指针指向的真实对象（ 每次访问这个属性时都会构造返回一个新的相同对象）
• _type_属性：指明所指向的类型。
• 指针对象也可以通过整数下标进行访问；
• 通过整数下标赋值可以改变指针所指向的真实内容；
• 无参调用指针类型可以创建一个null指针；

i = c_int(12)
pi = pointer(i)
ic = pi.contents

print(ic, ic is i)
# c_int(12) false

# 通过下标访问与修改内容
pi[0]=34
print(pi[0], pi.contents)
# 34 c_int(34)

# 修改指针指向
ii = c_int(45)
pi.contents = ii
print(pi[0])
# 56

结构体类型

结构体必须通过子类化ctypes.structure来创建，并且至少要定义一个 _fields_类变量，并允许通过直接属性访问来读取和写入字段。

• _fields_属性：定义结构体字段的序列。 其中的条目必须为2元组或3元组。
  • 第一项是字段名称；
  • 第二项指明字段类型，可以是任何 ctypes 数据类型；
  • 对于整数类型字段（如c_int），可以给定第三个可选项；为定义字段比特位宽度的小正整数。
• _pack_属性：一个可选的小整数，它允许覆盖实体中结构体字段的对齐方式。

对于不完整类型：即在结构体中包含指向自身的指针：

struct cell; /* forward declaration */

struct cell {
    char *name;
    struct cell *next;
};

在python中不能在类中使用自身，需要先定义结构，然后在设定_fields_属性：

class cell(structure):
  pass

cell._fields_ = [("name", c_char_p),
                ("next", pointer(cell))]

回调函数

必须先为回调函数创建一个类（明确调用约定，返回值类型以及参数信息）；cfunctype()工厂函数使用 cdecl 调用约定创建回调函数类型。

qsort = libc.qsort
qsort.restype=none

# 第一个参数为返回值类型，后续一次为对应函数参数
cmpfun = cfunctype(c_int, pointer(c_int), pointer(c_int))
def py_cmp_func(a,b):
  print('py_cmp_func', a[0], b[0])
  return 0

cmp_fun = cmpfun(py_cmp_func)

intarray5 = c_int * 5
ia = intarray5(1, 9, 7, 5, 8)
qsort(ia, len(ia), sizeof(c_int), py_cmp_func)

注意：回调函数是在python之外的另外一个线程使用（外部代码调用这个回调函数）， ctypes 会在每一次调用时创建一个虚拟 python 线程。这个行为在大多数情况下是合理的，但也意味着如果有数据使用 threading.local 方式存储，将无法访问，就算它们是在同一个c线程中调用的。

工具函数

一些常用工具函数：

• ctypes.addressof(obj)：以整数形式返回内存缓冲区地址；obj 必须为一个 ctypes 类型的实例。
• ctypes.alignment(obj_or_type)：返回一个 ctypes 类型的对齐要求；obj_or_type 必须为一个 ctypes 类型或实例。
• ctypes.byref(obj[, offset])：返回指向obj的引用，该对象必须为一个 ctypes 类型的实例。 offset 默认值为零，且必须为一个将被添加到内部指针值的整数。
• ctypes.cast(obj, type)：类似于 c 的强制转换运算符。 它返回一个 type 的新实例，该实例指向与 obj 相同的内存块。 type 必须为指针类型，而 obj 必须为可以被作为指针来解读的对象。
• ctypes.create_string_buffer(init_or_size, size=none)：创建一个可变的字符缓冲区。 返回的对象是一个 c_char 的 ctypes 数组。
  • init_or_size 必须是一个指明数组大小的整数，或者是一个将被用来初始化数组条目的字节串对象。
  • 如果将一个字节串对象指定为第一个参数，则将使缓冲区大小比其长度多一项以便数组的最后一项为一个 nul 终结符。 可以传入一个整数作为第二个参数以允许在不使用字节串长度的情况下指定数组大小。
• ctypes.create_unicode_buffer(init_or_size, size=none)：创建一个可变的 unicode 字符缓冲区。
• ctypes.get_errno()：返回调用线程中系统 errno 变量的 ctypes 私有副本的当前值。
• ctypes.memmove(dst, src, count)：与标准 c memmove 库函数相同：将 count 个字节从 src 拷贝到 dst。 dst 和 src 必须为整数或可被转换为指针的 ctypes 实例。
• ctypes.memset(dst, c, count)：与标准 c memset 库函数相同：将位于地址 dst 的内存块用 count 个字节的 c 值填充。 dst 必须为指定地址的整数或 ctypes 实例。
• ctypes.pointer(type)：创建并返回一个新的 ctypes 指针类型。 指针类型会被缓存并在内部重用，因此重复调用此函数耗费不大。 type 必须为 ctypes 类型。
• ctypes.pointer(obj)：创建一个新的指向 obj 的指针实例。 返回的对象类型为 pointer(type(obj))。
  • 如果你只是想向外部函数调用传递一个对象指针，你应当使用更为快速的 byref(obj)。
• ctypes.sizeof(obj_or_type)：返回 ctypes 类型或实例的内存缓冲区以字节表示的大小。
• ctypes.string_at(address, size=- 1)：返回从内存地址 address 开始的以字节串表示的 c 字符串。 如果指定了 size，则将其用作长度，否则将假定字符串以零值结尾。
• ctypes.wstring_at(address, size=- 1)：返回从内存地址 address 开始的以字符串表示的宽字节字符串。

示例

以c++回调一个python函数为例：

c++中的回调定义：

#ifdef __cplusplus
extern "c"
{
#endif

typedef void (*printoutput)(const char* outputs);

void set_callback(printoutput func);

#ifdef __cplusplus
};
#endif

python中使用回调：

from ctypes import cdll, c_char_p, cfunctype, pointer

target = cdll.loadlibrary("/workspace/libtest.so")


printcallback = cfunctype(none, c_char_p)
def print_callback(outputs):
    print("outputs:", outputs)

py_callback = printcallback(print_callback)

target.set_callback.restype = none
target.set_callback(py_callback)