python - C struct => ctypes struct ... 这个映射正确吗？

Question

我正在尝试从 Python 访问两个遗留的解/压缩函数，它们是用 C 语言编写的，目前可以通过 DLL 获得(我有 C 源代码)。

向函数传递一个(部分)填充的 C 结构，并使用此信息压缩或解压缩提供的缓冲区中的数据。

这就是调用函数的方式。我添加了 __cdecl 以实现 Python 兼容性。

// Both functions return 0 on success and nonzero value on failure
int __cdecl pkimplode(struct pkstream *pStr);
int __cdecl pkexplode(struct pkstream *pStr);

这是在 C 中定义的 pkstream 结构:

struct pkstream {
   unsigned char *pInBuffer;           // Pointer to input buffer
   unsigned int nInSize;               // Size of input buffer
   unsigned char *pOutBuffer;          // Pointer to output buffer
   unsigned int nOutSize;              // Size of output buffer upon return
   unsigned char nLitSize;             // Specifies fixed or var size literal bytes
   unsigned char nDictSizeByte;        // Dictionary size; either 1024, 2048, or 4096
   // The rest of the members of this struct are used internally,
   // so setting these values outside pkimplode or pkexplode has no effect
   unsigned char *pInPos;              // Current position in input buffer
   unsigned char *pOutPos;             // Current position in output buffer
   unsigned char nBits;                // Number of bits in bit buffer
   unsigned long nBitBuffer;           // Stores bits until enough to output a byte
   unsigned char *pDictPos;            // Position in dictionary
   unsigned int nDictSize;             // Maximum size of dictionary
   unsigned int nCurDictSize;          // Current size of dictionary
   unsigned char Dict[0x1000];         // Sliding dictionary used for compdecomp
};

这是我在 Python 中镜像此结构的尝试。

# Define the pkstream struct
class PKSTREAM(Structure):
   _fields_ = [('pInBuffer', c_ubyte),
               ('nInSize', c_uint),
               ('pOutBuffer', c_ubyte),
               ('nOutSize', c_uint),
               ('nLitSize', c_ubyte),
               ('nDictSizeByte', c_ubyte),
               ('pInPos', c_ubyte),
               ('pOutPos', c_ubyte),
               ('nBits', c_ubyte),
               ('nBitBuffer', c_ulong),
               ('pDictPos', c_ubyte),
               ('nDictSize', c_uint),
               ('nCurDictSize', c_uint),
               ('Dict', c_ubyte)]

对于以下问题，我非常感谢您的帮助(我选择在前端提问，而不是只是“即兴”，希望出于显而易见的原因):

1. 对于 unsigned char 类型的成员，我不确定是使用 c_ubyte、c_char 还是 c_char_p。 c_ubyte 最接近地映射到 unsigned char 的 ctypes(至少根据文档)，但实际上是一个 ?int/long?在 Python 中。

2. 有时成员是一个指向无符号字符的指针...这会映射到 c_char_p 吗？ ctypes 文档说所有字节和 unicode 字符串无论如何都作为指针传递，那么我需要为此做出哪些规定？

3. 我需要向该函数提供 pOutBuffer，它应该是指向已分配内存位置的指针，函数可以将解压/压缩数据复制到该位置。我认为我应该为此使用 create_string_buffer() 创建一个大小合适的缓冲区？

4. 我还需要知道如何定义成员 Dict[0x1000]，它(在我看来)创建一个 4096 字节的缓冲区供函数内部使用。我知道我的定义显然是错误的，但不知道应该如何定义？

5. 应该将 C 函数修饰为 __stdcall 还是 __cdecl？ (到目前为止，我一直在一些测试 DLL 上使用后者)。

非常感谢任何反馈!

提前致谢

詹姆斯

Answer 1

如果结构中的数据是一个指针，你也必须在 Python 端将其声明为一个指针。

一种方法是在 ctypes 中使用 POINTER 实用程序 - 它是一个比 ctypes.c_char_p 更高级别的对象(并且不完全兼容那) - 但你的代码将变得更具可读性。此外，为了模拟 C 数组，基本 ctypes 类型可以乘以一个标量，返回的对象是一个可以用作相同大小的基本类型的 C 向量的对象 - (因此 Dict 字段可以定义为下面，c_ubyte * 4096)

请注意，虽然 char 等同于 c_ubyte，但 int 等同于 c_int 而不是 c_uint 和 long 也是如此。

您的结构定义没有说明指向的缓冲区是 const。如果你传递一个 python 字符串(不可变的)并且你的库试图改变它你会得到错误。相反，您应该传递从 create_string_buffer 返回的可变内存，由您的字符串初始化。

POINTER = ctypes.POINTER
# Define the pkstream struct
class PKSTREAM(Structure):
   _fields_ = [('pInBuffer', POINTER(c_char)),
               ('nInSize', c_int),
               ('pOutBuffer', POINTER(c_char)),
               ('nOutSize', c_int),
               ('nLitSize', c_char),
               ('nDictSizeByte', c_char),
               ('pInPos', POINTER(c_char)),
               ('pOutPos', POINTER(c_char)),
               ('nBits', c_char),
               ('nBitBuffer', c_long),
               ('pDictPos', POINTER(c_char)),
               ('nDictSize', c_int),
               ('nCurDictSize', c_int),
               ('Dict', c_char * 0x1000)]

至于 (5)，我不知道您应该如何装饰您的 C 函数 - 使用任何有效的方法。