Linux动态库的导出控制

在实际工作中，许多软件模块是以动态库的方式提供的。做为模块开发人员，我们不仅要掌握如何编写和构建动态库，还要了解如何控制动态库的导出接口，这样，我们可以向模块的用户仅导出必要的接口，而另一些内部接口，为了安全或其他考虑，可以不必导出。当需要导出C++类时，问题显得更复杂一些，不过我认为不应导出C++类成员，而只应导出纯C接口。

和Visual C++不同，GCC编译器默认会导出所有符号。假设我们需要导出两个全局函数test和test2，以及一个C++类foo，此类有两个public成员函数a和b，声明文件so.h如下：

 #ifndef __SO_H__
 #define __SO_H__

 #ifdef __cplusplus
 extern "C" {
 #endif

 void  test();
 int   test2(int _v);

 class foo
 {
 public:
     void a();
     int  b(int _v);
 };

 #ifdef __cplusplus
 }
 #endif

 #endif

实现文件so.cpp如下：

 #include <stdio.h>
 #include "so.h"

 void  test()
 {
     printf("test\n");
 }

 int  test2(int _v)
 {
     return _v*_v;
 }

 void  foo::a()
 {
     printf("foo::a()\n");
 }

 int  foo::b(int _v)
 {
     return _v*_v;
 }

我们把这些代码编译成一个动态库test.so:

$ g++ -shared -o test.so -fPIC so.cpp

然后使用nm命令查看动态符号表：

$ nm -D test.so
                 w _Jv_RegisterClasses
000000000000063e T _ZN3foo1aEv
 T _ZN3foo1bEi
 A __bss_start
                 w __cxa_finalize
                 w __gmon_start__
 A _edata
 A _end
00000000000006a8 T _fini
 T _init
                 U puts
000000000000061c T test
000000000000062e T test2

可见，test、test2、foo::a、foo::b都被导出了（注意带有大写T的项）。

接着我们再写一个客户程序main.cpp，来实现此动态库，代码如下：

 #include <stdio.h>
 #include "so.h"

 int main(int argc, char** argv)
 {
     test();
     printf("test2: %d\n", test2());

     foo f;
     f.a();
     printf("foo::b: %d\n", f.b());

     return ;
 }

编译命令和输出如下：

$ g++ -o app main.cpp test.so
$ ./app
test
test2:
foo::a()
foo::b: 

上面的操作，显示了默认情况下，Linux动态库是导出了所有符号的，另外，也展示了如何导出和使用动态库中的C++类成员。

现在，假设我们要只导出全局函数test和foo类的成员函数a，怎么办呢？有好几种方法，最方便的是使用GCC编译器特性。首先，将so.h修改如下：

 #ifndef __SO_H__
 #define __SO_H__

 #define DLL_PUBLIC __attribute__ ((visibility("default")))

 #ifdef __cplusplus
 extern "C" {
 #endif

 DLL_PUBLIC  void  test();
 int   test2(int _v);

 class foo
 {
 public:
     DLL_PUBLIC  void a();
     int  b(int _v);
 };

 #ifdef __cplusplus
 }
 #endif

 #endif

so.cpp不变。接着，使用以下命令编译test.so：

$ g++ -shared -o test.so -fPIC -fvisibility=hidden so.cpp

其中，__attribute__ ((visibility("default")))是默认可见标签，还有一个是__attribute__ ((visibility("hidden")))。-fvisibility=hidden，意思是将动态库中的符号设置为默认不导出。这样一来，只有添加了DLL_PUBLIC，也就是__attribute__ ((visibility("default")))标签的符号才会被导出。我们可以用nm命令来检验：

$ nm -D test.so
                 w _Jv_RegisterClasses
00000000000005ee T _ZN3foo1aEv
 A __bss_start
                 w __cxa_finalize
                 w __gmon_start__
 A _edata
 A _end
 T _fini
00000000000004b8 T _init
                 U puts
00000000000005cc T test

可见，只留下了test和foo::a，其他两个符号已经看不到了。

如果此时，我们按一开始的步骤编译main.cpp，会报错：

$ g++ -o app main.cpp test.so
/tmp/ccA12RQf.o: In function `main':
main.cpp:(.text+0x1a): undefined reference to `test2'
main.cpp:(.text+0x48): undefined reference to `foo::b(int)'
collect2: ld returned  exit status

OK, 至此我们已经实现了Linux动态库(.so)中导出符号的控制。

【参考资料】

1. 这个还讲了其他导出符号控制方法 http://blog.csdn.net/zdragon2002/article/details/6061962

2. 这是一个PDF，《how to write shared libraries》，详细讲解了如何在Linux下创建共享库

http://www.akkadia.org/drepper/dsohowto.pdf

3. GCC Visibility http://gcc.gnu.org/wiki/Visibility