探查C++ name mangling

什么是name mangling？

C++编译器会为代码中的每个函数签名生成全局唯一的名字，以方便后续定位和引用，这个名字是由函数名和函数参数组合而成的，不考虑返回值（这是合理的，因为在cpp语法中：函数签名相同但返回值不同的函数声明被认为是具有二义性的非法声明）。

怎么查看mangled name？

可以使用nm工具探查编译后的目标文件：

g++ -c t.cpp
nm t.o

如果t.cpp中这么写：

int foo(bool x) {
    return 42;
}

int foo(int x) {
    return 100;
}

那么会得到输出：

0000000000000000 T __Z3foob
0000000000000020 T __Z3fooi

其中，__Z是gcc标识，3是函数名foo的长度，foo是函数名，b或i是参数类型列表（记得，函数中的参数名仅在定义体中是有用的），这里b代表bool类型，i代表int类型。
补充一些，nm命令可以显示文件中的符号：
nm指令是names的简称，通过该指令可以列举文件中的符号，这里摘录一份命令说明：

用法：nm [选项]  [文件名称] ，若未输入文件名，则默认作用于当前路径的a.out文件。

选项：
    -a    显示所有信息，包括调试信息
    -A    在每行符号信息前，打印查询的文件名
    -C    将低级别的符号名称转换为用户级别的名称，意思是转换为用户较容易理解的形式，如：class::memberfunction形式的信息
    -D    显示动态符号信息
    -g    只显示外部符号；封装成动态库时，需要被外部调用的函数必须是外部符号，否则无法使用
    -n    将符号按地址排序
    -r    反向排序
    -u    仅显示未定义符号，实测列出了GLIBC中的memset、memcpy等，不清楚具体作用
    -V    输出程序版本

nm支持的目标：动态库、静态库、可执行文件

如何反向解析mangled name？

可以使用c++filt命令，一般随gcc内置：

> c++filt __Z3foob __Z3fooi
foo(bool)
foo(int)

复杂的mangled name呢？

另外，name mangling不仅作用于普通函数，也可作用于类的成员函数，见下述声明：

class article 
{
public:
    std::string format(void)
    { 
            return "str";
    }
    bool print_to(std::ostream &) 
    {
            return false;
    }
    class wikilink 
    {
    public:
        wikilink(std::string const &name) {}
    };
};

> g++ t.cpp && nm -a a.out | grep article
0000000000001410 W _ZN7article6formatB5cxx11Ev
00000000000014a2 W _ZN7article8wikilinkC1ERKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
00000000000014a2 W _ZN7article8wikilinkC2ERKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
> g++ t.cpp && nm -a a.out | grep article | awk '{print $3}' | c++filt
article::format[abi:cxx11]()
article::wikilink::wikilink(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)
article::wikilink::wikilink(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)

可以看到规则大体与普通函数类似，只是嵌套了几层而已。

坑

1. 在macOS上的nm和c++filt命令分别输出和接受__Z开头的mangled name，而在linux上，则是_Z开头。
2. 简单地在一个cpp文件中定义一个class后，使用nm命令是看不到响应的符号的，必须要在一个具有外部链接性的函数中去使用它，才会真正地在目标文件中生成一个符号，初步考虑可能是因为被优化了。