使用python-c-api调用的Cython回调段错误

Question

在eGige摄像机的控制下，我有了一个C库，我已经启动了一个cython代码项目，它的想法是拥有每种语言中最好的东西。

该程序库提供了一种从摄像机中监听心跳的方法，以了解是否已断开连接。我已经做过的C++类中的回调，但从这个C++类中，调用类的python方法，在我尝试过的所有方法中都陷入了分段错误。

我已经将它封装在一个特定的C++类中：

#include <Python.h>
/* (...) */
PyCallback::PyCallback(PyObject* self, const char* methodName)
{
  Py_XINCREF(self);
  _self = self;
  _method = PyObject_GetAttrString(self, methodName);
}
PyCallback::~PyCallback()
{
  Py_XDECREF(_self);
}
void PyCallback::execute()
{
  try
  {
    PyObject *args = PyTuple_Pack(1,_self);
    PyObject_CallFunctionObjArgs(_method, args);
  }catch(...){
    _error("Exception calling python");
  }
}

从cython对象中，代码是：

cdef class Camera(...):
    # (...)
    cdef registerRemovalCallback(self):
        cdef:
            PyCallback* obj
        obj = new PyCallback(<PyObject*> self, <char*> "cameraRemovalCallback")
    cdef cameraRemovalCallback(self):
        self._isPresent = False

回溯的最低部分是在准备参数的时候。

#0  0x00007ffff7b24592 in PyErr_Restore () from /usr/lib64/libpython2.6.so.1.0
#1  0x00007ffff7b23fef in PyErr_SetString () from /usr/lib64/libpython2.6.so.1.0
#2  0x00007ffff7b314dd in ?? () from /usr/lib64/libpython2.6.so.1.0
#3  0x00007ffff7b313ca in ?? () from /usr/lib64/libpython2.6.so.1.0
#4  0x00007ffff7b316c1 in ?? () from /usr/lib64/libpython2.6.so.1.0
#5  0x00007ffff7b31d2f in ?? () from /usr/lib64/libpython2.6.so.1.0
#6  0x00007ffff7b31e9c in Py_BuildValue () from /usr/lib64/libpython2.6.so.1.0
#7  0x00007ffff637cbf8 in PyCallback::execute (this=0x16212a0) at pylon/PyCallback.cpp:53
#8  0x00007ffff6376248 in CppCamera::removalCallback (this=0x161fb30, pDevice=<value optimized out>) at pylon/Camera.cpp:387

我尝试使用_Py_BuildValue("(self)"，self)来进行论证；但是，在这里我遇到了一个分段错误。

我也尝试过在参数字段中使用带NULL的PyObject_CallFunctionObjArgs，认为指向"self“的指针可能已经嵌入，因为方法指向这个对象中的特定地址。但是他们--我在那里发现了断层。

有人看到我的错误了吗？用不同的方式制作的东西？我希望这是我对该由谁来做的误解。

@ 2016/08/01

在以下注释说明中，对代码进行了两次修改：

首先，指向PyCallback的指针存储作为相机cython类的成员存储：

cdef class Camera(...):
    cdef:
        #(...)
        PyCallback* _cbObj
    # (...)
    cdef registerRemovalCallback(self):
        self._cbObj = new PyCallback(<PyObject*> self, <char*> "cameraRemovalCallback")
    cdef cameraRemovalCallback(self):
        self._isPresent = False

即使这是一个基本的部分故障来源，它似乎没有涉及到当前的一个。

然后是PyCallback::execute()在c++中，我做了一些更改。在阅读了GIL (Global解释器Lock)并添加了一些对它的调用之后，我添加了一个可能指导解决方案的检查：

PyCallback::PyCallback(PyObject* self, const char* methodName)
{
  Py_Initialize();
  Py_XINCREF(self);
  _self = self;
  _method = PyObject_GetAttrString(self, methodName);
}

PyCallback::~PyCallback()
{
  Py_XDECREF(_self);
  Py_Finalize();
}

void PyCallback::execute()
{
  PyGILState_STATE gstate;

  gstate = PyGILState_Ensure();
  try
  {
    if ( PyCallable_Check(_method) )
    {
      _info("Build arguments and call method");
      PyObject *args = Py_BuildValue("(O)", _self);
      PyObject *kwargs = Py_BuildValue("{}", "", NULL);
      PyObject_Call(_method, args, kwargs);
    }
    else
    {
      _warning("The given method is not callable!");
    }
  }
  catch(...)
  {
    // TODO: collect and show more information about the exception
    _error("Exception calling python");
  }
  PyGILState_Release(gstate);
}

甚至我也不知道如何进行调用，主要问题是_PyCallable_Check_返回false。

我还测试了如何使用typedef选项和C指针来使用相同的分段错误结果调用它。

@ 2016/08/03

我已经着手进行建议的修改。cameraRemovalCallback现在从cdef改为def，而PyCallback中的一些if报告说现在找到了该方法。此外，还向~PyCallback()添加了对Py_XDECREF(_method)的调用，以便在构造函数中找到该调用。无用的try-catch也被删除了。

从DavidW提到的对DavidW的引用中，我检查了许多*Call*组合:掉到分段故障上。

我认为这个问题正在变得肮脏，并且正在出现一个论坛(问题->答案->重播->.)。对此我很抱歉，下一次我要写的时候，我会试着告诉你，分段故障已经解决了。

Answer 1

我没有保证这是唯一的问题，但这肯定是一个问题：

cameraRemovalCallback是一个cdef函数。这意味着函数完全可以从C/Cython访问，但不能从Python访问。这意味着PyObject_GetAttrString失败(因为cameraRemovalCallback不是cameraRemovalCallback属性)。

您应该用def而不是cdef来定义cdef，也就是说，它可以通过普通的cdef机制访问。您还应该检查PyObject_GetAttrString的结果--如果它返回NULL，那么它就找不到属性了。

因此，您最终会尝试将NULL作为一个Python函数调用。

其他较小的问题：

您应该在_method中减少~PyCallback。

您不应该调用Py_Initialize和Py_Finalize。无论如何，您似乎都是在Python中创建类，因此它不需要初始化或完成。最后定稿肯定会给你带来麻烦。

我不认为您需要将self作为参数传递给PyObject_Call。(但我可能错了)

Python不会引发C++异常，因此您的try{} catch(...)永远不会捕获任何东西。相反，请检查返回值。

您需要减少Py_BuildValue的两个调用的结果(当您完成它们时)，也就是PyObject_Call的结果。如果你不这么做你就是在漏掉记忆。

下面的完整示例适用于我(使用Python3.5-我很难用早期版本测试它)。如果它对您有效，那么您可能需要确定在您的情况下有什么不同？如果它对你不起作用，那就更神秘了。

pycallback.hpp：

#include <Python.h>
#include <stdexcept>

inline PyObject* getCallable(PyObject* o, const char* methodName) {
    // assume o is not null
    PyObject* callable = PyObject_GetAttrString(o,methodName);
    if (callable == nullptr) {
        throw std::runtime_error("Attribute does not exist");
    }
    return callable;
}

class PyCallback {
private:
    PyObject* _callable;

public:
    PyCallback(PyObject* callable) {
        // assume callable isn't null
        if (!PyCallable_Check(callable)) {
            throw std::runtime_error("object passed to PyCallback is not callable");
        }
        _callable = callable;
        Py_XINCREF(_callable);
    }

    PyCallback(PyObject* o, const char* methodName) : 
    PyCallback(getCallable(o,methodName)) { // needs C++11 to compile
    }

    // don't define copy operators
    PyCallback(const PyCallback&) = delete;
    PyCallback& operator=(const PyCallback&) = delete;

    ~PyCallback() {
        Py_XDECREF(_callable);
    }

    void execute() {
        PyGILState_STATE gstate;
        gstate = PyGILState_Ensure();

        PyObject* result = PyObject_CallFunctionObjArgs(_callable,nullptr);

        Py_XDECREF(result); // allowed to be null
        PyGILState_Release(gstate);
    }
};

camera.pyx

cdef extern from "pycallback.hpp":
    cdef cppclass PyCallback:
        PyCallback(object) except +
        PyCallback(object, const char*) except +
        void execute()

cdef class Camera:
    cdef PyCallback* o
    cdef public ispresent

    def __init__(self):
        self.o = NULL
        self.ispresent = True

    def registerRemovalCallback(self):
        self.o = new PyCallback(self,'cameraRemovalCallback')
        #self.o = new PyCallback(self.cameraRemovalCallback)

    def cameraRemovalCallback(self):
        self.ispresent = False

    def triggerCallback(self):
        if self.o != NULL:
            self.o.execute()

setup.py

from distutils.core import setup
from distutils.extension import Extension
from Cython.Distutils import build_ext

setup(
    ext_modules = [
        Extension('camera',sources=["camera.pyx"],
            language="c++",
            extra_compile_args=['-std=c++11'])],
    cmdclass={'build_ext': build_ext})

test.py

import camera

c = camera.Camera()
print(c.ispresent)
c.triggerCallback()
print(c.ispresent)
c.registerRemovalCallback()
print(c.ispresent)
c.triggerCallback()
print(c.ispresent)

注意-这有一个小问题。Camera和它保存的回调形成一个引用循环，因此它们永远不会被释放。这会导致小内存泄漏，但不会导致分段错误。