如何处理静态链接库之间的符号冲突?

dat*_*olf 79 c static symbols collision libraries

编写库时,最重要的规则和最佳实践之一是将库的所有符号放入特定于库的命名空间.由于namespace关键字,C++使这很容易.在C中,通常的方法是在标识符前面加上一些特定于库的前缀.

C标准的规则放在那些一些限制(安全编译):AC编译器可以看只是一个标识符的前8个字符,所以foobar2k_eggsfoobar2k_spam可能被解释为有效相同标识符-但是每一个现代的编译器允许任意长标识符所以在我们这个时代(21世纪),我们不应该为此烦恼.

但是如果你面对一些你无法改变符号名称/标识符的库呢?也许你只有一个静态二进制文件和标题或者不想要,或者不允许自己调整和重新编译.

dat*_*olf 127

至少在静态库的情况下,您可以非常方便地解决它.

考虑一下库foobar的标题.为了本教程的目的,我还将为您提供源文件

实例/ EX01/foo.h中

int spam(void);
double eggs(void);
Run Code Online (Sandbox Code Playgroud)

examples/ex01/foo.c(这可能不透明/不可用)

int the_spams;
double the_eggs;

int spam()
{
    return the_spams++;
}

double eggs()
{
    return the_eggs--;
}
Run Code Online (Sandbox Code Playgroud)

例如/ EX01/bar.h

int spam(int new_spams);
double eggs(double new_eggs);
Run Code Online (Sandbox Code Playgroud)

examples/ex01/bar.c(这可能是不透明的/不可用的)

int the_spams;
double the_eggs;

int spam(int new_spams)
{
    int old_spams = the_spams;
    the_spams = new_spams;
    return old_spams;
}

double eggs(double new_eggs)
{
    double old_eggs = the_eggs;
    the_eggs = new_eggs;
    return old_eggs;
}
Run Code Online (Sandbox Code Playgroud)

我们想在程序foobar中使用它们

例如/ EX01/foobar.c但是

#include <stdio.h>

#include "foo.h"
#include "bar.h"

int main()
{
    const int    new_bar_spam = 3;
    const double new_bar_eggs = 5.0f;

    printf("foo: spam = %d, eggs = %f\n", spam(), eggs() );
    printf("bar: old spam = %d, new spam = %d ; old eggs = %f, new eggs = %f\n", 
            spam(new_bar_spam), new_bar_spam, 
            eggs(new_bar_eggs), new_bar_eggs );

    return 0;
}
Run Code Online (Sandbox Code Playgroud)

一个问题立即变得明显:C不知道超载.所以我们有两次具有相同名称但签名不同的两个函数.所以我们需要一些方法来区分它们.无论如何,让我们看看编译器对此有何看法:

example/ex01/ $ make
cc    -c -o foobar.o foobar.c
In file included from foobar.c:4:
bar.h:1: error: conflicting types for ‘spam’
foo.h:1: note: previous declaration of ‘spam’ was here
bar.h:2: error: conflicting types for ‘eggs’
foo.h:2: note: previous declaration of ‘eggs’ was here
foobar.c: In function ‘main’:
foobar.c:11: error: too few arguments to function ‘spam’
foobar.c:11: error: too few arguments to function ‘eggs’
make: *** [foobar.o] Error 1
Run Code Online (Sandbox Code Playgroud)

好吧,这并不奇怪,它只是告诉我们,我们已经知道的,或者至少是怀疑的.

那么我们可以在不修改原始库的源代码或头文件的情况下以某种方式解决该标识符冲突吗?事实上我们可以.

首先让我们解决编译时问题.为此,我们将头文件包含在一堆预处理程序#define指令中,这些指令为库导出的所有符号添加前缀.稍后我们使用一些很好的舒适包装头来做这件事,但仅仅是为了证明正在进行的操作是在foob​​ar.c源文件中逐字记录:

例如/ EX02/foobar.c但是

#include <stdio.h>

#define spam foo_spam
#define eggs foo_eggs
#  include "foo.h"
#undef spam
#undef eggs

#define spam bar_spam
#define eggs bar_eggs
#  include "bar.h"
#undef spam
#undef eggs

int main()
{
    const int    new_bar_spam = 3;
    const double new_bar_eggs = 5.0f;

    printf("foo: spam = %d, eggs = %f\n", foo_spam(), foo_eggs() );
    printf("bar: old spam = %d, new spam = %d ; old eggs = %f, new eggs = %f\n", 
           bar_spam(new_bar_spam), new_bar_spam, 
           bar_eggs(new_bar_eggs), new_bar_eggs );

    return 0;
}
Run Code Online (Sandbox Code Playgroud)

现在,如果我们编译这个......

example/ex02/ $ make
cc    -c -o foobar.o foobar.c
cc   foobar.o foo.o bar.o   -o foobar
bar.o: In function `spam':
bar.c:(.text+0x0): multiple definition of `spam'
foo.o:foo.c:(.text+0x0): first defined here
bar.o: In function `eggs':
bar.c:(.text+0x1e): multiple definition of `eggs'
foo.o:foo.c:(.text+0x19): first defined here
foobar.o: In function `main':
foobar.c:(.text+0x1e): undefined reference to `foo_eggs'
foobar.c:(.text+0x28): undefined reference to `foo_spam'
foobar.c:(.text+0x4d): undefined reference to `bar_eggs'
foobar.c:(.text+0x5c): undefined reference to `bar_spam'
collect2: ld returned 1 exit status
make: *** [foobar] Error 1
Run Code Online (Sandbox Code Playgroud)

......首先看起来事情变得更糟.但仔细一看:实际上编译阶段很顺利.它只是链接器现在抱怨有符号冲突,它告诉我们发生这种情况的位置(源文件和行).我们可以看到这些符号没有前缀.

我们来看看带有nm实用程序的符号表:

example/ex02/ $ nm foo.o
0000000000000019 T eggs
0000000000000000 T spam
0000000000000008 C the_eggs
0000000000000004 C the_spams

example/ex02/ $ nm bar.o
0000000000000019 T eggs
0000000000000000 T spam
0000000000000008 C the_eggs
0000000000000004 C the_spams
Run Code Online (Sandbox Code Playgroud)

所以现在我们要对这些符号加上一些不透明的二进制符号的前缀进行挑战.是的,我知道在这个例子中我们有源,可以在那里改变它.但是现在,假设你只有那些.o文件或.a(实际上只是一堆.o).

objcopy救援

我们有一个特别有趣的工具:objcopy

objcopy适用于临时文件,因此我们可以像使用它一样使用它.有一个名为--prefix-symbols的选项/操作,你有三个猜测它做了什么.

让我们把这个家伙扔到我们顽固的图书馆:

example/ex03/ $ objcopy --prefix-symbols=foo_ foo.o
example/ex03/ $ objcopy --prefix-symbols=bar_ bar.o
Run Code Online (Sandbox Code Playgroud)

nm向我们展示了这似乎有效:

example/ex03/ $ nm foo.o
0000000000000019 T foo_eggs
0000000000000000 T foo_spam
0000000000000008 C foo_the_eggs
0000000000000004 C foo_the_spams

example/ex03/ $ nm bar.o
000000000000001e T bar_eggs
0000000000000000 T bar_spam
0000000000000008 C bar_the_eggs
0000000000000004 C bar_the_spams
Run Code Online (Sandbox Code Playgroud)

让我们尝试链接这整个事情:

example/ex03/ $ make
cc   foobar.o foo.o bar.o   -o foobar
Run Code Online (Sandbox Code Playgroud)

事实上,它有效:

example/ex03/ $ ./foobar 
foo: spam = 0, eggs = 0.000000
bar: old spam = 0, new spam = 3 ; old eggs = 0.000000, new eggs = 5.000000
Run Code Online (Sandbox Code Playgroud)

现在我把它作为练习留给读者实现一个工具/脚本,使用nm自动提取库的符号,写一个结构的包装头文件

/* wrapper header wrapper_foo.h for foo.h */
#define spam foo_spam
#define eggs foo_eggs
/* ... */
#include <foo.h>
#undef spam
#undef eggs
/* ... */
Run Code Online (Sandbox Code Playgroud)

并使用objcopy将符号前缀应用于静态库的目标文件.

共享库怎么样?

原则上,共享库也可以这样做.但是,名称告诉它,共享库在多个程序之间共享,因此以这种方式搞乱共享库并不是一个好主意.

你不会到处写一个蹦床包装.更糟糕的是,您无法链接到目标文件级别的共享库,但却被迫进行动态加载.但这值得它自己的文章.

请继续关注,并快乐编码.

  • @Alex B:这是一篇教程文章,我按照meta.stackoverflow.com向我建议的路径如何提供有关(有趣的?)问题及其解决方案的教程.关于图书馆冲突的问题出现了,我想"嗯,我知道如何处理这种解决方案",写了一篇文章,并以问答的形式发布在这里.http://meta.stackexchange.com/questions/97240/asking-for-requests-for-comments/97242#97242 (16认同)
  • 你刚才问...在1分钟内回答你自己的问题吗? (10认同)
  • Blah blah blah`objcopy --prefix-symbols` ... +1! (5认同)
  • @datenwolf关于为iOS库解决这个问题的任何想法.我发现,objcopy不支持iOS库:/ (4认同)
  • 令人印象深刻!不要指望用'objcopy`这么容易. (3认同)

R..*_*R.. 7

C标准的规则对这些规则施加了一些约束(用于安全编译):AC编译器可能只查看标识符的前8个字符,因此foobar2k_eggs和foobar2k_spam可以被有效地解释为相同的标识符 - 但是每个现代编译器都允许任意长标识符,所以在我们这个时代(21世纪),我们不应该为此烦恼.

这不仅仅是现代编译器的延伸; 当前的C标准还要求编译器支持合理长的外部名称.我忘记了确切的长度,但如果我没记错的话,它就像31个字符.

但是如果你面对一些你无法改变符号名称/标识符的库呢?也许你只有一个静态二进制文件和标题或者不想要,或者不允许自己调整和重新编译.

然后你就被困住了.抱怨图书馆的作者.我曾经遇到过这样一个错误:我的应用程序的用户由于Debian的libSDL链接而无法在Debian上构建它libsoundfile,这至少在当时用可变的类似的方式污染了全局命名空间dsp(我小时候你没有!).我向Debian抱怨,他们修复了他们的软件包并将修复程序发送到上游,我认为它已经应用了,因为我再也没有听说过这个问题.

我真的认为这是最好的方法,因为它解决了每个人的问题.你做的任何本地黑客都会将问题留在库中,以便下一个不幸的用户再次遇到并与之抗争.

如果你真的需要快速修复,并且你有源代码,你可以-Dfoo=crappylib_foo -Dbar=crappylib_bar在makefile中添加一堆等来修复它.如果没有,请使用objcopy您找到的解决方案.