Python swig - 从ctypes指针创建swig包装实例

时间:2016-12-16 23:36:46

标签: python swig

我有一个包含swig的类的C ++代码。我无法修改代码或包装。 在python中,我使用ctypes指向所述C ++类的实例。 如何围绕此指针创建一个swig包装器?

我知道swig对象有一个'这个'内部指向包装对象的属性,但我找不到将其设置为我手头指针的方法。

感谢您的帮助!

1 个答案:

答案 0 :(得分:1)

可以这样做,但它相当多的工作,并且修复使ctypes或SWIG接口完成和可用而不是强制互换的根本问题会更加简单。 (值得注意的是,从SWIG创建ctypes对象比执行你要做的事情更容易,也就是从ctypes创建一个SWIG对象。)

为了说明这一点,我创建了以下头文件,我们将用SWIG包装:

struct Foo {
  double d;
  char msg[20];
};

然后我用以下界面包装它:

%module test

%{
#include "test.h"
%}

// Prove I'm not cheating here - we can't even instantiate this class
%nodefaultctor;

%include "test.h"

我还为我们添加了一个测试函数,用于从ctypes调用,而不是SWIG包装:

#include "test.h"

// This function returns a Foo, but is only accessible to ctypes
extern "C" Foo *fun1() {
    static Foo f = { 1.234, "Hello" };
    return &f;
}

您对SWIG包装类的this属性的猜测是一个很好的起点,但它并不像更改那样简单 - 您插入的对象的类型必须与SWIG期望的匹配。它不仅仅是一个表示为int的指针:

repr(test.Foo().this) # You'll need to drop the nodefaultctor directive to see this
"<Swig Object of type 'Foo *' at 0x7f621197d1e0>"

如果我们检查SWIG生成的源代码,我们可以看到有一个函数接受指针,一些类型信息并为我们创建这些对象:

SWIGRUNTIME PyObject *
SwigPyObject_New(void *ptr, swig_type_info *ty, int own);

我们暂时忽略SWIGRUNTIME默认定义为static的事实,为了让我们开始尝试使用此运行时,我们可以将其重新定义为extern。稍后我们将看看我们何时不能做到这一点的解决方法。

所以我们的目标是获取“仅限ctypes”函数的输出并通过更多ctypes调用将其传递给SwigPyObject_New以创建我们可以使用SWIG模块的this属性进行交换的内容。 / p>

为了打电话,我们通常会调用SWIG_TypeQuery来查找要使用的正确swig_type_info。然而,这实际上是一个宏,它扩展为传递一些静态的静态变量。相反,我们将使用此功能:

SWIGRUNTIME swig_type_info *
SWIG_Python_TypeQuery(const char *type)

(使用相同的SWIGRUNTIME条件)。

此时我们已经足够了,我们可以交换代理对象的这个属性,如果我们能够构建捐赠者就可以完成。 (虽然那会泄漏)。我们有两种方法可以让这更好:

  1. __init__内的Monkey patch test.Foo可以正常工作。如果您真的在SWIG界面中有%nodefaultctor而不想重新编译,那么这是最好的:

    def patched_init(self, ptr):
        self.this = ptr
    test.Foo.__init__ = patched_init
    
  2. 创建一个只有__init__的新类,在修改this属性之前设置__class__属性并改为使用它:

    class FooCtypesSwigInterop(object):
        def __init__(self, ptr):
            self.this = ptr
            self.__class__ = test.Foo
    

    当您不想中断test.Foo现有的__init__实施时,此选项最有意义。

  3. 据说,我们现在可以通过以下方式实现我们的最初目标:

    import ctypes
    import test
    
    # This *must* happen after the import of the real SWIG module
    # 0x4 is RTLD_NOLOAD which ensures that we get the same handle as the Python 
    # import did, even if it was loaded with RTLD_LOCAL as Python is prone to.
    swig_module = ctypes.PyDLL('./_test.so',ctypes.RTLD_LOCAL|0x4)
    # Note that we used PyDLL instead of CDLL because we need to retain the GIL
    
    # Setup SWIG_Python_TypeQuery to have the right argument/return types
    # (Using void* as a substitute for swig_type_info*)
    SWIG_Python_TypeQuery = swig_module.SWIG_Python_TypeQuery
    SWIG_Python_TypeQuery.argtypes = [ctypes.c_char_p]
    SWIG_Python_TypeQuery.restype = ctypes.c_void_p
    
    # Likewise SwigPyObject_New, using ctypes.py_object though for return
    SwigPyObject_New = swig_module.SwigPyObject_New
    SwigPyObject_New.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int]
    SwigPyObject_New.restype = ctypes.py_object
    
    # Actually do the type query for the type our ctypes function returns:
    SWIGTYPE_p_Foo = SWIG_Python_TypeQuery('Foo*')
    print(hex(SWIGTYPE_p_Foo))
    
    # Now the ctypes function itself that returns the type we want SWIG managed
    fun1 = swig_module.fun1
    fun1.argtypes = []
    fun1.restype = ctypes.c_void_p
    
    # Make the actual ctypes call we care about here
    result = fun1()
    print(hex(result))
    
    # And then create a SwigPyObject for it from the void* return type
    # Note that 0 means not owned by SWIG
    sresult = SwigPyObject_New(result, SWIGTYPE_p_Foo, 0)
    print(repr(sresult))
    
    # This is how we jimmy it back into the this attribute of a SWIG type
    class FooCtypesSwigInterop(object):
        def __init__(self, ptr):
            self.this = ptr
            self.__class__ = test.Foo
    
    c = FooCtypesSwigInterop(sresult)
    
    # Finally a usable SWIG object from the ctypes call 
    print(c.msg)
    

    这一切都编译并与之合作:

    swig3.0 -python -c++ -Wall test.i
    g++ -shared -o _test.so test_wrap.cxx fun1.cc -Wall -Wextra -fPIC -I/usr/include/python2.7/ -std=c++11 -DSWIGRUNTIME=extern
    LD_LIBRARY_PATH=.  python run.py 
    

    并告诉我们:

    0x7fb6eccf29e0
    0x7fb6eccf2640
    <Swig Object of type 'Foo *' at 0x7fb6ee436720>
    Hello
    

    要解决将SWIGRUNTIME定义为static的问题,您需要再做一步。使用调试符号或对您已获得的SWIG二进制模块进行反向工程,但无法修改以查找相对于导出符号未导出的两个函数的地址。然后,您可以使用它们来构造ctypes函数指针,而不是按名称查找它们。当然,购买/查找/重写SWIG模块会更容易,或者可能会将缺少的功能添加到ctypes界面。

    (最后值得注意的是,虽然如果SWIG与-builtin一起运行似乎并不适用,但需要对此答案进行一些实质性更改。