从pybind11包装的代码动态链接共享库

Question

我正在尝试将python绑定添加到中等大小的C ++科学代码（成千上万的LOC）中。我设法使它正常工作而没有太多问题，但是现在出现了一个我无法解决自己的问题。该代码的组织如下：

• 所有类和数据结构都在库libcommon.a中编译
• 可执行文件通过链接此库创建
• pybind11用于创建core.so python模块

“主要”部分的绑定工作正常。实际上，从独立代码或从python启动的模拟给出的结果完全相同。

但是，代码还支持类似插件的系统，该系统可以在运行时加载共享库。这些共享库包含从主代码中定义的接口继承的类。原来，如果我尝试从python链接这些共享库，则会收到声名狼藉的“未定义符号”错误。我检查了这些符号是否在core.so模块中（使用nm -D）。实际上，使用独立代码执行动态链接的模拟可以完美地工作（在同一文件夹和相同的输入中）。通过某种方式，共享库在通过python调用时找不到正确的符号，但是在独立代码加载时没有问题。我正在使用CMake构建系统。

以下是MCE。复制文件夹中的每个文件，在同一位置复制（或链接）pybind11文件夹，然后使用以下命令：

mkdir build
cd build
cmake ..
make

这将生成一个standalone二进制文件和一个python模块。 standalone可执行文件将产生正确的输出。相比之下，在python3中使用以下命令（至少在我看来应该等效）会产生错误：

import core
b = core.load_plugin()

main.cpp

#include "Base.h"
#include "plugin_loader.h"

#include <iostream>

int main() {
    Base *d = load_plugin();
    if(d == NULL) {
        std::cerr << "No lib found" << std::endl;
        return 1;
    }
    d->foo();

    return 0;
}

Base.h

#ifndef BASE
#define BASE

struct Base {
    Base();
    virtual ~Base();

    virtual void foo();
};

#endif

Base.cpp

#include "Base.h"

#include <iostream>

Base::Base() {}

Base::~Base() {}

void Base::foo() {
    std::cout << "Hey, it's Base!" << std::endl;
}

plugin_loader.h

#ifndef LOADER
#define LOADER

#include "Base.h"

Base *load_plugin();

#endif

plugin_loader.cpp

#include "plugin_loader.h"

#include <dlfcn.h>
#include <iostream>

typedef Base* make_base();

Base *load_plugin() {
    void *handle = dlopen("./Derived.so", RTLD_LAZY | RTLD_GLOBAL);
    const char *dl_error = dlerror();
    if(dl_error != nullptr) {
        std::cerr << "Caught an error while opening shared library: " << dl_error << std::endl;
        return NULL;
    }
    make_base *entry = (make_base *) dlsym(handle, "make");

    return (Base *) entry();
}

Derived.h

#include "Base.h"

struct Derived : public Base {
    Derived();
    virtual ~Derived();
    void foo() override;
};

extern "C" Base *make() {
    return new Derived();
}

Derived.cpp

#include "Derived.h"

#include <iostream>

Derived::Derived() {}

Derived::~Derived() {}

void Derived::foo() {
    std::cout << "Hey, it's Derived!" << std::endl;
}

bindings.cpp

#include <pybind11/pybind11.h>

#include "Base.h"
#include "plugin_loader.h"

PYBIND11_MODULE(core, m) {
        pybind11::class_<Base, std::shared_ptr<Base>> base(m, "Base");

        base.def(pybind11::init<>());
        base.def("foo", &Base::foo);

        m.def("load_plugin", &load_plugin);
}

CMakeLists.txt

PROJECT(foobar)

# compile the library
ADD_LIBRARY(common SHARED Base.cpp plugin_loader.cpp)
TARGET_LINK_LIBRARIES(common ${CMAKE_DL_LIBS})
SET_TARGET_PROPERTIES(common PROPERTIES POSITION_INDEPENDENT_CODE ON)

# compile the standalone code
ADD_EXECUTABLE(standalone main.cpp)
TARGET_LINK_LIBRARIES(standalone common)

# compile the "plugin"
SET(CMAKE_SHARED_LIBRARY_PREFIX "")
ADD_LIBRARY(Derived SHARED Derived.cpp)

# compile the bindings
ADD_SUBDIRECTORY(pybind11)
INCLUDE_DIRECTORIES( ${PROJECT_SOURCE_DIR}/pybind11/include )

FIND_PACKAGE( PythonLibs 3 REQUIRED )
INCLUDE_DIRECTORIES( ${PYTHON_INCLUDE_DIRS} )

ADD_LIBRARY(_oxpy_lib STATIC bindings.cpp)
TARGET_LINK_LIBRARIES(_oxpy_lib ${PYTHON_LIBRARIES} common)
SET_TARGET_PROPERTIES(_oxpy_lib PROPERTIES POSITION_INDEPENDENT_CODE ON)

pybind11_add_module(core SHARED bindings.cpp)
TARGET_LINK_LIBRARIES(core PRIVATE _oxpy_lib)

Answer 1

[是的，导入的库中的符号不​​可见，因为未设置core标志的情况下加载了RTLD_GLOBAL。您可以通过在python端添加几行额外的操作来解决该问题：

import sys, os
sys.setdlopenflags(os.RTLD_GLOBAL | os.RTLD_LAZY)

import core
b = core.load_plugin()

从sys.setdlopenflags() doc：

要在扩展模块之间共享符号，请以sys.setdlopenflags(os.RTLD_GLOBAL)调用。可以在os模块中找到标志值的符号名称（RTLD_xxx常量，例如os.RTLD_LAZY）。