C++异常中的堆栈跟踪

2012/6/13 11:47:00  请友读忠(更多)  E界MRP开发下载网  511阅

C++语言的运行时环境是基于栈的环境，堆栈跟踪（trace stack）就是程序运行时能够跟踪并打印所调用的函数、变量及返回地址等，C++异常中的堆栈跟踪就是当程序抛出异常时，能够把导致抛出异常的语句所在的文件名和行号打印出来，以及把调用抛出异常的语句的函数以及其它上层函数信息都打印出来。
1． 为什么需要堆栈跟踪
当你在开发程序时，你是否曾遇到过程序运行过程中突然当机，而你不知道哪一行代码出的问题；你是否曾遇到过程序调试过程中突然抛出异常，而你不知道哪一行代码出的问题；你是否曾遇到过当你在单步调试时突然抛出异常而你却忘了单步执行到哪一步时抛出的异常，于是你只好重来一次。Beta程序在客户那里试运行当中，突然当机，而你不能调试，只能依据客户报告的一些信息来找bug，而客户大多不熟悉程序开发，所以他们报告的信息太少使你感觉无从下手、一筹莫展。
如果你碰到过以上情况，你就只好痛苦地一条一条单步执行语句，看抛出异常的语句在哪，检查非法访问内存的语句在哪里，糟糕的是根据海森堡不确定原理，有时当你调试时又不出问题了。所以幸运的话，你能很快就找到bug，不幸的话，几小时或几天都不能找出问题所在，并将成为你的梦魇。我在程序开发过程中，就经常碰到以上这些情况。
众所周知，在程序开发中发现一个bug将比改正这个bug难度大很多。所以如果有一个方法能够在程序出错时把出错信息打印出来，这样将大大方便找到bug，加快程序开发速度，提高程序的质量。这样，当客户报告程序出错时，你只需要客户把日志发送给你，你根据这个日志里的异常堆栈信息就能轻松发现问题所在。
在java中就有堆栈跟踪功能，它能在程序抛出异常时，能够打印出能够把导致抛出异常的语句所在的文件名和行号，C#中也有这个功能。很多人认为用java开发程序比用C++开发程序要快，我认为java有抛出异常时能够跟踪堆栈这个功能是其中的一个重要原因。 2． 如何实现C++异常中的堆栈跟踪
要实现堆栈跟踪，必须依赖于底层机制即操作系统或虚拟平台，java与jvm虚拟平台绑定，C#与.NET虚拟平台绑定，它们都提供了堆栈跟踪的功能，而C++与操作系统或平台无关，所以没有提供这个功能，但是否能够利用操作系统的系统函数实现这个功能呢？下面简要介绍如何在Windows2000下实现C++异常中的堆栈跟踪。
在Windows中，C++异常底层的实现是通过Windows中的结构化异常SEH来实现的，结构化异常包括如除0溢出、非法内存访问、堆栈溢出等，虽然用catch( … )能够捕获结构化异常，但不能知道是哪种结构化异常，所以第一步就是要把结构化异常转化为C++异常，Windows中的_set_se_translator()函数可以实现这个功能。先建立一个转化函数：void _cdecl TranslateSEHtoCE( UINT code, PEXCEPTION_POINTERS pep ) ；在这个转化函数中抛出一个继承C++标准异常的类，如CRecoverableSEHException（可以恢复的结构化异常类）和CUnRecoverableSEHException（不可以恢复的结构化异常类），这两个类继承CSEHException，CSEHException继承标准C++异常的基类exception。然后在main函数开始处调用 _set_se_translator(TranslateSEHtoCE )，这样就可以把结构化异常转换为C++异常。
另外，由于VC中默认new失败时并不抛出异常，所以需要让new失败时抛出异常，这样可以统一处理，可以使用WINDOWS中的_set_new_h*ler( )转化，让new失败时抛出异常。同上，先建立一个转化函数 int NewH*ler( size_t size )，在这个转化函数中抛出C++标准异常的类bad_alloc，在main函数开始处调用 _set_new_h*ler (NewH*ler)。
接着在CSEHException的构造函数中跟踪堆栈，把导致抛出结构化异常的语句所在的文件名和行号打印出来，调用void ShowStack( H*LE hThread, CONTEXT& c )。ShowStack函数封装了跟踪堆栈所需调用的各种系统API。它的功能就是根据参数c（线程的上下文），得到当前程序的路径，枚举所调用的系统动态连接库，然后按照从里到外的顺序打印出所有执行的函数名及其所在的文件名和行号。
创建自己的异常类使其具有堆栈跟踪的功能，定义自己使用的异常基类如CMyException（当然，如果你愿意，你可以修改其命名），令其继承标准C++异常类domain_error（当然也可以继承exception），然后在CMyException的构造函数中调用void ShowStack( H*LE hThread, CONTEXT& c )，这样就可以实现堆栈跟踪，其它自定义的异常继承CMyException，就自动获得堆栈跟踪的功能。这样就形成了一个完整的类层次。 exception logic_error *time_error
length_error
out_of_range bad_alloc bad_cast range_error
invalid_argument bad_exception overflow_error
domain_error ios_base:failure underflow_error CMyException（自定义异常基类） CSEHException（结构化异常基类） CRecoverableSEHException CUnRecoverableSEHException CSocketException（与socket相关的异常）
CConfigException（与配置文件相关的异常）
注：CMyException上面的异常类均为标准C++的异常类。
注：以上异常类的基类均为exception。
本人实现的具有堆栈跟踪的C++异常类库和测试程序可以从www.smiling.com.cn中的umlchina小组中下载StackTraceInC.zip文件。
3． 如何使用C++异常中的堆栈跟踪类库
下载的文件包括Exception.h Exception.cpp（具有堆栈跟踪功能的异常类库）， main.cpp, Test1.h, Test1.cpp （测试代码）。
让我们先感受一下堆栈跟踪的威力，运行下载的示例程序，将打印出如下结果（因为输出太长，所以只节选了其中一部分）。主程序为：
void main(){ // 在每个线程函数的入口加上以下语句。
// 检查内存泄露。
CWinUtil::vCheckMemoryLeak();
// 使new函数失败时抛出异常。
CWinUtil::vSetThrowNewException();
// 把WINDOWS中的结构化异常转化为C++异常。
CWinUtil::vMapSEHtoCE();
// 初始化。
CWinUtil::vInitStackEnviroment();
try {
// 捕获非法访问内存的结构化异常。
int* pInt; // 故意不分配内存
*pInt = 5; // 应该显示出这一行出错。
}
// 捕获可恢复的结构化异常。
catch ( const CRecoverableSEHException &bug ) {
cout > i; // 防止无意中按键使程序退出。
}