解析VC++ Name Mangling 机制

解析VC++ Name Mangling 机制

摘要

在C++中，Name Mangling 是为了支持重载而加入的一项技术，目前C++ Name Mangling 并没有统一的标准，也没有较完整的中文文档化资料，所以本篇文章在VS2005环境中，解析C++ Name Mangling 的技术细节，以及怎样将VC Name Mangling后的名称还原为可读的形式。

 

目录

l        Name Mangling 简介

 

l        VC环境中Name Mangling

 

n         VC环境中C 语言的 Name Mangling

n         VC环境中C++ 语言中的 Name Mangling

l        将Name Mangling 后的名称还原为可读的形式

 

 

Name Mangling 简介

Name Mangling 是一种在编译过程中，将函数、变量的名称重新改编的机制。在 C++重载、namespace等操作符下，函数可以有同样的名字，编译器为了区分各个不同地方的函数，将各个函数通过编译器内定的算法，将函数改成唯一的名称。

Name Mangling翻译成中文意思为：名字修饰、名字改编等，由于对这个翻译没有统一的约定，所以本文中采用英文表示。

在写VC++程序时，我们有时会遇到类似于“error LNK2019: unresolved external symbol "void __cdecl MyFun (void)" (?MyFun@@YAXXZ) referenced in function _wmain”的连接错误，此语句中“?MyFun@@YAXXZ”是VC Name Mangling后的结果。本文主要讨论Name Mangling 后名称还原为可读的方式。

本文首先讨论 VC 环境中，C/C++ 语言的 Name Mangling 算法机制。然后讨论手动将 C++ 语言 Name Mangling 后的字符串转换为函数的定义式，最后编码实现还原。

 

VC环境中Name Mangling

在VC中，微软采用了自己独特的Name Mangling技术，当然微软也为此Name Mangling技术申请了专利。

想要查看 VC 将函数名称 Name Mangling 的结果，只需将函数声明，不实现，然后调用之即可。

下面先讨论VC环境中C语言的Name Mangling技术，然后再讨论C++。

 

VC环境中C 语言的 Name Mangling

    在VC中，也可以采用C语言编译器，只需要如下设置：Project à Property…à Configuration Properties à C/C++ àAdvanced à Compile As，将其设为“(/TC)”即可。至于文件后缀是否为cpp，VC并不关心。

在 C 语言中，函数可以有如下声明方式（其中 __CALLTYPE 可以为 __cdecl、__stdcall、__fastcall等）[1]：

1、void __CALLTYPE fun();

2、int __CALLTYPE fun();

3、int __CALLTYPE fun(int);

4、double __CALLTYPE fun(int, double);

5、int* __CALLTYPE fun(int*, char*);

我们先假设此处 CALLTYPE 为 __cdecl（即：#define __CALLTYPE __cdecl），在 VC 中，Name Mangling 结果如下：

1、_fun

2、_fun

3、_fun

4、_fun

5、_fun

       由此可见，在 VC 编译 C 语言时（__cdecl），仅仅在函数名前加“_”。

我们再看看其他调用方式，如：__stdcall（#define __CALLTYPE __stdcall），结果如下：

       1、_fun@0

    2、_fun@0

       3、_fun@4

       4、_fun@12

    5、_fun@8

    最后，我们看看 __fastcall 的结果（#define __CALLTYPE __ fastcall）：

1、@fun@0

2、@fun@0

3、@fun@4

4、@fun@12

5、@fun@8

由此，我们可以得出结论，从被 Name Mangling 后的字符串推断出原来的函数名。

1、__cdecl

在此声明方式下，仅仅在函数名前加一个下划线，至于函数返回值、参数，完全没有处理。

2、__stdcall

在此声明方式下，在函数名前加一个下划线，然后紧跟“@”符号，最后是函数参数大小总和（注意：此总和包含了字节填充）。

3、__fastcall

在此声明方式下，跟 __stdcall 唯一不同的是，函数前面的下划线变为了“@”符号。

 

由上面 5 个实例函数，我们大概可以看到 VC 环境中，C 语言 Name Mangling 技术了，但也可以发现，从 Name Mangling 后的字符串，并不能得出函数原来的定义式。不同的定义式，Name Mangling 后的名称可以相同，由此也可以知道，C 语言不支持函数重载。

 

VC环境中C++ 语言中的 Name Mangling

在 C++ 语言中，函数需要支持重载，新增命名空间函数调用、类函数调用、运算符重载、模板函数等等，所以情况也比 C 语言复杂很多。

下面我们列举一些函数例子进行分析，函数可以有如下声明方式（其中 __CALLTYPE 可以为__cdecl、__stdcall、__fastcall等）[1]：

1、void __CALLTYPE fun();

2、int __CALLTYPE fun();

3、int __CALLTYPE fun(int);

4、double __CALLTYPE fun(int, double);

5、int* __CALLTYPE fun(int*, char*);

6、class ABCD

{

public:

        int __CALLTYPE fun();

};

7、template<typename T>

int fun(typename T);

我们仍先假设此处 CALLTYPE 为 __cdecl（即：#define __CALLTYPE __cdecl），在 VC 中，Name Mangling 结果如下：

       1、?fun@@YAXXZ

2、?fun@@YAHXZ

3、?fun@@YAHH@Z

    4、?fun@@YANHN@Z

    5、?fun@@YAPAHPAHPAD@Z

    6、?fun@ABCD@@QAAHXZ

    7、??$fun@H@@YAHH@Z

由此可见，C++ 的 Name Mangling 技术比 C 语言的复杂很多。

我们挑选第一条分析一下，“？”表示一个函数的开始，用以区别于 C 语言的“_”，fun 为函数名称，“@@YA”表示函数调用约定为 __cdecl，“X”表示函数的参数为空，“XZ”为结束标识。

将上述名称还原为可读方式并不复杂，但要记住这些规则，考虑到所有组合方式却是一件比较复杂的事情，下面我们来看看一个比较复杂的函数调用，声明函数如下：

int fun（const CString&, const std::vector&）;

Name Mangling 后的结果为：

?fun@@YAHABV?$CStringT@_WV?$StrTraitATL@_WV?$ChTraitsCRT@_W@ATL@@@ATL@@@ATL@@ABV?$vector@NV?$allocator@N@std@@@std@@@Z

如此长的一串，用人脑来直接分析显然不符合实际，好在 Windows 提供了 API 函数用于解析字符串，具体解析办法，下面一节将详细解释。

 

将Name Mangling 后的名称还原为可读的形式

在 Windows 的DbgHelp.dll 导出函数中，UnDecorateSymbolName 是用于解析 Name Mangling 字符串的，具体函数的细节可以查看 MSDN。如下为实例代码：

void UnDecorateName()

{

    char szDecorateName[1024] = {0};

    char szUnDecorateName[2048] = {0};

    printf("Please Input Decorated Name: ");

    scanf("%s", szDecorateName);

 

   if (UnDecorateSymbolName(szDecorateName, szUnDecorateName, sizeof(szUnDecorateName), UNDNAME_COMPLETE) == 0)

    {

        printf("UnDecorateSymbolName Failed. GetLastError() = %d", GetLastError());

        getchar();

        return;

    }

 

    printf("The UnDecorated Name Is: %s/r/n", szUnDecorateName);

    getchar();

    return;

}

 

在 Xp 中当我们输入如上的：?fun@@YAPAHPAHPAD@Z

程序得出的结果为：int * __cdecl fun(int *,char *)

注意：在 Xp 中，带有模板的 Name Mangling 字符串无法直接还原，如需还原，可以在 Vista、Win7 中运行此程序。

 函数声明部分的extern “C”表示连接规范（Linkage Specification）采用C，而不是C++，如果不写的话默认采用C++，当然也可以写成extern “C++”。把这3个函数放到一个文件中，并去掉每个函数前面的extern “C”，编译后用dumpbin分析.lib文件，结果如下（我只取了关键部分）：

       ?Sumcdecl@@YAHHHH@Z (int __cdecl Sumcdecl(int,int,int))

       ?Sumfastcall@@YIHHNHH@Z (int __fastcall Sumfastcall(int,double,int,int))

      ?Sumstdcall@@YGHHHH@Z (int __stdcall Sumstdcall(int,int,int))

       1、每个函数都是以“?”开头，接着是函数名，不改变大小写。

       2、对于__cdecl，函数名后接@@YA；对于__stdcall，函数名后接@@YG；对于__fastcall，函数后接@@YI。

       3、再后面接着的是函数返回值类型的代号和参数类型的代号，规则如下：

代 号

类 型

X

void

D

char

E

unsigned char

F

short

H

int

I

unsigned int

J

long

K

unsigned long

M

float

N

double

_N

bool

O

long double

PA

指针前缀

AA

引用前缀

V类名@@

类

      如果某个参数是指针，则在类型代号前加上PA；如果是引用，则在类型代号前加上AA。如果相同类型的指针连续出现，则以“代替，每个“都代表一次重复；如果相同类型的引用连续出现，则以“代替，每个“都代表一次重复。

    4、代号列表后接@Z或Z来标识整个函数名的结束：如果该函数有参数，则以@Z标识函数名结束；如果该函数没有参数，则以Z标识函数名结束。

     5、函数名结束标志后接一个空格，空格后是带括号的函数原型。在生成的最终文件（.exe或.dll）中，函数名结束标志后面将不会有函数原型。

       举个简单的例子，假设函数原型如下（Test为自定义类）：

       void abc(int a, long b, char* c, char* d, bool &e, Test f, short g)

       那么，修饰后的函数名为：

       ?abc@@YAXHJPAD0AA_NVTest@@F@Z

       其实，我们可以在VC++ 6.0的IDE环境中设置当前工程采用的默认函数调用约定。在主界面下按 Alt + F7 打开【Project Settings】对话框，选择【C/C++】选项卡，然后在【Category】下拉列表框中选择“Code Gernation”，就可以在【Call convetion】下拉列表框中选择函数调用约定了。至于命令行开关，/Gd表示__cdecl，/Gr表示__fastcall，/Gz表示__fastcall。

       __declspec(dllexport)，表示将该函数导出，将生成.lib文件，以便我们验证函数名是怎样修饰的。关于修饰后的函数名，我们可以使用VC98\bin目录下的dumpbin工具来验证，如umpbin /exports <lib文件名>。