C++ dlopen mini HOWTO

最新推荐文章于 2024-04-23 23:48:36 发布

翻译最新推荐文章于 2024-04-23 23:48:36 发布 · 1.6k 阅读

文章标签：

#c++ #library #编译器 #api #c #class

编程语言之c++ 同时被 2 个专栏收录

5 篇文章

订阅专栏

编译链接和装载

4 篇文章

订阅专栏

本文介绍了如何使用dlopenAPI动态加载C++函数和类，包括namemangling问题的解决方法，以及如何在运行时加载库并使用其中的类实例。提供了详细的示例代码，适用于Unix环境下。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Minidlopen

1 C++ dlopen mini HOWTO

1 C++ dlopen mini HOWTO

作者：Aaron Isotton <aaron@isotton.com> 2006-03-16

译者：camel.flying@gmail.com 2012-04-22

1.1 写在前面

翻译本文的动力有两个，首先是出于自己的爱好和自己的英文水平太烂。其次是觉得和篇文章很实用，基本可以解决unix下动态加载的所有问题，但还是建议大家去阅读原文。首先是因为本人能力有限，其次是该文不能及时更新！第一次发翻译的文章，欢迎大家拍砖。你们的砖头就是我的动力！

1.2 摘要

如何使用dlopen API动态的加载C＋＋函数和类

1.3 目录

1.3.1 介绍

如何使用dlopen API动态加载C++函数和类是Unix程序员经常碰到问题。事实上，情况偶尔有些复杂，需要一些解释。这正是写这篇Mini HowTo的缘由。理解这篇文档的前提是对c/c++语言中dlopen API有基本的理解。这篇HOWTO的维护链接是C++ dlopen mini HOWTO。

版本和许可证
这篇文档《C++ dlopen mini HOWTO》版权为Aaron Istton所有(copyrighted (c) 2002-2006).任何人在遵循自由基金定制的GPLv2许可证条款的前提下可以自由拷贝、分发和修改这份文档。
不承诺
本文不对文中的任何内容作可靠性承诺，您必须为您自己使用文中任何概念、示例和信息承担风险，因为其中可能存在错误和不准确的地方，或许会损坏您的系统－－尽管几乎不可能发生此类事故，但您还是小心行事－－作者不会为此负责。
贡献者
这篇文档中，我欣然致谢(按字母顺序):
- Joy Y Goodreau <joyg (at) us.ibm.com> 她的编辑工作。
- D. Stimitis <stimitis (at) idcomm.com> 指出一些formatting和namemangling的问题，还指出extern "C"的一些微妙之处。
反馈
欢迎对本文档的反馈！请把您的补充、评论和批评发送到这个邮箱：<aaron@isotton.com>.
术语
- dlopen API
  关于dlclose、dlerror、dlopen和dlsym函数的描述可以在dlopen(3)man手册页查到。
  请注意，我们使用"dlopen"时，指的是dlopen函数，而我们使用"dlopenAPI"则是指整个API集合。

1.3.2 问题所在

有时你想在运行时加载一个库（并使用其中的函数），这在你为你的程序写一些插件或者模块构架的时候经常发生。

在C语言中，加载一个库轻而易举（调用dlopen、dlsym和dlclose就够了），但是对于C＋＋来说，情况有些复杂。动态加载一个C＋＋库的困难，一部分是因为C＋＋的name mangling，另一部分是因为dlopen API是C语言实现的，因而没提供一个合适的方式来装载类。

在解释如何装载C＋＋库之前，最好再详细了解一下name mangling。我推荐您了解一下它，即使您对它不感兴趣。因为这有助于您理解问题是如何产生的，如何才能解决它。

name mangling
在每个C＋＋程序（或者库、目标文件）中，所有的非静态（non－static）函数在二进制文件中都是一“符号（symbol）”形式出现地。这些符号都是唯一的字符串，从而把各个函数在程序、库、目标文件中区分开来。
在C中，符号名正是函数名：strcpy函数的符号名字就是“strcpy”。这可能是因为两个非静态函数的名字一定各不相同的缘故。

而C＋＋允许重载（不同的函数可以有相同的名字但是不同的参数），并且有很多C所没有的特性－－比如类、成员函数和异常说明－－几乎不可能直接用函数名作符号名。为了解决这个问题，C＋＋采用了所谓的namemangling。它把函数名和一些信息（如参数数量和大小）糅杂在一起，改造成奇形怪状，只有编译器才懂的符号名。例如，被mangling后的foo可能看起来像foo@4%6^,或者符号名里面甚至不包含“foo”。

其中一个问题是，C＋＋标准（目前是[ISO14882]）并没有定义名字必须如何被mangle，所以每个编译器都按自己的方式来name mangling。有些编译器甚至在不同的版本间更换mangling算法（尤其是g++ 2.x和3.x）。即使你搞清楚了您的编译器到底怎么进行mangling的，从而可以用dlsym调用函数了，但可能仅仅限于您手头的这个编译器而已，而无法在下一版编译器下工作。
类
使用dlopen API的另一个问题是，它只支持加载函数。但在C＋＋中，您可能要用到库中的一个类，而这需要创建该类的一个实例，这个不容易做到。

1.3.3 解决方案

extern "C"
C＋＋有个特定的关键字用来声明采用C binding的函数：extern "C"。用extern "C"声明的函数将使用函数名作为符号名，就像C函数一样。因此，只有非成员函数才能被声明为extern "C",并且不能被重载。尽管限制很多，extern "C"函数还是非常有用，因为它们可以像C函数一样被dlopen动态加载。冠以extern "C"限定符后，并不意味着函数中不能使用C＋＋代码了，相反，它仍然是一个完整的C＋＋函数，可以使用任何C＋＋特性和各种类型的参数。

加载函数
在C＋＋中，函数用dlsym加载，就像C中一样。不过，该函数要用extern"C"声明，以防止其符号名被mangle。

示例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.cpp中函数hello被定义为extern "C"。它在main.cpp中被dlsym调用。函数名必须以extern "C"限定，否则我们无从知晓其符号名。

警告:extern "C"的声明形式上有两种：上面示例使用的那种内联（inline）形式extern "C",还有用花括号的extern "C" ｛…｝这种。第一种内联形式声明包含两层意义：外部链接（extern linkage）和C语言链接（language linkage），而第二种仅影响语言链接。下面两种形式等价：

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

和

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

对于函数来说，extern和non-extern的函数声明没有什么区别，对于变量就不同了。如果您声明变量，请牢记：

extern "C" int foo;

和

extern "C" {
    int foo;
}

是不同的事物。进一步的解释请参考[ISO14882], 7.5, 特别注意第7段; 或者参考[STR2000], 9.2.4。在用extern的变量之前，请细读“其它”一节罗列的文档。

加载类
加载类有点困难，因为我忙需要类的实例，而不仅仅是一个函数的指针。我忙无法通过new来创建类的实例，因为类不是可执行文件中定义的，况且（有时候）我忙连它的名字都不知道。

解决方案是：利用多态性！我们在可执行文件中定义一个带虚成员函数的接口基类，而在模块中定义派生实现类。通常来说，接口类是抽象的（如果一个类含有虚拟函数，那它就是抽象的）。

因为动态加载类往往用于实现插件，这意味着必须提供一个清晰定义的接口－－我们将定义一个接口类和派生实现类。

接下来，在模块中，我忙定义两个附加的helper函数，就是众所周知的“对象工厂函数（class factory functions）”。其中一个函数创建一个类实例，并返回其指针；令一个函数则用以销毁该指针。这两个函数都已extern "C"来限定修饰。

为了使用模块中的类，我们用dlsym向示例1中加载hello函数那样加载两个函数，然后我忙随心所欲的创建和销毁实例了。

示例2.加载类我们用用一个一般的多边形类作为接口，而继承它的三角形类做为实现。

//----------
//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操作符可以被重载；这容易导致new-delete不匹配调用，造成莫名奇妙的内存泄露和段错误。这在用不同的标准库链接模块和可执行文件时也一样。
接口类的析构函数在任何情况下都必须是虚函数（virtual)。因为即使错的可能性极小，近乎杞人忧天了，但仍旧不值得去冒险，方正额外的开销微不足道。如果基类不需要析构函数，定义一个空的（但必须是虚的）析构函数吧，否则你迟早要遇到问题，我向你保证。你可以在comp.lang.c++ FAQ的第20节了解到更多关于该问题的信息。

1.3.4 源码

你可以下载所有包含在文档中的代码：

1.3.5 常见问题

windows下我找不到头文件dlfcn.h！什么原因？
原因是windows下面没有dlopen API，因此没有dlfcn.h这个头文件。有一个类似API关于加载库函数。这些所写的大部分内容也使用于它。要了解更多信息请参阅Microsoft Developer Network Website。
有一些dlopen兼容的Windows LoadLibrary API封装么？
我不知道有什么，并且我不认为会有支持所有dlopen's选项。
有一个替代品：libtltdl(libtool的一部分），它封装了多种不同的包含在其他ldopen和LoadLibrary中的动态加载APIs。另一种是Glib的动态模块加载功能。你可以使用其中之一，以保证更好的夸平台兼容性。我从未使用过其中任何一种，所以我不能告诉你他们的稳定性和他们是否能真的工作。

你也应该阅读第四节，“动态加载的程库”，程序库HOWTO提供更多的技术去加载库和独立于你的平台创建类。

1.3.6 参阅

dlopen(3)man手册，它解释了dlopen API的目的和使用。
James Norton发表在http://www.linuxjournal.com/上的文章Dynamic Class Loading for C++ on Linux
您喜爱C＋＋，有关于的extern “C”、继承、虚函数、new和delete的参考我推荐[STR2000]。
[ISO14882]
Program Library HOWTO,它将告诉你你需要关于静态、共享和动态加载库的以及如何创建它们的大部分东西。强烈推荐！
Linux GCC HOWTO学习如何用GCC创建库。

1.3.7 参考书目

[ISO14482] ISO/IEC 14482-1998－C＋＋编程语言。PDF和打印在此http://webstore.ansi.org/。
[STR2000] StroustrupBjarne C++编程语言 Special Edition. ISBN 0-201-70073-5. Addison-Wesley。

Author: OCaml<camel.flying@gmail.com>

Date: 2012-04-23 19:27:25 CST

HTML generated by org-mode 6.33x in emacs 23