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

，然後利用函數

CaptureStackBackTrace

、

SymFromAddr

、

SymGetLineFromAddr64

來擷取當時的函數調用堆棧資訊，以下的代碼實作了一個簡單的列印堆棧新的函數，堆棧深度最大設定為12層，實際情況肯定是越深越好，設定為12一般就可以查到問題了。

#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平台下可以利用函數

   CaptureStackBackTrace

   、

   SymFromAddr

   、

   SymGetLineFromAddr64

   來擷取當時的函數調用堆棧資訊
2. 使用上述函數時，需要引用頭檔案

   <dbghelp.h>

   ，添加庫引用

   DbgHelp.Lib

程式源碼

列印堆棧資訊–源碼傳送門