C++ dlopen mini HOWTO 中譯版 [原創(chuàng)]
C++ dlopen mini HOWTO
作者：Aaron Isotton <aaron@isotton.com> 2006-03-16
譯者：Lolita@linuxsir.org 2006-08-05
------------------------------------------------
摘要
如何使用dlopen API動(dòng)態(tài)地加載C++函數(shù)和類(lèi)------------------------------------------------
目錄
介紹
版權(quán)和許可證
不承諾
貢獻(xiàn)者
反饋
術(shù)語(yǔ)
問(wèn)題所在
Name Mangling
類(lèi)
解決方案
extern "C"
加載函數(shù)
加載類(lèi)
源代碼
FAQ
其他
參考書(shū)------------------------------------------------
介紹 如何使用dlopen API動(dòng)態(tài)地加載C++函數(shù)和類(lèi)，是Unix C++程序員經(jīng)常碰到的問(wèn)題。事實(shí)上，情況偶爾有些復(fù)雜，需要一些解釋。這正是寫(xiě)這篇mini HOWTO的緣由。
理解這篇文檔的前提是對(duì)C/C++語(yǔ)言中dlopen API有基本的了解。這篇HOWTO的維護(hù)鏈接是
http://www.isotton.com/howtos/C++-dlopen-mini-HOWTO/ 版權(quán)和許可證 這篇文檔《C++ dlopen mini HOWTO》版權(quán)為Aaron Isotton所有（copyrighted (c) 2002-2006），任何人在遵守自由軟件基金會(huì)制定的GPLv2許可證條款前提下可以自由拷貝、分發(fā)和修改這份文檔。
不承諾 本文不對(duì)文中的任何內(nèi)容作可靠性承諾。您必須為您自己使用文中任何概念、示例和信息承擔(dān)風(fēng)險(xiǎn)，因?yàn)槠渲锌赡艽嬖阱e(cuò)誤和不準(zhǔn)確的地方，或許會(huì)損壞您的系統(tǒng)──盡管幾乎不可能發(fā)生此類(lèi)事故，但您還是小心行事──作者不會(huì)為此負(fù)任何責(zé)任。
貢獻(xiàn)者 在這篇文檔中，我欣然致謝（按字母順序）：
◆ Joy Y Goodreau <joyg (at) us.ibm.com> 她的編輯工作.
◆ D. Stimitis <stimitis (at) idcomm.com> 指出一些formatting和name mangling的問(wèn)題, 還指出extern “C”的一些微妙之處。
反饋 歡迎對(duì)本文檔的反饋信息！請(qǐng)把您的補(bǔ)充、評(píng)論和批評(píng)發(fā)送到這個(gè)郵件地址：<aaron@isotton.com>。
術(shù)語(yǔ) dlopen API
關(guān)于dlclose、dlerror、dlopen和dlsym函數(shù)的描述可以在 dlopen(3) man手冊(cè)頁(yè)查到。
請(qǐng)注意，我們使用“dlopen”時(shí)，指的是dlopen函數(shù)，而使用“dlopen API”則是指整個(gè)API集合。
------------------------------------------------
問(wèn)題所在 有時(shí)你想在運(yùn)行時(shí)加載一個(gè)庫(kù)（并使用其中的函數(shù)），這在你為你的程序?qū)懸恍┎寮蚰K架構(gòu)的時(shí)候經(jīng)常發(fā)生。
在C語(yǔ)言中，加載一個(gè)庫(kù)輕而易舉（調(diào)用dlopen、dlsym和dlclose就夠了），但對(duì)C++來(lái)說(shuō)，情況稍微復(fù)雜。動(dòng)態(tài)加載一個(gè)C++庫(kù)的困難一部分是因?yàn)镃++的name mangling（譯者注：也有人把它翻譯為“名字毀壞”，我覺(jué)得還是不翻譯好），另一部分是因?yàn)閐lopen API是用C語(yǔ)言實(shí)現(xiàn)的，因而沒(méi)有提供一個(gè)合適的方式來(lái)裝載類(lèi)。
在解釋如何裝載C++庫(kù)之前，最好再詳細(xì)了解一下name mangling。我推薦您了解一下它，即使您對(duì)它不感興趣。因?yàn)檫@有助于您理解問(wèn)題是如何產(chǎn)生的，如何才能解決它們。
Name Mangling 在每個(gè)C++程序（或庫(kù)、目標(biāo)文件）中，所有非靜態(tài)（non-static）函數(shù)在二進(jìn)制文件中都是以“符號(hào)（symbol）”形式出現(xiàn)的。這些符號(hào)都是唯一的字符串，從而把各個(gè)函數(shù)在程序、庫(kù)、目標(biāo)文件中區(qū)分開(kāi)來(lái)。
在C中，符號(hào)名正是函數(shù)名：strcpy函數(shù)的符號(hào)名就是“strcpy”，等等。這可能是因?yàn)閮蓚€(gè)非靜態(tài)函數(shù)的名字一定各不相同的緣故。
而C++允許重載（不同的函數(shù)有相同的名字但不同的參數(shù)），并且有很多C所沒(méi)有的特性──比如類(lèi)、成員函數(shù)、異常說(shuō)明──幾乎不可能直接用函數(shù)名作符號(hào)名。為了解決這個(gè)問(wèn)題，C++采用了所謂的name mangling。它把函數(shù)名和一些信息（如參數(shù)數(shù)量和大小）雜糅在一起，改造成奇形怪狀，只有編譯器才懂的符號(hào)名。例如，被mangle后的foo可能看起來(lái)像foo@4%6^，或者，符號(hào)名里頭甚至不包括“foo”。
其中一個(gè)問(wèn)題是，C++標(biāo)準(zhǔn)（目前是[ISO14882]）并沒(méi)有定義名字必須如何被mangle，所以每個(gè)編譯器都按自己的方式來(lái)進(jìn)行name mangling。有些編譯器甚至在不同版本間更換mangling算法（尤其是g++ 2.x和3.x）。即使您搞清楚了您的編譯器到底怎么進(jìn)行mangling的，從而可以用dlsym調(diào)用函數(shù)了，但可能僅僅限于您手頭的這個(gè)編譯器而已，而無(wú)法在下一版編譯器下工作。
類(lèi) 使用dlopen API的另一個(gè)問(wèn)題是，它只支持加載函數(shù)。但在C++中，您可能要用到庫(kù)中的一個(gè)類(lèi)，而這需要?jiǎng)?chuàng)建該類(lèi)的一個(gè)實(shí)例，這不容易做到。
解決方案 extern "C" C++有個(gè)特定的關(guān)鍵字用來(lái)聲明采用C binding的函數(shù)：extern "C" 。 用 extern "C"聲明的函數(shù)將使用函數(shù)名作符號(hào)名，就像C函數(shù)一樣。因此，只有非成員函數(shù)才能被聲明為extern "C"，并且不能被重載。盡管限制多多，extern "C"函數(shù)還是非常有用，因?yàn)樗鼈兛梢韵驝函數(shù)一樣被dlopen動(dòng)態(tài)加載。冠以extern "C"限定符后，并不意味著函數(shù)中無(wú)法使用C++代碼了，相反，它仍然是一個(gè)完全的C++函數(shù)，可以使用任何C++特性和各種類(lèi)型的參數(shù)。
加載函數(shù) 在C++中，函數(shù)用dlsym加載，就像C中一樣。不過(guò)，該函數(shù)要用extern "C"限定符聲明以防止其符號(hào)名被mangle。
示例1.加載函數(shù)
代碼:
//----------
//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中函數(shù)hello被定義為extern "C"。它在main.cpp中被dlsym調(diào)用。函數(shù)必須以extern "C"限定，否則我們無(wú)從知曉其符號(hào)名。
警告：
extern "C"的聲明形式有兩種：上面示例中使用的那種內(nèi)聯(lián)（inline）形式extern "C" ， 還有才用花括號(hào)的extern "C" { ... }這種。 第一種內(nèi)聯(lián)形式聲明包含兩層意義：外部鏈接(extern linkage)和C語(yǔ)言鏈接(language linkage)，而第二種僅影響語(yǔ)言鏈接。
下面兩種聲明形式等價(jià)：
代碼:
extern "C" int foo;
extern "C" void bar();
和
代碼:
extern "C" {
extern int foo;
extern void bar();
}
對(duì)于函數(shù)來(lái)說(shuō)，extern和non-extern的函數(shù)聲明沒(méi)有區(qū)別，但對(duì)于變量就有不同了。如果您聲明變量，請(qǐng)牢記：
和
代碼:
extern "C" {
int foo;
}
是不同的物事(譯者注：簡(jiǎn)言之，前者是個(gè)聲明; 而后者不僅是聲明，也可以是定義)。
進(jìn)一步的解釋請(qǐng)參考[ISO14882],7.5, 特別注意第7段; 或者參考[STR2000]，9.2.4。在用extern的變量尋幽訪勝之前，請(qǐng)細(xì)讀“其他”一節(jié)中羅列的文檔。
加載類(lèi) 加載類(lèi)有點(diǎn)困難，因?yàn)槲覀冃枰?lèi)的一個(gè)實(shí)例，而不僅僅是一個(gè)函數(shù)指針。我們無(wú)法通過(guò)new來(lái)創(chuàng)建類(lèi)的實(shí)例，因?yàn)轭?lèi)不是在可執(zhí)行文件中定義的，況且（有時(shí)候）我們連它的名字都不知道。
解決方案是：利用多態(tài)性！ 我們?cè)诳蓤?zhí)行文件中定義一個(gè)帶虛成員函數(shù)的接口基類(lèi)，而在模塊中定義派生實(shí)現(xiàn)類(lèi)。通常來(lái)說(shuō)，接口類(lèi)是抽象的（如果一個(gè)類(lèi)含有虛函數(shù)，那它就是抽象的）。
因?yàn)閯?dòng)態(tài)加載類(lèi)往往用于實(shí)現(xiàn)插件，這意味著必須提供一個(gè)清晰定義的接口──我們將定義一個(gè)接口類(lèi)和派生實(shí)現(xiàn)類(lèi)。
接下來(lái)，在模塊中，我們會(huì)定義兩個(gè)附加的helper函數(shù)，就是眾所周知的“類(lèi)工廠函數(shù)（class factory functions）（譯者注：或稱(chēng)對(duì)象工廠函數(shù)）”。其中一個(gè)函數(shù)創(chuàng)建一個(gè)類(lèi)實(shí)例，并返回其指針; 另一個(gè)函數(shù)則用以銷(xiāo)毀該指針。這兩個(gè)函數(shù)都以extern "C"來(lái)限定修飾。
為了使用模塊中的類(lèi)，我們用dlsym像示例1中加載hello函數(shù)那樣加載這兩個(gè)函數(shù)，然后我們就可以隨心所欲地創(chuàng)建和銷(xiāo)毀實(shí)例了。
示例2.加載類(lèi)
我們用一個(gè)一般性的多邊形類(lèi)作為接口，而繼承它的三角形類(lèi)（譯者注：正三角形類(lèi)）作為實(shí)現(xiàn)。
代碼:
//----------
//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;
}
加載類(lèi)時(shí)有一些值得注意的地方：
◆ 你必須（譯者注：在模塊或者說(shuō)共享庫(kù)中）同時(shí)提供一個(gè)創(chuàng)造函數(shù)和一個(gè)銷(xiāo)毀函數(shù)，且不能在執(zhí)行文件內(nèi)部使用delete來(lái)銷(xiāo)毀實(shí)例，只能把實(shí)例指針傳遞給模塊的銷(xiāo)毀函數(shù)處理。這是因?yàn)镃++里頭，new操作符可以被重載;這容易導(dǎo)致new-delete的不匹配調(diào)用，造成莫名其妙的內(nèi)存泄漏和段錯(cuò)誤。這在用不同的標(biāo)準(zhǔn)庫(kù)鏈接模塊和可執(zhí)行文件時(shí)也一樣。
◆ 接口類(lèi)的析構(gòu)函數(shù)在任何情況下都必須是虛函數(shù)（virtual）。因?yàn)榧词钩鲥e(cuò)的可能極小，近乎杞人憂(yōu)天了，但仍舊不值得去冒險(xiǎn)，反正額外的開(kāi)銷(xiāo)微不足道。如果基類(lèi)不需要析構(gòu)函數(shù)，定義一個(gè)空的（但必須虛的）析構(gòu)函數(shù)吧，否則你遲早要遇到問(wèn)題，我向您保證。你可以在comp.lang.c++ FAQ(
http://www.parashift.com/c++-faq-lite/ )的第20節(jié)了解到更多關(guān)于該問(wèn)題的信息。
源代碼 你可以下載所有包含在本文檔中的代碼包：
http://www.isotton.com/howtos/C++-dl...xamples.tar.gz