首页 > 嗟来之食 > 在Linux与Windows上获取当前堆栈信息
2017
08-17

在Linux与Windows上获取当前堆栈信息

在编写稳定可靠的软件服务时经常用到输出堆栈信息,以便用户/开发者获取准确的运行信息。常用在日志输出,错误报告,异常检测。
在Linux有比较简便的函数获取堆栈信息:

#include <stdio.h>
#include <execinfo.h>
#include <signal.h>
#include <stdlib.h>
#include <unistd.h>

void handler(int sig) {
void *array[5];
size_t size;

// get void*'s for all entries on the stack
size = backtrace(array, 5);

// print out all the frames to stderr
fprintf(stderr, "Error: signal %d:\n", sig);
char** msgs = backtrace_symbols(array, size);
for(int i=1;i<size && msgs[i];++i)
printf("[%d] %s\n", i, msgs[i]);
exit(1);
}

void baz() {
int *foo = (int*)-1; // make a bad pointer
printf("%d\n", *foo); // causes segfault
}

void bar() { baz(); }
void foo() { bar(); }

int main(int argc, char **argv) {
signal(SIGSEGV, handler); // install our handler
foo(); // this will call foo, bar, and baz. baz segfaults.
}

 
以上代码从参考的stackoverflow中稍作修改而来。核心就是backtrace与backtrace_symbols两个函数。
 
Windows下推荐用StackWalker这个开源代码,支持X86,AMD64,IA64。
如果你需要一个最简的代码,那么下面是我抽取出来的代码,明显比Linux要复杂一些。(Win的很多功能实现起来要复杂一些,当然也有很多功能实现要比Linux简单很多。)
我会做一些讲解,在后面。

#include "stdafx.h"
#include <Windows.h>
#include <iostream>
#include <DbgHelp.h>

using namespace std;

LONG expt_handler(LPEXCEPTION_POINTERS ep)
{
STACKFRAME64 sf = { 0 };
#ifdef _M_IX86 // ignore IA64
auto image_type = IMAGE_FILE_MACHINE_I386;
sf.AddrPC.Offset = ep->ContextRecord->Eip;
sf.AddrFrame.Offset = sf.AddrStack.Offset = ep->ContextRecord->Esp;
#elif _M_X64
auto image_type = IMAGE_FILE_MACHINE_AMD64;
sf.AddrPC.Offset = ep->ContextRecord->Rip;
sf.AddrFrame.Offset = sf.AddrStack.Offset = ep->ContextRecord->Rsp;
#endif
sf.AddrPC.Mode = sf.AddrFrame.Mode = sf.AddrStack.Mode = AddrModeFlat;

PIMAGEHLP_SYMBOL64 sym = (IMAGEHLP_SYMBOL64 *)malloc(sizeof(IMAGEHLP_SYMBOL64) + 100);
if (!sym)return EXCEPTION_CONTINUE_SEARCH;
memset(sym, 0, sizeof(IMAGEHLP_SYMBOL64) + 100);
sym->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL64);
sym->MaxNameLength = 100;

IMAGEHLP_LINE64 line = { 0 };
line.SizeOfStruct = sizeof(line);
CONTEXT ctx = *ep->ContextRecord;
while (StackWalk(image_type, (HANDLE)-1, (HANDLE)-2, &sf, &ctx, 0, SymFunctionTableAccess64, SymGetModuleBase64, 0)) {
DWORD64 offset = 0;
DWORD offset_for_line = 0;
CHAR und_fullname[100];

if (sf.AddrPC.Offset != 0) {
if (SymGetSymFromAddr64((HANDLE)-1, sf.AddrPC.Offset, &offset, sym)) {
UnDecorateSymbolName(sym->Name, und_fullname, 100, UNDNAME_COMPLETE);
cout << und_fullname;
}

if (SymGetLineFromAddr64((HANDLE)-1, sf.AddrPC.Offset, &offset_for_line, &line)) {
cout << " " << line.FileName << "(" << line.LineNumber << ")";
}
cout << endl;
}
}
return EXCEPTION_EXECUTE_HANDLER;
}

void baz()
{
int* v = 0;
*v = 0;
}
void bar()
{
baz();
}

void foo()
{
__try {
bar();
}
__except(expt_handler(GetExceptionInformation())) {
}
}
int main()
{
SymInitialize((HANDLE)-1, 0, TRUE);
foo();
SymCleanup((HANDLE)-1);
return 0;
}

 
编译请链接dbghelp.lib
核心就是StackWalk与SymGetSymFromAddr64,SymGetLineFromAddr64。
StackWalk用于获取下一层堆栈。
SymGetSymFromAddr64用于获取当前函数名。
SymGetLineFromAddr64用于获取函数所在文件及行号。
为了这三个函数正常工作,还要初始化符号相关功能(SymInitialize),以及清理(SymCleanup)。
用到了<DbgHelp.h> 这个头文件。
上面代码执行后会在控制台输出堆栈信息。
 
参考:
  https://stackoverflow.com/questions/77005/how-to-generate-a-stacktrace-when-my-gcc-c-app-crashes
  http://www.codeproject.com/KB/threads/StackWalker.aspx

最后编辑:
作者:
这个作者貌似有点懒,什么都没有留下。

留下一个回复