windows环境下C++代码打印函数堆栈调用情况

前言

程序运行的过程中,函数之间的是会相互调用的,在某一时刻函数之间的调用关系,可以通过函数调用堆栈表现出来,这个调用堆栈所展现的就是函数A调用了函数B,而函数B又调用了函数C,这些调用关系在代码中都是静态的,不需要程序运行就可以知道。

既然函数之间的调用关系可以通过分析代码就可以知道,那么查看函数调用的堆栈是不是作用不大了呢?事实上恰恰相反,查看函数调用堆栈的作用非常大。因为在较大型的项目中,函数之间的调用不是简单的一条线,常常会出现复杂的网状结构,这时如果函数C被调用了,可能不是仅仅是B函数调用过来的,也有可能是D、E、F等函数调用了C函数,所以知道在程序运行时究竟是哪个函数调用了C函数显得很重要,特别是有众多函数会调用C函数的时候。

查看函数堆栈的作用

举个例子就明白了,假如C函数中逻辑的执行需要一些特殊条件状态,理论上执行C函数时这些条件都应该满足的,但是程序在运行的过程中有时运行C函数时条件就是不满足的,那就说明有些调用C函数的逻辑分支有问题,无法满足C函数中逻辑所需条件,这时候知道是谁调用C函数导致条件不满足就是确定问题的关键。

如果是在VS调试状态下,在C函数不满足条件的逻辑中打一个断点,然后运行程序等待断点触发时,就可以通过VS工具自带的调用堆栈窗口,就可以看到程序从主函数main()开始怎样一步步调用的出错的函数C的。

可实际项目中,出错的时候不总是在VS的调试状态下,也有可能发生在程序实际的工作环境中,这时没有办法通过加断点来查看调用堆栈,如果此时有一个函数,可以打印当前的函数调用堆栈那就太好了,这样我就可以在需要调试的逻辑中,调用这个函数,将当时的函数调用堆栈信息打印到文件中,方便查找程序逻辑问题,这篇文章要做的就是在Windows环境下,利用现有的API实现这样一个函数。

实现打印堆栈信息的函数

在Windows系统上想打印函数调用堆栈信息,需要引用头文件<dbghelp.h>,添加库引用DbgHelp.Lib,然后利用函数CaptureStackBackTraceSymFromAddrSymGetLineFromAddr64来获取当时的函数调用堆栈信息,以下的代码实现了一个简单的打印堆栈新的函数,堆栈深度最大设置为12层,实际情况肯定是越深越好,设置为12一般就可以查到问题了。

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
#include <windows.h>
#include <dbghelp.h>
#include <stdio.h>

#if _MSC_VER
#define snprintf _snprintf
#endif

#define STACK_INFO_LEN 1024

void ShowTraceStack(char* szBriefInfo)
{
static const int MAX_STACK_FRAMES = 12;
void *pStack[MAX_STACK_FRAMES];
static char szStackInfo[STACK_INFO_LEN * MAX_STACK_FRAMES];
static char szFrameInfo[STACK_INFO_LEN];

HANDLE process = GetCurrentProcess();
SymInitialize(process, NULL, TRUE);
WORD frames = CaptureStackBackTrace(0, MAX_STACK_FRAMES, pStack, NULL);
strcpy(szStackInfo, szBriefInfo == NULL ? "stack traceback:\n" : szBriefInfo);

for (WORD i = 0; i < frames; ++i) {
DWORD64 address = (DWORD64)(pStack[i]);

DWORD64 displacementSym = 0;
char buffer[sizeof(SYMBOL_INFO)+MAX_SYM_NAME * sizeof(TCHAR)];
PSYMBOL_INFO pSymbol = (PSYMBOL_INFO)buffer;
pSymbol->SizeOfStruct = sizeof(SYMBOL_INFO);
pSymbol->MaxNameLen = MAX_SYM_NAME;

DWORD displacementLine = 0;
IMAGEHLP_LINE64 line;
line.SizeOfStruct = sizeof(IMAGEHLP_LINE64);

if (SymFromAddr(process, address, &displacementSym, pSymbol) &&
SymGetLineFromAddr64(process, address, &displacementLine, &line))
{
snprintf(szFrameInfo, sizeof(szFrameInfo), "\t%s() at %s:%d(0x%x)\n",
pSymbol->Name, line.FileName, line.LineNumber, pSymbol->Address);
}
else
{
snprintf(szFrameInfo, sizeof(szFrameInfo), "\terror: %d\n", GetLastError());
}
strcat(szStackInfo, szFrameInfo);
}

printf("%s", szStackInfo); // 输出到控制台,也可以打印到日志文件中
}

void func2()
{
bool isError = true;
if (isError)
{
ShowTraceStack("error in func2\n");
}
else
{
printf("this is func2\n");
}
}

void func1()
{
int sum = 0;
for (int i = 0; i < 100; ++i)
sum += i;

func2();
}


int main(int argc, char* argv[])
{
printf("hello world\n");
func1();

return 0;
}

显示堆栈调用信息

上面的测试代码中函数的调用逻辑为:main()函数调用func1()函数,然后func1()函数调用func2()函数,当func2()中发生问题的时候打印当时的堆栈信息,然后我们查看一下打印结果

hello world
error in func2

ShowTraceStack() at e:\vs2013projects\trackback\windowstrackback\windowstrackback.cpp:24(0xe01440)
 func2() at e:\vs2013projects\trackback\windowstrackback\windowstrackback.cpp:59(0xe01840)
 func1() at e:\vs2013projects\trackback\windowstrackback\windowstrackback.cpp:74(0xe017c0)
 main() at e:\vs2013projects\trackback\windowstrackback\windowstrackback.cpp:82(0xe018c0)
 __tmainCRTStartup() at f:\dd\vctools\crt\crtw32\dllstuff\crtexe.c:626(0xe01d40)
 mainCRTStartup() at f:\dd\vctools\crt\crtw32\dllstuff\crtexe.c:466(0xe020c0)
 error: 487
 error: 487
 error: 487

总结

  1. Windows平台下可以利用函数CaptureStackBackTraceSymFromAddrSymGetLineFromAddr64来获取当时的函数调用堆栈信息
  2. 使用上述函数时,需要引用头文件<dbghelp.h>,添加库引用DbgHelp.Lib

程序源码

打印堆栈信息–源码传送门

Albert Shi wechat
欢迎您扫一扫上面的微信公众号,订阅我的博客