Cython使用python-c-api调用回调segfault

Cython callback segfaults using python-c-api calls

本文关键字:回调 segfault 调用 python-c-api 使用 Cython      更新时间:2023-10-16

我使用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)进行参数设置但我有一个分段错误

我还尝试过在arguments字段中使用NULL的PyObject_CallFunctionObjArgs,认为可能已经嵌入了指向"self"的指针,因为该方法指向该对象中的特定地址。但他们我有分段错误

有人看到我的错误吗?有什么东西可以用不同的方式制作?我希望这是我方面对该由谁来做的误解。

更新@2016/08/01:

以下注释指示,代码中进行了两项修改:

首先,指向PyCallback的指针存储已存储为Cameracython类的成员:

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

即使这是segfoots的基本来源,它看起来也没有参与当前的事件。

然后在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指向函数的指针来调用它,并得到相同的segfault结果。

更新@2016/08/03:

我已着手进行建议的修改。cameraRemovalCallback现在从cdef变为def,并且PyCallback中的一些if报告现在找到了该方法。还向~PyCallback()添加了对Py_XDECREF(_method)的调用,以防在构造函数中找到它。无用的try-catch也被移除。

根据DavidW提到的对Python的Object协议的引用,我检查了许多*Call*组合:属于segfault。

我认为这个问题正在变得肮脏,并出现在论坛(问题->答案->重播->…)。我对此感到抱歉,下次我会写的时候,我会尝试告诉segfault已经解决,以及到底是什么。

我不保证这是唯一的问题,但这肯定是一个问题:

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

您应该用def而不是cdef定义cameraRemovalCallback,也就是说,它可以通过普通的Python机制访问。您还应该检查PyObject_GetAttrString的结果——如果它返回NULL,则说明它找不到属性。

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


其他较小的问题:

您应该在~PyCallback中递减_method

您应该而不是调用Py_InitializePy_Finalize。您似乎是从Python中创建类的,所以它不需要初始化或最终确定。定稿肯定会给你带来麻烦。

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

PythonCapi不会引发C++异常,因此try{} catch(...)永远不会捕获任何内容。相反,请检查返回值。

您需要将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);
    }
};

相机.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})

测试.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和它所包含的回调形成了一个引用循环,因此它们永远不会被释放。这会导致少量内存泄漏,但不会导致分段故障。