在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