Python CFFI - 无法在函数调用中将格式化的Python字符串用作字节数组

时间:2016-07-09 13:06:18

标签: python c python-cffi

我正在学习如何将C中编写的代码包含到Python的各种方法,因为我有一个用于Microchip设备的API,这非常...单调乏味,我希望通过为它添加Python包装器,让我的生活更轻松,这将使我能够更快地测试内容。一种方法是使用cffi模块,该模块甚至为其用户提供verify(),基本上调用C编译器来检查提供的cdef(...)是否正确。< / p>

我写了一个小项目,以便我可以先学习如何正确使用cffi。它由两部分组成

  1. 图书馆 - 用C语言编写。我相应地使用cmakemake来编译代码:

    CMakeLists.txt

    project(testlib_for_cffi)
    cmake_minimum_required(VERSION 2.8)
    
    set(CMAKE_BUILD_TYPE Release)
    set(CMAKE_CXX_FLAGS "-fPIC ${CMAKE_C_FLAGS}")
    # Debug build
    set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -Wall -g -O0")
    # Release build
    set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -Os")
    
    aux_source_directory(. SRC_LIST)
    add_library(testcffi SHARED ${SRC_LIST})
    
    # Not required for the library but needed if I want to check for memory leaks with Valgrind
    set(SRC main.c)
    add_executable(${PROJECT_NAME} ${SRC})
    target_link_libraries(${PROJECT_NAME} PUBLIC testcffi)
    

    testcffi.h

    typedef struct
    {
      double x;
      double y;
      double z;
      char *label;
    } point_t;
    
    // Creation, printing and deletion
    point_t* createPoint(double x, double y, double z, char *label);
    void printPoint(point_t *point);
    void deletePoint(point_t *point);
    

    testcffi.c

    #include "testcffi.h"
    #include <stdio.h>
    #include <malloc.h>
    
    point_t* createPoint(double x, double y, double z, char *label) {
      point_t *p = malloc(sizeof(point_t));
      p->x = x;
      p->y = y;
      p->z = z;
      p->label = label;
    
      return p;
    }
    
    void printPoint(point_t *point) {
      if(point == NULL) return;
      printf("Data:\n\tx : %f\n\ty : %f\n\tz : %f\n\tmsg : \"%s\"\n", point->x, point->y, point->z, point->label);
    }
    
    void deletePoint(point_t *point) {
      if(point == NULL) return;
      free(point);
      point = NULL;
    }
    
  2. 在Python中测试代码 - 代码演示了struct的使用以及上述库中的三个函数:

            #!/usr/bin/python3
    
            from cffi import FFI
            import random
    
            ffi = FFI()
    
            # Add library's header
            ffi.cdef('''
                typedef struct
                {
                  double x;
                  double y;
                  double z;
                  char * label;
                } point_t;
    
                // Creation, printing and deletion
                point_t * createPoint(double x=0., double y=0., double z=0., char *label="my_label");
                void printPoint(point_t *point);
                void deletePoint(point_t *point);
            ''')
    
            # Load shared object from subdirectory `build`
            CLibTC = ffi.dlopen('build/libtestcffi.so')
    
            def createList(length=5):
                if len:
                    lst = []
                    for i in range(0, length):
                        lst.append(CLibTC.createPoint(
                            float(random.random()*(i+1)*10),
                            float(random.random()*(i+1)*10),
                            float(random.random()*(i+1)*10),
                            b'hello'  # FIXME Why does ONLY this work?
                            # ('point_%d' % i).encode('utf-8') # NOT WORKING
                            # 'point_{0}'.format(str(i)).encode('utf-8') # NOT WORKING
                            # ffi.new('char[]', 'point_{0}'.format(str(i)).encode('utf-8')) # NOT WORKING
                        ))
    
                    return lst
                return None
    
    
            def printList(lst):
                if lst and len(lst):
                    for l in lst:
                        CLibTC.printPoint(l)
    
            list_of_dstruct_ptr = createList(10)
            printList(list_of_dstruct_ptr)
    
  3. 问题来自我必须将Python字符串转换为的字节数组,以便将数据传递到我的C代码中的相应位置。

    上面的代码正在运行,但是我想使用其他类似于b'hello'的字符串。这就是我尝试在format()中使用%(及其短格式Python)来组合一堆字母和数字的原因。它没有成功。我得到""作为我label point_t的{​​{1}}参数的值,或者我得到一个奇怪的交替垃圾数据(大多数是字母或数字的奇怪字符)

    我认为我正在使用struct函数错误但是当我在encode()交互式shell中测试它时,我得到了使用Python的SAME输出。

    知道这里发生了什么吗?

    一个很有说服力的问题:从我到目前为止看来,似乎b'...'使用cffi中的垃圾收集来解除分配动态分配C代码中的内存。我已经用一堆积分进行了测试,但我想确保实际上总是如此。

    更新 好的,似乎没有Python的东西确实有效,但在这种情况下,所有的值都与循环中的最后一个值相同。例如,如果循环达到10,那么所有new(...) Python对象的标签中都有10个。这似乎是一个参考问题。当我使用struct时,我会获得垃圾数据。

1 个答案:

答案 0 :(得分:1)

在您的C代码中,point_t结构保存在label a char *中,即指向内存中其他位置的指针。如果你创建10个point_t结构,它们会保存指向内存中其他位置的10个字符串的指针。只要使用point_t结构,就必须确保这10个字符串保持活动状态。 CFFI无法猜测存在这样的关系。当您执行调用CLibTC.createPoint(..., some_string)时,CFFI会在呼叫周围分配char[]数组,并在其中复制some_string,但在调用后会释放此char[]内存。

使用那种代码:

c_string = ffi.new("char[]", some_string)
lst.append(createPoint(..., c_string))
keepalive.append(c_string)

其中keepalive是另一个列表,只要您需要point_t包含有效的label,就必须确保该列表保持活动状态。