nm是 UNIX/Linux 系统下查看二进制文件（可执行文件、目标文件、静态库、动态库）中符号信息的命令行工具。那么所谓的符号又是什么呢？

什么是符号

现代的编程语言越来越智能，开发工具链越来越完善，各种 IDE 更是将程序员往傻瓜方向带，导致不少程序员（特别是开发上层应用的程序员）对程序的编译过程不甚了解。日常开发过程中的编译也就是按个按钮或者敲一条指令就完成了整个编译构建的过程，也的确接触不到这个编译过程中的细节。

上图是 GCC 编译过程的分解，从图中可以看到整个过程分为预处理、编译、汇编、链接等几个过程。目前常见的静态编译型的语言多数也会涉及到其中的编译、汇编、链接等步骤，只不过是强大的工具链将这些细节为我们隐藏了罢了。而符号在这其中扮演着重要的角色。

在现代软件开发过程中，软件的规模往往都很大，动辄数百万行代码，如果都放在一个模块肯定无法想象。所以现代的大型软件往往拥有成千上万个模块，这些模块之间相互依赖又相对独立。这种按照层次化及模块化存储和组织源代码有很多好处，比如代码更容易阅读、理解、重用，每个模块可以单独开发、编译、测试，改变部分代码不需要编译整个程序等。

在一个程序被分割成多个模块以后，这些模块之间最后如何组合形成一个单一的程序是须解决的问题。模块之间如何组合的问题可以归结为模块之间如何通信的问题，最常见的属于静态语言的 C/C++ 模块之间通信有两种方式，一种是模块间的函数调用，另外一种是模块间的变量访问。函数访问须知道目标函数的地址，变量访问也须知道目标变量的地址，所以这两种方式都可以归结为一种方式，那就是模块间符号的引用。模块间依靠符号来通信类似于拼图版，定义符号的模块多出一块区域，引用该符号的模块刚好少了那一块区域，两者一拼接刚好完美组合。这个模块的拼接过程就是链接（Linking）。

链接过程的本质就是要把多个不同的目标文件之间相互“粘”到一起，或者说像玩具积木一样，可以拼装形成一个整体。为了使不同目标文件之间能够相互粘合，这些目标文件之间必须有固定的规则才行，就像积木模块必须有凹凸部分才能够拼合。在链接中，目标文件之间相互拼合实际上是目标文件之间对地址的引用，即对函数和变量的地址的引用。比如目标文件B要用到了目标文件A中的函数foo，那么我们就称目标文件A定义（Define）了函数foo，称目标文件B引用（Reference）了目标文件A中的函数foo。这两个概念也同样适用于变量。每个函数或变量都有自己独特的名字，才能避免链接过程中不同变量和函数之间的混淆。在链接中，我们将函数和变量统称为符号（Symbol），函数名或变量名就是符号名（Symbol Name）。

示例

接下来将会用 C/C++ 编写一个简单的程序，并使用 nm 分别查看目标文件和可执行文件中的符号表。通过这个真实的例子来更加直观地体验下符号。

• a.cpp

  1 2 3 4 5 6 7 8 9 10 11 12 13 14

  #include <iostream> namespace testns { int shared = 7; }; extern int shared; void swap(int *a, int *b); int main(int argc, char *argv[]) { int a = 100; swap(&a, &shared); std::printf("a=%d, shared=%d\n", a, shared); }

• b.cpp

  1 2 3 4 5 6 7

  int shared = 1; void swap(int *a, int *b) { int c = *a; *a = *b; *b = c; }

• 分别对 a.cpp 和 b.cpp 文件进行编译并查看两者的符号表

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

  $ g++ -g -c a.cpp $ g++ -g -c b.cpp $ nm a.o U __cxa_atexit U __dso_handle 0000000000000086 t _GLOBAL__sub_I__ZN6testns6sharedE 0000000000000000 T main U printf U shared 0000000000000048 t _Z41__static_initialization_and_destruction_0ii U _Z4swapPiS_ 0000000000000000 D _ZN6testns6sharedE U _ZNSt8ios_base4InitC1Ev U _ZNSt8ios_base4InitD1Ev 0000000000000000 r _ZStL19piecewise_construct 0000000000000000 b _ZStL8__ioinit $ nm b.o 0000000000000000 D shared 0000000000000000 T _Z4swapPiS_

• 将 a.cpp 和 b.cpp 文件编译成可执行文件a.out并查看其符号表

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81

  $ g++ -g a.cpp b.cpp $ nm a.out 0000000000400635 t .annobin__dl_relocate_static_pie.end 0000000000400630 t .annobin__dl_relocate_static_pie.start 00000000004007b0 t .annobin_elf_init.c 0000000000400825 t .annobin_elf_init.c_end 0000000000400600 t .annobin_elf_init.c_end.exit 0000000000400600 t .annobin_elf_init.c_end.hot 0000000000400600 t .annobin_elf_init.c_end.startup 0000000000400600 t .annobin_elf_init.c_end.unlikely 0000000000400600 t .annobin_elf_init.c.exit 0000000000400600 t .annobin_elf_init.c.hot 0000000000400600 t .annobin_elf_init.c.startup 0000000000400600 t .annobin_elf_init.c.unlikely 000000000040062f t .annobin_init.c 000000000040062f t .annobin_init.c_end 0000000000400600 t .annobin_init.c_end.exit 0000000000400600 t .annobin_init.c_end.hot 0000000000400600 t .annobin_init.c_end.startup 0000000000400600 t .annobin_init.c_end.unlikely 0000000000400600 t .annobin_init.c.exit 0000000000400600 t .annobin_init.c.hot 0000000000400600 t .annobin_init.c.startup 0000000000400600 t .annobin_init.c.unlikely 0000000000400825 t .annobin___libc_csu_fini.end 0000000000400815 t .annobin___libc_csu_fini.start 0000000000400815 t .annobin___libc_csu_init.end 00000000004007b0 t .annobin___libc_csu_init.start 0000000000400630 t .annobin_static_reloc.c 0000000000400635 t .annobin_static_reloc.c_end 0000000000400600 t .annobin_static_reloc.c_end.exit 0000000000400600 t .annobin_static_reloc.c_end.hot 0000000000400600 t .annobin_static_reloc.c_end.startup 0000000000400600 t .annobin_static_reloc.c_end.unlikely 0000000000400600 t .annobin_static_reloc.c.exit 0000000000400600 t .annobin_static_reloc.c.hot 0000000000400600 t .annobin_static_reloc.c.startup 0000000000400600 t .annobin_static_reloc.c.unlikely 0000000000601044 B __bss_start 0000000000601044 b completed.7294 U __cxa_atexit@@GLIBC_2.2.5 0000000000601038 D __data_start 0000000000601038 W data_start 0000000000400640 t deregister_tm_clones 0000000000400630 T _dl_relocate_static_pie 00000000004006b0 t __do_global_dtors_aux 0000000000600dd8 t __do_global_dtors_aux_fini_array_entry 0000000000400840 R __dso_handle 0000000000600de0 d _DYNAMIC 0000000000601044 D _edata 0000000000601048 B _end 0000000000400828 T _fini 00000000004006e0 t frame_dummy 0000000000600dc8 t __frame_dummy_init_array_entry 00000000004009f4 r __FRAME_END__ 0000000000601000 d _GLOBAL_OFFSET_TABLE_ 000000000040076c t _GLOBAL__sub_I__ZN6testns6sharedE w __gmon_start__ 000000000040085c r __GNU_EH_FRAME_HDR 0000000000400590 T _init 0000000000600dd8 t __init_array_end 0000000000600dc8 t __init_array_start 0000000000400838 R _IO_stdin_used w _ITM_deregisterTMCloneTable w _ITM_registerTMCloneTable 0000000000400820 T __libc_csu_fini 00000000004007b0 T __libc_csu_init U __libc_start_main@@GLIBC_2.2.5 00000000004006e6 T main U printf@@GLIBC_2.2.5 0000000000400670 t register_tm_clones 0000000000601040 D shared 0000000000400600 T _start 0000000000601048 D __TMC_END__ 000000000040072e t _Z41__static_initialization_and_destruction_0ii 0000000000400781 T _Z4swapPiS_ 000000000060103c D _ZN6testns6sharedE U _ZNSt8ios_base4InitC1Ev@@GLIBCXX_3.4 U _ZNSt8ios_base4InitD1Ev@@GLIBCXX_3.4 0000000000400848 r _ZStL19piecewise_construct 0000000000601045 b _ZStL8__ioinit

符号类型

nm 的默认输出格式是每行一个符号，每行均由空格分隔成了三列：第一列是内存地址；第二列是符号类型；第三列是符号名。

内存地址指的是虚拟内存地址，如果地址是0000000000000000，链接器会在链接过程中重新计算一个新的内存地址，这个过程叫重定位。比如上文示例中全局变量shared在 b.o 目标文件中的符号内存地址就是0000000000000000，但是经过链接后的可执行文件 a.out 中的符号内存地址就被重定位成了0000000000601040。

符号名通常就是上文所提到的函数和变量，链接器在链接过程中需要通过各个目标文件中的符号进行重定位计算内存地址并生成最终的可执行文件，因为符号名在这些目标文件中得是唯一的。C++ 拥有丰富的语言特性，其中命名空间、类继承、函数重载等特性允许在不同作用域下拥有同名的变量和函数，这就必须有一套机制去确保符号不会重名，这也就是符号修饰。比如上文示例中存在两个名为shared的变量，一个为默认命名空间中的变量，一个为testns命名空间中的变量。为了支持 C++ 的命名空间特性，同时也为了保证符号名称的唯一性，编译器对符号名称进行了修饰，最终的符号名变成了_ZN6testns6sharedE。当然，符号修饰的规则各家编译器厂商并不统一，因此最终的符号名称不一定就是示例中给出的名称。正因如此，C++ 的 ABI 兼容性并不好，甚至同一编译器的不同版本也存在 ABI 不兼容的情况。

本节对重定位和符号修饰不做过多展开，主要来阐述下有关符号类型的话题。符号类型一般遵循这样的规则：大写字母表示全局符号（global），小写字母表示局部符号（local）。所谓的全局符号，是在某个目标文件中能被其他目标文件所引用的符号，比如全局函数、全局变量等。所谓的局部符号，则是只能在当前目标文件内部被引用的符号，比如 C/C++ 中使用 static 关键字修饰的全局变量，它们仅仅在编译单元内部可见。而上文所提及的外部符号，是那些在当前目标文件中所引用的其他目标文件中的全局符号。

以下是对常见符号类型的说明：

nm命令行选项

go tool nm命令行选项

go 标准库工具链中也提供了go tool nm子命令。该子命令是一个 nm 的简化实现，仅提供了有限的几个选项。注意：不建议在编译时为链接器指定选项-ldflags='-s -w'，否则相关的符号表和调试信息将被去除。

参考资料

• 《程序员的自我修养：链接、装载与库》
• nm 目标文件格式分析
• nm(1)