将静态库链接到动态库时删除死代码
Remove dead code when linking static library into dynamic library
假设我有以下文件:
libmy_static_lib.c:
#include <stdio.h>
void func1(void){
printf("func1() called from a static library\n");
}
void unused_func1(void){
printf("printing from the unused function1\n");
}
void unused_func2(void){
printf("printing from unused function2\n");
}
libmy_static_lib.h:
void func(void);
void unused_func1(void);
void unused_func2(void);
my_prog.c:
#include "libmy_static_lib.h"
#include <stdio.h>
void func_in_my_prog()
{
printf("in my prog\n");
func1();
}
这是我 link 图书馆的方式:
# build the static library libmy_static_lib.a
gcc -fPIC -c -fdata-sections --function-sections -c libmy_static_lib.c -o libmy_static_lib.o
ar rcs libmy_static_lib.a libmy_static_lib.o
# build libmy_static_lib.a into a new shared library
gcc -fPIC -c ./my_prog.c -o ./my_prog.o
gcc -Wl,--gc-sections -shared -m64 -o libmy_shared_lib.so ./my_prog.o -L. -l:libmy_static_lib.a
libmy_static_lib.c里面有2个函数没用到,从this post开始,我觉得
gcc fdata-sections --function-sections
应该为每个函数创建一个符号,
gcc -Wl,--gc-sections
应该在 linking
时删除未使用的符号
然而当我运行
nm libmy_shared_lib.so
这表明这 2 个未使用的函数也正在 linked 到共享库中。
关于如何让 gcc 自动删除未使用的函数有什么建议吗?
编辑:
如果我 link 将静态库直接转换为可执行文件,我可以使用 gcc 的上述选项删除未使用的函数。但是如果我 link 静态库到共享库,它不会删除未使用的函数。
您正在创建一个 库 ,并且您的符号不是 static,因此链接器不删除是正常的任何全局符号。
此 -gc-sections
选项专为可执行文件设计。链接器从入口点 (main
) 开始并发现函数调用。它标记已使用的部分,并丢弃其他部分。
一个库没有 1 个入口点,它有与全局符号一样多的入口点,这说明它不能 清理你的符号。如果有人在他的程序中使用您的 .h
文件并调用“未使用”的函数怎么办?
要找出哪些函数未被“使用”,我建议您将 void func_in_my_prog()
转换为 int main()
(或将源代码复制到包含 [=18= 的修改后的函数中) ]), 然后用源代码创建一个可执行文件,并在链接创建映射文件时添加 -Wl,-Map=mapfile.txt
选项。
gcc -Wl,--gc-sections -Wl,--Map=mapfile.txt -fdata-sections -ffunction-sections libmy_static_lib.c my_prog.c
此映射文件包含丢弃的符号:
Discarded input sections
.drectve 0x00000000 0x54 c:/gnatpro/17.1/bin/../lib/gcc/i686-pc-mingw32/6.2.1/crt2.o
.drectve 0x00000000 0x1c c:/gnatpro/17.1/bin/../lib/gcc/i686-pc-
...
.text$unused_func1
0x00000000 0x14 C:\Users\xx\AppData\Local\Temp\ccOOESqJ.o
.text$unused_func2
0x00000000 0x14 C:\Users\xx\AppData\Local\Temp\ccOOESqJ.o
.rdata$zzz 0x00000000 0x38 C:\Users\xx\AppData\Local\Temp\ccOOESqJ.o
...
现在我们看到未使用的功能已被删除。它们不再出现在最终的可执行文件中。
现有工具可以做到这一点(使用此技术但不需要 main
),例如 Callcatcher。人们还可以轻松地创建一个工具来反汇编库并检查已定义但未调用的符号(我已经在 python 中多次编写过此类工具,解析汇编比解析高级代码要容易得多)
要清理,您可以从源代码中手动删除未使用的函数(在使用 existing/custom 汇编分析工具时,必须小心使用面向对象的语言和调度调用。另一方面,编译器是不会删除 可以 使用的部分,这样是安全的)
您还可以删除库文件中的相关部分,避免更改源代码,例如删除部分:
$ objcopy --remove-section .text$unused_func1 --remove-section text$unused_func2 libmy_static_lib.a stripped.a
$ nm stripped.a
libmy_static_lib.o:
00000000 b .bss
00000000 d .data
00000000 r .rdata
00000000 r .rdata$zzz
00000000 t .text
00000000 t .text$func1
00000000 T _func1
U _puts
您可以使用版本脚本结合 -ffunction-sections
和 --gc-sections
来标记入口点。
例如,考虑这个 C 文件 (example.c
):
int
foo (void)
{
return 17;
}
int
bar (void)
{
return 251;
}
而这个 version script,叫做 version.script
:
{
global: foo;
local: *;
};
像这样编译和link源代码:
gcc -Wl,--gc-sections -shared -ffunction-sections -Wl,--version-script=version.script example.c
如果您查看 objdump -d --reloc a.out
的输出,您会注意到只有 foo
包含在共享对象中,而不是 bar
。
以这种方式删除函数时,linker 将考虑间接依赖性。例如,如果你把 foo
变成这样:
void *
foo (void)
{
extern int bar (void);
return bar;
}
linker 会将 foo
和 bar
都放入共享对象中,因为两者都需要,即使只导出 bar
。
(显然,这并不适用于所有平台,但 ELF 支持。)
假设我有以下文件:
libmy_static_lib.c:
#include <stdio.h>
void func1(void){
printf("func1() called from a static library\n");
}
void unused_func1(void){
printf("printing from the unused function1\n");
}
void unused_func2(void){
printf("printing from unused function2\n");
}
libmy_static_lib.h:
void func(void);
void unused_func1(void);
void unused_func2(void);
my_prog.c:
#include "libmy_static_lib.h"
#include <stdio.h>
void func_in_my_prog()
{
printf("in my prog\n");
func1();
}
这是我 link 图书馆的方式:
# build the static library libmy_static_lib.a
gcc -fPIC -c -fdata-sections --function-sections -c libmy_static_lib.c -o libmy_static_lib.o
ar rcs libmy_static_lib.a libmy_static_lib.o
# build libmy_static_lib.a into a new shared library
gcc -fPIC -c ./my_prog.c -o ./my_prog.o
gcc -Wl,--gc-sections -shared -m64 -o libmy_shared_lib.so ./my_prog.o -L. -l:libmy_static_lib.a
libmy_static_lib.c里面有2个函数没用到,从this post开始,我觉得
gcc fdata-sections --function-sections
应该为每个函数创建一个符号,
gcc -Wl,--gc-sections
应该在 linking
时删除未使用的符号然而当我运行
nm libmy_shared_lib.so
这表明这 2 个未使用的函数也正在 linked 到共享库中。
关于如何让 gcc 自动删除未使用的函数有什么建议吗?
编辑: 如果我 link 将静态库直接转换为可执行文件,我可以使用 gcc 的上述选项删除未使用的函数。但是如果我 link 静态库到共享库,它不会删除未使用的函数。
您正在创建一个 库 ,并且您的符号不是 static,因此链接器不删除是正常的任何全局符号。
此 -gc-sections
选项专为可执行文件设计。链接器从入口点 (main
) 开始并发现函数调用。它标记已使用的部分,并丢弃其他部分。
一个库没有 1 个入口点,它有与全局符号一样多的入口点,这说明它不能 清理你的符号。如果有人在他的程序中使用您的 .h
文件并调用“未使用”的函数怎么办?
要找出哪些函数未被“使用”,我建议您将 void func_in_my_prog()
转换为 int main()
(或将源代码复制到包含 [=18= 的修改后的函数中) ]), 然后用源代码创建一个可执行文件,并在链接创建映射文件时添加 -Wl,-Map=mapfile.txt
选项。
gcc -Wl,--gc-sections -Wl,--Map=mapfile.txt -fdata-sections -ffunction-sections libmy_static_lib.c my_prog.c
此映射文件包含丢弃的符号:
Discarded input sections
.drectve 0x00000000 0x54 c:/gnatpro/17.1/bin/../lib/gcc/i686-pc-mingw32/6.2.1/crt2.o
.drectve 0x00000000 0x1c c:/gnatpro/17.1/bin/../lib/gcc/i686-pc-
...
.text$unused_func1
0x00000000 0x14 C:\Users\xx\AppData\Local\Temp\ccOOESqJ.o
.text$unused_func2
0x00000000 0x14 C:\Users\xx\AppData\Local\Temp\ccOOESqJ.o
.rdata$zzz 0x00000000 0x38 C:\Users\xx\AppData\Local\Temp\ccOOESqJ.o
...
现在我们看到未使用的功能已被删除。它们不再出现在最终的可执行文件中。
现有工具可以做到这一点(使用此技术但不需要 main
),例如 Callcatcher。人们还可以轻松地创建一个工具来反汇编库并检查已定义但未调用的符号(我已经在 python 中多次编写过此类工具,解析汇编比解析高级代码要容易得多)
要清理,您可以从源代码中手动删除未使用的函数(在使用 existing/custom 汇编分析工具时,必须小心使用面向对象的语言和调度调用。另一方面,编译器是不会删除 可以 使用的部分,这样是安全的)
您还可以删除库文件中的相关部分,避免更改源代码,例如删除部分:
$ objcopy --remove-section .text$unused_func1 --remove-section text$unused_func2 libmy_static_lib.a stripped.a
$ nm stripped.a
libmy_static_lib.o:
00000000 b .bss
00000000 d .data
00000000 r .rdata
00000000 r .rdata$zzz
00000000 t .text
00000000 t .text$func1
00000000 T _func1
U _puts
您可以使用版本脚本结合 -ffunction-sections
和 --gc-sections
来标记入口点。
例如,考虑这个 C 文件 (example.c
):
int
foo (void)
{
return 17;
}
int
bar (void)
{
return 251;
}
而这个 version script,叫做 version.script
:
{
global: foo;
local: *;
};
像这样编译和link源代码:
gcc -Wl,--gc-sections -shared -ffunction-sections -Wl,--version-script=version.script example.c
如果您查看 objdump -d --reloc a.out
的输出,您会注意到只有 foo
包含在共享对象中,而不是 bar
。
以这种方式删除函数时,linker 将考虑间接依赖性。例如,如果你把 foo
变成这样:
void *
foo (void)
{
extern int bar (void);
return bar;
}
linker 会将 foo
和 bar
都放入共享对象中,因为两者都需要,即使只导出 bar
。
(显然,这并不适用于所有平台,但 ELF 支持。)