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

Question

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

C 标准的规则对这些进行了一些限制（为了安全编译）：AC 编译器可能只查看第一个 标识符的 8 个字符，因此 foobar2k_eggs 和 foobar2k_spam 可能被解释为相同 标识符有效 - 然而每个现代编译器都允许任意长标识符，所以在我们这个时代 （21世纪）我们不应该为此烦恼。

但是，如果您遇到一些无法更改符号名称/标识符的库怎么办？也许你有 只有静态二进制文件和标头或不想或不允许自己调整和重新编译。

Answer 1

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

考虑一下库 foo 和 bar 的标头。为了本教程的目的，我还将向您提供源文件

example/ex01/foo.h

int spam(void);
double eggs(void);

Examples/ex01/foo.c （这可能是不透明/不可用）

int the_spams;
double the_eggs;

int spam()
{
    return the_spams++;
}

double eggs()
{
    return the_eggs--;
}

example/ex01/bar.h

int spam(int new_spams);
double eggs(double new_eggs);

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;
}

我们想在程序 foobar

example/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;
}

中使用它们，一个问题立即变得显而易见：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

好吧，这并不奇怪，它只是告诉我们，我们已经知道或至少怀疑的事情。

那么我们是否可以在不修改原始库的情况下以某种方式解决标识符冲突？
源代码还是标题？事实上我们可以。

首先让我们解决编译时间问题。为此，我们将标头包含在
一堆预处理器 #define 指令，为库导出的所有符号添加前缀。
稍后我们用一些漂亮舒适的包装标头来做到这一点，但只是为了演示
正在发生的事情是在 foobar.c 源文件中逐字执行：

example/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;
}

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

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

... 首先看起来事情变得更糟。但仔细一看：其实是编译阶段
一切顺利。只是链接器现在抱怨有符号冲突
它告诉我们发生这种情况的位置（源文件和行）。正如我们所看到的
这些符号没有前缀。

让我们用 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

现在我们面临的挑战是在一些不透明的二进制文件中为这些符号添加前缀。是的，我知道
在这个例子的过程中，我们有源并且可以在那里改变它。但现在，假设
你只有那些.o文件，或者一个.a（实际上只是一堆.o）。

objcopy 来救援

有一个工具对我们来说特别有趣：objcopy

objcopy 适用于临时文件，因此我们可以像就地操作一样使用它。有一个
名为 --prefix-symbols 的选项/操作，您有 3 个猜测它的作用。

因此，让我们把这个家伙扔到我们顽固的图书馆：

example/ex03/ $ objcopy --prefix-symbols=foo_ foo.o
example/ex03/ $ objcopy --prefix-symbols=bar_ bar.o

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

让我们尝试链接整个事情：

example/ex03/ $ make
cc   foobar.o foo.o bar.o   -o foobar

事实上，它有效：

example/ex03/ $ ./foobar 
foo: spam = 0, eggs = 0.000000
bar: old spam = 0, new spam = 3 ; old eggs = 0.000000, new eggs = 5.000000

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

/* wrapper header wrapper_foo.h for foo.h */
#define spam foo_spam
#define eggs foo_eggs
/* ... */
#include <foo.h>
#undef spam
#undef eggs
/* ... */

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

那么共享库呢？

原则上，共享库也可以做到这一点。然而共享库，顾名思义，
在多个程序之间共享，因此以这种方式弄乱共享库并不是一个好主意。

你无法回避编写一个蹦床包装器。更糟糕的是你无法链接到共享库
在目标文件级别，但被迫进行动态加载。但这值得单独写一篇文章。

请继续关注，祝您编码愉快。

Answer 2

C 标准的规则对此施加了一些限制（为了安全编译）：AC 编译器可能只查看标识符的前 8 个字符，因此 foobar2k_eggs 和 foobar2k_spam 可以有效地解释为相同的标识符 - 然而每个现代编译器允许任意长的标识符，所以在我们这个时代（21世纪）我们不必担心这个。

这不仅仅是现代编译器的扩展；当前的 C 标准还要求编译器支持相当长的外部名称。我忘记了确切的长度，但如果我没记错的话，现在大约是 31 个字符。

但是，如果您遇到一些无法更改符号名称/标识符的库怎么办？也许您只有静态二进制文件和标头，或者您不想，或者不允许您自己调整和重新编译。

然后你就被困住了。向图书馆的作者投诉。我曾经遇到过这样一个错误，由于 Debian 的 libSDL 链接 libsoundfile，我的应用程序的用户无法在 Debian 上构建它，这（至少在当时）污染了全球命名空间中包含像 dsp 这样的变量（我没有骗你！）。我向 Debian 投诉，他们修复了他们的软件包并将修复发送到上游，我认为它已被应用，因为我再也没有听说过这个问题。

我确实认为这是最好的方法，因为它为每个人解决了问题。您所做的任何本地黑客行为都会将问题留在库中，供下一个不幸的用户再次遇到并与之战斗。

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

Answer 3

如果您使用 GCC，--allow-multiple-definition 链接器开关是一个方便的调试工具。这迫使链接器使用第一个定义（而不是抱怨它）。有关更多信息，请参见此处。

当我有供应商提供的库的源代码并且由于某种原因需要跟踪库函数时，这在开发过程中对我很有帮助。该开关允许您在源文件的本地副本中进行编译和链接，并且仍然链接到未修改的静态供应商库。一旦发现之旅完成，不要忘记将开关从 make 符号中拉出来。故意发生名称空间冲突的发布代码很容易出现陷阱，包括无意名称空间冲突。