4

我正在尝试用来cython包装 C++ 库(fastText如果相关)。C++ 库类从磁盘加载一个非常大的数组。我的包装器从 C++ 库实例化一个类以加载数组,然后使用cython内存视图并将numpy.asarray数组转换为numpy数组,然后调用torch.from_numpy以创建张量。

出现的问题是如何处理数组的内存释放。

现在,pointer being freed was not allocated当程序退出时,我得到了。我希望这是因为 C++ 代码和numpy/pytorch都在尝试管理同一块 RAM。

我可以简单地注释掉 C++ 库中的析构函数,但感觉它会给我带来一个不同的问题。

我应该如何处理这个问题?是否有任何关于如何使用 C++ 处理内存共享的最佳实践文档cython

如果我修改 C++ 库以将数组包装在 a 中shared_ptrcython(和numpypytorch​​、等)会shared_ptr正确共享吗?

如果问题很幼稚,我深表歉意;Python 垃圾收集对我来说非常神秘。

任何建议表示赞赏。

4

1 回答 1

9

我能想到三种明智的做法。我将在下面概述它们(即没有一个代码是完整的,但希望它会清楚如何完成它)。

1. C++拥有内存;Cython/Python 持有指向 C++ 类的共享指针

(这看起来是您已经在考虑的路线)。

首先创建一个包含共享指针的 Cython 类

from libcpp.memory cimport shared_ptr

cdef class Holder:
    cdef shared_ptr[cpp_class] ptr

    @staticmethod
    cdef make_holder(shared_ptr[cpp_class] ptr):
       cdef holder = Holder() # empty class
       holder.ptr = ptr
       return holder

然后,您需要为Holder. cpp_class这允许以numpy 数组和 Cython memoryviews 都可以理解的方式直接访问分配的内存。因此,它们持有对Holder实例的引用,而实例又使实例保持cpp_class活动状态。(np.asarray(holder_instance)用于创建使用实例内存的 numpy 数组)

缓冲协议有点涉及,但 Cython 有相当广泛的文档,您应该能够在很大程度上复制和粘贴他们的示例。您需要添加的两个方法Holder__getbuffer____releasebuffer__

2. Python拥有内存;您的 C++ 类拥有一个指向 Python 对象的指针

在这个版本中,您将内存分配为一个 numpy 数组(使用 Python C API 接口)。当您的 C++ 类被销毁时,数组的引用计数会递减,但是如果 Python 持有对该数组的引用,那么该数组的寿命可能比 C++ 类长。

#include <numpy/arrayobject.h>
#include <Python.h>

class cpp_class {
   private:
     PyObject* arr;
     double* data;
   public:
     cpp_class() {
       arr = PyArray_SimpleNew(...); // details left to be filled in
       data = PyArray_DATA(reinterpret_cast<PyArrayObject*>(arr));
       # fill in the data
     }

     ~cpp_class() {
         Py_DECREF(arr); // release our reference to it
     }

     PyObject* get_np_array() {
         Py_INCREF(arr); // Cython expects this to be done before it receives a PyObject
         return arr;
     }
};

有关如何从 C/C++ 分配 numpy 数组的详细信息,请参阅numpy 文档。如果您定义复制/移动构造函数,请注意引用计数。

Cython 包装器看起来像:

cdef extern from "some_header.hpp":
    cdef cppclass cpp_class:
       # whatever constructors you want to allow
       object get_np_array()

3. C++ 将数据的所有权转移给 Python/Cython

在此方案中,C++ 分配数组,但 Cython/Python 负责释放它。一旦所有权转移,C++ 就不再有权访问数据。

class cpp_class {
   public:
     double* data; // for simplicity this is public - you may want to use accessors
     cpp_class() :
     data(new double[50])
     {/* fill the array as needed */}

     ~cpp_class() {
       delete [] data;
     }
};

// helper function for Cython
inline void del_cpp_array(double* a) {
   delete [] a;
}

然后,您使用cython.view.array该类来捕获分配的内存。这有一个用于销毁的回调函数:

from cython cimport view

cdef extern from "some_header.hpp":
   cdef cppclass cpp_class:
      double* data
      # whatever constructors and other functions
   void del_cpp_array(double*)

# later
cdef cpp_class cpp_instance # create this however you like
# ...
# modify line below to match your data
arr = view.array(shape=(10, 2), itemsize=sizeof(double), format="d",
                 mode="C", allocate_buffer=False)
arr.data = <char*>cpp_instance.data
cpp_instance.data = None # reset to NULL pointer
arr.callback_free_data = del_cpp_array

arr然后可以与 memoryview 或 numpy 数组一起使用。

void*您可能不得不对从或char*使用的强制转换有点混乱del_cpp_array- 我不确定 Cython 接口需要什么类型。


第一个选项可能是要实现的大部分工作,但需要对 C++ 代码进行少量更改。第二个选项可能需要更改您不想更改的 C++ 代码。第三个选项很简单,但意味着 C++ 不再有权访问数据,这可能是一个缺点。

于 2017-06-06T19:54:08.470 回答