在Linux與Windows上擷取當前堆棧資訊

標籤：walk   size_t   frame   eof   over   else   nal   開源   cin   

在編寫穩定可靠的軟體服務時經常用到輸出堆棧資訊，以便使用者/開發人員擷取準確的運行資訊。常用在日誌輸出，錯誤報表，異常檢測。

在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>#include <TlHelp32.h>using namespace std;HANDLE ph;void baz(){    int* v = 0;    *v = 0;}void bar(){    baz();}void foo(){    __try {        bar();    }    __except(EXCEPTION_EXECUTE_HANDLER) {        auto sire = SymInitialize(ph, 0, FALSE);        sire = SymSetOptions(SymGetOptions() | SYMOPT_LOAD_LINES | SYMOPT_FAIL_CRITICAL_ERRORS);        CONTEXT ctx = { 0 };        ctx.ContextFlags = CONTEXT_FULL;        RtlCaptureContext(&ctx);        STACKFRAME64 sf = { 0 };    #ifdef _M_IX86 // ignore IA64        auto imageType = IMAGE_FILE_MACHINE_I386;        sf.AddrPC.Offset = ctx.Eip;        sf.AddrPC.Mode = AddrModeFlat;        sf.AddrFrame.Offset = ctx.Ebp;        sf.AddrFrame.Mode = AddrModeFlat;        sf.AddrStack.Offset = ctx.Esp;        sf.AddrStack.Mode = AddrModeFlat;    #elif _M_X64        auto imageType = IMAGE_FILE_MACHINE_AMD64;        sf.AddrPC.Offset = ctx.Rip;        sf.AddrPC.Mode = AddrModeFlat;        sf.AddrFrame.Offset = ctx.Rsp;        sf.AddrFrame.Mode = AddrModeFlat;        sf.AddrStack.Offset = ctx.Rsp;        sf.AddrStack.Mode = AddrModeFlat;    #endif        MODULEENTRY32 me;        auto snap = CreateToolhelp32Snapshot(TH32CS_SNAPMODULE, GetCurrentProcessId());        auto info = Module32First(snap, &me);        while (info) {            auto dw = SymLoadModule64(ph, 0, me.szExePath, me.szModule, (DWORD64)me.modBaseAddr, me.modBaseSize);            if (!Module32Next(snap, &me))break;        }        CloseHandle(snap);        auto thread = GetCurrentThread();        PIMAGEHLP_SYMBOL64 sym = (IMAGEHLP_SYMBOL64 *)malloc(sizeof(IMAGEHLP_SYMBOL64) + 100);        if (!sym)            return;        memset(sym, 0, sizeof(IMAGEHLP_SYMBOL64) + 100);        sym->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL64);        sym->MaxNameLength = 100;        IMAGEHLP_LINE64 line = { 0 };        line.SizeOfStruct = sizeof(line);        for (;;) {            auto result = StackWalk(imageType, ph, thread, &sf, &ctx, 0, SymFunctionTableAccess64, SymGetModuleBase64, 0);            if (result) {                DWORD64 offset = 0;                DWORD offset_for_line = 0;                CHAR und_fullname[100];                if (sf.AddrPC.Offset != 0) {                    if (SymGetSymFromAddr64(ph, sf.AddrPC.Offset, &offset, sym)) {                        UnDecorateSymbolName(sym->Name, und_fullname, 100, UNDNAME_COMPLETE);                        cout << und_fullname;                    }                    if (SymGetLineFromAddr64(ph, sf.AddrPC.Offset, &offset_for_line, &line)) {                        cout << " " << line.FileName << "(" << line.LineNumber << ")";                    }                    cout << endl;                }            }            else                break;        }        SymCleanup(ph);    }}int main(){    ph = GetCurrentProcess();    foo();    return 0;}

 

編譯請連結dbghelp.lib

核心就是StackWalk與SymGetSymFromAddr64，SymGetLineFromAddr64。

StackWalk用於擷取下一層堆棧。

SymGetSymFromAddr64用於擷取當前函數名。

SymGetLineFromAddr64用於擷取函數所在檔案及行號。

為了這三個函數正常工作，還要初始化符號相關功能（SymInitialize），取得當前線程描述表（RtlCaptureContext），載入用到的模組（SymLoadModule64）。

用到了<DbgHelp.h> <TlHelp32.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

在Linux與Windows上擷取當前堆棧資訊