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

Question

在使用eCige相机进行控制并拥有C库的同时，我开始了一个cython代码项目 ，其目的是让每种语言都拥有最好的东西。

该库提供了一种从相机监听心跳以了解其是否已断开连接的方法。 我已经在C ++类中进行过回调，但是从该C ++类中，以我尝试过的所有方式调用类的python方法都陷入了Segmentation错误 。

我已经将其封装在特定的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）;进行参数设置； 但后来我有一个段错误出现。

我也尝试在arguments字段中使用NULL的 PyObject_CallFunctionObjArgs ，认为可能已经嵌入了指向“ self ”的指针，因为该方法指向此对象中的特定地址。 不过他们，我已经得到了段错误出现。

有人看到我的错误吗？ 那里应该用不同的方式来做些什么？ 我希望这对我是谁造成了误解。

更新 @ 2016/08/01 ：

在注释指示之后，代码中进行了两个修改：

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

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

即使这是段错误的根本源泉，它看起来它并没有参与目前的一个。

然后在C ++中的PyCallback :: execute（）中，我做了一些更改。 在阅读了有关GIL （全局解释器锁定）的信息并为其添加了一些调用之后，我添加了一张可能指导解决方案的检查：

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 ， if PyCallback中的PyCallback报告现在找到了该方法，则有些更改。 如果在构造函数中发现Py_XDECREF(_method) ，则Py_XDECREF(_method)它添加到~PyCallback()中。 无用的try-catch也已删除。

从DavidW提到的对Python的Object协议的引用中，我已经检查了许多*Call*组合：属于段错误。

我认为这个问题变得肮脏 ，并且正在出现一个论坛 （问题->答案->重播-> ...）。 对此我感到很抱歉，下次我写的时候，我将尽力告诉segfault是否已解决以及到底是什么。

Answer 1

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

cameraRemovalCallback是cdef函数。 这意味着该函数只能从C / Cython访问，而不能从Python访问。 这意味着PyObject_GetAttrString失败（因为cameraRemovalCallback不是Python属性）。

您应该使用def而不是cdef定义cameraRemovalCallback ，这是可以通过常规Python机制访问的。 您还应该检查PyObject_GetAttrString的结果-如果它返回NULL则它找不到属性。

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

---

其他较小的问题：

您应该在~PyCallback解码_method 。

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

我认为您不需要将self作为PyObject_Call的参数传递。 （我可能是错的）

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

您需要同时引用Py_BuildValue的两个调用的Py_BuildValue （完成后）以及PyObject_Call的结果。 如果不这样做，则会泄漏内存。

---

以下完整示例适用于我（使用Python 3.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和它保存的回调形成一个引用循环，因此它们永远不会被释放。 这将导致少量的内存泄漏，但不会导致分段错误。