C++ dlopen 迷你 HOWTO

Aaron Isotton

<aaron@isotton.com>

2006-03-16

修订历史
修订版 1.10	2006-03-16	修订者：AI
将许可证从 GFDL 更改为 GPL。修复了 dlerror 的用法；感谢 Carmelo Piccione。在示例中使用了虚析构函数；感谢 Joerg Knobloch。添加了源代码部分。小幅修复。
修订版 1.03	2003-08-12	修订者：AI
添加了对 GLib 动态模块加载器的引用。感谢 G. V. Sriraam 提供的线索。
修订版 1.02	2002-12-08	修订者：AI
添加了 FAQ。小幅更改
修订版 1.01	2002-06-30	修订者：AI
更新了虚析构函数的解释。小幅更改。
修订版 1.00	2002-06-19	修订者：AI
将版权和许可部分移至开头。添加了术语部分。小幅更改。
修订版 0.97	2002-06-19	修订者：JYG
进行了细微的语法和句子级别的更改。
修订版 0.96	2002-06-12	修订者：AI
添加了参考书目。修正了 extern 函数和变量的解释。
修订版 0.95	2002-06-11	修订者：AI
小幅改进。

如何使用dlopenAPI 动态加载 C++ 函数和类。

目录

1. 简介

1.1. 版权和许可
1.2. 免责声明
1.3. 鸣谢/贡献者
1.4. 反馈
1.5. 本文档中使用的术语

2. 问题

2.1. 名称修饰
2.2. 类

3. 解决方案

3.1. extern "C"
3.2. 加载函数
3.3. 加载类

4. 源代码

5. 常见问题解答

6. 另请参阅

参考书目

1. 简介

在 Unix C++ 程序员中经常出现的一个问题是如何使用dlopenAPI 动态加载 C++ 函数和类。

动态加载 C++ 函数和类。实际上，这并不总是那么简单，需要一些解释。这就是本迷你 HOWTO 的目的。

要理解本文档，需要对 C 和 C++ 编程语言以及dlopenAPI 有一定的了解。

本 HOWTO 的主要位置是 http://www.isotton.com/howtos/C++-dlopen-mini-HOWTO/。

1.1. 版权和许可

1.2. 免责声明

对本文档的内容不承担任何责任。使用文中的概念、示例和信息，风险自负。可能存在错误和不准确之处，可能会对您的系统造成损害。请谨慎操作，尽管这种情况极不可能发生，但作者不承担任何责任。

所有版权均归其各自所有者所有，除非另有明确说明。在本文档中使用术语不应被视为影响任何商标或服务标志的有效性。特定产品或品牌的命名不应被视为认可。

1.3. 鸣谢/贡献者

在本文档中，我很荣幸地承认（按字母顺序排列）

Joy Y Goodreau<joyg (at) us.ibm.com>感谢她的编辑。
D. Stimitis<stimitis (at) idcomm.com>感谢他指出了格式和名称修饰方面的一些问题，并指出了extern "C".
许多未具名的人指出了错误或提供了改进本 HOWTO 的技巧。你们知道自己是谁！

1.4. 反馈

非常欢迎您对本文档提供反馈。请将您的补充、评论和批评发送至以下电子邮件地址<aaron@isotton.com>.

1.5. 本文档中使用的术语

dlopenAPI

指dlclose, dlerror, dlopen和dlsym函数，如dlopen(3)手册页中所述。

请注意，我们使用 "dlopen" 来指代单个dlopen 函数，并使用 "dlopen API" 来指代整个 API。

2. 问题

有时您可能需要在运行时加载库（并使用其函数）；当您为程序编写某种插件或模块架构时，这种情况最常发生。

在 C 语言中，加载库非常简单（调用dlopen, dlsym和dlclose就足够了），但在 C++ 中，这要复杂一些。动态加载 C++ 库的困难部分是由于名称修饰，部分是由于dlopenAPI 是在考虑 C 语言的情况下编写的，因此没有提供加载类的合适方法。

在解释如何在 C++ 中加载库之前，让我们通过更详细地了解名称修饰来更好地分析问题。我建议您阅读名称修饰的解释，即使您对此不感兴趣，因为它将帮助您理解为什么会发生问题以及如何解决问题。

2.1. 名称修饰

在每个 C++ 程序（或库，或目标文件）中，所有非静态函数都以符号的形式表示在二进制文件中。这些符号是特殊的文本字符串，用于唯一标识程序、库或目标文件中的函数。

在 C 语言中，符号名称与函数名称相同：strcpy的符号将是strcpy等等。这是可能的，因为在 C 语言中，没有两个非静态函数可以具有相同的名称。

由于 C++ 允许重载（具有相同名称但参数不同的不同函数），并且具有 C 语言没有的许多特性——例如类、成员函数、异常规范——因此不可能简单地使用函数名称作为符号名称。为了解决这个问题，C++ 使用了所谓的名称修饰，它将函数名称和所有必要的信息（例如参数的数量和大小）转换为一些看起来很奇怪的字符串，只有编译器知道这些字符串。例如，foo的修饰名称可能看起来像foo@4%6^。或者它甚至可能不包含单词 "foo"。

名称修饰的问题之一是 C++ 标准（当前为 [ISO14882]）没有定义名称必须如何修饰；因此，每个编译器都以自己的方式修饰名称。一些编译器甚至在不同的版本之间更改其名称修饰算法（尤其是 g++ 2.x 和 3.x）。即使您弄清楚了您的特定编译器如何修饰名称（因此能够通过dlsym加载函数），这也很可能只适用于您的编译器，并且可能在下一个版本中就已经损坏。

2.2. 类

dlopenAPI 的另一个问题是它仅支持加载函数。但是在 C++ 中，库通常会公开一个类，您希望在程序中使用该类。显然，要使用该类，您需要创建它的一个实例，但这不容易做到。

3. 解决方案

3.1. `extern "C"`

C++ 有一个特殊的关键字来声明具有 C 绑定的函数extern "C"。声明为extern "C"的函数使用函数名称作为符号名称，就像 C 函数一样。因此，只有非成员函数可以声明为extern "C"，并且它们不能被重载。

尽管存在严重的局限性，extern "C"函数非常有用，因为可以使用dlopen动态加载它们，就像 C 函数一样。

这不意味着限定为extern "C"的函数不能包含 C++ 代码。这样的函数是一个功能齐全的 C++ 函数，可以使用 C++ 功能并接受任何类型的参数。

3.2. 加载函数

在 C++ 中，函数像在 C 中一样加载，使用dlsym。您要加载的函数必须限定为extern "C"以避免符号名称被修饰。

示例 1. 加载函数

main.cpp

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

int main() {
    using std::cout;
    using std::cerr;

    cout << "C++ dlopen demo\n\n";

    // open the library
    cout << "Opening hello.so...\n";
    void* handle = dlopen("./hello.so", RTLD_LAZY);
    
    if (!handle) {
        cerr << "Cannot open library: " << dlerror() << '\n';
        return 1;
    }
    
    // load the symbol
    cout << "Loading symbol hello...\n";
    typedef void (*hello_t)();

    // reset errors
    dlerror();
    hello_t hello = (hello_t) dlsym(handle, "hello");
    const char *dlsym_error = dlerror();
    if (dlsym_error) {
        cerr << "Cannot load symbol 'hello': " << dlsym_error <<
            '\n';
        dlclose(handle);
        return 1;
    }
    
    // use it to do the calculation
    cout << "Calling hello...\n";
    hello();
    
    // close the library
    cout << "Closing library...\n";
    dlclose(handle);
}

hello.cpp

#include <iostream>

extern "C" void hello() {
    std::cout << "hello" << '\n';
}

函数hello在hello.cpp中定义为extern "C"；它在main.cpp中使用dlsym调用加载。该函数必须限定为extern "C"，因为否则我们不知道它的符号名称。

有extern "C"声明的两种不同形式extern "C"，如上面使用的，以及extern "C" { … }，其中声明在花括号之间。第一种（内联）形式是具有 extern 链接和 C 语言链接的声明；第二种形式仅影响语言链接。因此，以下两个声明是等效的

extern "C" int foo;
extern "C" void bar();

和

extern "C" {
     extern int foo;
     extern void bar();
}

由于extern和非extern 函数声明之间没有区别，只要您不声明任何变量，这就不是问题。如果您声明变量，请记住

extern "C" int foo;

和

extern "C" {
    int foo;
}

不是同一件事。

有关进一步的澄清，请参阅 [ISO14882]，7.5，特别注意第 7 段，或 [STR2000]，第 9.2.4 段。

在对 extern 变量进行花哨的操作之前，请仔细阅读另请参阅部分中列出的文档。

3.3. 加载类

加载类有点困难，因为我们需要类的实例，而不仅仅是指向函数的指针。

我们不能使用new创建类的实例，因为该类未在可执行文件中定义，并且（在某些情况下）我们甚至不知道它的名称。

解决方案是通过多态性实现的。我们在可执行文件中定义一个基类，即接口类，其中包含虚成员，并在模块中定义一个派生类，即实现类。通常，接口类是抽象的（如果一个类具有纯虚函数，则该类是抽象的）。

由于类的动态加载通常用于插件——插件必须公开明确定义的接口——无论如何我们都必须定义一个接口和派生的实现类。

接下来，在模块中，我们定义两个额外的辅助函数，称为类工厂函数。其中一个函数创建类的实例并返回指向它的指针。另一个函数接受指向工厂创建的类的指针并销毁它。这两个函数都限定为extern "C".

要使用模块中的类，请使用dlsym加载两个工厂函数，就像我们加载 hello 函数一样；然后，我们可以根据需要创建和销毁任意数量的实例。

示例 2. 加载类

在这里，我们使用通用的polygon类作为接口，并使用派生类triangle作为实现。

main.cpp

#include "polygon.hpp"
#include <iostream>
#include <dlfcn.h>

int main() {
    using std::cout;
    using std::cerr;

    // load the triangle library
    void* triangle = dlopen("./triangle.so", RTLD_LAZY);
    if (!triangle) {
        cerr << "Cannot load library: " << dlerror() << '\n';
        return 1;
    }

    // reset errors
    dlerror();
    
    // load the symbols
    create_t* create_triangle = (create_t*) dlsym(triangle, "create");
    const char* dlsym_error = dlerror();
    if (dlsym_error) {
        cerr << "Cannot load symbol create: " << dlsym_error << '\n';
        return 1;
    }
    
    destroy_t* destroy_triangle = (destroy_t*) dlsym(triangle, "destroy");
    dlsym_error = dlerror();
    if (dlsym_error) {
        cerr << "Cannot load symbol destroy: " << dlsym_error << '\n';
        return 1;
    }

    // create an instance of the class
    polygon* poly = create_triangle();

    // use the class
    poly->set_side_length(7);
        cout << "The area is: " << poly->area() << '\n';

    // destroy the class
    destroy_triangle(poly);

    // unload the triangle library
    dlclose(triangle);
}

polygon.hpp

#ifndef POLYGON_HPP
#define POLYGON_HPP

class polygon {
protected:
    double side_length_;

public:
    polygon()
        : side_length_(0) {}

    virtual ~polygon() {}

    void set_side_length(double side_length) {
        side_length_ = side_length;
    }

    virtual double area() const = 0;
};

// the types of the class factories
typedef polygon* create_t();
typedef void destroy_t(polygon*);

#endif

triangle.cpp

#include "polygon.hpp"
#include <cmath>

class triangle : public polygon {
public:
    virtual double area() const {
        return side_length_ * side_length_ * sqrt(3) / 2;
    }
};


// the class factories

extern "C" polygon* create() {
    return new triangle;
}

extern "C" void destroy(polygon* p) {
    delete p;
}

加载类时，需要注意以下几点

您必须提供创建函数和销毁函数；您不得使用delete从可执行文件内部销毁实例，而是始终将其传递回模块。这是因为在 C++ 中，运算符new和delete可能会被重载；这将导致调用不匹配的new和delete，这可能会导致从无到有到内存泄漏和段错误等任何问题。如果使用不同的标准库链接模块和可执行文件，情况也是如此。
在任何情况下，接口类的析构函数都应该是虚函数。可能在极少数情况下，这可能不是必需的，但这不值得冒险，因为额外的开销通常可以忽略不计。
如果您的基类不需要析构函数，请无论如何定义一个空的（和virtual）析构函数；否则您迟早会遇到问题；我可以向您保证。您可以在 comp.lang.c++ FAQ 中的 http://www.parashift.com/c++-faq-lite/ 的第 20 节中阅读有关此问题的更多信息。

4. 源代码

您可以下载本 HOWTO 中提供的所有源代码，作为存档文件：examples.tar.gz。

5. 常见问题解答

5.1. 我正在使用 Windows，并且找不到 dlfcn.h 头文件！这是怎么回事？
5.2. 是否有某种与 dlopen 兼容的包装器用于 Windows LoadLibrary API？

5.1. 我正在使用 Windows，并且找不到dlfcn.h头文件！这是怎么回事？

问题是 Windows 没有dlopenAPI，因此没有dlfcn.h头文件。在LoadLibrary函数周围有一个类似的 API，这里写的大部分内容也适用于它。有关更多信息，请参阅 Microsoft 开发人员网络网站。

5.2. 是否有某种与dlopen兼容的包装器用于 WindowsLoadLibraryAPI？

我不知道有任何，而且我认为永远不会有一个支持dlopen的所有选项的包装器。

但是，还有其他替代方案：libtltdl（libtool 的一部分），它包装了各种不同的动态加载 API，其中包括dlopen和LoadLibrary。另一个是 GLib 的动态模块加载功能。您可以使用其中之一来确保更好的跨平台兼容性。我从未使用过它们中的任何一个，所以我无法告诉您它们的稳定性如何以及它们是否真的有效。

您还应该阅读程序库 HOWTO 的第 4 节“动态加载 (DL) 库”，了解更多独立于平台加载库和创建类的技术。

6. 另请参阅

指dlopen(3)手册页。它解释了dlopenAPI 动态加载 C++ 函数和类。
的目的和用途。《 Linux 上 C++ 的动态类加载》一文，作者 James Norton，发表在 Linux Journal 上。
您最喜欢的关于extern "C"、继承、虚函数、new和delete的 C++ 参考书。我推荐 [STR2000]。
[ISO14882]
程序库 HOWTO，它告诉您关于静态库、共享库和动态加载库以及如何创建它们的大部分知识。强烈推荐。
Linux GCC HOWTO，了解更多关于如何使用 GCC 创建库的信息。

参考书目

ISO14482 ISO/IEC 14482-1998 — C++ 编程语言。可从 http://webstore.ansi.org/ 获取 PDF 和印刷书籍版本。

STR2000 Bjarne Stroustrup C++ 编程语言，特别版。ISBN 0-201-70073-5。Addison-Wesley 出版社。